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

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v9.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: "v9"
  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/v9
  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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2252           required: true
2253           schema:
2254             $ref: "#/definitions/vlan"
2255     patch:
2256       tags:
2257         - CloudInfrastructure
2258       summary: update an existing vlan
2259       description: |
2260         Update an existing vlan
2261         #
2262         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2263         The PUT operation will entirely replace an existing object.
2264         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2265         #
2266         Other differences between PUT and PATCH are:
2267         #
2268         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2269         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2270         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2271       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2272       consumes:
2273         - application/json
2274         - application/xml
2275       produces:
2276         - application/json
2277         - application/xml
2278       responses:
2279         "default":
2280           description: Response codes found in [response codes](https://wiki.onap.org/).
2281       parameters:
2282         - name: cloud-owner
2283           in: path
2284           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2285           required: true
2286           type: string
2287           example: __CLOUD-OWNER__
2288         - name: cloud-region-id
2289           in: path
2290           description: Identifier used by the vendor for the region. Second part of composite key
2291           required: true
2292           type: string
2293           example: __CLOUD-REGION-ID__
2294         - name: tenant-id
2295           in: path
2296           description: Unique id relative to the cloud-region.
2297           required: true
2298           type: string
2299           example: __TENANT-ID__
2300         - name: vserver-id
2301           in: path
2302           description: Unique identifier for this vserver relative to its tenant
2303           required: true
2304           type: string
2305           example: __VSERVER-ID__
2306         - name: interface-name
2307           in: path
2308           description: Name given to the interface
2309           required: true
2310           type: string
2311           example: __INTERFACE-NAME__
2312         - name: vlan-interface
2313           in: path
2314           description: String that identifies the interface
2315           required: true
2316           type: string
2317           example: __VLAN-INTERFACE__
2318         - name: body
2319           in: body
2320           description: vlan object that needs to be updated.
2321           required: true
2322           schema:
2323             $ref: "#/patchDefinitions/vlan"
2324     delete:
2325       tags:
2326         - CloudInfrastructure
2327       summary: delete an existing vlan
2328       description: delete an existing vlan
2329       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2330       consumes:
2331         - application/json
2332         - application/xml
2333       produces:
2334         - application/json
2335         - application/xml
2336       responses:
2337         "default":
2338           description: Response codes found in [response codes](https://wiki.onap.org/).
2339       parameters:
2340         - name: cloud-owner
2341           in: path
2342           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2343           required: true
2344           type: string
2345           example: __CLOUD-OWNER__
2346         - name: cloud-region-id
2347           in: path
2348           description: Identifier used by the vendor for the region. Second part of composite key
2349           required: true
2350           type: string
2351           example: __CLOUD-REGION-ID__
2352         - name: tenant-id
2353           in: path
2354           description: Unique id relative to the cloud-region.
2355           required: true
2356           type: string
2357           example: __TENANT-ID__
2358         - name: vserver-id
2359           in: path
2360           description: Unique identifier for this vserver relative to its tenant
2361           required: true
2362           type: string
2363           example: __VSERVER-ID__
2364         - name: interface-name
2365           in: path
2366           description: Name given to the interface
2367           required: true
2368           type: string
2369           example: __INTERFACE-NAME__
2370         - name: vlan-interface
2371           in: path
2372           description: String that identifies the interface
2373           required: true
2374           type: string
2375           example: __VLAN-INTERFACE__
2376         - name: resource-version
2377           in: query
2378           description: resource-version for concurrency
2379           required: true
2380           type: string
2381   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans:
2382     get:
2383       tags:
2384         - CloudInfrastructure
2385       summary: returns vlans
2386       description: returns vlans
2387       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2388       produces:
2389         - application/json
2390         - application/xml
2391       responses:
2392         "200":
2393           description: successful operation
2394           schema:
2395               $ref: "#/getDefinitions/vlans"
2396         "default":
2397           description: Response codes found in [response codes](https://wiki.onap.org/).
2398       parameters:
2399         - name: cloud-owner
2400           in: path
2401           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2402           required: true
2403           type: string
2404           example: __CLOUD-OWNER__
2405         - name: cloud-region-id
2406           in: path
2407           description: Identifier used by the vendor for the region. Second part of composite key
2408           required: true
2409           type: string
2410           example: __CLOUD-REGION-ID__
2411         - name: tenant-id
2412           in: path
2413           description: Unique id relative to the cloud-region.
2414           required: true
2415           type: string
2416           example: __TENANT-ID__
2417         - name: vserver-id
2418           in: path
2419           description: Unique identifier for this vserver relative to its tenant
2420           required: true
2421           type: string
2422           example: __VSERVER-ID__
2423         - name: interface-name
2424           in: path
2425           description: Name given to the interface
2426           required: true
2427           type: string
2428           example: __INTERFACE-NAME__
2429         - name: vlan-interface
2430           in: query
2431           description:
2432           required: false
2433           type: string
2434         - name: vlan-id-inner
2435           in: query
2436           description:
2437           required: false
2438           type: integer
2439           format: int64
2440         - name: vpn-id
2441           in: query
2442           description:
2443           required: false
2444           type: string
2445   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
2446     put:
2447       tags:
2448         - CloudInfrastructure
2449       summary: see node definition for valid relationships
2450       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2451       consumes:
2452         - application/json
2453         - application/xml
2454       produces:
2455         - application/json
2456         - application/xml
2457       responses:
2458         "default":
2459           description: Response codes found in [response codes](https://wiki.onap.org/).
2460       parameters:
2461         - name: cloud-owner
2462           in: path
2463           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2464           required: true
2465           type: string
2466           example: __CLOUD-OWNER__
2467         - name: cloud-region-id
2468           in: path
2469           description: Identifier used by the vendor for the region. Second part of composite key
2470           required: true
2471           type: string
2472           example: __CLOUD-REGION-ID__
2473         - name: tenant-id
2474           in: path
2475           description: Unique id relative to the cloud-region.
2476           required: true
2477           type: string
2478           example: __TENANT-ID__
2479         - name: vserver-id
2480           in: path
2481           description: Unique identifier for this vserver relative to its tenant
2482           required: true
2483           type: string
2484           example: __VSERVER-ID__
2485         - name: interface-name
2486           in: path
2487           description: Name given to the interface
2488           required: true
2489           type: string
2490           example: __INTERFACE-NAME__
2491         - name: pci-id
2492           in: path
2493           description: PCI ID used to identify the sriov-vf
2494           required: true
2495           type: string
2496           example: __PCI-ID__
2497         - name: body
2498           in: body
2499           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4357           required: true
4358           schema:
4359             $ref: "#/definitions/tenant"
4360     patch:
4361       tags:
4362         - CloudInfrastructure
4363       summary: update an existing tenant
4364       description: |
4365         Update an existing tenant
4366         #
4367         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4368         The PUT operation will entirely replace an existing object.
4369         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4370         #
4371         Other differences between PUT and PATCH are:
4372         #
4373         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4374         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4375         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4376       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4377       consumes:
4378         - application/json
4379         - application/xml
4380       produces:
4381         - application/json
4382         - application/xml
4383       responses:
4384         "default":
4385           description: Response codes found in [response codes](https://wiki.onap.org/).
4386       parameters:
4387         - name: cloud-owner
4388           in: path
4389           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4390           required: true
4391           type: string
4392           example: __CLOUD-OWNER__
4393         - name: cloud-region-id
4394           in: path
4395           description: Identifier used by the vendor for the region. Second part of composite key
4396           required: true
4397           type: string
4398           example: __CLOUD-REGION-ID__
4399         - name: tenant-id
4400           in: path
4401           description: Unique id relative to the cloud-region.
4402           required: true
4403           type: string
4404           example: __TENANT-ID__
4405         - name: body
4406           in: body
4407           description: tenant object that needs to be updated.
4408           required: true
4409           schema:
4410             $ref: "#/patchDefinitions/tenant"
4411     delete:
4412       tags:
4413         - CloudInfrastructure
4414       summary: delete an existing tenant
4415       description: delete an existing tenant
4416       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4417       consumes:
4418         - application/json
4419         - application/xml
4420       produces:
4421         - application/json
4422         - application/xml
4423       responses:
4424         "default":
4425           description: Response codes found in [response codes](https://wiki.onap.org/).
4426       parameters:
4427         - name: cloud-owner
4428           in: path
4429           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4430           required: true
4431           type: string
4432           example: __CLOUD-OWNER__
4433         - name: cloud-region-id
4434           in: path
4435           description: Identifier used by the vendor for the region. Second part of composite key
4436           required: true
4437           type: string
4438           example: __CLOUD-REGION-ID__
4439         - name: tenant-id
4440           in: path
4441           description: Unique id relative to the cloud-region.
4442           required: true
4443           type: string
4444           example: __TENANT-ID__
4445         - name: resource-version
4446           in: query
4447           description: resource-version for concurrency
4448           required: true
4449           type: string
4450   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
4451     get:
4452       tags:
4453         - CloudInfrastructure
4454       summary: returns tenants
4455       description: returns tenants
4456       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
4457       produces:
4458         - application/json
4459         - application/xml
4460       responses:
4461         "200":
4462           description: successful operation
4463           schema:
4464               $ref: "#/getDefinitions/tenants"
4465         "default":
4466           description: Response codes found in [response codes](https://wiki.onap.org/).
4467       parameters:
4468         - name: cloud-owner
4469           in: path
4470           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4471           required: true
4472           type: string
4473           example: __CLOUD-OWNER__
4474         - name: cloud-region-id
4475           in: path
4476           description: Identifier used by the vendor for the region. Second part of composite key
4477           required: true
4478           type: string
4479           example: __CLOUD-REGION-ID__
4480         - name: tenant-id
4481           in: query
4482           description:
4483           required: false
4484           type: string
4485         - name: tenant-name
4486           in: query
4487           description:
4488           required: false
4489           type: string
4490   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
4491     put:
4492       tags:
4493         - CloudInfrastructure
4494       summary: see node definition for valid relationships
4495       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4496       consumes:
4497         - application/json
4498         - application/xml
4499       produces:
4500         - application/json
4501         - application/xml
4502       responses:
4503         "default":
4504           description: Response codes found in [response codes](https://wiki.onap.org/).
4505       parameters:
4506         - name: cloud-owner
4507           in: path
4508           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4509           required: true
4510           type: string
4511           example: __CLOUD-OWNER__
4512         - name: cloud-region-id
4513           in: path
4514           description: Identifier used by the vendor for the region. Second part of composite key
4515           required: true
4516           type: string
4517           example: __CLOUD-REGION-ID__
4518         - name: flavor-id
4519           in: path
4520           description: Flavor id, expected to be unique across cloud-region.
4521           required: true
4522           type: string
4523           example: __FLAVOR-ID__
4524         - name: body
4525           in: body
4526           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4527           required: true
4528           schema:
4529             $ref: "#/definitions/relationship"
4530     delete:
4531       tags:
4532         - CloudInfrastructure
4533       summary: delete an existing relationship
4534       description: delete an existing relationship
4535       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4536       consumes:
4537         - application/json
4538         - application/xml
4539       produces:
4540         - application/json
4541         - application/xml
4542       responses:
4543         "default":
4544           description: Response codes found in [response codes](https://wiki.onap.org/).
4545       parameters:
4546         - name: cloud-owner
4547           in: path
4548           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4549           required: true
4550           type: string
4551           example: __CLOUD-OWNER__
4552         - name: cloud-region-id
4553           in: path
4554           description: Identifier used by the vendor for the region. Second part of composite key
4555           required: true
4556           type: string
4557           example: __CLOUD-REGION-ID__
4558         - name: flavor-id
4559           in: path
4560           description: Flavor id, expected to be unique across cloud-region.
4561           required: true
4562           type: string
4563           example: __FLAVOR-ID__
4564   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
4565     get:
4566       tags:
4567         - CloudInfrastructure
4568       summary: returns flavor
4569       description: returns flavor
4570       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4571       produces:
4572         - application/json
4573         - application/xml
4574       responses:
4575         "200":
4576           description: successful operation
4577           schema:
4578               $ref: "#/getDefinitions/flavor"
4579         "default":
4580           description: Response codes found in [response codes](https://wiki.onap.org/).
4581       parameters:
4582         - name: cloud-owner
4583           in: path
4584           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4585           required: true
4586           type: string
4587           example: __CLOUD-OWNER__
4588         - name: cloud-region-id
4589           in: path
4590           description: Identifier used by the vendor for the region. Second part of composite key
4591           required: true
4592           type: string
4593           example: __CLOUD-REGION-ID__
4594         - name: flavor-id
4595           in: path
4596           description: Flavor id, expected to be unique across cloud-region.
4597           required: true
4598           type: string
4599           example: __FLAVOR-ID__
4600     put:
4601       tags:
4602         - CloudInfrastructure
4603       summary: create or update an existing flavor
4604       description: |
4605         Create or update an existing flavor.
4606         #
4607         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4608       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4609       consumes:
4610         - application/json
4611         - application/xml
4612       produces:
4613         - application/json
4614         - application/xml
4615       responses:
4616         "default":
4617           description: Response codes found in [response codes](https://wiki.onap.org/).
4618       parameters:
4619         - name: cloud-owner
4620           in: path
4621           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4622           required: true
4623           type: string
4624           example: __CLOUD-OWNER__
4625         - name: cloud-region-id
4626           in: path
4627           description: Identifier used by the vendor for the region. Second part of composite key
4628           required: true
4629           type: string
4630           example: __CLOUD-REGION-ID__
4631         - name: flavor-id
4632           in: path
4633           description: Flavor id, expected to be unique across cloud-region.
4634           required: true
4635           type: string
4636           example: __FLAVOR-ID__
4637         - name: body
4638           in: body
4639           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4640           required: true
4641           schema:
4642             $ref: "#/definitions/flavor"
4643     patch:
4644       tags:
4645         - CloudInfrastructure
4646       summary: update an existing flavor
4647       description: |
4648         Update an existing flavor
4649         #
4650         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4651         The PUT operation will entirely replace an existing object.
4652         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4653         #
4654         Other differences between PUT and PATCH are:
4655         #
4656         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4657         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4658         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4659       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4660       consumes:
4661         - application/json
4662         - application/xml
4663       produces:
4664         - application/json
4665         - application/xml
4666       responses:
4667         "default":
4668           description: Response codes found in [response codes](https://wiki.onap.org/).
4669       parameters:
4670         - name: cloud-owner
4671           in: path
4672           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4673           required: true
4674           type: string
4675           example: __CLOUD-OWNER__
4676         - name: cloud-region-id
4677           in: path
4678           description: Identifier used by the vendor for the region. Second part of composite key
4679           required: true
4680           type: string
4681           example: __CLOUD-REGION-ID__
4682         - name: flavor-id
4683           in: path
4684           description: Flavor id, expected to be unique across cloud-region.
4685           required: true
4686           type: string
4687           example: __FLAVOR-ID__
4688         - name: body
4689           in: body
4690           description: flavor object that needs to be updated.
4691           required: true
4692           schema:
4693             $ref: "#/patchDefinitions/flavor"
4694     delete:
4695       tags:
4696         - CloudInfrastructure
4697       summary: delete an existing flavor
4698       description: delete an existing flavor
4699       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4700       consumes:
4701         - application/json
4702         - application/xml
4703       produces:
4704         - application/json
4705         - application/xml
4706       responses:
4707         "default":
4708           description: Response codes found in [response codes](https://wiki.onap.org/).
4709       parameters:
4710         - name: cloud-owner
4711           in: path
4712           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4713           required: true
4714           type: string
4715           example: __CLOUD-OWNER__
4716         - name: cloud-region-id
4717           in: path
4718           description: Identifier used by the vendor for the region. Second part of composite key
4719           required: true
4720           type: string
4721           example: __CLOUD-REGION-ID__
4722         - name: flavor-id
4723           in: path
4724           description: Flavor id, expected to be unique across cloud-region.
4725           required: true
4726           type: string
4727           example: __FLAVOR-ID__
4728         - name: resource-version
4729           in: query
4730           description: resource-version for concurrency
4731           required: true
4732           type: string
4733   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
4734     get:
4735       tags:
4736         - CloudInfrastructure
4737       summary: returns flavors
4738       description: returns flavors
4739       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
4740       produces:
4741         - application/json
4742         - application/xml
4743       responses:
4744         "200":
4745           description: successful operation
4746           schema:
4747               $ref: "#/getDefinitions/flavors"
4748         "default":
4749           description: Response codes found in [response codes](https://wiki.onap.org/).
4750       parameters:
4751         - name: cloud-owner
4752           in: path
4753           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4754           required: true
4755           type: string
4756           example: __CLOUD-OWNER__
4757         - name: cloud-region-id
4758           in: path
4759           description: Identifier used by the vendor for the region. Second part of composite key
4760           required: true
4761           type: string
4762           example: __CLOUD-REGION-ID__
4763         - name: flavor-id
4764           in: query
4765           description:
4766           required: false
4767           type: string
4768         - name: flavor-name
4769           in: query
4770           description:
4771           required: false
4772           type: string
4773   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
4774     put:
4775       tags:
4776         - CloudInfrastructure
4777       summary: see node definition for valid relationships
4778       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4779       consumes:
4780         - application/json
4781         - application/xml
4782       produces:
4783         - application/json
4784         - application/xml
4785       responses:
4786         "default":
4787           description: Response codes found in [response codes](https://wiki.onap.org/).
4788       parameters:
4789         - name: cloud-owner
4790           in: path
4791           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4792           required: true
4793           type: string
4794           example: __CLOUD-OWNER__
4795         - name: cloud-region-id
4796           in: path
4797           description: Identifier used by the vendor for the region. Second part of composite key
4798           required: true
4799           type: string
4800           example: __CLOUD-REGION-ID__
4801         - name: group-id
4802           in: path
4803           description: Group id, expected to be unique across cloud-region.
4804           required: true
4805           type: string
4806           example: __GROUP-ID__
4807         - name: body
4808           in: body
4809           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4810           required: true
4811           schema:
4812             $ref: "#/definitions/relationship"
4813     delete:
4814       tags:
4815         - CloudInfrastructure
4816       summary: delete an existing relationship
4817       description: delete an existing relationship
4818       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4819       consumes:
4820         - application/json
4821         - application/xml
4822       produces:
4823         - application/json
4824         - application/xml
4825       responses:
4826         "default":
4827           description: Response codes found in [response codes](https://wiki.onap.org/).
4828       parameters:
4829         - name: cloud-owner
4830           in: path
4831           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4832           required: true
4833           type: string
4834           example: __CLOUD-OWNER__
4835         - name: cloud-region-id
4836           in: path
4837           description: Identifier used by the vendor for the region. Second part of composite key
4838           required: true
4839           type: string
4840           example: __CLOUD-REGION-ID__
4841         - name: group-id
4842           in: path
4843           description: Group id, expected to be unique across cloud-region.
4844           required: true
4845           type: string
4846           example: __GROUP-ID__
4847   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
4848     get:
4849       tags:
4850         - CloudInfrastructure
4851       summary: returns group-assignment
4852       description: returns group-assignment
4853       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4854       produces:
4855         - application/json
4856         - application/xml
4857       responses:
4858         "200":
4859           description: successful operation
4860           schema:
4861               $ref: "#/getDefinitions/group-assignment"
4862         "default":
4863           description: Response codes found in [response codes](https://wiki.onap.org/).
4864       parameters:
4865         - name: cloud-owner
4866           in: path
4867           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4868           required: true
4869           type: string
4870           example: __CLOUD-OWNER__
4871         - name: cloud-region-id
4872           in: path
4873           description: Identifier used by the vendor for the region. Second part of composite key
4874           required: true
4875           type: string
4876           example: __CLOUD-REGION-ID__
4877         - name: group-id
4878           in: path
4879           description: Group id, expected to be unique across cloud-region.
4880           required: true
4881           type: string
4882           example: __GROUP-ID__
4883     put:
4884       tags:
4885         - CloudInfrastructure
4886       summary: create or update an existing group-assignment
4887       description: |
4888         Create or update an existing group-assignment.
4889         #
4890         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4891       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4892       consumes:
4893         - application/json
4894         - application/xml
4895       produces:
4896         - application/json
4897         - application/xml
4898       responses:
4899         "default":
4900           description: Response codes found in [response codes](https://wiki.onap.org/).
4901       parameters:
4902         - name: cloud-owner
4903           in: path
4904           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4905           required: true
4906           type: string
4907           example: __CLOUD-OWNER__
4908         - name: cloud-region-id
4909           in: path
4910           description: Identifier used by the vendor for the region. Second part of composite key
4911           required: true
4912           type: string
4913           example: __CLOUD-REGION-ID__
4914         - name: group-id
4915           in: path
4916           description: Group id, expected to be unique across cloud-region.
4917           required: true
4918           type: string
4919           example: __GROUP-ID__
4920         - name: body
4921           in: body
4922           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4923           required: true
4924           schema:
4925             $ref: "#/definitions/group-assignment"
4926     patch:
4927       tags:
4928         - CloudInfrastructure
4929       summary: update an existing group-assignment
4930       description: |
4931         Update an existing group-assignment
4932         #
4933         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4934         The PUT operation will entirely replace an existing object.
4935         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4936         #
4937         Other differences between PUT and PATCH are:
4938         #
4939         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4940         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4941         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4942       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4943       consumes:
4944         - application/json
4945         - application/xml
4946       produces:
4947         - application/json
4948         - application/xml
4949       responses:
4950         "default":
4951           description: Response codes found in [response codes](https://wiki.onap.org/).
4952       parameters:
4953         - name: cloud-owner
4954           in: path
4955           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4956           required: true
4957           type: string
4958           example: __CLOUD-OWNER__
4959         - name: cloud-region-id
4960           in: path
4961           description: Identifier used by the vendor for the region. Second part of composite key
4962           required: true
4963           type: string
4964           example: __CLOUD-REGION-ID__
4965         - name: group-id
4966           in: path
4967           description: Group id, expected to be unique across cloud-region.
4968           required: true
4969           type: string
4970           example: __GROUP-ID__
4971         - name: body
4972           in: body
4973           description: group-assignment object that needs to be updated.
4974           required: true
4975           schema:
4976             $ref: "#/patchDefinitions/group-assignment"
4977     delete:
4978       tags:
4979         - CloudInfrastructure
4980       summary: delete an existing group-assignment
4981       description: delete an existing group-assignment
4982       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4983       consumes:
4984         - application/json
4985         - application/xml
4986       produces:
4987         - application/json
4988         - application/xml
4989       responses:
4990         "default":
4991           description: Response codes found in [response codes](https://wiki.onap.org/).
4992       parameters:
4993         - name: cloud-owner
4994           in: path
4995           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4996           required: true
4997           type: string
4998           example: __CLOUD-OWNER__
4999         - name: cloud-region-id
5000           in: path
5001           description: Identifier used by the vendor for the region. Second part of composite key
5002           required: true
5003           type: string
5004           example: __CLOUD-REGION-ID__
5005         - name: group-id
5006           in: path
5007           description: Group id, expected to be unique across cloud-region.
5008           required: true
5009           type: string
5010           example: __GROUP-ID__
5011         - name: resource-version
5012           in: query
5013           description: resource-version for concurrency
5014           required: true
5015           type: string
5016   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5017     get:
5018       tags:
5019         - CloudInfrastructure
5020       summary: returns group-assignments
5021       description: returns group-assignments
5022       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5023       produces:
5024         - application/json
5025         - application/xml
5026       responses:
5027         "200":
5028           description: successful operation
5029           schema:
5030               $ref: "#/getDefinitions/group-assignments"
5031         "default":
5032           description: Response codes found in [response codes](https://wiki.onap.org/).
5033       parameters:
5034         - name: cloud-owner
5035           in: path
5036           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5037           required: true
5038           type: string
5039           example: __CLOUD-OWNER__
5040         - name: cloud-region-id
5041           in: path
5042           description: Identifier used by the vendor for the region. Second part of composite key
5043           required: true
5044           type: string
5045           example: __CLOUD-REGION-ID__
5046         - name: group-id
5047           in: query
5048           description:
5049           required: false
5050           type: string
5051         - name: group-type
5052           in: query
5053           description:
5054           required: false
5055           type: string
5056         - name: group-name
5057           in: query
5058           description:
5059           required: false
5060           type: string
5061   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5062     put:
5063       tags:
5064         - CloudInfrastructure
5065       summary: see node definition for valid relationships
5066       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5067       consumes:
5068         - application/json
5069         - application/xml
5070       produces:
5071         - application/json
5072         - application/xml
5073       responses:
5074         "default":
5075           description: Response codes found in [response codes](https://wiki.onap.org/).
5076       parameters:
5077         - name: cloud-owner
5078           in: path
5079           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5080           required: true
5081           type: string
5082           example: __CLOUD-OWNER__
5083         - name: cloud-region-id
5084           in: path
5085           description: Identifier used by the vendor for the region. Second part of composite key
5086           required: true
5087           type: string
5088           example: __CLOUD-REGION-ID__
5089         - name: snapshot-id
5090           in: path
5091           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5092           required: true
5093           type: string
5094           example: __SNAPSHOT-ID__
5095         - name: body
5096           in: body
5097           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5098           required: true
5099           schema:
5100             $ref: "#/definitions/relationship"
5101     delete:
5102       tags:
5103         - CloudInfrastructure
5104       summary: delete an existing relationship
5105       description: delete an existing relationship
5106       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5107       consumes:
5108         - application/json
5109         - application/xml
5110       produces:
5111         - application/json
5112         - application/xml
5113       responses:
5114         "default":
5115           description: Response codes found in [response codes](https://wiki.onap.org/).
5116       parameters:
5117         - name: cloud-owner
5118           in: path
5119           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5120           required: true
5121           type: string
5122           example: __CLOUD-OWNER__
5123         - name: cloud-region-id
5124           in: path
5125           description: Identifier used by the vendor for the region. Second part of composite key
5126           required: true
5127           type: string
5128           example: __CLOUD-REGION-ID__
5129         - name: snapshot-id
5130           in: path
5131           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5132           required: true
5133           type: string
5134           example: __SNAPSHOT-ID__
5135   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5136     get:
5137       tags:
5138         - CloudInfrastructure
5139       summary: returns snapshot
5140       description: returns snapshot
5141       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5142       produces:
5143         - application/json
5144         - application/xml
5145       responses:
5146         "200":
5147           description: successful operation
5148           schema:
5149               $ref: "#/getDefinitions/snapshot"
5150         "default":
5151           description: Response codes found in [response codes](https://wiki.onap.org/).
5152       parameters:
5153         - name: cloud-owner
5154           in: path
5155           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5156           required: true
5157           type: string
5158           example: __CLOUD-OWNER__
5159         - name: cloud-region-id
5160           in: path
5161           description: Identifier used by the vendor for the region. Second part of composite key
5162           required: true
5163           type: string
5164           example: __CLOUD-REGION-ID__
5165         - name: snapshot-id
5166           in: path
5167           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5168           required: true
5169           type: string
5170           example: __SNAPSHOT-ID__
5171     put:
5172       tags:
5173         - CloudInfrastructure
5174       summary: create or update an existing snapshot
5175       description: |
5176         Create or update an existing snapshot.
5177         #
5178         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5179       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5180       consumes:
5181         - application/json
5182         - application/xml
5183       produces:
5184         - application/json
5185         - application/xml
5186       responses:
5187         "default":
5188           description: Response codes found in [response codes](https://wiki.onap.org/).
5189       parameters:
5190         - name: cloud-owner
5191           in: path
5192           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5193           required: true
5194           type: string
5195           example: __CLOUD-OWNER__
5196         - name: cloud-region-id
5197           in: path
5198           description: Identifier used by the vendor for the region. Second part of composite key
5199           required: true
5200           type: string
5201           example: __CLOUD-REGION-ID__
5202         - name: snapshot-id
5203           in: path
5204           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5205           required: true
5206           type: string
5207           example: __SNAPSHOT-ID__
5208         - name: body
5209           in: body
5210           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5211           required: true
5212           schema:
5213             $ref: "#/definitions/snapshot"
5214     patch:
5215       tags:
5216         - CloudInfrastructure
5217       summary: update an existing snapshot
5218       description: |
5219         Update an existing snapshot
5220         #
5221         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5222         The PUT operation will entirely replace an existing object.
5223         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5224         #
5225         Other differences between PUT and PATCH are:
5226         #
5227         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5228         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5229         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5230       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5231       consumes:
5232         - application/json
5233         - application/xml
5234       produces:
5235         - application/json
5236         - application/xml
5237       responses:
5238         "default":
5239           description: Response codes found in [response codes](https://wiki.onap.org/).
5240       parameters:
5241         - name: cloud-owner
5242           in: path
5243           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5244           required: true
5245           type: string
5246           example: __CLOUD-OWNER__
5247         - name: cloud-region-id
5248           in: path
5249           description: Identifier used by the vendor for the region. Second part of composite key
5250           required: true
5251           type: string
5252           example: __CLOUD-REGION-ID__
5253         - name: snapshot-id
5254           in: path
5255           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5256           required: true
5257           type: string
5258           example: __SNAPSHOT-ID__
5259         - name: body
5260           in: body
5261           description: snapshot object that needs to be updated.
5262           required: true
5263           schema:
5264             $ref: "#/patchDefinitions/snapshot"
5265     delete:
5266       tags:
5267         - CloudInfrastructure
5268       summary: delete an existing snapshot
5269       description: delete an existing snapshot
5270       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5271       consumes:
5272         - application/json
5273         - application/xml
5274       produces:
5275         - application/json
5276         - application/xml
5277       responses:
5278         "default":
5279           description: Response codes found in [response codes](https://wiki.onap.org/).
5280       parameters:
5281         - name: cloud-owner
5282           in: path
5283           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5284           required: true
5285           type: string
5286           example: __CLOUD-OWNER__
5287         - name: cloud-region-id
5288           in: path
5289           description: Identifier used by the vendor for the region. Second part of composite key
5290           required: true
5291           type: string
5292           example: __CLOUD-REGION-ID__
5293         - name: snapshot-id
5294           in: path
5295           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5296           required: true
5297           type: string
5298           example: __SNAPSHOT-ID__
5299         - name: resource-version
5300           in: query
5301           description: resource-version for concurrency
5302           required: true
5303           type: string
5304   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5305     get:
5306       tags:
5307         - CloudInfrastructure
5308       summary: returns snapshots
5309       description: returns snapshots
5310       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5311       produces:
5312         - application/json
5313         - application/xml
5314       responses:
5315         "200":
5316           description: successful operation
5317           schema:
5318               $ref: "#/getDefinitions/snapshots"
5319         "default":
5320           description: Response codes found in [response codes](https://wiki.onap.org/).
5321       parameters:
5322         - name: cloud-owner
5323           in: path
5324           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5325           required: true
5326           type: string
5327           example: __CLOUD-OWNER__
5328         - name: cloud-region-id
5329           in: path
5330           description: Identifier used by the vendor for the region. Second part of composite key
5331           required: true
5332           type: string
5333           example: __CLOUD-REGION-ID__
5334         - name: snapshot-id
5335           in: query
5336           description:
5337           required: false
5338           type: string
5339         - name: snapshot-name
5340           in: query
5341           description:
5342           required: false
5343           type: string
5344         - name: application
5345           in: query
5346           description:
5347           required: false
5348           type: string
5349         - name: application-vendor
5350           in: query
5351           description:
5352           required: false
5353           type: string
5354         - name: application-version
5355           in: query
5356           description:
5357           required: false
5358           type: string
5359         - name: prev-snapshot-id
5360           in: query
5361           description:
5362           required: false
5363           type: string
5364   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
5365     put:
5366       tags:
5367         - CloudInfrastructure
5368       summary: see node definition for valid relationships
5369       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5370       consumes:
5371         - application/json
5372         - application/xml
5373       produces:
5374         - application/json
5375         - application/xml
5376       responses:
5377         "default":
5378           description: Response codes found in [response codes](https://wiki.onap.org/).
5379       parameters:
5380         - name: cloud-owner
5381           in: path
5382           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5383           required: true
5384           type: string
5385           example: __CLOUD-OWNER__
5386         - name: cloud-region-id
5387           in: path
5388           description: Identifier used by the vendor for the region. Second part of composite key
5389           required: true
5390           type: string
5391           example: __CLOUD-REGION-ID__
5392         - name: image-id
5393           in: path
5394           description: Image id, expected to be unique across cloud region
5395           required: true
5396           type: string
5397           example: __IMAGE-ID__
5398         - name: body
5399           in: body
5400           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5401           required: true
5402           schema:
5403             $ref: "#/definitions/relationship"
5404     delete:
5405       tags:
5406         - CloudInfrastructure
5407       summary: delete an existing relationship
5408       description: delete an existing relationship
5409       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5410       consumes:
5411         - application/json
5412         - application/xml
5413       produces:
5414         - application/json
5415         - application/xml
5416       responses:
5417         "default":
5418           description: Response codes found in [response codes](https://wiki.onap.org/).
5419       parameters:
5420         - name: cloud-owner
5421           in: path
5422           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5423           required: true
5424           type: string
5425           example: __CLOUD-OWNER__
5426         - name: cloud-region-id
5427           in: path
5428           description: Identifier used by the vendor for the region. Second part of composite key
5429           required: true
5430           type: string
5431           example: __CLOUD-REGION-ID__
5432         - name: image-id
5433           in: path
5434           description: Image id, expected to be unique across cloud region
5435           required: true
5436           type: string
5437           example: __IMAGE-ID__
5438   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
5439     get:
5440       tags:
5441         - CloudInfrastructure
5442       summary: returns metadatum
5443       description: returns metadatum
5444       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5445       produces:
5446         - application/json
5447         - application/xml
5448       responses:
5449         "200":
5450           description: successful operation
5451           schema:
5452               $ref: "#/getDefinitions/metadatum"
5453         "default":
5454           description: Response codes found in [response codes](https://wiki.onap.org/).
5455       parameters:
5456         - name: cloud-owner
5457           in: path
5458           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5459           required: true
5460           type: string
5461           example: __CLOUD-OWNER__
5462         - name: cloud-region-id
5463           in: path
5464           description: Identifier used by the vendor for the region. Second part of composite key
5465           required: true
5466           type: string
5467           example: __CLOUD-REGION-ID__
5468         - name: image-id
5469           in: path
5470           description: Image id, expected to be unique across cloud region
5471           required: true
5472           type: string
5473           example: __IMAGE-ID__
5474         - name: metaname
5475           in: path
5476           required: true
5477           type: string
5478           example: __METANAME__
5479     put:
5480       tags:
5481         - CloudInfrastructure
5482       summary: create or update an existing metadatum
5483       description: |
5484         Create or update an existing metadatum.
5485         #
5486         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5487       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5488       consumes:
5489         - application/json
5490         - application/xml
5491       produces:
5492         - application/json
5493         - application/xml
5494       responses:
5495         "default":
5496           description: Response codes found in [response codes](https://wiki.onap.org/).
5497       parameters:
5498         - name: cloud-owner
5499           in: path
5500           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5501           required: true
5502           type: string
5503           example: __CLOUD-OWNER__
5504         - name: cloud-region-id
5505           in: path
5506           description: Identifier used by the vendor for the region. Second part of composite key
5507           required: true
5508           type: string
5509           example: __CLOUD-REGION-ID__
5510         - name: image-id
5511           in: path
5512           description: Image id, expected to be unique across cloud region
5513           required: true
5514           type: string
5515           example: __IMAGE-ID__
5516         - name: metaname
5517           in: path
5518           required: true
5519           type: string
5520           example: __METANAME__
5521         - name: body
5522           in: body
5523           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
5524           required: true
5525           schema:
5526             $ref: "#/definitions/metadatum"
5527     patch:
5528       tags:
5529         - CloudInfrastructure
5530       summary: update an existing metadatum
5531       description: |
5532         Update an existing metadatum
5533         #
5534         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5535         The PUT operation will entirely replace an existing object.
5536         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5537         #
5538         Other differences between PUT and PATCH are:
5539         #
5540         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5541         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5542         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5543       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5544       consumes:
5545         - application/json
5546         - application/xml
5547       produces:
5548         - application/json
5549         - application/xml
5550       responses:
5551         "default":
5552           description: Response codes found in [response codes](https://wiki.onap.org/).
5553       parameters:
5554         - name: cloud-owner
5555           in: path
5556           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5557           required: true
5558           type: string
5559           example: __CLOUD-OWNER__
5560         - name: cloud-region-id
5561           in: path
5562           description: Identifier used by the vendor for the region. Second part of composite key
5563           required: true
5564           type: string
5565           example: __CLOUD-REGION-ID__
5566         - name: image-id
5567           in: path
5568           description: Image id, expected to be unique across cloud region
5569           required: true
5570           type: string
5571           example: __IMAGE-ID__
5572         - name: metaname
5573           in: path
5574           required: true
5575           type: string
5576           example: __METANAME__
5577         - name: body
5578           in: body
5579           description: metadatum object that needs to be updated.
5580           required: true
5581           schema:
5582             $ref: "#/patchDefinitions/metadatum"
5583     delete:
5584       tags:
5585         - CloudInfrastructure
5586       summary: delete an existing metadatum
5587       description: delete an existing metadatum
5588       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5589       consumes:
5590         - application/json
5591         - application/xml
5592       produces:
5593         - application/json
5594         - application/xml
5595       responses:
5596         "default":
5597           description: Response codes found in [response codes](https://wiki.onap.org/).
5598       parameters:
5599         - name: cloud-owner
5600           in: path
5601           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5602           required: true
5603           type: string
5604           example: __CLOUD-OWNER__
5605         - name: cloud-region-id
5606           in: path
5607           description: Identifier used by the vendor for the region. Second part of composite key
5608           required: true
5609           type: string
5610           example: __CLOUD-REGION-ID__
5611         - name: image-id
5612           in: path
5613           description: Image id, expected to be unique across cloud region
5614           required: true
5615           type: string
5616           example: __IMAGE-ID__
5617         - name: metaname
5618           in: path
5619           required: true
5620           type: string
5621           example: __METANAME__
5622         - name: resource-version
5623           in: query
5624           description: resource-version for concurrency
5625           required: true
5626           type: string
5627   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
5628     get:
5629       tags:
5630         - CloudInfrastructure
5631       summary: returns metadata
5632       description: returns metadata
5633       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
5634       produces:
5635         - application/json
5636         - application/xml
5637       responses:
5638         "200":
5639           description: successful operation
5640           schema:
5641               $ref: "#/getDefinitions/metadata"
5642         "default":
5643           description: Response codes found in [response codes](https://wiki.onap.org/).
5644       parameters:
5645         - name: cloud-owner
5646           in: path
5647           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5648           required: true
5649           type: string
5650           example: __CLOUD-OWNER__
5651         - name: cloud-region-id
5652           in: path
5653           description: Identifier used by the vendor for the region. Second part of composite key
5654           required: true
5655           type: string
5656           example: __CLOUD-REGION-ID__
5657         - name: image-id
5658           in: path
5659           description: Image id, expected to be unique across cloud region
5660           required: true
5661           type: string
5662           example: __IMAGE-ID__
5663         - name: metaname
5664           in: query
5665           description:
5666           required: false
5667           type: string
5668   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
5669     get:
5670       tags:
5671         - CloudInfrastructure
5672       summary: returns image
5673       description: returns image
5674       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
5675       produces:
5676         - application/json
5677         - application/xml
5678       responses:
5679         "200":
5680           description: successful operation
5681           schema:
5682               $ref: "#/getDefinitions/image"
5683         "default":
5684           description: Response codes found in [response codes](https://wiki.onap.org/).
5685       parameters:
5686         - name: cloud-owner
5687           in: path
5688           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5689           required: true
5690           type: string
5691           example: __CLOUD-OWNER__
5692         - name: cloud-region-id
5693           in: path
5694           description: Identifier used by the vendor for the region. Second part of composite key
5695           required: true
5696           type: string
5697           example: __CLOUD-REGION-ID__
5698         - name: image-id
5699           in: path
5700           description: Image id, expected to be unique across cloud region
5701           required: true
5702           type: string
5703           example: __IMAGE-ID__
5704     put:
5705       tags:
5706         - CloudInfrastructure
5707       summary: create or update an existing image
5708       description: |
5709         Create or update an existing image.
5710         #
5711         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5712       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5713       consumes:
5714         - application/json
5715         - application/xml
5716       produces:
5717         - application/json
5718         - application/xml
5719       responses:
5720         "default":
5721           description: Response codes found in [response codes](https://wiki.onap.org/).
5722       parameters:
5723         - name: cloud-owner
5724           in: path
5725           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5726           required: true
5727           type: string
5728           example: __CLOUD-OWNER__
5729         - name: cloud-region-id
5730           in: path
5731           description: Identifier used by the vendor for the region. Second part of composite key
5732           required: true
5733           type: string
5734           example: __CLOUD-REGION-ID__
5735         - name: image-id
5736           in: path
5737           description: Image id, expected to be unique across cloud region
5738           required: true
5739           type: string
5740           example: __IMAGE-ID__
5741         - name: body
5742           in: body
5743           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5744           required: true
5745           schema:
5746             $ref: "#/definitions/image"
5747     patch:
5748       tags:
5749         - CloudInfrastructure
5750       summary: update an existing image
5751       description: |
5752         Update an existing image
5753         #
5754         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5755         The PUT operation will entirely replace an existing object.
5756         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5757         #
5758         Other differences between PUT and PATCH are:
5759         #
5760         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5761         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5762         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5763       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5764       consumes:
5765         - application/json
5766         - application/xml
5767       produces:
5768         - application/json
5769         - application/xml
5770       responses:
5771         "default":
5772           description: Response codes found in [response codes](https://wiki.onap.org/).
5773       parameters:
5774         - name: cloud-owner
5775           in: path
5776           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5777           required: true
5778           type: string
5779           example: __CLOUD-OWNER__
5780         - name: cloud-region-id
5781           in: path
5782           description: Identifier used by the vendor for the region. Second part of composite key
5783           required: true
5784           type: string
5785           example: __CLOUD-REGION-ID__
5786         - name: image-id
5787           in: path
5788           description: Image id, expected to be unique across cloud region
5789           required: true
5790           type: string
5791           example: __IMAGE-ID__
5792         - name: body
5793           in: body
5794           description: image object that needs to be updated.
5795           required: true
5796           schema:
5797             $ref: "#/patchDefinitions/image"
5798     delete:
5799       tags:
5800         - CloudInfrastructure
5801       summary: delete an existing image
5802       description: delete an existing image
5803       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
5804       consumes:
5805         - application/json
5806         - application/xml
5807       produces:
5808         - application/json
5809         - application/xml
5810       responses:
5811         "default":
5812           description: Response codes found in [response codes](https://wiki.onap.org/).
5813       parameters:
5814         - name: cloud-owner
5815           in: path
5816           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5817           required: true
5818           type: string
5819           example: __CLOUD-OWNER__
5820         - name: cloud-region-id
5821           in: path
5822           description: Identifier used by the vendor for the region. Second part of composite key
5823           required: true
5824           type: string
5825           example: __CLOUD-REGION-ID__
5826         - name: image-id
5827           in: path
5828           description: Image id, expected to be unique across cloud region
5829           required: true
5830           type: string
5831           example: __IMAGE-ID__
5832         - name: resource-version
5833           in: query
5834           description: resource-version for concurrency
5835           required: true
5836           type: string
5837   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
5838     get:
5839       tags:
5840         - CloudInfrastructure
5841       summary: returns images
5842       description: returns images
5843       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
5844       produces:
5845         - application/json
5846         - application/xml
5847       responses:
5848         "200":
5849           description: successful operation
5850           schema:
5851               $ref: "#/getDefinitions/images"
5852         "default":
5853           description: Response codes found in [response codes](https://wiki.onap.org/).
5854       parameters:
5855         - name: cloud-owner
5856           in: path
5857           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5858           required: true
5859           type: string
5860           example: __CLOUD-OWNER__
5861         - name: cloud-region-id
5862           in: path
5863           description: Identifier used by the vendor for the region. Second part of composite key
5864           required: true
5865           type: string
5866           example: __CLOUD-REGION-ID__
5867         - name: image-id
5868           in: query
5869           description:
5870           required: false
5871           type: string
5872         - name: image-name
5873           in: query
5874           description:
5875           required: false
5876           type: string
5877         - name: application
5878           in: query
5879           description:
5880           required: false
5881           type: string
5882         - name: application-vendor
5883           in: query
5884           description:
5885           required: false
5886           type: string
5887         - name: application-version
5888           in: query
5889           description:
5890           required: false
5891           type: string
5892   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
5893     put:
5894       tags:
5895         - CloudInfrastructure
5896       summary: see node definition for valid relationships
5897       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5898       consumes:
5899         - application/json
5900         - application/xml
5901       produces:
5902         - application/json
5903         - application/xml
5904       responses:
5905         "default":
5906           description: Response codes found in [response codes](https://wiki.onap.org/).
5907       parameters:
5908         - name: cloud-owner
5909           in: path
5910           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5911           required: true
5912           type: string
5913           example: __CLOUD-OWNER__
5914         - name: cloud-region-id
5915           in: path
5916           description: Identifier used by the vendor for the region. Second part of composite key
5917           required: true
5918           type: string
5919           example: __CLOUD-REGION-ID__
5920         - name: switch-name
5921           in: path
5922           description: DVS switch name
5923           required: true
5924           type: string
5925           example: __SWITCH-NAME__
5926         - name: body
5927           in: body
5928           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
5929           required: true
5930           schema:
5931             $ref: "#/definitions/relationship"
5932     delete:
5933       tags:
5934         - CloudInfrastructure
5935       summary: delete an existing relationship
5936       description: delete an existing relationship
5937       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5938       consumes:
5939         - application/json
5940         - application/xml
5941       produces:
5942         - application/json
5943         - application/xml
5944       responses:
5945         "default":
5946           description: Response codes found in [response codes](https://wiki.onap.org/).
5947       parameters:
5948         - name: cloud-owner
5949           in: path
5950           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5951           required: true
5952           type: string
5953           example: __CLOUD-OWNER__
5954         - name: cloud-region-id
5955           in: path
5956           description: Identifier used by the vendor for the region. Second part of composite key
5957           required: true
5958           type: string
5959           example: __CLOUD-REGION-ID__
5960         - name: switch-name
5961           in: path
5962           description: DVS switch name
5963           required: true
5964           type: string
5965           example: __SWITCH-NAME__
5966   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
5967     get:
5968       tags:
5969         - CloudInfrastructure
5970       summary: returns dvs-switch
5971       description: returns dvs-switch
5972       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
5973       produces:
5974         - application/json
5975         - application/xml
5976       responses:
5977         "200":
5978           description: successful operation
5979           schema:
5980               $ref: "#/getDefinitions/dvs-switch"
5981         "default":
5982           description: Response codes found in [response codes](https://wiki.onap.org/).
5983       parameters:
5984         - name: cloud-owner
5985           in: path
5986           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5987           required: true
5988           type: string
5989           example: __CLOUD-OWNER__
5990         - name: cloud-region-id
5991           in: path
5992           description: Identifier used by the vendor for the region. Second part of composite key
5993           required: true
5994           type: string
5995           example: __CLOUD-REGION-ID__
5996         - name: switch-name
5997           in: path
5998           description: DVS switch name
5999           required: true
6000           type: string
6001           example: __SWITCH-NAME__
6002     put:
6003       tags:
6004         - CloudInfrastructure
6005       summary: create or update an existing dvs-switch
6006       description: |
6007         Create or update an existing dvs-switch.
6008         #
6009         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6010       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6011       consumes:
6012         - application/json
6013         - application/xml
6014       produces:
6015         - application/json
6016         - application/xml
6017       responses:
6018         "default":
6019           description: Response codes found in [response codes](https://wiki.onap.org/).
6020       parameters:
6021         - name: cloud-owner
6022           in: path
6023           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6024           required: true
6025           type: string
6026           example: __CLOUD-OWNER__
6027         - name: cloud-region-id
6028           in: path
6029           description: Identifier used by the vendor for the region. Second part of composite key
6030           required: true
6031           type: string
6032           example: __CLOUD-REGION-ID__
6033         - name: switch-name
6034           in: path
6035           description: DVS switch name
6036           required: true
6037           type: string
6038           example: __SWITCH-NAME__
6039         - name: body
6040           in: body
6041           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6042           required: true
6043           schema:
6044             $ref: "#/definitions/dvs-switch"
6045     patch:
6046       tags:
6047         - CloudInfrastructure
6048       summary: update an existing dvs-switch
6049       description: |
6050         Update an existing dvs-switch
6051         #
6052         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6053         The PUT operation will entirely replace an existing object.
6054         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6055         #
6056         Other differences between PUT and PATCH are:
6057         #
6058         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6059         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6060         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6061       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6062       consumes:
6063         - application/json
6064         - application/xml
6065       produces:
6066         - application/json
6067         - application/xml
6068       responses:
6069         "default":
6070           description: Response codes found in [response codes](https://wiki.onap.org/).
6071       parameters:
6072         - name: cloud-owner
6073           in: path
6074           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6075           required: true
6076           type: string
6077           example: __CLOUD-OWNER__
6078         - name: cloud-region-id
6079           in: path
6080           description: Identifier used by the vendor for the region. Second part of composite key
6081           required: true
6082           type: string
6083           example: __CLOUD-REGION-ID__
6084         - name: switch-name
6085           in: path
6086           description: DVS switch name
6087           required: true
6088           type: string
6089           example: __SWITCH-NAME__
6090         - name: body
6091           in: body
6092           description: dvs-switch object that needs to be updated.
6093           required: true
6094           schema:
6095             $ref: "#/patchDefinitions/dvs-switch"
6096     delete:
6097       tags:
6098         - CloudInfrastructure
6099       summary: delete an existing dvs-switch
6100       description: delete an existing dvs-switch
6101       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6102       consumes:
6103         - application/json
6104         - application/xml
6105       produces:
6106         - application/json
6107         - application/xml
6108       responses:
6109         "default":
6110           description: Response codes found in [response codes](https://wiki.onap.org/).
6111       parameters:
6112         - name: cloud-owner
6113           in: path
6114           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6115           required: true
6116           type: string
6117           example: __CLOUD-OWNER__
6118         - name: cloud-region-id
6119           in: path
6120           description: Identifier used by the vendor for the region. Second part of composite key
6121           required: true
6122           type: string
6123           example: __CLOUD-REGION-ID__
6124         - name: switch-name
6125           in: path
6126           description: DVS switch name
6127           required: true
6128           type: string
6129           example: __SWITCH-NAME__
6130         - name: resource-version
6131           in: query
6132           description: resource-version for concurrency
6133           required: true
6134           type: string
6135   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6136     get:
6137       tags:
6138         - CloudInfrastructure
6139       summary: returns dvs-switches
6140       description: returns dvs-switches
6141       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6142       produces:
6143         - application/json
6144         - application/xml
6145       responses:
6146         "200":
6147           description: successful operation
6148           schema:
6149               $ref: "#/getDefinitions/dvs-switches"
6150         "default":
6151           description: Response codes found in [response codes](https://wiki.onap.org/).
6152       parameters:
6153         - name: cloud-owner
6154           in: path
6155           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6156           required: true
6157           type: string
6158           example: __CLOUD-OWNER__
6159         - name: cloud-region-id
6160           in: path
6161           description: Identifier used by the vendor for the region. Second part of composite key
6162           required: true
6163           type: string
6164           example: __CLOUD-REGION-ID__
6165         - name: switch-name
6166           in: query
6167           description:
6168           required: false
6169           type: string
6170         - name: vcenter-url
6171           in: query
6172           description:
6173           required: false
6174           type: string
6175   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6176     put:
6177       tags:
6178         - CloudInfrastructure
6179       summary: see node definition for valid relationships
6180       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6181       consumes:
6182         - application/json
6183         - application/xml
6184       produces:
6185         - application/json
6186         - application/xml
6187       responses:
6188         "default":
6189           description: Response codes found in [response codes](https://wiki.onap.org/).
6190       parameters:
6191         - name: cloud-owner
6192           in: path
6193           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6194           required: true
6195           type: string
6196           example: __CLOUD-OWNER__
6197         - name: cloud-region-id
6198           in: path
6199           description: Identifier used by the vendor for the region. Second part of composite key
6200           required: true
6201           type: string
6202           example: __CLOUD-REGION-ID__
6203         - name: network-uuid
6204           in: path
6205           description: UUID of the network. Unique across a cloud-region
6206           required: true
6207           type: string
6208           example: __NETWORK-UUID__
6209         - name: body
6210           in: body
6211           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6212           required: true
6213           schema:
6214             $ref: "#/definitions/relationship"
6215     delete:
6216       tags:
6217         - CloudInfrastructure
6218       summary: delete an existing relationship
6219       description: delete an existing relationship
6220       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6221       consumes:
6222         - application/json
6223         - application/xml
6224       produces:
6225         - application/json
6226         - application/xml
6227       responses:
6228         "default":
6229           description: Response codes found in [response codes](https://wiki.onap.org/).
6230       parameters:
6231         - name: cloud-owner
6232           in: path
6233           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6234           required: true
6235           type: string
6236           example: __CLOUD-OWNER__
6237         - name: cloud-region-id
6238           in: path
6239           description: Identifier used by the vendor for the region. Second part of composite key
6240           required: true
6241           type: string
6242           example: __CLOUD-REGION-ID__
6243         - name: network-uuid
6244           in: path
6245           description: UUID of the network. Unique across a cloud-region
6246           required: true
6247           type: string
6248           example: __NETWORK-UUID__
6249   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6250     get:
6251       tags:
6252         - CloudInfrastructure
6253       summary: returns oam-network
6254       description: returns oam-network
6255       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6256       produces:
6257         - application/json
6258         - application/xml
6259       responses:
6260         "200":
6261           description: successful operation
6262           schema:
6263               $ref: "#/getDefinitions/oam-network"
6264         "default":
6265           description: Response codes found in [response codes](https://wiki.onap.org/).
6266       parameters:
6267         - name: cloud-owner
6268           in: path
6269           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6270           required: true
6271           type: string
6272           example: __CLOUD-OWNER__
6273         - name: cloud-region-id
6274           in: path
6275           description: Identifier used by the vendor for the region. Second part of composite key
6276           required: true
6277           type: string
6278           example: __CLOUD-REGION-ID__
6279         - name: network-uuid
6280           in: path
6281           description: UUID of the network. Unique across a cloud-region
6282           required: true
6283           type: string
6284           example: __NETWORK-UUID__
6285     put:
6286       tags:
6287         - CloudInfrastructure
6288       summary: create or update an existing oam-network
6289       description: |
6290         Create or update an existing oam-network.
6291         #
6292         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6293       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6294       consumes:
6295         - application/json
6296         - application/xml
6297       produces:
6298         - application/json
6299         - application/xml
6300       responses:
6301         "default":
6302           description: Response codes found in [response codes](https://wiki.onap.org/).
6303       parameters:
6304         - name: cloud-owner
6305           in: path
6306           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6307           required: true
6308           type: string
6309           example: __CLOUD-OWNER__
6310         - name: cloud-region-id
6311           in: path
6312           description: Identifier used by the vendor for the region. Second part of composite key
6313           required: true
6314           type: string
6315           example: __CLOUD-REGION-ID__
6316         - name: network-uuid
6317           in: path
6318           description: UUID of the network. Unique across a cloud-region
6319           required: true
6320           type: string
6321           example: __NETWORK-UUID__
6322         - name: body
6323           in: body
6324           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6325           required: true
6326           schema:
6327             $ref: "#/definitions/oam-network"
6328     patch:
6329       tags:
6330         - CloudInfrastructure
6331       summary: update an existing oam-network
6332       description: |
6333         Update an existing oam-network
6334         #
6335         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6336         The PUT operation will entirely replace an existing object.
6337         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6338         #
6339         Other differences between PUT and PATCH are:
6340         #
6341         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6342         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6343         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6344       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6345       consumes:
6346         - application/json
6347         - application/xml
6348       produces:
6349         - application/json
6350         - application/xml
6351       responses:
6352         "default":
6353           description: Response codes found in [response codes](https://wiki.onap.org/).
6354       parameters:
6355         - name: cloud-owner
6356           in: path
6357           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6358           required: true
6359           type: string
6360           example: __CLOUD-OWNER__
6361         - name: cloud-region-id
6362           in: path
6363           description: Identifier used by the vendor for the region. Second part of composite key
6364           required: true
6365           type: string
6366           example: __CLOUD-REGION-ID__
6367         - name: network-uuid
6368           in: path
6369           description: UUID of the network. Unique across a cloud-region
6370           required: true
6371           type: string
6372           example: __NETWORK-UUID__
6373         - name: body
6374           in: body
6375           description: oam-network object that needs to be updated.
6376           required: true
6377           schema:
6378             $ref: "#/patchDefinitions/oam-network"
6379     delete:
6380       tags:
6381         - CloudInfrastructure
6382       summary: delete an existing oam-network
6383       description: delete an existing oam-network
6384       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6385       consumes:
6386         - application/json
6387         - application/xml
6388       produces:
6389         - application/json
6390         - application/xml
6391       responses:
6392         "default":
6393           description: Response codes found in [response codes](https://wiki.onap.org/).
6394       parameters:
6395         - name: cloud-owner
6396           in: path
6397           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6398           required: true
6399           type: string
6400           example: __CLOUD-OWNER__
6401         - name: cloud-region-id
6402           in: path
6403           description: Identifier used by the vendor for the region. Second part of composite key
6404           required: true
6405           type: string
6406           example: __CLOUD-REGION-ID__
6407         - name: network-uuid
6408           in: path
6409           description: UUID of the network. Unique across a cloud-region
6410           required: true
6411           type: string
6412           example: __NETWORK-UUID__
6413         - name: resource-version
6414           in: query
6415           description: resource-version for concurrency
6416           required: true
6417           type: string
6418   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
6419     get:
6420       tags:
6421         - CloudInfrastructure
6422       summary: returns oam-networks
6423       description: returns oam-networks
6424       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
6425       produces:
6426         - application/json
6427         - application/xml
6428       responses:
6429         "200":
6430           description: successful operation
6431           schema:
6432               $ref: "#/getDefinitions/oam-networks"
6433         "default":
6434           description: Response codes found in [response codes](https://wiki.onap.org/).
6435       parameters:
6436         - name: cloud-owner
6437           in: path
6438           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6439           required: true
6440           type: string
6441           example: __CLOUD-OWNER__
6442         - name: cloud-region-id
6443           in: path
6444           description: Identifier used by the vendor for the region. Second part of composite key
6445           required: true
6446           type: string
6447           example: __CLOUD-REGION-ID__
6448         - name: network-uuid
6449           in: query
6450           description:
6451           required: false
6452           type: string
6453         - name: network-name
6454           in: query
6455           description:
6456           required: false
6457           type: string
6458         - name: cvlan-tag
6459           in: query
6460           description:
6461           required: false
6462           type: integer
6463           format: int64
6464   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
6465     put:
6466       tags:
6467         - CloudInfrastructure
6468       summary: see node definition for valid relationships
6469       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6470       consumes:
6471         - application/json
6472         - application/xml
6473       produces:
6474         - application/json
6475         - application/xml
6476       responses:
6477         "default":
6478           description: Response codes found in [response codes](https://wiki.onap.org/).
6479       parameters:
6480         - name: cloud-owner
6481           in: path
6482           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6483           required: true
6484           type: string
6485           example: __CLOUD-OWNER__
6486         - name: cloud-region-id
6487           in: path
6488           description: Identifier used by the vendor for the region. Second part of composite key
6489           required: true
6490           type: string
6491           example: __CLOUD-REGION-ID__
6492         - name: availability-zone-name
6493           in: path
6494           description: Name of the availability zone.  Unique across a cloud region
6495           required: true
6496           type: string
6497           example: __AVAILABILITY-ZONE-NAME__
6498         - name: body
6499           in: body
6500           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6501           required: true
6502           schema:
6503             $ref: "#/definitions/relationship"
6504     delete:
6505       tags:
6506         - CloudInfrastructure
6507       summary: delete an existing relationship
6508       description: delete an existing relationship
6509       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6510       consumes:
6511         - application/json
6512         - application/xml
6513       produces:
6514         - application/json
6515         - application/xml
6516       responses:
6517         "default":
6518           description: Response codes found in [response codes](https://wiki.onap.org/).
6519       parameters:
6520         - name: cloud-owner
6521           in: path
6522           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6523           required: true
6524           type: string
6525           example: __CLOUD-OWNER__
6526         - name: cloud-region-id
6527           in: path
6528           description: Identifier used by the vendor for the region. Second part of composite key
6529           required: true
6530           type: string
6531           example: __CLOUD-REGION-ID__
6532         - name: availability-zone-name
6533           in: path
6534           description: Name of the availability zone.  Unique across a cloud region
6535           required: true
6536           type: string
6537           example: __AVAILABILITY-ZONE-NAME__
6538   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
6539     get:
6540       tags:
6541         - CloudInfrastructure
6542       summary: returns availability-zone
6543       description: returns availability-zone
6544       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6545       produces:
6546         - application/json
6547         - application/xml
6548       responses:
6549         "200":
6550           description: successful operation
6551           schema:
6552               $ref: "#/getDefinitions/availability-zone"
6553         "default":
6554           description: Response codes found in [response codes](https://wiki.onap.org/).
6555       parameters:
6556         - name: cloud-owner
6557           in: path
6558           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6559           required: true
6560           type: string
6561           example: __CLOUD-OWNER__
6562         - name: cloud-region-id
6563           in: path
6564           description: Identifier used by the vendor for the region. Second part of composite key
6565           required: true
6566           type: string
6567           example: __CLOUD-REGION-ID__
6568         - name: availability-zone-name
6569           in: path
6570           description: Name of the availability zone.  Unique across a cloud region
6571           required: true
6572           type: string
6573           example: __AVAILABILITY-ZONE-NAME__
6574     put:
6575       tags:
6576         - CloudInfrastructure
6577       summary: create or update an existing availability-zone
6578       description: |
6579         Create or update an existing availability-zone.
6580         #
6581         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6582       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6583       consumes:
6584         - application/json
6585         - application/xml
6586       produces:
6587         - application/json
6588         - application/xml
6589       responses:
6590         "default":
6591           description: Response codes found in [response codes](https://wiki.onap.org/).
6592       parameters:
6593         - name: cloud-owner
6594           in: path
6595           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6596           required: true
6597           type: string
6598           example: __CLOUD-OWNER__
6599         - name: cloud-region-id
6600           in: path
6601           description: Identifier used by the vendor for the region. Second part of composite key
6602           required: true
6603           type: string
6604           example: __CLOUD-REGION-ID__
6605         - name: availability-zone-name
6606           in: path
6607           description: Name of the availability zone.  Unique across a cloud region
6608           required: true
6609           type: string
6610           example: __AVAILABILITY-ZONE-NAME__
6611         - name: body
6612           in: body
6613           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6614           required: true
6615           schema:
6616             $ref: "#/definitions/availability-zone"
6617     patch:
6618       tags:
6619         - CloudInfrastructure
6620       summary: update an existing availability-zone
6621       description: |
6622         Update an existing availability-zone
6623         #
6624         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6625         The PUT operation will entirely replace an existing object.
6626         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6627         #
6628         Other differences between PUT and PATCH are:
6629         #
6630         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6631         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6632         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6633       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6634       consumes:
6635         - application/json
6636         - application/xml
6637       produces:
6638         - application/json
6639         - application/xml
6640       responses:
6641         "default":
6642           description: Response codes found in [response codes](https://wiki.onap.org/).
6643       parameters:
6644         - name: cloud-owner
6645           in: path
6646           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6647           required: true
6648           type: string
6649           example: __CLOUD-OWNER__
6650         - name: cloud-region-id
6651           in: path
6652           description: Identifier used by the vendor for the region. Second part of composite key
6653           required: true
6654           type: string
6655           example: __CLOUD-REGION-ID__
6656         - name: availability-zone-name
6657           in: path
6658           description: Name of the availability zone.  Unique across a cloud region
6659           required: true
6660           type: string
6661           example: __AVAILABILITY-ZONE-NAME__
6662         - name: body
6663           in: body
6664           description: availability-zone object that needs to be updated.
6665           required: true
6666           schema:
6667             $ref: "#/patchDefinitions/availability-zone"
6668     delete:
6669       tags:
6670         - CloudInfrastructure
6671       summary: delete an existing availability-zone
6672       description: delete an existing availability-zone
6673       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6674       consumes:
6675         - application/json
6676         - application/xml
6677       produces:
6678         - application/json
6679         - application/xml
6680       responses:
6681         "default":
6682           description: Response codes found in [response codes](https://wiki.onap.org/).
6683       parameters:
6684         - name: cloud-owner
6685           in: path
6686           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6687           required: true
6688           type: string
6689           example: __CLOUD-OWNER__
6690         - name: cloud-region-id
6691           in: path
6692           description: Identifier used by the vendor for the region. Second part of composite key
6693           required: true
6694           type: string
6695           example: __CLOUD-REGION-ID__
6696         - name: availability-zone-name
6697           in: path
6698           description: Name of the availability zone.  Unique across a cloud region
6699           required: true
6700           type: string
6701           example: __AVAILABILITY-ZONE-NAME__
6702         - name: resource-version
6703           in: query
6704           description: resource-version for concurrency
6705           required: true
6706           type: string
6707   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
6708     get:
6709       tags:
6710         - CloudInfrastructure
6711       summary: returns availability-zones
6712       description: returns availability-zones
6713       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
6714       produces:
6715         - application/json
6716         - application/xml
6717       responses:
6718         "200":
6719           description: successful operation
6720           schema:
6721               $ref: "#/getDefinitions/availability-zones"
6722         "default":
6723           description: Response codes found in [response codes](https://wiki.onap.org/).
6724       parameters:
6725         - name: cloud-owner
6726           in: path
6727           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6728           required: true
6729           type: string
6730           example: __CLOUD-OWNER__
6731         - name: cloud-region-id
6732           in: path
6733           description: Identifier used by the vendor for the region. Second part of composite key
6734           required: true
6735           type: string
6736           example: __CLOUD-REGION-ID__
6737         - name: availability-zone-name
6738           in: query
6739           description:
6740           required: false
6741           type: string
6742   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
6743     put:
6744       tags:
6745         - CloudInfrastructure
6746       summary: see node definition for valid relationships
6747       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6748       consumes:
6749         - application/json
6750         - application/xml
6751       produces:
6752         - application/json
6753         - application/xml
6754       responses:
6755         "default":
6756           description: Response codes found in [response codes](https://wiki.onap.org/).
6757       parameters:
6758         - name: cloud-owner
6759           in: path
6760           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6761           required: true
6762           type: string
6763           example: __CLOUD-OWNER__
6764         - name: cloud-region-id
6765           in: path
6766           description: Identifier used by the vendor for the region. Second part of composite key
6767           required: true
6768           type: string
6769           example: __CLOUD-REGION-ID__
6770         - name: body
6771           in: body
6772           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegion.json)
6773           required: true
6774           schema:
6775             $ref: "#/definitions/relationship"
6776     delete:
6777       tags:
6778         - CloudInfrastructure
6779       summary: delete an existing relationship
6780       description: delete an existing relationship
6781       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6782       consumes:
6783         - application/json
6784         - application/xml
6785       produces:
6786         - application/json
6787         - application/xml
6788       responses:
6789         "default":
6790           description: Response codes found in [response codes](https://wiki.onap.org/).
6791       parameters:
6792         - name: cloud-owner
6793           in: path
6794           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6795           required: true
6796           type: string
6797           example: __CLOUD-OWNER__
6798         - name: cloud-region-id
6799           in: path
6800           description: Identifier used by the vendor for the region. Second part of composite key
6801           required: true
6802           type: string
6803           example: __CLOUD-REGION-ID__
6804   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
6805     get:
6806       tags:
6807         - CloudInfrastructure
6808       summary: returns cloud-region
6809       description: returns cloud-region
6810       operationId: getCloudInfrastructureCloudRegionsCloudRegion
6811       produces:
6812         - application/json
6813         - application/xml
6814       responses:
6815         "200":
6816           description: successful operation
6817           schema:
6818               $ref: "#/getDefinitions/cloud-region"
6819         "default":
6820           description: Response codes found in [response codes](https://wiki.onap.org/).
6821       parameters:
6822         - name: cloud-owner
6823           in: path
6824           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6825           required: true
6826           type: string
6827           example: __CLOUD-OWNER__
6828         - name: cloud-region-id
6829           in: path
6830           description: Identifier used by the vendor for the region. Second part of composite key
6831           required: true
6832           type: string
6833           example: __CLOUD-REGION-ID__
6834     put:
6835       tags:
6836         - CloudInfrastructure
6837       summary: create or update an existing cloud-region
6838       description: |
6839         Create or update an existing cloud-region.
6840         #
6841         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6842       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
6843       consumes:
6844         - application/json
6845         - application/xml
6846       produces:
6847         - application/json
6848         - application/xml
6849       responses:
6850         "default":
6851           description: Response codes found in [response codes](https://wiki.onap.org/).
6852       parameters:
6853         - name: cloud-owner
6854           in: path
6855           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6856           required: true
6857           type: string
6858           example: __CLOUD-OWNER__
6859         - name: cloud-region-id
6860           in: path
6861           description: Identifier used by the vendor for the region. Second part of composite key
6862           required: true
6863           type: string
6864           example: __CLOUD-REGION-ID__
6865         - name: body
6866           in: body
6867           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegion.json)
6868           required: true
6869           schema:
6870             $ref: "#/definitions/cloud-region"
6871     patch:
6872       tags:
6873         - CloudInfrastructure
6874       summary: update an existing cloud-region
6875       description: |
6876         Update an existing cloud-region
6877         #
6878         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6879         The PUT operation will entirely replace an existing object.
6880         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6881         #
6882         Other differences between PUT and PATCH are:
6883         #
6884         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6885         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6886         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6887       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
6888       consumes:
6889         - application/json
6890         - application/xml
6891       produces:
6892         - application/json
6893         - application/xml
6894       responses:
6895         "default":
6896           description: Response codes found in [response codes](https://wiki.onap.org/).
6897       parameters:
6898         - name: cloud-owner
6899           in: path
6900           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6901           required: true
6902           type: string
6903           example: __CLOUD-OWNER__
6904         - name: cloud-region-id
6905           in: path
6906           description: Identifier used by the vendor for the region. Second part of composite key
6907           required: true
6908           type: string
6909           example: __CLOUD-REGION-ID__
6910         - name: body
6911           in: body
6912           description: cloud-region object that needs to be updated.
6913           required: true
6914           schema:
6915             $ref: "#/patchDefinitions/cloud-region"
6916     delete:
6917       tags:
6918         - CloudInfrastructure
6919       summary: delete an existing cloud-region
6920       description: delete an existing cloud-region
6921       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
6922       consumes:
6923         - application/json
6924         - application/xml
6925       produces:
6926         - application/json
6927         - application/xml
6928       responses:
6929         "default":
6930           description: Response codes found in [response codes](https://wiki.onap.org/).
6931       parameters:
6932         - name: cloud-owner
6933           in: path
6934           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6935           required: true
6936           type: string
6937           example: __CLOUD-OWNER__
6938         - name: cloud-region-id
6939           in: path
6940           description: Identifier used by the vendor for the region. Second part of composite key
6941           required: true
6942           type: string
6943           example: __CLOUD-REGION-ID__
6944         - name: resource-version
6945           in: query
6946           description: resource-version for concurrency
6947           required: true
6948           type: string
6949   /cloud-infrastructure/cloud-regions:
6950     get:
6951       tags:
6952         - CloudInfrastructure
6953       summary: returns cloud-regions
6954       description: returns cloud-regions
6955       operationId: getCloudInfrastructureCloudRegions
6956       produces:
6957         - application/json
6958         - application/xml
6959       responses:
6960         "200":
6961           description: successful operation
6962           schema:
6963               $ref: "#/getDefinitions/cloud-regions"
6964         "default":
6965           description: Response codes found in [response codes](https://wiki.onap.org/).
6966       parameters:
6967         - name: cloud-owner
6968           in: query
6969           description:
6970           required: false
6971           type: string
6972         - name: cloud-region-id
6973           in: query
6974           description:
6975           required: false
6976           type: string
6977         - name: cloud-type
6978           in: query
6979           description:
6980           required: false
6981           type: string
6982         - name: owner-defined-type
6983           in: query
6984           description:
6985           required: false
6986           type: string
6987   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
6988     put:
6989       tags:
6990         - CloudInfrastructure
6991       summary: see node definition for valid relationships
6992       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
6993       consumes:
6994         - application/json
6995         - application/xml
6996       produces:
6997         - application/json
6998         - application/xml
6999       responses:
7000         "default":
7001           description: Response codes found in [response codes](https://wiki.onap.org/).
7002       parameters:
7003         - name: nm-profile-name
7004           in: path
7005           description: Unique name of network profile.
7006           required: true
7007           type: string
7008           example: __NM-PROFILE-NAME__
7009         - name: body
7010           in: body
7011           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7012           required: true
7013           schema:
7014             $ref: "#/definitions/relationship"
7015     delete:
7016       tags:
7017         - CloudInfrastructure
7018       summary: delete an existing relationship
7019       description: delete an existing relationship
7020       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7021       consumes:
7022         - application/json
7023         - application/xml
7024       produces:
7025         - application/json
7026         - application/xml
7027       responses:
7028         "default":
7029           description: Response codes found in [response codes](https://wiki.onap.org/).
7030       parameters:
7031         - name: nm-profile-name
7032           in: path
7033           description: Unique name of network profile.
7034           required: true
7035           type: string
7036           example: __NM-PROFILE-NAME__
7037   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7038     get:
7039       tags:
7040         - CloudInfrastructure
7041       summary: returns network-profile
7042       description: returns network-profile
7043       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7044       produces:
7045         - application/json
7046         - application/xml
7047       responses:
7048         "200":
7049           description: successful operation
7050           schema:
7051               $ref: "#/getDefinitions/network-profile"
7052         "default":
7053           description: Response codes found in [response codes](https://wiki.onap.org/).
7054       parameters:
7055         - name: nm-profile-name
7056           in: path
7057           description: Unique name of network profile.
7058           required: true
7059           type: string
7060           example: __NM-PROFILE-NAME__
7061     put:
7062       tags:
7063         - CloudInfrastructure
7064       summary: create or update an existing network-profile
7065       description: |
7066         Create or update an existing network-profile.
7067         #
7068         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7069       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
7070       consumes:
7071         - application/json
7072         - application/xml
7073       produces:
7074         - application/json
7075         - application/xml
7076       responses:
7077         "default":
7078           description: Response codes found in [response codes](https://wiki.onap.org/).
7079       parameters:
7080         - name: nm-profile-name
7081           in: path
7082           description: Unique name of network profile.
7083           required: true
7084           type: string
7085           example: __NM-PROFILE-NAME__
7086         - name: body
7087           in: body
7088           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7089           required: true
7090           schema:
7091             $ref: "#/definitions/network-profile"
7092     patch:
7093       tags:
7094         - CloudInfrastructure
7095       summary: update an existing network-profile
7096       description: |
7097         Update an existing network-profile
7098         #
7099         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7100         The PUT operation will entirely replace an existing object.
7101         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7102         #
7103         Other differences between PUT and PATCH are:
7104         #
7105         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7106         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7107         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7108       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7109       consumes:
7110         - application/json
7111         - application/xml
7112       produces:
7113         - application/json
7114         - application/xml
7115       responses:
7116         "default":
7117           description: Response codes found in [response codes](https://wiki.onap.org/).
7118       parameters:
7119         - name: nm-profile-name
7120           in: path
7121           description: Unique name of network profile.
7122           required: true
7123           type: string
7124           example: __NM-PROFILE-NAME__
7125         - name: body
7126           in: body
7127           description: network-profile object that needs to be updated.
7128           required: true
7129           schema:
7130             $ref: "#/patchDefinitions/network-profile"
7131     delete:
7132       tags:
7133         - CloudInfrastructure
7134       summary: delete an existing network-profile
7135       description: delete an existing network-profile
7136       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
7137       consumes:
7138         - application/json
7139         - application/xml
7140       produces:
7141         - application/json
7142         - application/xml
7143       responses:
7144         "default":
7145           description: Response codes found in [response codes](https://wiki.onap.org/).
7146       parameters:
7147         - name: nm-profile-name
7148           in: path
7149           description: Unique name of network profile.
7150           required: true
7151           type: string
7152           example: __NM-PROFILE-NAME__
7153         - name: resource-version
7154           in: query
7155           description: resource-version for concurrency
7156           required: true
7157           type: string
7158   /cloud-infrastructure/network-profiles:
7159     get:
7160       tags:
7161         - CloudInfrastructure
7162       summary: returns network-profiles
7163       description: returns network-profiles
7164       operationId: getCloudInfrastructureNetworkProfiles
7165       produces:
7166         - application/json
7167         - application/xml
7168       responses:
7169         "200":
7170           description: successful operation
7171           schema:
7172               $ref: "#/getDefinitions/network-profiles"
7173         "default":
7174           description: Response codes found in [response codes](https://wiki.onap.org/).
7175       parameters:
7176         - name: nm-profile-name
7177           in: query
7178           description:
7179           required: false
7180           type: string
7181   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
7182     put:
7183       tags:
7184         - CloudInfrastructure
7185       summary: see node definition for valid relationships
7186       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
7187       consumes:
7188         - application/json
7189         - application/xml
7190       produces:
7191         - application/json
7192         - application/xml
7193       responses:
7194         "default":
7195           description: Response codes found in [response codes](https://wiki.onap.org/).
7196       parameters:
7197         - name: hostname
7198           in: path
7199           description: Value from executing hostname on the compute node.
7200           required: true
7201           type: string
7202           example: __HOSTNAME__
7203         - name: body
7204           in: body
7205           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)
7206           required: true
7207           schema:
7208             $ref: "#/definitions/relationship"
7209     delete:
7210       tags:
7211         - CloudInfrastructure
7212       summary: delete an existing relationship
7213       description: delete an existing relationship
7214       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
7215       consumes:
7216         - application/json
7217         - application/xml
7218       produces:
7219         - application/json
7220         - application/xml
7221       responses:
7222         "default":
7223           description: Response codes found in [response codes](https://wiki.onap.org/).
7224       parameters:
7225         - name: hostname
7226           in: path
7227           description: Value from executing hostname on the compute node.
7228           required: true
7229           type: string
7230           example: __HOSTNAME__
7231   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
7232     put:
7233       tags:
7234         - CloudInfrastructure
7235       summary: see node definition for valid relationships
7236       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7237       consumes:
7238         - application/json
7239         - application/xml
7240       produces:
7241         - application/json
7242         - application/xml
7243       responses:
7244         "default":
7245           description: Response codes found in [response codes](https://wiki.onap.org/).
7246       parameters:
7247         - name: hostname
7248           in: path
7249           description: Value from executing hostname on the compute node.
7250           required: true
7251           type: string
7252           example: __HOSTNAME__
7253         - name: interface-name
7254           in: path
7255           description: Name that identifies the physical interface
7256           required: true
7257           type: string
7258           example: __INTERFACE-NAME__
7259         - name: body
7260           in: body
7261           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
7262           required: true
7263           schema:
7264             $ref: "#/definitions/relationship"
7265     delete:
7266       tags:
7267         - CloudInfrastructure
7268       summary: delete an existing relationship
7269       description: delete an existing relationship
7270       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7271       consumes:
7272         - application/json
7273         - application/xml
7274       produces:
7275         - application/json
7276         - application/xml
7277       responses:
7278         "default":
7279           description: Response codes found in [response codes](https://wiki.onap.org/).
7280       parameters:
7281         - name: hostname
7282           in: path
7283           description: Value from executing hostname on the compute node.
7284           required: true
7285           type: string
7286           example: __HOSTNAME__
7287         - name: interface-name
7288           in: path
7289           description: Name that identifies the physical interface
7290           required: true
7291           type: string
7292           example: __INTERFACE-NAME__
7293   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
7294     put:
7295       tags:
7296         - CloudInfrastructure
7297       summary: see node definition for valid relationships
7298       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7299       consumes:
7300         - application/json
7301         - application/xml
7302       produces:
7303         - application/json
7304         - application/xml
7305       responses:
7306         "default":
7307           description: Response codes found in [response codes](https://wiki.onap.org/).
7308       parameters:
7309         - name: hostname
7310           in: path
7311           description: Value from executing hostname on the compute node.
7312           required: true
7313           type: string
7314           example: __HOSTNAME__
7315         - name: interface-name
7316           in: path
7317           description: Name that identifies the physical interface
7318           required: true
7319           type: string
7320           example: __INTERFACE-NAME__
7321         - name: interface-name
7322           in: path
7323           description: Name given to the interface
7324           required: true
7325           type: string
7326           example: __INTERFACE-NAME__
7327         - name: vlan-interface
7328           in: path
7329           description: String that identifies the interface
7330           required: true
7331           type: string
7332           example: __VLAN-INTERFACE__
7333         - name: body
7334           in: body
7335           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
7336           required: true
7337           schema:
7338             $ref: "#/definitions/relationship"
7339     delete:
7340       tags:
7341         - CloudInfrastructure
7342       summary: delete an existing relationship
7343       description: delete an existing relationship
7344       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7345       consumes:
7346         - application/json
7347         - application/xml
7348       produces:
7349         - application/json
7350         - application/xml
7351       responses:
7352         "default":
7353           description: Response codes found in [response codes](https://wiki.onap.org/).
7354       parameters:
7355         - name: hostname
7356           in: path
7357           description: Value from executing hostname on the compute node.
7358           required: true
7359           type: string
7360           example: __HOSTNAME__
7361         - name: interface-name
7362           in: path
7363           description: Name that identifies the physical interface
7364           required: true
7365           type: string
7366           example: __INTERFACE-NAME__
7367         - name: interface-name
7368           in: path
7369           description: Name given to the interface
7370           required: true
7371           type: string
7372           example: __INTERFACE-NAME__
7373         - name: vlan-interface
7374           in: path
7375           description: String that identifies the interface
7376           required: true
7377           type: string
7378           example: __VLAN-INTERFACE__
7379   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
7380     put:
7381       tags:
7382         - CloudInfrastructure
7383       summary: see node definition for valid relationships
7384       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7385       consumes:
7386         - application/json
7387         - application/xml
7388       produces:
7389         - application/json
7390         - application/xml
7391       responses:
7392         "default":
7393           description: Response codes found in [response codes](https://wiki.onap.org/).
7394       parameters:
7395         - name: hostname
7396           in: path
7397           description: Value from executing hostname on the compute node.
7398           required: true
7399           type: string
7400           example: __HOSTNAME__
7401         - name: interface-name
7402           in: path
7403           description: Name that identifies the physical interface
7404           required: true
7405           type: string
7406           example: __INTERFACE-NAME__
7407         - name: interface-name
7408           in: path
7409           description: Name given to the interface
7410           required: true
7411           type: string
7412           example: __INTERFACE-NAME__
7413         - name: vlan-interface
7414           in: path
7415           description: String that identifies the interface
7416           required: true
7417           type: string
7418           example: __VLAN-INTERFACE__
7419         - name: l3-interface-ipv4-address
7420           in: path
7421           description: IP address
7422           required: true
7423           type: string
7424           example: __L3-INTERFACE-IPV4-ADDRESS__
7425         - name: body
7426           in: body
7427           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7428           required: true
7429           schema:
7430             $ref: "#/definitions/relationship"
7431     delete:
7432       tags:
7433         - CloudInfrastructure
7434       summary: delete an existing relationship
7435       description: delete an existing relationship
7436       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7437       consumes:
7438         - application/json
7439         - application/xml
7440       produces:
7441         - application/json
7442         - application/xml
7443       responses:
7444         "default":
7445           description: Response codes found in [response codes](https://wiki.onap.org/).
7446       parameters:
7447         - name: hostname
7448           in: path
7449           description: Value from executing hostname on the compute node.
7450           required: true
7451           type: string
7452           example: __HOSTNAME__
7453         - name: interface-name
7454           in: path
7455           description: Name that identifies the physical interface
7456           required: true
7457           type: string
7458           example: __INTERFACE-NAME__
7459         - name: interface-name
7460           in: path
7461           description: Name given to the interface
7462           required: true
7463           type: string
7464           example: __INTERFACE-NAME__
7465         - name: vlan-interface
7466           in: path
7467           description: String that identifies the interface
7468           required: true
7469           type: string
7470           example: __VLAN-INTERFACE__
7471         - name: l3-interface-ipv4-address
7472           in: path
7473           description: IP address
7474           required: true
7475           type: string
7476           example: __L3-INTERFACE-IPV4-ADDRESS__
7477   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
7478     get:
7479       tags:
7480         - CloudInfrastructure
7481       summary: returns l3-interface-ipv4-address-list
7482       description: returns l3-interface-ipv4-address-list
7483       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7484       produces:
7485         - application/json
7486         - application/xml
7487       responses:
7488         "200":
7489           description: successful operation
7490           schema:
7491               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
7492         "default":
7493           description: Response codes found in [response codes](https://wiki.onap.org/).
7494       parameters:
7495         - name: hostname
7496           in: path
7497           description: Value from executing hostname on the compute node.
7498           required: true
7499           type: string
7500           example: __HOSTNAME__
7501         - name: interface-name
7502           in: path
7503           description: Name that identifies the physical interface
7504           required: true
7505           type: string
7506           example: __INTERFACE-NAME__
7507         - name: interface-name
7508           in: path
7509           description: Name given to the interface
7510           required: true
7511           type: string
7512           example: __INTERFACE-NAME__
7513         - name: vlan-interface
7514           in: path
7515           description: String that identifies the interface
7516           required: true
7517           type: string
7518           example: __VLAN-INTERFACE__
7519         - name: l3-interface-ipv4-address
7520           in: path
7521           description: IP address
7522           required: true
7523           type: string
7524           example: __L3-INTERFACE-IPV4-ADDRESS__
7525     put:
7526       tags:
7527         - CloudInfrastructure
7528       summary: create or update an existing l3-interface-ipv4-address-list
7529       description: |
7530         Create or update an existing l3-interface-ipv4-address-list.
7531         #
7532         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7533       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7534       consumes:
7535         - application/json
7536         - application/xml
7537       produces:
7538         - application/json
7539         - application/xml
7540       responses:
7541         "default":
7542           description: Response codes found in [response codes](https://wiki.onap.org/).
7543       parameters:
7544         - name: hostname
7545           in: path
7546           description: Value from executing hostname on the compute node.
7547           required: true
7548           type: string
7549           example: __HOSTNAME__
7550         - name: interface-name
7551           in: path
7552           description: Name that identifies the physical interface
7553           required: true
7554           type: string
7555           example: __INTERFACE-NAME__
7556         - name: interface-name
7557           in: path
7558           description: Name given to the interface
7559           required: true
7560           type: string
7561           example: __INTERFACE-NAME__
7562         - name: vlan-interface
7563           in: path
7564           description: String that identifies the interface
7565           required: true
7566           type: string
7567           example: __VLAN-INTERFACE__
7568         - name: l3-interface-ipv4-address
7569           in: path
7570           description: IP address
7571           required: true
7572           type: string
7573           example: __L3-INTERFACE-IPV4-ADDRESS__
7574         - name: body
7575           in: body
7576           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7577           required: true
7578           schema:
7579             $ref: "#/definitions/l3-interface-ipv4-address-list"
7580     patch:
7581       tags:
7582         - CloudInfrastructure
7583       summary: update an existing l3-interface-ipv4-address-list
7584       description: |
7585         Update an existing l3-interface-ipv4-address-list
7586         #
7587         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7588         The PUT operation will entirely replace an existing object.
7589         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7590         #
7591         Other differences between PUT and PATCH are:
7592         #
7593         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7594         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7595         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7596       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7597       consumes:
7598         - application/json
7599         - application/xml
7600       produces:
7601         - application/json
7602         - application/xml
7603       responses:
7604         "default":
7605           description: Response codes found in [response codes](https://wiki.onap.org/).
7606       parameters:
7607         - name: hostname
7608           in: path
7609           description: Value from executing hostname on the compute node.
7610           required: true
7611           type: string
7612           example: __HOSTNAME__
7613         - name: interface-name
7614           in: path
7615           description: Name that identifies the physical interface
7616           required: true
7617           type: string
7618           example: __INTERFACE-NAME__
7619         - name: interface-name
7620           in: path
7621           description: Name given to the interface
7622           required: true
7623           type: string
7624           example: __INTERFACE-NAME__
7625         - name: vlan-interface
7626           in: path
7627           description: String that identifies the interface
7628           required: true
7629           type: string
7630           example: __VLAN-INTERFACE__
7631         - name: l3-interface-ipv4-address
7632           in: path
7633           description: IP address
7634           required: true
7635           type: string
7636           example: __L3-INTERFACE-IPV4-ADDRESS__
7637         - name: body
7638           in: body
7639           description: l3-interface-ipv4-address-list object that needs to be updated.
7640           required: true
7641           schema:
7642             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
7643     delete:
7644       tags:
7645         - CloudInfrastructure
7646       summary: delete an existing l3-interface-ipv4-address-list
7647       description: delete an existing l3-interface-ipv4-address-list
7648       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7649       consumes:
7650         - application/json
7651         - application/xml
7652       produces:
7653         - application/json
7654         - application/xml
7655       responses:
7656         "default":
7657           description: Response codes found in [response codes](https://wiki.onap.org/).
7658       parameters:
7659         - name: hostname
7660           in: path
7661           description: Value from executing hostname on the compute node.
7662           required: true
7663           type: string
7664           example: __HOSTNAME__
7665         - name: interface-name
7666           in: path
7667           description: Name that identifies the physical interface
7668           required: true
7669           type: string
7670           example: __INTERFACE-NAME__
7671         - name: interface-name
7672           in: path
7673           description: Name given to the interface
7674           required: true
7675           type: string
7676           example: __INTERFACE-NAME__
7677         - name: vlan-interface
7678           in: path
7679           description: String that identifies the interface
7680           required: true
7681           type: string
7682           example: __VLAN-INTERFACE__
7683         - name: l3-interface-ipv4-address
7684           in: path
7685           description: IP address
7686           required: true
7687           type: string
7688           example: __L3-INTERFACE-IPV4-ADDRESS__
7689         - name: resource-version
7690           in: query
7691           description: resource-version for concurrency
7692           required: true
7693           type: string
7694   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
7695     put:
7696       tags:
7697         - CloudInfrastructure
7698       summary: see node definition for valid relationships
7699       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7700       consumes:
7701         - application/json
7702         - application/xml
7703       produces:
7704         - application/json
7705         - application/xml
7706       responses:
7707         "default":
7708           description: Response codes found in [response codes](https://wiki.onap.org/).
7709       parameters:
7710         - name: hostname
7711           in: path
7712           description: Value from executing hostname on the compute node.
7713           required: true
7714           type: string
7715           example: __HOSTNAME__
7716         - name: interface-name
7717           in: path
7718           description: Name that identifies the physical interface
7719           required: true
7720           type: string
7721           example: __INTERFACE-NAME__
7722         - name: interface-name
7723           in: path
7724           description: Name given to the interface
7725           required: true
7726           type: string
7727           example: __INTERFACE-NAME__
7728         - name: vlan-interface
7729           in: path
7730           description: String that identifies the interface
7731           required: true
7732           type: string
7733           example: __VLAN-INTERFACE__
7734         - name: l3-interface-ipv6-address
7735           in: path
7736           description: IP address
7737           required: true
7738           type: string
7739           example: __L3-INTERFACE-IPV6-ADDRESS__
7740         - name: body
7741           in: body
7742           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7743           required: true
7744           schema:
7745             $ref: "#/definitions/relationship"
7746     delete:
7747       tags:
7748         - CloudInfrastructure
7749       summary: delete an existing relationship
7750       description: delete an existing relationship
7751       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7752       consumes:
7753         - application/json
7754         - application/xml
7755       produces:
7756         - application/json
7757         - application/xml
7758       responses:
7759         "default":
7760           description: Response codes found in [response codes](https://wiki.onap.org/).
7761       parameters:
7762         - name: hostname
7763           in: path
7764           description: Value from executing hostname on the compute node.
7765           required: true
7766           type: string
7767           example: __HOSTNAME__
7768         - name: interface-name
7769           in: path
7770           description: Name that identifies the physical interface
7771           required: true
7772           type: string
7773           example: __INTERFACE-NAME__
7774         - name: interface-name
7775           in: path
7776           description: Name given to the interface
7777           required: true
7778           type: string
7779           example: __INTERFACE-NAME__
7780         - name: vlan-interface
7781           in: path
7782           description: String that identifies the interface
7783           required: true
7784           type: string
7785           example: __VLAN-INTERFACE__
7786         - name: l3-interface-ipv6-address
7787           in: path
7788           description: IP address
7789           required: true
7790           type: string
7791           example: __L3-INTERFACE-IPV6-ADDRESS__
7792   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
7793     get:
7794       tags:
7795         - CloudInfrastructure
7796       summary: returns l3-interface-ipv6-address-list
7797       description: returns l3-interface-ipv6-address-list
7798       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7799       produces:
7800         - application/json
7801         - application/xml
7802       responses:
7803         "200":
7804           description: successful operation
7805           schema:
7806               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
7807         "default":
7808           description: Response codes found in [response codes](https://wiki.onap.org/).
7809       parameters:
7810         - name: hostname
7811           in: path
7812           description: Value from executing hostname on the compute node.
7813           required: true
7814           type: string
7815           example: __HOSTNAME__
7816         - name: interface-name
7817           in: path
7818           description: Name that identifies the physical interface
7819           required: true
7820           type: string
7821           example: __INTERFACE-NAME__
7822         - name: interface-name
7823           in: path
7824           description: Name given to the interface
7825           required: true
7826           type: string
7827           example: __INTERFACE-NAME__
7828         - name: vlan-interface
7829           in: path
7830           description: String that identifies the interface
7831           required: true
7832           type: string
7833           example: __VLAN-INTERFACE__
7834         - name: l3-interface-ipv6-address
7835           in: path
7836           description: IP address
7837           required: true
7838           type: string
7839           example: __L3-INTERFACE-IPV6-ADDRESS__
7840     put:
7841       tags:
7842         - CloudInfrastructure
7843       summary: create or update an existing l3-interface-ipv6-address-list
7844       description: |
7845         Create or update an existing l3-interface-ipv6-address-list.
7846         #
7847         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7848       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7849       consumes:
7850         - application/json
7851         - application/xml
7852       produces:
7853         - application/json
7854         - application/xml
7855       responses:
7856         "default":
7857           description: Response codes found in [response codes](https://wiki.onap.org/).
7858       parameters:
7859         - name: hostname
7860           in: path
7861           description: Value from executing hostname on the compute node.
7862           required: true
7863           type: string
7864           example: __HOSTNAME__
7865         - name: interface-name
7866           in: path
7867           description: Name that identifies the physical interface
7868           required: true
7869           type: string
7870           example: __INTERFACE-NAME__
7871         - name: interface-name
7872           in: path
7873           description: Name given to the interface
7874           required: true
7875           type: string
7876           example: __INTERFACE-NAME__
7877         - name: vlan-interface
7878           in: path
7879           description: String that identifies the interface
7880           required: true
7881           type: string
7882           example: __VLAN-INTERFACE__
7883         - name: l3-interface-ipv6-address
7884           in: path
7885           description: IP address
7886           required: true
7887           type: string
7888           example: __L3-INTERFACE-IPV6-ADDRESS__
7889         - name: body
7890           in: body
7891           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7892           required: true
7893           schema:
7894             $ref: "#/definitions/l3-interface-ipv6-address-list"
7895     patch:
7896       tags:
7897         - CloudInfrastructure
7898       summary: update an existing l3-interface-ipv6-address-list
7899       description: |
7900         Update an existing l3-interface-ipv6-address-list
7901         #
7902         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7903         The PUT operation will entirely replace an existing object.
7904         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7905         #
7906         Other differences between PUT and PATCH are:
7907         #
7908         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7909         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7910         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7911       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7912       consumes:
7913         - application/json
7914         - application/xml
7915       produces:
7916         - application/json
7917         - application/xml
7918       responses:
7919         "default":
7920           description: Response codes found in [response codes](https://wiki.onap.org/).
7921       parameters:
7922         - name: hostname
7923           in: path
7924           description: Value from executing hostname on the compute node.
7925           required: true
7926           type: string
7927           example: __HOSTNAME__
7928         - name: interface-name
7929           in: path
7930           description: Name that identifies the physical interface
7931           required: true
7932           type: string
7933           example: __INTERFACE-NAME__
7934         - name: interface-name
7935           in: path
7936           description: Name given to the interface
7937           required: true
7938           type: string
7939           example: __INTERFACE-NAME__
7940         - name: vlan-interface
7941           in: path
7942           description: String that identifies the interface
7943           required: true
7944           type: string
7945           example: __VLAN-INTERFACE__
7946         - name: l3-interface-ipv6-address
7947           in: path
7948           description: IP address
7949           required: true
7950           type: string
7951           example: __L3-INTERFACE-IPV6-ADDRESS__
7952         - name: body
7953           in: body
7954           description: l3-interface-ipv6-address-list object that needs to be updated.
7955           required: true
7956           schema:
7957             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
7958     delete:
7959       tags:
7960         - CloudInfrastructure
7961       summary: delete an existing l3-interface-ipv6-address-list
7962       description: delete an existing l3-interface-ipv6-address-list
7963       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7964       consumes:
7965         - application/json
7966         - application/xml
7967       produces:
7968         - application/json
7969         - application/xml
7970       responses:
7971         "default":
7972           description: Response codes found in [response codes](https://wiki.onap.org/).
7973       parameters:
7974         - name: hostname
7975           in: path
7976           description: Value from executing hostname on the compute node.
7977           required: true
7978           type: string
7979           example: __HOSTNAME__
7980         - name: interface-name
7981           in: path
7982           description: Name that identifies the physical interface
7983           required: true
7984           type: string
7985           example: __INTERFACE-NAME__
7986         - name: interface-name
7987           in: path
7988           description: Name given to the interface
7989           required: true
7990           type: string
7991           example: __INTERFACE-NAME__
7992         - name: vlan-interface
7993           in: path
7994           description: String that identifies the interface
7995           required: true
7996           type: string
7997           example: __VLAN-INTERFACE__
7998         - name: l3-interface-ipv6-address
7999           in: path
8000           description: IP address
8001           required: true
8002           type: string
8003           example: __L3-INTERFACE-IPV6-ADDRESS__
8004         - name: resource-version
8005           in: query
8006           description: resource-version for concurrency
8007           required: true
8008           type: string
8009   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8010     get:
8011       tags:
8012         - CloudInfrastructure
8013       summary: returns vlan
8014       description: returns vlan
8015       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8016       produces:
8017         - application/json
8018         - application/xml
8019       responses:
8020         "200":
8021           description: successful operation
8022           schema:
8023               $ref: "#/getDefinitions/vlan"
8024         "default":
8025           description: Response codes found in [response codes](https://wiki.onap.org/).
8026       parameters:
8027         - name: hostname
8028           in: path
8029           description: Value from executing hostname on the compute node.
8030           required: true
8031           type: string
8032           example: __HOSTNAME__
8033         - name: interface-name
8034           in: path
8035           description: Name that identifies the physical interface
8036           required: true
8037           type: string
8038           example: __INTERFACE-NAME__
8039         - name: interface-name
8040           in: path
8041           description: Name given to the interface
8042           required: true
8043           type: string
8044           example: __INTERFACE-NAME__
8045         - name: vlan-interface
8046           in: path
8047           description: String that identifies the interface
8048           required: true
8049           type: string
8050           example: __VLAN-INTERFACE__
8051     put:
8052       tags:
8053         - CloudInfrastructure
8054       summary: create or update an existing vlan
8055       description: |
8056         Create or update an existing vlan.
8057         #
8058         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8059       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8060       consumes:
8061         - application/json
8062         - application/xml
8063       produces:
8064         - application/json
8065         - application/xml
8066       responses:
8067         "default":
8068           description: Response codes found in [response codes](https://wiki.onap.org/).
8069       parameters:
8070         - name: hostname
8071           in: path
8072           description: Value from executing hostname on the compute node.
8073           required: true
8074           type: string
8075           example: __HOSTNAME__
8076         - name: interface-name
8077           in: path
8078           description: Name that identifies the physical interface
8079           required: true
8080           type: string
8081           example: __INTERFACE-NAME__
8082         - name: interface-name
8083           in: path
8084           description: Name given to the interface
8085           required: true
8086           type: string
8087           example: __INTERFACE-NAME__
8088         - name: vlan-interface
8089           in: path
8090           description: String that identifies the interface
8091           required: true
8092           type: string
8093           example: __VLAN-INTERFACE__
8094         - name: body
8095           in: body
8096           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8097           required: true
8098           schema:
8099             $ref: "#/definitions/vlan"
8100     patch:
8101       tags:
8102         - CloudInfrastructure
8103       summary: update an existing vlan
8104       description: |
8105         Update an existing vlan
8106         #
8107         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8108         The PUT operation will entirely replace an existing object.
8109         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8110         #
8111         Other differences between PUT and PATCH are:
8112         #
8113         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8114         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8115         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8116       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8117       consumes:
8118         - application/json
8119         - application/xml
8120       produces:
8121         - application/json
8122         - application/xml
8123       responses:
8124         "default":
8125           description: Response codes found in [response codes](https://wiki.onap.org/).
8126       parameters:
8127         - name: hostname
8128           in: path
8129           description: Value from executing hostname on the compute node.
8130           required: true
8131           type: string
8132           example: __HOSTNAME__
8133         - name: interface-name
8134           in: path
8135           description: Name that identifies the physical interface
8136           required: true
8137           type: string
8138           example: __INTERFACE-NAME__
8139         - name: interface-name
8140           in: path
8141           description: Name given to the interface
8142           required: true
8143           type: string
8144           example: __INTERFACE-NAME__
8145         - name: vlan-interface
8146           in: path
8147           description: String that identifies the interface
8148           required: true
8149           type: string
8150           example: __VLAN-INTERFACE__
8151         - name: body
8152           in: body
8153           description: vlan object that needs to be updated.
8154           required: true
8155           schema:
8156             $ref: "#/patchDefinitions/vlan"
8157     delete:
8158       tags:
8159         - CloudInfrastructure
8160       summary: delete an existing vlan
8161       description: delete an existing vlan
8162       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8163       consumes:
8164         - application/json
8165         - application/xml
8166       produces:
8167         - application/json
8168         - application/xml
8169       responses:
8170         "default":
8171           description: Response codes found in [response codes](https://wiki.onap.org/).
8172       parameters:
8173         - name: hostname
8174           in: path
8175           description: Value from executing hostname on the compute node.
8176           required: true
8177           type: string
8178           example: __HOSTNAME__
8179         - name: interface-name
8180           in: path
8181           description: Name that identifies the physical interface
8182           required: true
8183           type: string
8184           example: __INTERFACE-NAME__
8185         - name: interface-name
8186           in: path
8187           description: Name given to the interface
8188           required: true
8189           type: string
8190           example: __INTERFACE-NAME__
8191         - name: vlan-interface
8192           in: path
8193           description: String that identifies the interface
8194           required: true
8195           type: string
8196           example: __VLAN-INTERFACE__
8197         - name: resource-version
8198           in: query
8199           description: resource-version for concurrency
8200           required: true
8201           type: string
8202   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
8203     get:
8204       tags:
8205         - CloudInfrastructure
8206       summary: returns vlans
8207       description: returns vlans
8208       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
8209       produces:
8210         - application/json
8211         - application/xml
8212       responses:
8213         "200":
8214           description: successful operation
8215           schema:
8216               $ref: "#/getDefinitions/vlans"
8217         "default":
8218           description: Response codes found in [response codes](https://wiki.onap.org/).
8219       parameters:
8220         - name: hostname
8221           in: path
8222           description: Value from executing hostname on the compute node.
8223           required: true
8224           type: string
8225           example: __HOSTNAME__
8226         - name: interface-name
8227           in: path
8228           description: Name that identifies the physical interface
8229           required: true
8230           type: string
8231           example: __INTERFACE-NAME__
8232         - name: interface-name
8233           in: path
8234           description: Name given to the interface
8235           required: true
8236           type: string
8237           example: __INTERFACE-NAME__
8238         - name: vlan-interface
8239           in: query
8240           description:
8241           required: false
8242           type: string
8243         - name: vlan-id-inner
8244           in: query
8245           description:
8246           required: false
8247           type: integer
8248           format: int64
8249         - name: vpn-id
8250           in: query
8251           description:
8252           required: false
8253           type: string
8254   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
8255     put:
8256       tags:
8257         - CloudInfrastructure
8258       summary: see node definition for valid relationships
8259       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8260       consumes:
8261         - application/json
8262         - application/xml
8263       produces:
8264         - application/json
8265         - application/xml
8266       responses:
8267         "default":
8268           description: Response codes found in [response codes](https://wiki.onap.org/).
8269       parameters:
8270         - name: hostname
8271           in: path
8272           description: Value from executing hostname on the compute node.
8273           required: true
8274           type: string
8275           example: __HOSTNAME__
8276         - name: interface-name
8277           in: path
8278           description: Name that identifies the physical interface
8279           required: true
8280           type: string
8281           example: __INTERFACE-NAME__
8282         - name: interface-name
8283           in: path
8284           description: Name given to the interface
8285           required: true
8286           type: string
8287           example: __INTERFACE-NAME__
8288         - name: pci-id
8289           in: path
8290           description: PCI ID used to identify the sriov-vf
8291           required: true
8292           type: string
8293           example: __PCI-ID__
8294         - name: body
8295           in: body
8296           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8297           required: true
8298           schema:
8299             $ref: "#/definitions/relationship"
8300     delete:
8301       tags:
8302         - CloudInfrastructure
8303       summary: delete an existing relationship
8304       description: delete an existing relationship
8305       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8306       consumes:
8307         - application/json
8308         - application/xml
8309       produces:
8310         - application/json
8311         - application/xml
8312       responses:
8313         "default":
8314           description: Response codes found in [response codes](https://wiki.onap.org/).
8315       parameters:
8316         - name: hostname
8317           in: path
8318           description: Value from executing hostname on the compute node.
8319           required: true
8320           type: string
8321           example: __HOSTNAME__
8322         - name: interface-name
8323           in: path
8324           description: Name that identifies the physical interface
8325           required: true
8326           type: string
8327           example: __INTERFACE-NAME__
8328         - name: interface-name
8329           in: path
8330           description: Name given to the interface
8331           required: true
8332           type: string
8333           example: __INTERFACE-NAME__
8334         - name: pci-id
8335           in: path
8336           description: PCI ID used to identify the sriov-vf
8337           required: true
8338           type: string
8339           example: __PCI-ID__
8340   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
8341     get:
8342       tags:
8343         - CloudInfrastructure
8344       summary: returns sriov-vf
8345       description: returns sriov-vf
8346       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8347       produces:
8348         - application/json
8349         - application/xml
8350       responses:
8351         "200":
8352           description: successful operation
8353           schema:
8354               $ref: "#/getDefinitions/sriov-vf"
8355         "default":
8356           description: Response codes found in [response codes](https://wiki.onap.org/).
8357       parameters:
8358         - name: hostname
8359           in: path
8360           description: Value from executing hostname on the compute node.
8361           required: true
8362           type: string
8363           example: __HOSTNAME__
8364         - name: interface-name
8365           in: path
8366           description: Name that identifies the physical interface
8367           required: true
8368           type: string
8369           example: __INTERFACE-NAME__
8370         - name: interface-name
8371           in: path
8372           description: Name given to the interface
8373           required: true
8374           type: string
8375           example: __INTERFACE-NAME__
8376         - name: pci-id
8377           in: path
8378           description: PCI ID used to identify the sriov-vf
8379           required: true
8380           type: string
8381           example: __PCI-ID__
8382     put:
8383       tags:
8384         - CloudInfrastructure
8385       summary: create or update an existing sriov-vf
8386       description: |
8387         Create or update an existing sriov-vf.
8388         #
8389         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8390       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8391       consumes:
8392         - application/json
8393         - application/xml
8394       produces:
8395         - application/json
8396         - application/xml
8397       responses:
8398         "default":
8399           description: Response codes found in [response codes](https://wiki.onap.org/).
8400       parameters:
8401         - name: hostname
8402           in: path
8403           description: Value from executing hostname on the compute node.
8404           required: true
8405           type: string
8406           example: __HOSTNAME__
8407         - name: interface-name
8408           in: path
8409           description: Name that identifies the physical interface
8410           required: true
8411           type: string
8412           example: __INTERFACE-NAME__
8413         - name: interface-name
8414           in: path
8415           description: Name given to the interface
8416           required: true
8417           type: string
8418           example: __INTERFACE-NAME__
8419         - name: pci-id
8420           in: path
8421           description: PCI ID used to identify the sriov-vf
8422           required: true
8423           type: string
8424           example: __PCI-ID__
8425         - name: body
8426           in: body
8427           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8428           required: true
8429           schema:
8430             $ref: "#/definitions/sriov-vf"
8431     patch:
8432       tags:
8433         - CloudInfrastructure
8434       summary: update an existing sriov-vf
8435       description: |
8436         Update an existing sriov-vf
8437         #
8438         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8439         The PUT operation will entirely replace an existing object.
8440         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8441         #
8442         Other differences between PUT and PATCH are:
8443         #
8444         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8445         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8446         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8447       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8448       consumes:
8449         - application/json
8450         - application/xml
8451       produces:
8452         - application/json
8453         - application/xml
8454       responses:
8455         "default":
8456           description: Response codes found in [response codes](https://wiki.onap.org/).
8457       parameters:
8458         - name: hostname
8459           in: path
8460           description: Value from executing hostname on the compute node.
8461           required: true
8462           type: string
8463           example: __HOSTNAME__
8464         - name: interface-name
8465           in: path
8466           description: Name that identifies the physical interface
8467           required: true
8468           type: string
8469           example: __INTERFACE-NAME__
8470         - name: interface-name
8471           in: path
8472           description: Name given to the interface
8473           required: true
8474           type: string
8475           example: __INTERFACE-NAME__
8476         - name: pci-id
8477           in: path
8478           description: PCI ID used to identify the sriov-vf
8479           required: true
8480           type: string
8481           example: __PCI-ID__
8482         - name: body
8483           in: body
8484           description: sriov-vf object that needs to be updated.
8485           required: true
8486           schema:
8487             $ref: "#/patchDefinitions/sriov-vf"
8488     delete:
8489       tags:
8490         - CloudInfrastructure
8491       summary: delete an existing sriov-vf
8492       description: delete an existing sriov-vf
8493       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8494       consumes:
8495         - application/json
8496         - application/xml
8497       produces:
8498         - application/json
8499         - application/xml
8500       responses:
8501         "default":
8502           description: Response codes found in [response codes](https://wiki.onap.org/).
8503       parameters:
8504         - name: hostname
8505           in: path
8506           description: Value from executing hostname on the compute node.
8507           required: true
8508           type: string
8509           example: __HOSTNAME__
8510         - name: interface-name
8511           in: path
8512           description: Name that identifies the physical interface
8513           required: true
8514           type: string
8515           example: __INTERFACE-NAME__
8516         - name: interface-name
8517           in: path
8518           description: Name given to the interface
8519           required: true
8520           type: string
8521           example: __INTERFACE-NAME__
8522         - name: pci-id
8523           in: path
8524           description: PCI ID used to identify the sriov-vf
8525           required: true
8526           type: string
8527           example: __PCI-ID__
8528         - name: resource-version
8529           in: query
8530           description: resource-version for concurrency
8531           required: true
8532           type: string
8533   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
8534     get:
8535       tags:
8536         - CloudInfrastructure
8537       summary: returns sriov-vfs
8538       description: returns sriov-vfs
8539       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
8540       produces:
8541         - application/json
8542         - application/xml
8543       responses:
8544         "200":
8545           description: successful operation
8546           schema:
8547               $ref: "#/getDefinitions/sriov-vfs"
8548         "default":
8549           description: Response codes found in [response codes](https://wiki.onap.org/).
8550       parameters:
8551         - name: hostname
8552           in: path
8553           description: Value from executing hostname on the compute node.
8554           required: true
8555           type: string
8556           example: __HOSTNAME__
8557         - name: interface-name
8558           in: path
8559           description: Name that identifies the physical interface
8560           required: true
8561           type: string
8562           example: __INTERFACE-NAME__
8563         - name: interface-name
8564           in: path
8565           description: Name given to the interface
8566           required: true
8567           type: string
8568           example: __INTERFACE-NAME__
8569         - name: pci-id
8570           in: query
8571           description:
8572           required: false
8573           type: string
8574         - name: vf-vlan-filter
8575           in: query
8576           description:
8577           required: false
8578           type: string
8579         - name: vf-mac-filter
8580           in: query
8581           description:
8582           required: false
8583           type: string
8584         - name: vf-vlan-strip
8585           in: query
8586           description:
8587           required: false
8588           type: boolean
8589         - name: neutron-network-id
8590           in: query
8591           description:
8592           required: false
8593           type: string
8594   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
8595     put:
8596       tags:
8597         - CloudInfrastructure
8598       summary: see node definition for valid relationships
8599       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8600       consumes:
8601         - application/json
8602         - application/xml
8603       produces:
8604         - application/json
8605         - application/xml
8606       responses:
8607         "default":
8608           description: Response codes found in [response codes](https://wiki.onap.org/).
8609       parameters:
8610         - name: hostname
8611           in: path
8612           description: Value from executing hostname on the compute node.
8613           required: true
8614           type: string
8615           example: __HOSTNAME__
8616         - name: interface-name
8617           in: path
8618           description: Name that identifies the physical interface
8619           required: true
8620           type: string
8621           example: __INTERFACE-NAME__
8622         - name: interface-name
8623           in: path
8624           description: Name given to the interface
8625           required: true
8626           type: string
8627           example: __INTERFACE-NAME__
8628         - name: body
8629           in: body
8630           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
8631           required: true
8632           schema:
8633             $ref: "#/definitions/relationship"
8634     delete:
8635       tags:
8636         - CloudInfrastructure
8637       summary: delete an existing relationship
8638       description: delete an existing relationship
8639       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8640       consumes:
8641         - application/json
8642         - application/xml
8643       produces:
8644         - application/json
8645         - application/xml
8646       responses:
8647         "default":
8648           description: Response codes found in [response codes](https://wiki.onap.org/).
8649       parameters:
8650         - name: hostname
8651           in: path
8652           description: Value from executing hostname on the compute node.
8653           required: true
8654           type: string
8655           example: __HOSTNAME__
8656         - name: interface-name
8657           in: path
8658           description: Name that identifies the physical interface
8659           required: true
8660           type: string
8661           example: __INTERFACE-NAME__
8662         - name: interface-name
8663           in: path
8664           description: Name given to the interface
8665           required: true
8666           type: string
8667           example: __INTERFACE-NAME__
8668   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
8669     put:
8670       tags:
8671         - CloudInfrastructure
8672       summary: see node definition for valid relationships
8673       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8674       consumes:
8675         - application/json
8676         - application/xml
8677       produces:
8678         - application/json
8679         - application/xml
8680       responses:
8681         "default":
8682           description: Response codes found in [response codes](https://wiki.onap.org/).
8683       parameters:
8684         - name: hostname
8685           in: path
8686           description: Value from executing hostname on the compute node.
8687           required: true
8688           type: string
8689           example: __HOSTNAME__
8690         - name: interface-name
8691           in: path
8692           description: Name that identifies the physical interface
8693           required: true
8694           type: string
8695           example: __INTERFACE-NAME__
8696         - name: interface-name
8697           in: path
8698           description: Name given to the interface
8699           required: true
8700           type: string
8701           example: __INTERFACE-NAME__
8702         - name: l3-interface-ipv4-address
8703           in: path
8704           description: IP address
8705           required: true
8706           type: string
8707           example: __L3-INTERFACE-IPV4-ADDRESS__
8708         - name: body
8709           in: body
8710           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8711           required: true
8712           schema:
8713             $ref: "#/definitions/relationship"
8714     delete:
8715       tags:
8716         - CloudInfrastructure
8717       summary: delete an existing relationship
8718       description: delete an existing relationship
8719       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8720       consumes:
8721         - application/json
8722         - application/xml
8723       produces:
8724         - application/json
8725         - application/xml
8726       responses:
8727         "default":
8728           description: Response codes found in [response codes](https://wiki.onap.org/).
8729       parameters:
8730         - name: hostname
8731           in: path
8732           description: Value from executing hostname on the compute node.
8733           required: true
8734           type: string
8735           example: __HOSTNAME__
8736         - name: interface-name
8737           in: path
8738           description: Name that identifies the physical interface
8739           required: true
8740           type: string
8741           example: __INTERFACE-NAME__
8742         - name: interface-name
8743           in: path
8744           description: Name given to the interface
8745           required: true
8746           type: string
8747           example: __INTERFACE-NAME__
8748         - name: l3-interface-ipv4-address
8749           in: path
8750           description: IP address
8751           required: true
8752           type: string
8753           example: __L3-INTERFACE-IPV4-ADDRESS__
8754   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
8755     get:
8756       tags:
8757         - CloudInfrastructure
8758       summary: returns l3-interface-ipv4-address-list
8759       description: returns l3-interface-ipv4-address-list
8760       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8761       produces:
8762         - application/json
8763         - application/xml
8764       responses:
8765         "200":
8766           description: successful operation
8767           schema:
8768               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8769         "default":
8770           description: Response codes found in [response codes](https://wiki.onap.org/).
8771       parameters:
8772         - name: hostname
8773           in: path
8774           description: Value from executing hostname on the compute node.
8775           required: true
8776           type: string
8777           example: __HOSTNAME__
8778         - name: interface-name
8779           in: path
8780           description: Name that identifies the physical interface
8781           required: true
8782           type: string
8783           example: __INTERFACE-NAME__
8784         - name: interface-name
8785           in: path
8786           description: Name given to the interface
8787           required: true
8788           type: string
8789           example: __INTERFACE-NAME__
8790         - name: l3-interface-ipv4-address
8791           in: path
8792           description: IP address
8793           required: true
8794           type: string
8795           example: __L3-INTERFACE-IPV4-ADDRESS__
8796     put:
8797       tags:
8798         - CloudInfrastructure
8799       summary: create or update an existing l3-interface-ipv4-address-list
8800       description: |
8801         Create or update an existing l3-interface-ipv4-address-list.
8802         #
8803         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8804       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8805       consumes:
8806         - application/json
8807         - application/xml
8808       produces:
8809         - application/json
8810         - application/xml
8811       responses:
8812         "default":
8813           description: Response codes found in [response codes](https://wiki.onap.org/).
8814       parameters:
8815         - name: hostname
8816           in: path
8817           description: Value from executing hostname on the compute node.
8818           required: true
8819           type: string
8820           example: __HOSTNAME__
8821         - name: interface-name
8822           in: path
8823           description: Name that identifies the physical interface
8824           required: true
8825           type: string
8826           example: __INTERFACE-NAME__
8827         - name: interface-name
8828           in: path
8829           description: Name given to the interface
8830           required: true
8831           type: string
8832           example: __INTERFACE-NAME__
8833         - name: l3-interface-ipv4-address
8834           in: path
8835           description: IP address
8836           required: true
8837           type: string
8838           example: __L3-INTERFACE-IPV4-ADDRESS__
8839         - name: body
8840           in: body
8841           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8842           required: true
8843           schema:
8844             $ref: "#/definitions/l3-interface-ipv4-address-list"
8845     patch:
8846       tags:
8847         - CloudInfrastructure
8848       summary: update an existing l3-interface-ipv4-address-list
8849       description: |
8850         Update an existing l3-interface-ipv4-address-list
8851         #
8852         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8853         The PUT operation will entirely replace an existing object.
8854         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8855         #
8856         Other differences between PUT and PATCH are:
8857         #
8858         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8859         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8860         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8861       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8862       consumes:
8863         - application/json
8864         - application/xml
8865       produces:
8866         - application/json
8867         - application/xml
8868       responses:
8869         "default":
8870           description: Response codes found in [response codes](https://wiki.onap.org/).
8871       parameters:
8872         - name: hostname
8873           in: path
8874           description: Value from executing hostname on the compute node.
8875           required: true
8876           type: string
8877           example: __HOSTNAME__
8878         - name: interface-name
8879           in: path
8880           description: Name that identifies the physical interface
8881           required: true
8882           type: string
8883           example: __INTERFACE-NAME__
8884         - name: interface-name
8885           in: path
8886           description: Name given to the interface
8887           required: true
8888           type: string
8889           example: __INTERFACE-NAME__
8890         - name: l3-interface-ipv4-address
8891           in: path
8892           description: IP address
8893           required: true
8894           type: string
8895           example: __L3-INTERFACE-IPV4-ADDRESS__
8896         - name: body
8897           in: body
8898           description: l3-interface-ipv4-address-list object that needs to be updated.
8899           required: true
8900           schema:
8901             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8902     delete:
8903       tags:
8904         - CloudInfrastructure
8905       summary: delete an existing l3-interface-ipv4-address-list
8906       description: delete an existing l3-interface-ipv4-address-list
8907       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8908       consumes:
8909         - application/json
8910         - application/xml
8911       produces:
8912         - application/json
8913         - application/xml
8914       responses:
8915         "default":
8916           description: Response codes found in [response codes](https://wiki.onap.org/).
8917       parameters:
8918         - name: hostname
8919           in: path
8920           description: Value from executing hostname on the compute node.
8921           required: true
8922           type: string
8923           example: __HOSTNAME__
8924         - name: interface-name
8925           in: path
8926           description: Name that identifies the physical interface
8927           required: true
8928           type: string
8929           example: __INTERFACE-NAME__
8930         - name: interface-name
8931           in: path
8932           description: Name given to the interface
8933           required: true
8934           type: string
8935           example: __INTERFACE-NAME__
8936         - name: l3-interface-ipv4-address
8937           in: path
8938           description: IP address
8939           required: true
8940           type: string
8941           example: __L3-INTERFACE-IPV4-ADDRESS__
8942         - name: resource-version
8943           in: query
8944           description: resource-version for concurrency
8945           required: true
8946           type: string
8947   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
8948     put:
8949       tags:
8950         - CloudInfrastructure
8951       summary: see node definition for valid relationships
8952       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
8953       consumes:
8954         - application/json
8955         - application/xml
8956       produces:
8957         - application/json
8958         - application/xml
8959       responses:
8960         "default":
8961           description: Response codes found in [response codes](https://wiki.onap.org/).
8962       parameters:
8963         - name: hostname
8964           in: path
8965           description: Value from executing hostname on the compute node.
8966           required: true
8967           type: string
8968           example: __HOSTNAME__
8969         - name: interface-name
8970           in: path
8971           description: Name that identifies the physical interface
8972           required: true
8973           type: string
8974           example: __INTERFACE-NAME__
8975         - name: interface-name
8976           in: path
8977           description: Name given to the interface
8978           required: true
8979           type: string
8980           example: __INTERFACE-NAME__
8981         - name: l3-interface-ipv6-address
8982           in: path
8983           description: IP address
8984           required: true
8985           type: string
8986           example: __L3-INTERFACE-IPV6-ADDRESS__
8987         - name: body
8988           in: body
8989           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
8990           required: true
8991           schema:
8992             $ref: "#/definitions/relationship"
8993     delete:
8994       tags:
8995         - CloudInfrastructure
8996       summary: delete an existing relationship
8997       description: delete an existing relationship
8998       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
8999       consumes:
9000         - application/json
9001         - application/xml
9002       produces:
9003         - application/json
9004         - application/xml
9005       responses:
9006         "default":
9007           description: Response codes found in [response codes](https://wiki.onap.org/).
9008       parameters:
9009         - name: hostname
9010           in: path
9011           description: Value from executing hostname on the compute node.
9012           required: true
9013           type: string
9014           example: __HOSTNAME__
9015         - name: interface-name
9016           in: path
9017           description: Name that identifies the physical interface
9018           required: true
9019           type: string
9020           example: __INTERFACE-NAME__
9021         - name: interface-name
9022           in: path
9023           description: Name given to the interface
9024           required: true
9025           type: string
9026           example: __INTERFACE-NAME__
9027         - name: l3-interface-ipv6-address
9028           in: path
9029           description: IP address
9030           required: true
9031           type: string
9032           example: __L3-INTERFACE-IPV6-ADDRESS__
9033   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
9034     get:
9035       tags:
9036         - CloudInfrastructure
9037       summary: returns l3-interface-ipv6-address-list
9038       description: returns l3-interface-ipv6-address-list
9039       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9040       produces:
9041         - application/json
9042         - application/xml
9043       responses:
9044         "200":
9045           description: successful operation
9046           schema:
9047               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9048         "default":
9049           description: Response codes found in [response codes](https://wiki.onap.org/).
9050       parameters:
9051         - name: hostname
9052           in: path
9053           description: Value from executing hostname on the compute node.
9054           required: true
9055           type: string
9056           example: __HOSTNAME__
9057         - name: interface-name
9058           in: path
9059           description: Name that identifies the physical interface
9060           required: true
9061           type: string
9062           example: __INTERFACE-NAME__
9063         - name: interface-name
9064           in: path
9065           description: Name given to the interface
9066           required: true
9067           type: string
9068           example: __INTERFACE-NAME__
9069         - name: l3-interface-ipv6-address
9070           in: path
9071           description: IP address
9072           required: true
9073           type: string
9074           example: __L3-INTERFACE-IPV6-ADDRESS__
9075     put:
9076       tags:
9077         - CloudInfrastructure
9078       summary: create or update an existing l3-interface-ipv6-address-list
9079       description: |
9080         Create or update an existing l3-interface-ipv6-address-list.
9081         #
9082         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9083       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9084       consumes:
9085         - application/json
9086         - application/xml
9087       produces:
9088         - application/json
9089         - application/xml
9090       responses:
9091         "default":
9092           description: Response codes found in [response codes](https://wiki.onap.org/).
9093       parameters:
9094         - name: hostname
9095           in: path
9096           description: Value from executing hostname on the compute node.
9097           required: true
9098           type: string
9099           example: __HOSTNAME__
9100         - name: interface-name
9101           in: path
9102           description: Name that identifies the physical interface
9103           required: true
9104           type: string
9105           example: __INTERFACE-NAME__
9106         - name: interface-name
9107           in: path
9108           description: Name given to the interface
9109           required: true
9110           type: string
9111           example: __INTERFACE-NAME__
9112         - name: l3-interface-ipv6-address
9113           in: path
9114           description: IP address
9115           required: true
9116           type: string
9117           example: __L3-INTERFACE-IPV6-ADDRESS__
9118         - name: body
9119           in: body
9120           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
9121           required: true
9122           schema:
9123             $ref: "#/definitions/l3-interface-ipv6-address-list"
9124     patch:
9125       tags:
9126         - CloudInfrastructure
9127       summary: update an existing l3-interface-ipv6-address-list
9128       description: |
9129         Update an existing l3-interface-ipv6-address-list
9130         #
9131         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9132         The PUT operation will entirely replace an existing object.
9133         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9134         #
9135         Other differences between PUT and PATCH are:
9136         #
9137         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9138         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9139         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9140       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9141       consumes:
9142         - application/json
9143         - application/xml
9144       produces:
9145         - application/json
9146         - application/xml
9147       responses:
9148         "default":
9149           description: Response codes found in [response codes](https://wiki.onap.org/).
9150       parameters:
9151         - name: hostname
9152           in: path
9153           description: Value from executing hostname on the compute node.
9154           required: true
9155           type: string
9156           example: __HOSTNAME__
9157         - name: interface-name
9158           in: path
9159           description: Name that identifies the physical interface
9160           required: true
9161           type: string
9162           example: __INTERFACE-NAME__
9163         - name: interface-name
9164           in: path
9165           description: Name given to the interface
9166           required: true
9167           type: string
9168           example: __INTERFACE-NAME__
9169         - name: l3-interface-ipv6-address
9170           in: path
9171           description: IP address
9172           required: true
9173           type: string
9174           example: __L3-INTERFACE-IPV6-ADDRESS__
9175         - name: body
9176           in: body
9177           description: l3-interface-ipv6-address-list object that needs to be updated.
9178           required: true
9179           schema:
9180             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9181     delete:
9182       tags:
9183         - CloudInfrastructure
9184       summary: delete an existing l3-interface-ipv6-address-list
9185       description: delete an existing l3-interface-ipv6-address-list
9186       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9187       consumes:
9188         - application/json
9189         - application/xml
9190       produces:
9191         - application/json
9192         - application/xml
9193       responses:
9194         "default":
9195           description: Response codes found in [response codes](https://wiki.onap.org/).
9196       parameters:
9197         - name: hostname
9198           in: path
9199           description: Value from executing hostname on the compute node.
9200           required: true
9201           type: string
9202           example: __HOSTNAME__
9203         - name: interface-name
9204           in: path
9205           description: Name that identifies the physical interface
9206           required: true
9207           type: string
9208           example: __INTERFACE-NAME__
9209         - name: interface-name
9210           in: path
9211           description: Name given to the interface
9212           required: true
9213           type: string
9214           example: __INTERFACE-NAME__
9215         - name: l3-interface-ipv6-address
9216           in: path
9217           description: IP address
9218           required: true
9219           type: string
9220           example: __L3-INTERFACE-IPV6-ADDRESS__
9221         - name: resource-version
9222           in: query
9223           description: resource-version for concurrency
9224           required: true
9225           type: string
9226   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
9227     get:
9228       tags:
9229         - CloudInfrastructure
9230       summary: returns l-interface
9231       description: returns l-interface
9232       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9233       produces:
9234         - application/json
9235         - application/xml
9236       responses:
9237         "200":
9238           description: successful operation
9239           schema:
9240               $ref: "#/getDefinitions/l-interface"
9241         "default":
9242           description: Response codes found in [response codes](https://wiki.onap.org/).
9243       parameters:
9244         - name: hostname
9245           in: path
9246           description: Value from executing hostname on the compute node.
9247           required: true
9248           type: string
9249           example: __HOSTNAME__
9250         - name: interface-name
9251           in: path
9252           description: Name that identifies the physical interface
9253           required: true
9254           type: string
9255           example: __INTERFACE-NAME__
9256         - name: interface-name
9257           in: path
9258           description: Name given to the interface
9259           required: true
9260           type: string
9261           example: __INTERFACE-NAME__
9262     put:
9263       tags:
9264         - CloudInfrastructure
9265       summary: create or update an existing l-interface
9266       description: |
9267         Create or update an existing l-interface.
9268         #
9269         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9270       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9271       consumes:
9272         - application/json
9273         - application/xml
9274       produces:
9275         - application/json
9276         - application/xml
9277       responses:
9278         "default":
9279           description: Response codes found in [response codes](https://wiki.onap.org/).
9280       parameters:
9281         - name: hostname
9282           in: path
9283           description: Value from executing hostname on the compute node.
9284           required: true
9285           type: string
9286           example: __HOSTNAME__
9287         - name: interface-name
9288           in: path
9289           description: Name that identifies the physical interface
9290           required: true
9291           type: string
9292           example: __INTERFACE-NAME__
9293         - name: interface-name
9294           in: path
9295           description: Name given to the interface
9296           required: true
9297           type: string
9298           example: __INTERFACE-NAME__
9299         - name: body
9300           in: body
9301           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9302           required: true
9303           schema:
9304             $ref: "#/definitions/l-interface"
9305     patch:
9306       tags:
9307         - CloudInfrastructure
9308       summary: update an existing l-interface
9309       description: |
9310         Update an existing l-interface
9311         #
9312         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9313         The PUT operation will entirely replace an existing object.
9314         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9315         #
9316         Other differences between PUT and PATCH are:
9317         #
9318         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9319         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9320         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9321       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9322       consumes:
9323         - application/json
9324         - application/xml
9325       produces:
9326         - application/json
9327         - application/xml
9328       responses:
9329         "default":
9330           description: Response codes found in [response codes](https://wiki.onap.org/).
9331       parameters:
9332         - name: hostname
9333           in: path
9334           description: Value from executing hostname on the compute node.
9335           required: true
9336           type: string
9337           example: __HOSTNAME__
9338         - name: interface-name
9339           in: path
9340           description: Name that identifies the physical interface
9341           required: true
9342           type: string
9343           example: __INTERFACE-NAME__
9344         - name: interface-name
9345           in: path
9346           description: Name given to the interface
9347           required: true
9348           type: string
9349           example: __INTERFACE-NAME__
9350         - name: body
9351           in: body
9352           description: l-interface object that needs to be updated.
9353           required: true
9354           schema:
9355             $ref: "#/patchDefinitions/l-interface"
9356     delete:
9357       tags:
9358         - CloudInfrastructure
9359       summary: delete an existing l-interface
9360       description: delete an existing l-interface
9361       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9362       consumes:
9363         - application/json
9364         - application/xml
9365       produces:
9366         - application/json
9367         - application/xml
9368       responses:
9369         "default":
9370           description: Response codes found in [response codes](https://wiki.onap.org/).
9371       parameters:
9372         - name: hostname
9373           in: path
9374           description: Value from executing hostname on the compute node.
9375           required: true
9376           type: string
9377           example: __HOSTNAME__
9378         - name: interface-name
9379           in: path
9380           description: Name that identifies the physical interface
9381           required: true
9382           type: string
9383           example: __INTERFACE-NAME__
9384         - name: interface-name
9385           in: path
9386           description: Name given to the interface
9387           required: true
9388           type: string
9389           example: __INTERFACE-NAME__
9390         - name: resource-version
9391           in: query
9392           description: resource-version for concurrency
9393           required: true
9394           type: string
9395   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
9396     get:
9397       tags:
9398         - CloudInfrastructure
9399       summary: returns l-interfaces
9400       description: returns l-interfaces
9401       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
9402       produces:
9403         - application/json
9404         - application/xml
9405       responses:
9406         "200":
9407           description: successful operation
9408           schema:
9409               $ref: "#/getDefinitions/l-interfaces"
9410         "default":
9411           description: Response codes found in [response codes](https://wiki.onap.org/).
9412       parameters:
9413         - name: hostname
9414           in: path
9415           description: Value from executing hostname on the compute node.
9416           required: true
9417           type: string
9418           example: __HOSTNAME__
9419         - name: interface-name
9420           in: path
9421           description: Name that identifies the physical interface
9422           required: true
9423           type: string
9424           example: __INTERFACE-NAME__
9425         - name: interface-name
9426           in: query
9427           description:
9428           required: false
9429           type: string
9430         - name: interface-id
9431           in: query
9432           description:
9433           required: false
9434           type: string
9435         - name: macaddr
9436           in: query
9437           description:
9438           required: false
9439           type: string
9440         - name: network-name
9441           in: query
9442           description:
9443           required: false
9444           type: string
9445   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
9446     get:
9447       tags:
9448         - CloudInfrastructure
9449       summary: returns p-interface
9450       description: returns p-interface
9451       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
9452       produces:
9453         - application/json
9454         - application/xml
9455       responses:
9456         "200":
9457           description: successful operation
9458           schema:
9459               $ref: "#/getDefinitions/p-interface"
9460         "default":
9461           description: Response codes found in [response codes](https://wiki.onap.org/).
9462       parameters:
9463         - name: hostname
9464           in: path
9465           description: Value from executing hostname on the compute node.
9466           required: true
9467           type: string
9468           example: __HOSTNAME__
9469         - name: interface-name
9470           in: path
9471           description: Name that identifies the physical interface
9472           required: true
9473           type: string
9474           example: __INTERFACE-NAME__
9475     put:
9476       tags:
9477         - CloudInfrastructure
9478       summary: create or update an existing p-interface
9479       description: |
9480         Create or update an existing p-interface.
9481         #
9482         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9483       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9484       consumes:
9485         - application/json
9486         - application/xml
9487       produces:
9488         - application/json
9489         - application/xml
9490       responses:
9491         "default":
9492           description: Response codes found in [response codes](https://wiki.onap.org/).
9493       parameters:
9494         - name: hostname
9495           in: path
9496           description: Value from executing hostname on the compute node.
9497           required: true
9498           type: string
9499           example: __HOSTNAME__
9500         - name: interface-name
9501           in: path
9502           description: Name that identifies the physical interface
9503           required: true
9504           type: string
9505           example: __INTERFACE-NAME__
9506         - name: body
9507           in: body
9508           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9509           required: true
9510           schema:
9511             $ref: "#/definitions/p-interface"
9512     patch:
9513       tags:
9514         - CloudInfrastructure
9515       summary: update an existing p-interface
9516       description: |
9517         Update an existing p-interface
9518         #
9519         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9520         The PUT operation will entirely replace an existing object.
9521         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9522         #
9523         Other differences between PUT and PATCH are:
9524         #
9525         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9526         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9527         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9528       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9529       consumes:
9530         - application/json
9531         - application/xml
9532       produces:
9533         - application/json
9534         - application/xml
9535       responses:
9536         "default":
9537           description: Response codes found in [response codes](https://wiki.onap.org/).
9538       parameters:
9539         - name: hostname
9540           in: path
9541           description: Value from executing hostname on the compute node.
9542           required: true
9543           type: string
9544           example: __HOSTNAME__
9545         - name: interface-name
9546           in: path
9547           description: Name that identifies the physical interface
9548           required: true
9549           type: string
9550           example: __INTERFACE-NAME__
9551         - name: body
9552           in: body
9553           description: p-interface object that needs to be updated.
9554           required: true
9555           schema:
9556             $ref: "#/patchDefinitions/p-interface"
9557     delete:
9558       tags:
9559         - CloudInfrastructure
9560       summary: delete an existing p-interface
9561       description: delete an existing p-interface
9562       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
9563       consumes:
9564         - application/json
9565         - application/xml
9566       produces:
9567         - application/json
9568         - application/xml
9569       responses:
9570         "default":
9571           description: Response codes found in [response codes](https://wiki.onap.org/).
9572       parameters:
9573         - name: hostname
9574           in: path
9575           description: Value from executing hostname on the compute node.
9576           required: true
9577           type: string
9578           example: __HOSTNAME__
9579         - name: interface-name
9580           in: path
9581           description: Name that identifies the physical interface
9582           required: true
9583           type: string
9584           example: __INTERFACE-NAME__
9585         - name: resource-version
9586           in: query
9587           description: resource-version for concurrency
9588           required: true
9589           type: string
9590   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
9591     get:
9592       tags:
9593         - CloudInfrastructure
9594       summary: returns p-interfaces
9595       description: returns p-interfaces
9596       operationId: getCloudInfrastructurePserversPserverPInterfaces
9597       produces:
9598         - application/json
9599         - application/xml
9600       responses:
9601         "200":
9602           description: successful operation
9603           schema:
9604               $ref: "#/getDefinitions/p-interfaces"
9605         "default":
9606           description: Response codes found in [response codes](https://wiki.onap.org/).
9607       parameters:
9608         - name: hostname
9609           in: path
9610           description: Value from executing hostname on the compute node.
9611           required: true
9612           type: string
9613           example: __HOSTNAME__
9614         - name: interface-name
9615           in: query
9616           description:
9617           required: false
9618           type: string
9619         - name: prov-status
9620           in: query
9621           description:
9622           required: false
9623           type: string
9624   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
9625     put:
9626       tags:
9627         - CloudInfrastructure
9628       summary: see node definition for valid relationships
9629       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9630       consumes:
9631         - application/json
9632         - application/xml
9633       produces:
9634         - application/json
9635         - application/xml
9636       responses:
9637         "default":
9638           description: Response codes found in [response codes](https://wiki.onap.org/).
9639       parameters:
9640         - name: hostname
9641           in: path
9642           description: Value from executing hostname on the compute node.
9643           required: true
9644           type: string
9645           example: __HOSTNAME__
9646         - name: interface-name
9647           in: path
9648           description: Name that identifies the link aggregate interface
9649           required: true
9650           type: string
9651           example: __INTERFACE-NAME__
9652         - name: body
9653           in: body
9654           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
9655           required: true
9656           schema:
9657             $ref: "#/definitions/relationship"
9658     delete:
9659       tags:
9660         - CloudInfrastructure
9661       summary: delete an existing relationship
9662       description: delete an existing relationship
9663       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9664       consumes:
9665         - application/json
9666         - application/xml
9667       produces:
9668         - application/json
9669         - application/xml
9670       responses:
9671         "default":
9672           description: Response codes found in [response codes](https://wiki.onap.org/).
9673       parameters:
9674         - name: hostname
9675           in: path
9676           description: Value from executing hostname on the compute node.
9677           required: true
9678           type: string
9679           example: __HOSTNAME__
9680         - name: interface-name
9681           in: path
9682           description: Name that identifies the link aggregate interface
9683           required: true
9684           type: string
9685           example: __INTERFACE-NAME__
9686   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9687     put:
9688       tags:
9689         - CloudInfrastructure
9690       summary: see node definition for valid relationships
9691       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9692       consumes:
9693         - application/json
9694         - application/xml
9695       produces:
9696         - application/json
9697         - application/xml
9698       responses:
9699         "default":
9700           description: Response codes found in [response codes](https://wiki.onap.org/).
9701       parameters:
9702         - name: hostname
9703           in: path
9704           description: Value from executing hostname on the compute node.
9705           required: true
9706           type: string
9707           example: __HOSTNAME__
9708         - name: interface-name
9709           in: path
9710           description: Name that identifies the link aggregate interface
9711           required: true
9712           type: string
9713           example: __INTERFACE-NAME__
9714         - name: interface-name
9715           in: path
9716           description: Name given to the interface
9717           required: true
9718           type: string
9719           example: __INTERFACE-NAME__
9720         - name: vlan-interface
9721           in: path
9722           description: String that identifies the interface
9723           required: true
9724           type: string
9725           example: __VLAN-INTERFACE__
9726         - name: body
9727           in: body
9728           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
9729           required: true
9730           schema:
9731             $ref: "#/definitions/relationship"
9732     delete:
9733       tags:
9734         - CloudInfrastructure
9735       summary: delete an existing relationship
9736       description: delete an existing relationship
9737       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9738       consumes:
9739         - application/json
9740         - application/xml
9741       produces:
9742         - application/json
9743         - application/xml
9744       responses:
9745         "default":
9746           description: Response codes found in [response codes](https://wiki.onap.org/).
9747       parameters:
9748         - name: hostname
9749           in: path
9750           description: Value from executing hostname on the compute node.
9751           required: true
9752           type: string
9753           example: __HOSTNAME__
9754         - name: interface-name
9755           in: path
9756           description: Name that identifies the link aggregate interface
9757           required: true
9758           type: string
9759           example: __INTERFACE-NAME__
9760         - name: interface-name
9761           in: path
9762           description: Name given to the interface
9763           required: true
9764           type: string
9765           example: __INTERFACE-NAME__
9766         - name: vlan-interface
9767           in: path
9768           description: String that identifies the interface
9769           required: true
9770           type: string
9771           example: __VLAN-INTERFACE__
9772   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9773     put:
9774       tags:
9775         - CloudInfrastructure
9776       summary: see node definition for valid relationships
9777       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9778       consumes:
9779         - application/json
9780         - application/xml
9781       produces:
9782         - application/json
9783         - application/xml
9784       responses:
9785         "default":
9786           description: Response codes found in [response codes](https://wiki.onap.org/).
9787       parameters:
9788         - name: hostname
9789           in: path
9790           description: Value from executing hostname on the compute node.
9791           required: true
9792           type: string
9793           example: __HOSTNAME__
9794         - name: interface-name
9795           in: path
9796           description: Name that identifies the link aggregate interface
9797           required: true
9798           type: string
9799           example: __INTERFACE-NAME__
9800         - name: interface-name
9801           in: path
9802           description: Name given to the interface
9803           required: true
9804           type: string
9805           example: __INTERFACE-NAME__
9806         - name: vlan-interface
9807           in: path
9808           description: String that identifies the interface
9809           required: true
9810           type: string
9811           example: __VLAN-INTERFACE__
9812         - name: l3-interface-ipv4-address
9813           in: path
9814           description: IP address
9815           required: true
9816           type: string
9817           example: __L3-INTERFACE-IPV4-ADDRESS__
9818         - name: body
9819           in: body
9820           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9821           required: true
9822           schema:
9823             $ref: "#/definitions/relationship"
9824     delete:
9825       tags:
9826         - CloudInfrastructure
9827       summary: delete an existing relationship
9828       description: delete an existing relationship
9829       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9830       consumes:
9831         - application/json
9832         - application/xml
9833       produces:
9834         - application/json
9835         - application/xml
9836       responses:
9837         "default":
9838           description: Response codes found in [response codes](https://wiki.onap.org/).
9839       parameters:
9840         - name: hostname
9841           in: path
9842           description: Value from executing hostname on the compute node.
9843           required: true
9844           type: string
9845           example: __HOSTNAME__
9846         - name: interface-name
9847           in: path
9848           description: Name that identifies the link aggregate interface
9849           required: true
9850           type: string
9851           example: __INTERFACE-NAME__
9852         - name: interface-name
9853           in: path
9854           description: Name given to the interface
9855           required: true
9856           type: string
9857           example: __INTERFACE-NAME__
9858         - name: vlan-interface
9859           in: path
9860           description: String that identifies the interface
9861           required: true
9862           type: string
9863           example: __VLAN-INTERFACE__
9864         - name: l3-interface-ipv4-address
9865           in: path
9866           description: IP address
9867           required: true
9868           type: string
9869           example: __L3-INTERFACE-IPV4-ADDRESS__
9870   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9871     get:
9872       tags:
9873         - CloudInfrastructure
9874       summary: returns l3-interface-ipv4-address-list
9875       description: returns l3-interface-ipv4-address-list
9876       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9877       produces:
9878         - application/json
9879         - application/xml
9880       responses:
9881         "200":
9882           description: successful operation
9883           schema:
9884               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9885         "default":
9886           description: Response codes found in [response codes](https://wiki.onap.org/).
9887       parameters:
9888         - name: hostname
9889           in: path
9890           description: Value from executing hostname on the compute node.
9891           required: true
9892           type: string
9893           example: __HOSTNAME__
9894         - name: interface-name
9895           in: path
9896           description: Name that identifies the link aggregate interface
9897           required: true
9898           type: string
9899           example: __INTERFACE-NAME__
9900         - name: interface-name
9901           in: path
9902           description: Name given to the interface
9903           required: true
9904           type: string
9905           example: __INTERFACE-NAME__
9906         - name: vlan-interface
9907           in: path
9908           description: String that identifies the interface
9909           required: true
9910           type: string
9911           example: __VLAN-INTERFACE__
9912         - name: l3-interface-ipv4-address
9913           in: path
9914           description: IP address
9915           required: true
9916           type: string
9917           example: __L3-INTERFACE-IPV4-ADDRESS__
9918     put:
9919       tags:
9920         - CloudInfrastructure
9921       summary: create or update an existing l3-interface-ipv4-address-list
9922       description: |
9923         Create or update an existing l3-interface-ipv4-address-list.
9924         #
9925         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9926       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9927       consumes:
9928         - application/json
9929         - application/xml
9930       produces:
9931         - application/json
9932         - application/xml
9933       responses:
9934         "default":
9935           description: Response codes found in [response codes](https://wiki.onap.org/).
9936       parameters:
9937         - name: hostname
9938           in: path
9939           description: Value from executing hostname on the compute node.
9940           required: true
9941           type: string
9942           example: __HOSTNAME__
9943         - name: interface-name
9944           in: path
9945           description: Name that identifies the link aggregate interface
9946           required: true
9947           type: string
9948           example: __INTERFACE-NAME__
9949         - name: interface-name
9950           in: path
9951           description: Name given to the interface
9952           required: true
9953           type: string
9954           example: __INTERFACE-NAME__
9955         - name: vlan-interface
9956           in: path
9957           description: String that identifies the interface
9958           required: true
9959           type: string
9960           example: __VLAN-INTERFACE__
9961         - name: l3-interface-ipv4-address
9962           in: path
9963           description: IP address
9964           required: true
9965           type: string
9966           example: __L3-INTERFACE-IPV4-ADDRESS__
9967         - name: body
9968           in: body
9969           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9970           required: true
9971           schema:
9972             $ref: "#/definitions/l3-interface-ipv4-address-list"
9973     patch:
9974       tags:
9975         - CloudInfrastructure
9976       summary: update an existing l3-interface-ipv4-address-list
9977       description: |
9978         Update an existing l3-interface-ipv4-address-list
9979         #
9980         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9981         The PUT operation will entirely replace an existing object.
9982         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9983         #
9984         Other differences between PUT and PATCH are:
9985         #
9986         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9987         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9988         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9989       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9990       consumes:
9991         - application/json
9992         - application/xml
9993       produces:
9994         - application/json
9995         - application/xml
9996       responses:
9997         "default":
9998           description: Response codes found in [response codes](https://wiki.onap.org/).
9999       parameters:
10000         - name: hostname
10001           in: path
10002           description: Value from executing hostname on the compute node.
10003           required: true
10004           type: string
10005           example: __HOSTNAME__
10006         - name: interface-name
10007           in: path
10008           description: Name that identifies the link aggregate interface
10009           required: true
10010           type: string
10011           example: __INTERFACE-NAME__
10012         - name: interface-name
10013           in: path
10014           description: Name given to the interface
10015           required: true
10016           type: string
10017           example: __INTERFACE-NAME__
10018         - name: vlan-interface
10019           in: path
10020           description: String that identifies the interface
10021           required: true
10022           type: string
10023           example: __VLAN-INTERFACE__
10024         - name: l3-interface-ipv4-address
10025           in: path
10026           description: IP address
10027           required: true
10028           type: string
10029           example: __L3-INTERFACE-IPV4-ADDRESS__
10030         - name: body
10031           in: body
10032           description: l3-interface-ipv4-address-list object that needs to be updated.
10033           required: true
10034           schema:
10035             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10036     delete:
10037       tags:
10038         - CloudInfrastructure
10039       summary: delete an existing l3-interface-ipv4-address-list
10040       description: delete an existing l3-interface-ipv4-address-list
10041       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10042       consumes:
10043         - application/json
10044         - application/xml
10045       produces:
10046         - application/json
10047         - application/xml
10048       responses:
10049         "default":
10050           description: Response codes found in [response codes](https://wiki.onap.org/).
10051       parameters:
10052         - name: hostname
10053           in: path
10054           description: Value from executing hostname on the compute node.
10055           required: true
10056           type: string
10057           example: __HOSTNAME__
10058         - name: interface-name
10059           in: path
10060           description: Name that identifies the link aggregate interface
10061           required: true
10062           type: string
10063           example: __INTERFACE-NAME__
10064         - name: interface-name
10065           in: path
10066           description: Name given to the interface
10067           required: true
10068           type: string
10069           example: __INTERFACE-NAME__
10070         - name: vlan-interface
10071           in: path
10072           description: String that identifies the interface
10073           required: true
10074           type: string
10075           example: __VLAN-INTERFACE__
10076         - name: l3-interface-ipv4-address
10077           in: path
10078           description: IP address
10079           required: true
10080           type: string
10081           example: __L3-INTERFACE-IPV4-ADDRESS__
10082         - name: resource-version
10083           in: query
10084           description: resource-version for concurrency
10085           required: true
10086           type: string
10087   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10088     put:
10089       tags:
10090         - CloudInfrastructure
10091       summary: see node definition for valid relationships
10092       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10093       consumes:
10094         - application/json
10095         - application/xml
10096       produces:
10097         - application/json
10098         - application/xml
10099       responses:
10100         "default":
10101           description: Response codes found in [response codes](https://wiki.onap.org/).
10102       parameters:
10103         - name: hostname
10104           in: path
10105           description: Value from executing hostname on the compute node.
10106           required: true
10107           type: string
10108           example: __HOSTNAME__
10109         - name: interface-name
10110           in: path
10111           description: Name that identifies the link aggregate interface
10112           required: true
10113           type: string
10114           example: __INTERFACE-NAME__
10115         - name: interface-name
10116           in: path
10117           description: Name given to the interface
10118           required: true
10119           type: string
10120           example: __INTERFACE-NAME__
10121         - name: vlan-interface
10122           in: path
10123           description: String that identifies the interface
10124           required: true
10125           type: string
10126           example: __VLAN-INTERFACE__
10127         - name: l3-interface-ipv6-address
10128           in: path
10129           description: IP address
10130           required: true
10131           type: string
10132           example: __L3-INTERFACE-IPV6-ADDRESS__
10133         - name: body
10134           in: body
10135           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10136           required: true
10137           schema:
10138             $ref: "#/definitions/relationship"
10139     delete:
10140       tags:
10141         - CloudInfrastructure
10142       summary: delete an existing relationship
10143       description: delete an existing relationship
10144       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10145       consumes:
10146         - application/json
10147         - application/xml
10148       produces:
10149         - application/json
10150         - application/xml
10151       responses:
10152         "default":
10153           description: Response codes found in [response codes](https://wiki.onap.org/).
10154       parameters:
10155         - name: hostname
10156           in: path
10157           description: Value from executing hostname on the compute node.
10158           required: true
10159           type: string
10160           example: __HOSTNAME__
10161         - name: interface-name
10162           in: path
10163           description: Name that identifies the link aggregate interface
10164           required: true
10165           type: string
10166           example: __INTERFACE-NAME__
10167         - name: interface-name
10168           in: path
10169           description: Name given to the interface
10170           required: true
10171           type: string
10172           example: __INTERFACE-NAME__
10173         - name: vlan-interface
10174           in: path
10175           description: String that identifies the interface
10176           required: true
10177           type: string
10178           example: __VLAN-INTERFACE__
10179         - name: l3-interface-ipv6-address
10180           in: path
10181           description: IP address
10182           required: true
10183           type: string
10184           example: __L3-INTERFACE-IPV6-ADDRESS__
10185   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10186     get:
10187       tags:
10188         - CloudInfrastructure
10189       summary: returns l3-interface-ipv6-address-list
10190       description: returns l3-interface-ipv6-address-list
10191       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10192       produces:
10193         - application/json
10194         - application/xml
10195       responses:
10196         "200":
10197           description: successful operation
10198           schema:
10199               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10200         "default":
10201           description: Response codes found in [response codes](https://wiki.onap.org/).
10202       parameters:
10203         - name: hostname
10204           in: path
10205           description: Value from executing hostname on the compute node.
10206           required: true
10207           type: string
10208           example: __HOSTNAME__
10209         - name: interface-name
10210           in: path
10211           description: Name that identifies the link aggregate interface
10212           required: true
10213           type: string
10214           example: __INTERFACE-NAME__
10215         - name: interface-name
10216           in: path
10217           description: Name given to the interface
10218           required: true
10219           type: string
10220           example: __INTERFACE-NAME__
10221         - name: vlan-interface
10222           in: path
10223           description: String that identifies the interface
10224           required: true
10225           type: string
10226           example: __VLAN-INTERFACE__
10227         - name: l3-interface-ipv6-address
10228           in: path
10229           description: IP address
10230           required: true
10231           type: string
10232           example: __L3-INTERFACE-IPV6-ADDRESS__
10233     put:
10234       tags:
10235         - CloudInfrastructure
10236       summary: create or update an existing l3-interface-ipv6-address-list
10237       description: |
10238         Create or update an existing l3-interface-ipv6-address-list.
10239         #
10240         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10241       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10242       consumes:
10243         - application/json
10244         - application/xml
10245       produces:
10246         - application/json
10247         - application/xml
10248       responses:
10249         "default":
10250           description: Response codes found in [response codes](https://wiki.onap.org/).
10251       parameters:
10252         - name: hostname
10253           in: path
10254           description: Value from executing hostname on the compute node.
10255           required: true
10256           type: string
10257           example: __HOSTNAME__
10258         - name: interface-name
10259           in: path
10260           description: Name that identifies the link aggregate interface
10261           required: true
10262           type: string
10263           example: __INTERFACE-NAME__
10264         - name: interface-name
10265           in: path
10266           description: Name given to the interface
10267           required: true
10268           type: string
10269           example: __INTERFACE-NAME__
10270         - name: vlan-interface
10271           in: path
10272           description: String that identifies the interface
10273           required: true
10274           type: string
10275           example: __VLAN-INTERFACE__
10276         - name: l3-interface-ipv6-address
10277           in: path
10278           description: IP address
10279           required: true
10280           type: string
10281           example: __L3-INTERFACE-IPV6-ADDRESS__
10282         - name: body
10283           in: body
10284           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10285           required: true
10286           schema:
10287             $ref: "#/definitions/l3-interface-ipv6-address-list"
10288     patch:
10289       tags:
10290         - CloudInfrastructure
10291       summary: update an existing l3-interface-ipv6-address-list
10292       description: |
10293         Update an existing l3-interface-ipv6-address-list
10294         #
10295         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10296         The PUT operation will entirely replace an existing object.
10297         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10298         #
10299         Other differences between PUT and PATCH are:
10300         #
10301         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10302         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10303         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10304       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10305       consumes:
10306         - application/json
10307         - application/xml
10308       produces:
10309         - application/json
10310         - application/xml
10311       responses:
10312         "default":
10313           description: Response codes found in [response codes](https://wiki.onap.org/).
10314       parameters:
10315         - name: hostname
10316           in: path
10317           description: Value from executing hostname on the compute node.
10318           required: true
10319           type: string
10320           example: __HOSTNAME__
10321         - name: interface-name
10322           in: path
10323           description: Name that identifies the link aggregate interface
10324           required: true
10325           type: string
10326           example: __INTERFACE-NAME__
10327         - name: interface-name
10328           in: path
10329           description: Name given to the interface
10330           required: true
10331           type: string
10332           example: __INTERFACE-NAME__
10333         - name: vlan-interface
10334           in: path
10335           description: String that identifies the interface
10336           required: true
10337           type: string
10338           example: __VLAN-INTERFACE__
10339         - name: l3-interface-ipv6-address
10340           in: path
10341           description: IP address
10342           required: true
10343           type: string
10344           example: __L3-INTERFACE-IPV6-ADDRESS__
10345         - name: body
10346           in: body
10347           description: l3-interface-ipv6-address-list object that needs to be updated.
10348           required: true
10349           schema:
10350             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10351     delete:
10352       tags:
10353         - CloudInfrastructure
10354       summary: delete an existing l3-interface-ipv6-address-list
10355       description: delete an existing l3-interface-ipv6-address-list
10356       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10357       consumes:
10358         - application/json
10359         - application/xml
10360       produces:
10361         - application/json
10362         - application/xml
10363       responses:
10364         "default":
10365           description: Response codes found in [response codes](https://wiki.onap.org/).
10366       parameters:
10367         - name: hostname
10368           in: path
10369           description: Value from executing hostname on the compute node.
10370           required: true
10371           type: string
10372           example: __HOSTNAME__
10373         - name: interface-name
10374           in: path
10375           description: Name that identifies the link aggregate interface
10376           required: true
10377           type: string
10378           example: __INTERFACE-NAME__
10379         - name: interface-name
10380           in: path
10381           description: Name given to the interface
10382           required: true
10383           type: string
10384           example: __INTERFACE-NAME__
10385         - name: vlan-interface
10386           in: path
10387           description: String that identifies the interface
10388           required: true
10389           type: string
10390           example: __VLAN-INTERFACE__
10391         - name: l3-interface-ipv6-address
10392           in: path
10393           description: IP address
10394           required: true
10395           type: string
10396           example: __L3-INTERFACE-IPV6-ADDRESS__
10397         - name: resource-version
10398           in: query
10399           description: resource-version for concurrency
10400           required: true
10401           type: string
10402   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10403     get:
10404       tags:
10405         - CloudInfrastructure
10406       summary: returns vlan
10407       description: returns vlan
10408       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10409       produces:
10410         - application/json
10411         - application/xml
10412       responses:
10413         "200":
10414           description: successful operation
10415           schema:
10416               $ref: "#/getDefinitions/vlan"
10417         "default":
10418           description: Response codes found in [response codes](https://wiki.onap.org/).
10419       parameters:
10420         - name: hostname
10421           in: path
10422           description: Value from executing hostname on the compute node.
10423           required: true
10424           type: string
10425           example: __HOSTNAME__
10426         - name: interface-name
10427           in: path
10428           description: Name that identifies the link aggregate interface
10429           required: true
10430           type: string
10431           example: __INTERFACE-NAME__
10432         - name: interface-name
10433           in: path
10434           description: Name given to the interface
10435           required: true
10436           type: string
10437           example: __INTERFACE-NAME__
10438         - name: vlan-interface
10439           in: path
10440           description: String that identifies the interface
10441           required: true
10442           type: string
10443           example: __VLAN-INTERFACE__
10444     put:
10445       tags:
10446         - CloudInfrastructure
10447       summary: create or update an existing vlan
10448       description: |
10449         Create or update an existing vlan.
10450         #
10451         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10452       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10453       consumes:
10454         - application/json
10455         - application/xml
10456       produces:
10457         - application/json
10458         - application/xml
10459       responses:
10460         "default":
10461           description: Response codes found in [response codes](https://wiki.onap.org/).
10462       parameters:
10463         - name: hostname
10464           in: path
10465           description: Value from executing hostname on the compute node.
10466           required: true
10467           type: string
10468           example: __HOSTNAME__
10469         - name: interface-name
10470           in: path
10471           description: Name that identifies the link aggregate interface
10472           required: true
10473           type: string
10474           example: __INTERFACE-NAME__
10475         - name: interface-name
10476           in: path
10477           description: Name given to the interface
10478           required: true
10479           type: string
10480           example: __INTERFACE-NAME__
10481         - name: vlan-interface
10482           in: path
10483           description: String that identifies the interface
10484           required: true
10485           type: string
10486           example: __VLAN-INTERFACE__
10487         - name: body
10488           in: body
10489           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10490           required: true
10491           schema:
10492             $ref: "#/definitions/vlan"
10493     patch:
10494       tags:
10495         - CloudInfrastructure
10496       summary: update an existing vlan
10497       description: |
10498         Update an existing vlan
10499         #
10500         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10501         The PUT operation will entirely replace an existing object.
10502         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10503         #
10504         Other differences between PUT and PATCH are:
10505         #
10506         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10507         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10508         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10509       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10510       consumes:
10511         - application/json
10512         - application/xml
10513       produces:
10514         - application/json
10515         - application/xml
10516       responses:
10517         "default":
10518           description: Response codes found in [response codes](https://wiki.onap.org/).
10519       parameters:
10520         - name: hostname
10521           in: path
10522           description: Value from executing hostname on the compute node.
10523           required: true
10524           type: string
10525           example: __HOSTNAME__
10526         - name: interface-name
10527           in: path
10528           description: Name that identifies the link aggregate interface
10529           required: true
10530           type: string
10531           example: __INTERFACE-NAME__
10532         - name: interface-name
10533           in: path
10534           description: Name given to the interface
10535           required: true
10536           type: string
10537           example: __INTERFACE-NAME__
10538         - name: vlan-interface
10539           in: path
10540           description: String that identifies the interface
10541           required: true
10542           type: string
10543           example: __VLAN-INTERFACE__
10544         - name: body
10545           in: body
10546           description: vlan object that needs to be updated.
10547           required: true
10548           schema:
10549             $ref: "#/patchDefinitions/vlan"
10550     delete:
10551       tags:
10552         - CloudInfrastructure
10553       summary: delete an existing vlan
10554       description: delete an existing vlan
10555       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10556       consumes:
10557         - application/json
10558         - application/xml
10559       produces:
10560         - application/json
10561         - application/xml
10562       responses:
10563         "default":
10564           description: Response codes found in [response codes](https://wiki.onap.org/).
10565       parameters:
10566         - name: hostname
10567           in: path
10568           description: Value from executing hostname on the compute node.
10569           required: true
10570           type: string
10571           example: __HOSTNAME__
10572         - name: interface-name
10573           in: path
10574           description: Name that identifies the link aggregate interface
10575           required: true
10576           type: string
10577           example: __INTERFACE-NAME__
10578         - name: interface-name
10579           in: path
10580           description: Name given to the interface
10581           required: true
10582           type: string
10583           example: __INTERFACE-NAME__
10584         - name: vlan-interface
10585           in: path
10586           description: String that identifies the interface
10587           required: true
10588           type: string
10589           example: __VLAN-INTERFACE__
10590         - name: resource-version
10591           in: query
10592           description: resource-version for concurrency
10593           required: true
10594           type: string
10595   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10596     get:
10597       tags:
10598         - CloudInfrastructure
10599       summary: returns vlans
10600       description: returns vlans
10601       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
10602       produces:
10603         - application/json
10604         - application/xml
10605       responses:
10606         "200":
10607           description: successful operation
10608           schema:
10609               $ref: "#/getDefinitions/vlans"
10610         "default":
10611           description: Response codes found in [response codes](https://wiki.onap.org/).
10612       parameters:
10613         - name: hostname
10614           in: path
10615           description: Value from executing hostname on the compute node.
10616           required: true
10617           type: string
10618           example: __HOSTNAME__
10619         - name: interface-name
10620           in: path
10621           description: Name that identifies the link aggregate interface
10622           required: true
10623           type: string
10624           example: __INTERFACE-NAME__
10625         - name: interface-name
10626           in: path
10627           description: Name given to the interface
10628           required: true
10629           type: string
10630           example: __INTERFACE-NAME__
10631         - name: vlan-interface
10632           in: query
10633           description:
10634           required: false
10635           type: string
10636         - name: vlan-id-inner
10637           in: query
10638           description:
10639           required: false
10640           type: integer
10641           format: int64
10642         - name: vpn-id
10643           in: query
10644           description:
10645           required: false
10646           type: string
10647   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
10648     put:
10649       tags:
10650         - CloudInfrastructure
10651       summary: see node definition for valid relationships
10652       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10653       consumes:
10654         - application/json
10655         - application/xml
10656       produces:
10657         - application/json
10658         - application/xml
10659       responses:
10660         "default":
10661           description: Response codes found in [response codes](https://wiki.onap.org/).
10662       parameters:
10663         - name: hostname
10664           in: path
10665           description: Value from executing hostname on the compute node.
10666           required: true
10667           type: string
10668           example: __HOSTNAME__
10669         - name: interface-name
10670           in: path
10671           description: Name that identifies the link aggregate interface
10672           required: true
10673           type: string
10674           example: __INTERFACE-NAME__
10675         - name: interface-name
10676           in: path
10677           description: Name given to the interface
10678           required: true
10679           type: string
10680           example: __INTERFACE-NAME__
10681         - name: pci-id
10682           in: path
10683           description: PCI ID used to identify the sriov-vf
10684           required: true
10685           type: string
10686           example: __PCI-ID__
10687         - name: body
10688           in: body
10689           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10690           required: true
10691           schema:
10692             $ref: "#/definitions/relationship"
10693     delete:
10694       tags:
10695         - CloudInfrastructure
10696       summary: delete an existing relationship
10697       description: delete an existing relationship
10698       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10699       consumes:
10700         - application/json
10701         - application/xml
10702       produces:
10703         - application/json
10704         - application/xml
10705       responses:
10706         "default":
10707           description: Response codes found in [response codes](https://wiki.onap.org/).
10708       parameters:
10709         - name: hostname
10710           in: path
10711           description: Value from executing hostname on the compute node.
10712           required: true
10713           type: string
10714           example: __HOSTNAME__
10715         - name: interface-name
10716           in: path
10717           description: Name that identifies the link aggregate interface
10718           required: true
10719           type: string
10720           example: __INTERFACE-NAME__
10721         - name: interface-name
10722           in: path
10723           description: Name given to the interface
10724           required: true
10725           type: string
10726           example: __INTERFACE-NAME__
10727         - name: pci-id
10728           in: path
10729           description: PCI ID used to identify the sriov-vf
10730           required: true
10731           type: string
10732           example: __PCI-ID__
10733   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10734     get:
10735       tags:
10736         - CloudInfrastructure
10737       summary: returns sriov-vf
10738       description: returns sriov-vf
10739       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10740       produces:
10741         - application/json
10742         - application/xml
10743       responses:
10744         "200":
10745           description: successful operation
10746           schema:
10747               $ref: "#/getDefinitions/sriov-vf"
10748         "default":
10749           description: Response codes found in [response codes](https://wiki.onap.org/).
10750       parameters:
10751         - name: hostname
10752           in: path
10753           description: Value from executing hostname on the compute node.
10754           required: true
10755           type: string
10756           example: __HOSTNAME__
10757         - name: interface-name
10758           in: path
10759           description: Name that identifies the link aggregate interface
10760           required: true
10761           type: string
10762           example: __INTERFACE-NAME__
10763         - name: interface-name
10764           in: path
10765           description: Name given to the interface
10766           required: true
10767           type: string
10768           example: __INTERFACE-NAME__
10769         - name: pci-id
10770           in: path
10771           description: PCI ID used to identify the sriov-vf
10772           required: true
10773           type: string
10774           example: __PCI-ID__
10775     put:
10776       tags:
10777         - CloudInfrastructure
10778       summary: create or update an existing sriov-vf
10779       description: |
10780         Create or update an existing sriov-vf.
10781         #
10782         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10783       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10784       consumes:
10785         - application/json
10786         - application/xml
10787       produces:
10788         - application/json
10789         - application/xml
10790       responses:
10791         "default":
10792           description: Response codes found in [response codes](https://wiki.onap.org/).
10793       parameters:
10794         - name: hostname
10795           in: path
10796           description: Value from executing hostname on the compute node.
10797           required: true
10798           type: string
10799           example: __HOSTNAME__
10800         - name: interface-name
10801           in: path
10802           description: Name that identifies the link aggregate interface
10803           required: true
10804           type: string
10805           example: __INTERFACE-NAME__
10806         - name: interface-name
10807           in: path
10808           description: Name given to the interface
10809           required: true
10810           type: string
10811           example: __INTERFACE-NAME__
10812         - name: pci-id
10813           in: path
10814           description: PCI ID used to identify the sriov-vf
10815           required: true
10816           type: string
10817           example: __PCI-ID__
10818         - name: body
10819           in: body
10820           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10821           required: true
10822           schema:
10823             $ref: "#/definitions/sriov-vf"
10824     patch:
10825       tags:
10826         - CloudInfrastructure
10827       summary: update an existing sriov-vf
10828       description: |
10829         Update an existing sriov-vf
10830         #
10831         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10832         The PUT operation will entirely replace an existing object.
10833         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10834         #
10835         Other differences between PUT and PATCH are:
10836         #
10837         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10838         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10839         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10840       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10841       consumes:
10842         - application/json
10843         - application/xml
10844       produces:
10845         - application/json
10846         - application/xml
10847       responses:
10848         "default":
10849           description: Response codes found in [response codes](https://wiki.onap.org/).
10850       parameters:
10851         - name: hostname
10852           in: path
10853           description: Value from executing hostname on the compute node.
10854           required: true
10855           type: string
10856           example: __HOSTNAME__
10857         - name: interface-name
10858           in: path
10859           description: Name that identifies the link aggregate interface
10860           required: true
10861           type: string
10862           example: __INTERFACE-NAME__
10863         - name: interface-name
10864           in: path
10865           description: Name given to the interface
10866           required: true
10867           type: string
10868           example: __INTERFACE-NAME__
10869         - name: pci-id
10870           in: path
10871           description: PCI ID used to identify the sriov-vf
10872           required: true
10873           type: string
10874           example: __PCI-ID__
10875         - name: body
10876           in: body
10877           description: sriov-vf object that needs to be updated.
10878           required: true
10879           schema:
10880             $ref: "#/patchDefinitions/sriov-vf"
10881     delete:
10882       tags:
10883         - CloudInfrastructure
10884       summary: delete an existing sriov-vf
10885       description: delete an existing sriov-vf
10886       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10887       consumes:
10888         - application/json
10889         - application/xml
10890       produces:
10891         - application/json
10892         - application/xml
10893       responses:
10894         "default":
10895           description: Response codes found in [response codes](https://wiki.onap.org/).
10896       parameters:
10897         - name: hostname
10898           in: path
10899           description: Value from executing hostname on the compute node.
10900           required: true
10901           type: string
10902           example: __HOSTNAME__
10903         - name: interface-name
10904           in: path
10905           description: Name that identifies the link aggregate interface
10906           required: true
10907           type: string
10908           example: __INTERFACE-NAME__
10909         - name: interface-name
10910           in: path
10911           description: Name given to the interface
10912           required: true
10913           type: string
10914           example: __INTERFACE-NAME__
10915         - name: pci-id
10916           in: path
10917           description: PCI ID used to identify the sriov-vf
10918           required: true
10919           type: string
10920           example: __PCI-ID__
10921         - name: resource-version
10922           in: query
10923           description: resource-version for concurrency
10924           required: true
10925           type: string
10926   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10927     get:
10928       tags:
10929         - CloudInfrastructure
10930       summary: returns sriov-vfs
10931       description: returns sriov-vfs
10932       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
10933       produces:
10934         - application/json
10935         - application/xml
10936       responses:
10937         "200":
10938           description: successful operation
10939           schema:
10940               $ref: "#/getDefinitions/sriov-vfs"
10941         "default":
10942           description: Response codes found in [response codes](https://wiki.onap.org/).
10943       parameters:
10944         - name: hostname
10945           in: path
10946           description: Value from executing hostname on the compute node.
10947           required: true
10948           type: string
10949           example: __HOSTNAME__
10950         - name: interface-name
10951           in: path
10952           description: Name that identifies the link aggregate interface
10953           required: true
10954           type: string
10955           example: __INTERFACE-NAME__
10956         - name: interface-name
10957           in: path
10958           description: Name given to the interface
10959           required: true
10960           type: string
10961           example: __INTERFACE-NAME__
10962         - name: pci-id
10963           in: query
10964           description:
10965           required: false
10966           type: string
10967         - name: vf-vlan-filter
10968           in: query
10969           description:
10970           required: false
10971           type: string
10972         - name: vf-mac-filter
10973           in: query
10974           description:
10975           required: false
10976           type: string
10977         - name: vf-vlan-strip
10978           in: query
10979           description:
10980           required: false
10981           type: boolean
10982         - name: neutron-network-id
10983           in: query
10984           description:
10985           required: false
10986           type: string
10987   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10988     put:
10989       tags:
10990         - CloudInfrastructure
10991       summary: see node definition for valid relationships
10992       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
10993       consumes:
10994         - application/json
10995         - application/xml
10996       produces:
10997         - application/json
10998         - application/xml
10999       responses:
11000         "default":
11001           description: Response codes found in [response codes](https://wiki.onap.org/).
11002       parameters:
11003         - name: hostname
11004           in: path
11005           description: Value from executing hostname on the compute node.
11006           required: true
11007           type: string
11008           example: __HOSTNAME__
11009         - name: interface-name
11010           in: path
11011           description: Name that identifies the link aggregate interface
11012           required: true
11013           type: string
11014           example: __INTERFACE-NAME__
11015         - name: interface-name
11016           in: path
11017           description: Name given to the interface
11018           required: true
11019           type: string
11020           example: __INTERFACE-NAME__
11021         - name: body
11022           in: body
11023           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11024           required: true
11025           schema:
11026             $ref: "#/definitions/relationship"
11027     delete:
11028       tags:
11029         - CloudInfrastructure
11030       summary: delete an existing relationship
11031       description: delete an existing relationship
11032       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
11033       consumes:
11034         - application/json
11035         - application/xml
11036       produces:
11037         - application/json
11038         - application/xml
11039       responses:
11040         "default":
11041           description: Response codes found in [response codes](https://wiki.onap.org/).
11042       parameters:
11043         - name: hostname
11044           in: path
11045           description: Value from executing hostname on the compute node.
11046           required: true
11047           type: string
11048           example: __HOSTNAME__
11049         - name: interface-name
11050           in: path
11051           description: Name that identifies the link aggregate interface
11052           required: true
11053           type: string
11054           example: __INTERFACE-NAME__
11055         - name: interface-name
11056           in: path
11057           description: Name given to the interface
11058           required: true
11059           type: string
11060           example: __INTERFACE-NAME__
11061   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
11062     put:
11063       tags:
11064         - CloudInfrastructure
11065       summary: see node definition for valid relationships
11066       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11067       consumes:
11068         - application/json
11069         - application/xml
11070       produces:
11071         - application/json
11072         - application/xml
11073       responses:
11074         "default":
11075           description: Response codes found in [response codes](https://wiki.onap.org/).
11076       parameters:
11077         - name: hostname
11078           in: path
11079           description: Value from executing hostname on the compute node.
11080           required: true
11081           type: string
11082           example: __HOSTNAME__
11083         - name: interface-name
11084           in: path
11085           description: Name that identifies the link aggregate interface
11086           required: true
11087           type: string
11088           example: __INTERFACE-NAME__
11089         - name: interface-name
11090           in: path
11091           description: Name given to the interface
11092           required: true
11093           type: string
11094           example: __INTERFACE-NAME__
11095         - name: l3-interface-ipv4-address
11096           in: path
11097           description: IP address
11098           required: true
11099           type: string
11100           example: __L3-INTERFACE-IPV4-ADDRESS__
11101         - name: body
11102           in: body
11103           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11104           required: true
11105           schema:
11106             $ref: "#/definitions/relationship"
11107     delete:
11108       tags:
11109         - CloudInfrastructure
11110       summary: delete an existing relationship
11111       description: delete an existing relationship
11112       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11113       consumes:
11114         - application/json
11115         - application/xml
11116       produces:
11117         - application/json
11118         - application/xml
11119       responses:
11120         "default":
11121           description: Response codes found in [response codes](https://wiki.onap.org/).
11122       parameters:
11123         - name: hostname
11124           in: path
11125           description: Value from executing hostname on the compute node.
11126           required: true
11127           type: string
11128           example: __HOSTNAME__
11129         - name: interface-name
11130           in: path
11131           description: Name that identifies the link aggregate interface
11132           required: true
11133           type: string
11134           example: __INTERFACE-NAME__
11135         - name: interface-name
11136           in: path
11137           description: Name given to the interface
11138           required: true
11139           type: string
11140           example: __INTERFACE-NAME__
11141         - name: l3-interface-ipv4-address
11142           in: path
11143           description: IP address
11144           required: true
11145           type: string
11146           example: __L3-INTERFACE-IPV4-ADDRESS__
11147   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11148     get:
11149       tags:
11150         - CloudInfrastructure
11151       summary: returns l3-interface-ipv4-address-list
11152       description: returns l3-interface-ipv4-address-list
11153       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11154       produces:
11155         - application/json
11156         - application/xml
11157       responses:
11158         "200":
11159           description: successful operation
11160           schema:
11161               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11162         "default":
11163           description: Response codes found in [response codes](https://wiki.onap.org/).
11164       parameters:
11165         - name: hostname
11166           in: path
11167           description: Value from executing hostname on the compute node.
11168           required: true
11169           type: string
11170           example: __HOSTNAME__
11171         - name: interface-name
11172           in: path
11173           description: Name that identifies the link aggregate interface
11174           required: true
11175           type: string
11176           example: __INTERFACE-NAME__
11177         - name: interface-name
11178           in: path
11179           description: Name given to the interface
11180           required: true
11181           type: string
11182           example: __INTERFACE-NAME__
11183         - name: l3-interface-ipv4-address
11184           in: path
11185           description: IP address
11186           required: true
11187           type: string
11188           example: __L3-INTERFACE-IPV4-ADDRESS__
11189     put:
11190       tags:
11191         - CloudInfrastructure
11192       summary: create or update an existing l3-interface-ipv4-address-list
11193       description: |
11194         Create or update an existing l3-interface-ipv4-address-list.
11195         #
11196         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11197       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11198       consumes:
11199         - application/json
11200         - application/xml
11201       produces:
11202         - application/json
11203         - application/xml
11204       responses:
11205         "default":
11206           description: Response codes found in [response codes](https://wiki.onap.org/).
11207       parameters:
11208         - name: hostname
11209           in: path
11210           description: Value from executing hostname on the compute node.
11211           required: true
11212           type: string
11213           example: __HOSTNAME__
11214         - name: interface-name
11215           in: path
11216           description: Name that identifies the link aggregate interface
11217           required: true
11218           type: string
11219           example: __INTERFACE-NAME__
11220         - name: interface-name
11221           in: path
11222           description: Name given to the interface
11223           required: true
11224           type: string
11225           example: __INTERFACE-NAME__
11226         - name: l3-interface-ipv4-address
11227           in: path
11228           description: IP address
11229           required: true
11230           type: string
11231           example: __L3-INTERFACE-IPV4-ADDRESS__
11232         - name: body
11233           in: body
11234           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11235           required: true
11236           schema:
11237             $ref: "#/definitions/l3-interface-ipv4-address-list"
11238     patch:
11239       tags:
11240         - CloudInfrastructure
11241       summary: update an existing l3-interface-ipv4-address-list
11242       description: |
11243         Update an existing l3-interface-ipv4-address-list
11244         #
11245         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11246         The PUT operation will entirely replace an existing object.
11247         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11248         #
11249         Other differences between PUT and PATCH are:
11250         #
11251         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11252         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11253         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11254       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11255       consumes:
11256         - application/json
11257         - application/xml
11258       produces:
11259         - application/json
11260         - application/xml
11261       responses:
11262         "default":
11263           description: Response codes found in [response codes](https://wiki.onap.org/).
11264       parameters:
11265         - name: hostname
11266           in: path
11267           description: Value from executing hostname on the compute node.
11268           required: true
11269           type: string
11270           example: __HOSTNAME__
11271         - name: interface-name
11272           in: path
11273           description: Name that identifies the link aggregate interface
11274           required: true
11275           type: string
11276           example: __INTERFACE-NAME__
11277         - name: interface-name
11278           in: path
11279           description: Name given to the interface
11280           required: true
11281           type: string
11282           example: __INTERFACE-NAME__
11283         - name: l3-interface-ipv4-address
11284           in: path
11285           description: IP address
11286           required: true
11287           type: string
11288           example: __L3-INTERFACE-IPV4-ADDRESS__
11289         - name: body
11290           in: body
11291           description: l3-interface-ipv4-address-list object that needs to be updated.
11292           required: true
11293           schema:
11294             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11295     delete:
11296       tags:
11297         - CloudInfrastructure
11298       summary: delete an existing l3-interface-ipv4-address-list
11299       description: delete an existing l3-interface-ipv4-address-list
11300       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11301       consumes:
11302         - application/json
11303         - application/xml
11304       produces:
11305         - application/json
11306         - application/xml
11307       responses:
11308         "default":
11309           description: Response codes found in [response codes](https://wiki.onap.org/).
11310       parameters:
11311         - name: hostname
11312           in: path
11313           description: Value from executing hostname on the compute node.
11314           required: true
11315           type: string
11316           example: __HOSTNAME__
11317         - name: interface-name
11318           in: path
11319           description: Name that identifies the link aggregate interface
11320           required: true
11321           type: string
11322           example: __INTERFACE-NAME__
11323         - name: interface-name
11324           in: path
11325           description: Name given to the interface
11326           required: true
11327           type: string
11328           example: __INTERFACE-NAME__
11329         - name: l3-interface-ipv4-address
11330           in: path
11331           description: IP address
11332           required: true
11333           type: string
11334           example: __L3-INTERFACE-IPV4-ADDRESS__
11335         - name: resource-version
11336           in: query
11337           description: resource-version for concurrency
11338           required: true
11339           type: string
11340   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11341     put:
11342       tags:
11343         - CloudInfrastructure
11344       summary: see node definition for valid relationships
11345       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11346       consumes:
11347         - application/json
11348         - application/xml
11349       produces:
11350         - application/json
11351         - application/xml
11352       responses:
11353         "default":
11354           description: Response codes found in [response codes](https://wiki.onap.org/).
11355       parameters:
11356         - name: hostname
11357           in: path
11358           description: Value from executing hostname on the compute node.
11359           required: true
11360           type: string
11361           example: __HOSTNAME__
11362         - name: interface-name
11363           in: path
11364           description: Name that identifies the link aggregate interface
11365           required: true
11366           type: string
11367           example: __INTERFACE-NAME__
11368         - name: interface-name
11369           in: path
11370           description: Name given to the interface
11371           required: true
11372           type: string
11373           example: __INTERFACE-NAME__
11374         - name: l3-interface-ipv6-address
11375           in: path
11376           description: IP address
11377           required: true
11378           type: string
11379           example: __L3-INTERFACE-IPV6-ADDRESS__
11380         - name: body
11381           in: body
11382           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11383           required: true
11384           schema:
11385             $ref: "#/definitions/relationship"
11386     delete:
11387       tags:
11388         - CloudInfrastructure
11389       summary: delete an existing relationship
11390       description: delete an existing relationship
11391       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11392       consumes:
11393         - application/json
11394         - application/xml
11395       produces:
11396         - application/json
11397         - application/xml
11398       responses:
11399         "default":
11400           description: Response codes found in [response codes](https://wiki.onap.org/).
11401       parameters:
11402         - name: hostname
11403           in: path
11404           description: Value from executing hostname on the compute node.
11405           required: true
11406           type: string
11407           example: __HOSTNAME__
11408         - name: interface-name
11409           in: path
11410           description: Name that identifies the link aggregate interface
11411           required: true
11412           type: string
11413           example: __INTERFACE-NAME__
11414         - name: interface-name
11415           in: path
11416           description: Name given to the interface
11417           required: true
11418           type: string
11419           example: __INTERFACE-NAME__
11420         - name: l3-interface-ipv6-address
11421           in: path
11422           description: IP address
11423           required: true
11424           type: string
11425           example: __L3-INTERFACE-IPV6-ADDRESS__
11426   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11427     get:
11428       tags:
11429         - CloudInfrastructure
11430       summary: returns l3-interface-ipv6-address-list
11431       description: returns l3-interface-ipv6-address-list
11432       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11433       produces:
11434         - application/json
11435         - application/xml
11436       responses:
11437         "200":
11438           description: successful operation
11439           schema:
11440               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11441         "default":
11442           description: Response codes found in [response codes](https://wiki.onap.org/).
11443       parameters:
11444         - name: hostname
11445           in: path
11446           description: Value from executing hostname on the compute node.
11447           required: true
11448           type: string
11449           example: __HOSTNAME__
11450         - name: interface-name
11451           in: path
11452           description: Name that identifies the link aggregate interface
11453           required: true
11454           type: string
11455           example: __INTERFACE-NAME__
11456         - name: interface-name
11457           in: path
11458           description: Name given to the interface
11459           required: true
11460           type: string
11461           example: __INTERFACE-NAME__
11462         - name: l3-interface-ipv6-address
11463           in: path
11464           description: IP address
11465           required: true
11466           type: string
11467           example: __L3-INTERFACE-IPV6-ADDRESS__
11468     put:
11469       tags:
11470         - CloudInfrastructure
11471       summary: create or update an existing l3-interface-ipv6-address-list
11472       description: |
11473         Create or update an existing l3-interface-ipv6-address-list.
11474         #
11475         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11476       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11477       consumes:
11478         - application/json
11479         - application/xml
11480       produces:
11481         - application/json
11482         - application/xml
11483       responses:
11484         "default":
11485           description: Response codes found in [response codes](https://wiki.onap.org/).
11486       parameters:
11487         - name: hostname
11488           in: path
11489           description: Value from executing hostname on the compute node.
11490           required: true
11491           type: string
11492           example: __HOSTNAME__
11493         - name: interface-name
11494           in: path
11495           description: Name that identifies the link aggregate interface
11496           required: true
11497           type: string
11498           example: __INTERFACE-NAME__
11499         - name: interface-name
11500           in: path
11501           description: Name given to the interface
11502           required: true
11503           type: string
11504           example: __INTERFACE-NAME__
11505         - name: l3-interface-ipv6-address
11506           in: path
11507           description: IP address
11508           required: true
11509           type: string
11510           example: __L3-INTERFACE-IPV6-ADDRESS__
11511         - name: body
11512           in: body
11513           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11514           required: true
11515           schema:
11516             $ref: "#/definitions/l3-interface-ipv6-address-list"
11517     patch:
11518       tags:
11519         - CloudInfrastructure
11520       summary: update an existing l3-interface-ipv6-address-list
11521       description: |
11522         Update an existing l3-interface-ipv6-address-list
11523         #
11524         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11525         The PUT operation will entirely replace an existing object.
11526         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11527         #
11528         Other differences between PUT and PATCH are:
11529         #
11530         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11531         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11532         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11533       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11534       consumes:
11535         - application/json
11536         - application/xml
11537       produces:
11538         - application/json
11539         - application/xml
11540       responses:
11541         "default":
11542           description: Response codes found in [response codes](https://wiki.onap.org/).
11543       parameters:
11544         - name: hostname
11545           in: path
11546           description: Value from executing hostname on the compute node.
11547           required: true
11548           type: string
11549           example: __HOSTNAME__
11550         - name: interface-name
11551           in: path
11552           description: Name that identifies the link aggregate interface
11553           required: true
11554           type: string
11555           example: __INTERFACE-NAME__
11556         - name: interface-name
11557           in: path
11558           description: Name given to the interface
11559           required: true
11560           type: string
11561           example: __INTERFACE-NAME__
11562         - name: l3-interface-ipv6-address
11563           in: path
11564           description: IP address
11565           required: true
11566           type: string
11567           example: __L3-INTERFACE-IPV6-ADDRESS__
11568         - name: body
11569           in: body
11570           description: l3-interface-ipv6-address-list object that needs to be updated.
11571           required: true
11572           schema:
11573             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11574     delete:
11575       tags:
11576         - CloudInfrastructure
11577       summary: delete an existing l3-interface-ipv6-address-list
11578       description: delete an existing l3-interface-ipv6-address-list
11579       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11580       consumes:
11581         - application/json
11582         - application/xml
11583       produces:
11584         - application/json
11585         - application/xml
11586       responses:
11587         "default":
11588           description: Response codes found in [response codes](https://wiki.onap.org/).
11589       parameters:
11590         - name: hostname
11591           in: path
11592           description: Value from executing hostname on the compute node.
11593           required: true
11594           type: string
11595           example: __HOSTNAME__
11596         - name: interface-name
11597           in: path
11598           description: Name that identifies the link aggregate interface
11599           required: true
11600           type: string
11601           example: __INTERFACE-NAME__
11602         - name: interface-name
11603           in: path
11604           description: Name given to the interface
11605           required: true
11606           type: string
11607           example: __INTERFACE-NAME__
11608         - name: l3-interface-ipv6-address
11609           in: path
11610           description: IP address
11611           required: true
11612           type: string
11613           example: __L3-INTERFACE-IPV6-ADDRESS__
11614         - name: resource-version
11615           in: query
11616           description: resource-version for concurrency
11617           required: true
11618           type: string
11619   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11620     get:
11621       tags:
11622         - CloudInfrastructure
11623       summary: returns l-interface
11624       description: returns l-interface
11625       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11626       produces:
11627         - application/json
11628         - application/xml
11629       responses:
11630         "200":
11631           description: successful operation
11632           schema:
11633               $ref: "#/getDefinitions/l-interface"
11634         "default":
11635           description: Response codes found in [response codes](https://wiki.onap.org/).
11636       parameters:
11637         - name: hostname
11638           in: path
11639           description: Value from executing hostname on the compute node.
11640           required: true
11641           type: string
11642           example: __HOSTNAME__
11643         - name: interface-name
11644           in: path
11645           description: Name that identifies the link aggregate interface
11646           required: true
11647           type: string
11648           example: __INTERFACE-NAME__
11649         - name: interface-name
11650           in: path
11651           description: Name given to the interface
11652           required: true
11653           type: string
11654           example: __INTERFACE-NAME__
11655     put:
11656       tags:
11657         - CloudInfrastructure
11658       summary: create or update an existing l-interface
11659       description: |
11660         Create or update an existing l-interface.
11661         #
11662         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11663       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11664       consumes:
11665         - application/json
11666         - application/xml
11667       produces:
11668         - application/json
11669         - application/xml
11670       responses:
11671         "default":
11672           description: Response codes found in [response codes](https://wiki.onap.org/).
11673       parameters:
11674         - name: hostname
11675           in: path
11676           description: Value from executing hostname on the compute node.
11677           required: true
11678           type: string
11679           example: __HOSTNAME__
11680         - name: interface-name
11681           in: path
11682           description: Name that identifies the link aggregate interface
11683           required: true
11684           type: string
11685           example: __INTERFACE-NAME__
11686         - name: interface-name
11687           in: path
11688           description: Name given to the interface
11689           required: true
11690           type: string
11691           example: __INTERFACE-NAME__
11692         - name: body
11693           in: body
11694           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11695           required: true
11696           schema:
11697             $ref: "#/definitions/l-interface"
11698     patch:
11699       tags:
11700         - CloudInfrastructure
11701       summary: update an existing l-interface
11702       description: |
11703         Update an existing l-interface
11704         #
11705         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11706         The PUT operation will entirely replace an existing object.
11707         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11708         #
11709         Other differences between PUT and PATCH are:
11710         #
11711         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11712         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11713         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11714       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11715       consumes:
11716         - application/json
11717         - application/xml
11718       produces:
11719         - application/json
11720         - application/xml
11721       responses:
11722         "default":
11723           description: Response codes found in [response codes](https://wiki.onap.org/).
11724       parameters:
11725         - name: hostname
11726           in: path
11727           description: Value from executing hostname on the compute node.
11728           required: true
11729           type: string
11730           example: __HOSTNAME__
11731         - name: interface-name
11732           in: path
11733           description: Name that identifies the link aggregate interface
11734           required: true
11735           type: string
11736           example: __INTERFACE-NAME__
11737         - name: interface-name
11738           in: path
11739           description: Name given to the interface
11740           required: true
11741           type: string
11742           example: __INTERFACE-NAME__
11743         - name: body
11744           in: body
11745           description: l-interface object that needs to be updated.
11746           required: true
11747           schema:
11748             $ref: "#/patchDefinitions/l-interface"
11749     delete:
11750       tags:
11751         - CloudInfrastructure
11752       summary: delete an existing l-interface
11753       description: delete an existing l-interface
11754       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11755       consumes:
11756         - application/json
11757         - application/xml
11758       produces:
11759         - application/json
11760         - application/xml
11761       responses:
11762         "default":
11763           description: Response codes found in [response codes](https://wiki.onap.org/).
11764       parameters:
11765         - name: hostname
11766           in: path
11767           description: Value from executing hostname on the compute node.
11768           required: true
11769           type: string
11770           example: __HOSTNAME__
11771         - name: interface-name
11772           in: path
11773           description: Name that identifies the link aggregate interface
11774           required: true
11775           type: string
11776           example: __INTERFACE-NAME__
11777         - name: interface-name
11778           in: path
11779           description: Name given to the interface
11780           required: true
11781           type: string
11782           example: __INTERFACE-NAME__
11783         - name: resource-version
11784           in: query
11785           description: resource-version for concurrency
11786           required: true
11787           type: string
11788   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
11789     get:
11790       tags:
11791         - CloudInfrastructure
11792       summary: returns l-interfaces
11793       description: returns l-interfaces
11794       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
11795       produces:
11796         - application/json
11797         - application/xml
11798       responses:
11799         "200":
11800           description: successful operation
11801           schema:
11802               $ref: "#/getDefinitions/l-interfaces"
11803         "default":
11804           description: Response codes found in [response codes](https://wiki.onap.org/).
11805       parameters:
11806         - name: hostname
11807           in: path
11808           description: Value from executing hostname on the compute node.
11809           required: true
11810           type: string
11811           example: __HOSTNAME__
11812         - name: interface-name
11813           in: path
11814           description: Name that identifies the link aggregate interface
11815           required: true
11816           type: string
11817           example: __INTERFACE-NAME__
11818         - name: interface-name
11819           in: query
11820           description:
11821           required: false
11822           type: string
11823         - name: interface-id
11824           in: query
11825           description:
11826           required: false
11827           type: string
11828         - name: macaddr
11829           in: query
11830           description:
11831           required: false
11832           type: string
11833         - name: network-name
11834           in: query
11835           description:
11836           required: false
11837           type: string
11838   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
11839     get:
11840       tags:
11841         - CloudInfrastructure
11842       summary: returns lag-interface
11843       description: returns lag-interface
11844       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
11845       produces:
11846         - application/json
11847         - application/xml
11848       responses:
11849         "200":
11850           description: successful operation
11851           schema:
11852               $ref: "#/getDefinitions/lag-interface"
11853         "default":
11854           description: Response codes found in [response codes](https://wiki.onap.org/).
11855       parameters:
11856         - name: hostname
11857           in: path
11858           description: Value from executing hostname on the compute node.
11859           required: true
11860           type: string
11861           example: __HOSTNAME__
11862         - name: interface-name
11863           in: path
11864           description: Name that identifies the link aggregate interface
11865           required: true
11866           type: string
11867           example: __INTERFACE-NAME__
11868     put:
11869       tags:
11870         - CloudInfrastructure
11871       summary: create or update an existing lag-interface
11872       description: |
11873         Create or update an existing lag-interface.
11874         #
11875         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11876       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11877       consumes:
11878         - application/json
11879         - application/xml
11880       produces:
11881         - application/json
11882         - application/xml
11883       responses:
11884         "default":
11885           description: Response codes found in [response codes](https://wiki.onap.org/).
11886       parameters:
11887         - name: hostname
11888           in: path
11889           description: Value from executing hostname on the compute node.
11890           required: true
11891           type: string
11892           example: __HOSTNAME__
11893         - name: interface-name
11894           in: path
11895           description: Name that identifies the link aggregate interface
11896           required: true
11897           type: string
11898           example: __INTERFACE-NAME__
11899         - name: body
11900           in: body
11901           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11902           required: true
11903           schema:
11904             $ref: "#/definitions/lag-interface"
11905     patch:
11906       tags:
11907         - CloudInfrastructure
11908       summary: update an existing lag-interface
11909       description: |
11910         Update an existing lag-interface
11911         #
11912         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11913         The PUT operation will entirely replace an existing object.
11914         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11915         #
11916         Other differences between PUT and PATCH are:
11917         #
11918         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11919         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11920         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11921       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11922       consumes:
11923         - application/json
11924         - application/xml
11925       produces:
11926         - application/json
11927         - application/xml
11928       responses:
11929         "default":
11930           description: Response codes found in [response codes](https://wiki.onap.org/).
11931       parameters:
11932         - name: hostname
11933           in: path
11934           description: Value from executing hostname on the compute node.
11935           required: true
11936           type: string
11937           example: __HOSTNAME__
11938         - name: interface-name
11939           in: path
11940           description: Name that identifies the link aggregate interface
11941           required: true
11942           type: string
11943           example: __INTERFACE-NAME__
11944         - name: body
11945           in: body
11946           description: lag-interface object that needs to be updated.
11947           required: true
11948           schema:
11949             $ref: "#/patchDefinitions/lag-interface"
11950     delete:
11951       tags:
11952         - CloudInfrastructure
11953       summary: delete an existing lag-interface
11954       description: delete an existing lag-interface
11955       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
11956       consumes:
11957         - application/json
11958         - application/xml
11959       produces:
11960         - application/json
11961         - application/xml
11962       responses:
11963         "default":
11964           description: Response codes found in [response codes](https://wiki.onap.org/).
11965       parameters:
11966         - name: hostname
11967           in: path
11968           description: Value from executing hostname on the compute node.
11969           required: true
11970           type: string
11971           example: __HOSTNAME__
11972         - name: interface-name
11973           in: path
11974           description: Name that identifies the link aggregate interface
11975           required: true
11976           type: string
11977           example: __INTERFACE-NAME__
11978         - name: resource-version
11979           in: query
11980           description: resource-version for concurrency
11981           required: true
11982           type: string
11983   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
11984     get:
11985       tags:
11986         - CloudInfrastructure
11987       summary: returns lag-interfaces
11988       description: returns lag-interfaces
11989       operationId: getCloudInfrastructurePserversPserverLagInterfaces
11990       produces:
11991         - application/json
11992         - application/xml
11993       responses:
11994         "200":
11995           description: successful operation
11996           schema:
11997               $ref: "#/getDefinitions/lag-interfaces"
11998         "default":
11999           description: Response codes found in [response codes](https://wiki.onap.org/).
12000       parameters:
12001         - name: hostname
12002           in: path
12003           description: Value from executing hostname on the compute node.
12004           required: true
12005           type: string
12006           example: __HOSTNAME__
12007         - name: interface-name
12008           in: query
12009           description:
12010           required: false
12011           type: string
12012         - name: interface-id
12013           in: query
12014           description:
12015           required: false
12016           type: string
12017         - name: interface-role
12018           in: query
12019           description:
12020           required: false
12021           type: string
12022   /cloud-infrastructure/pservers/pserver/{hostname}:
12023     get:
12024       tags:
12025         - CloudInfrastructure
12026       summary: returns pserver
12027       description: returns pserver
12028       operationId: getCloudInfrastructurePserversPserver
12029       produces:
12030         - application/json
12031         - application/xml
12032       responses:
12033         "200":
12034           description: successful operation
12035           schema:
12036               $ref: "#/getDefinitions/pserver"
12037         "default":
12038           description: Response codes found in [response codes](https://wiki.onap.org/).
12039       parameters:
12040         - name: hostname
12041           in: path
12042           description: Value from executing hostname on the compute node.
12043           required: true
12044           type: string
12045           example: __HOSTNAME__
12046     put:
12047       tags:
12048         - CloudInfrastructure
12049       summary: create or update an existing pserver
12050       description: |
12051         Create or update an existing pserver.
12052         #
12053         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12054       operationId: createOrUpdateCloudInfrastructurePserversPserver
12055       consumes:
12056         - application/json
12057         - application/xml
12058       produces:
12059         - application/json
12060         - application/xml
12061       responses:
12062         "default":
12063           description: Response codes found in [response codes](https://wiki.onap.org/).
12064       parameters:
12065         - name: hostname
12066           in: path
12067           description: Value from executing hostname on the compute node.
12068           required: true
12069           type: string
12070           example: __HOSTNAME__
12071         - name: body
12072           in: body
12073           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)
12074           required: true
12075           schema:
12076             $ref: "#/definitions/pserver"
12077     patch:
12078       tags:
12079         - CloudInfrastructure
12080       summary: update an existing pserver
12081       description: |
12082         Update an existing pserver
12083         #
12084         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12085         The PUT operation will entirely replace an existing object.
12086         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12087         #
12088         Other differences between PUT and PATCH are:
12089         #
12090         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12091         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12092         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12093       operationId: UpdateCloudInfrastructurePserversPserver
12094       consumes:
12095         - application/json
12096         - application/xml
12097       produces:
12098         - application/json
12099         - application/xml
12100       responses:
12101         "default":
12102           description: Response codes found in [response codes](https://wiki.onap.org/).
12103       parameters:
12104         - name: hostname
12105           in: path
12106           description: Value from executing hostname on the compute node.
12107           required: true
12108           type: string
12109           example: __HOSTNAME__
12110         - name: body
12111           in: body
12112           description: pserver object that needs to be updated.
12113           required: true
12114           schema:
12115             $ref: "#/patchDefinitions/pserver"
12116     delete:
12117       tags:
12118         - CloudInfrastructure
12119       summary: delete an existing pserver
12120       description: delete an existing pserver
12121       operationId: deleteCloudInfrastructurePserversPserver
12122       consumes:
12123         - application/json
12124         - application/xml
12125       produces:
12126         - application/json
12127         - application/xml
12128       responses:
12129         "default":
12130           description: Response codes found in [response codes](https://wiki.onap.org/).
12131       parameters:
12132         - name: hostname
12133           in: path
12134           description: Value from executing hostname on the compute node.
12135           required: true
12136           type: string
12137           example: __HOSTNAME__
12138         - name: resource-version
12139           in: query
12140           description: resource-version for concurrency
12141           required: true
12142           type: string
12143   /cloud-infrastructure/pservers:
12144     get:
12145       tags:
12146         - CloudInfrastructure
12147       summary: returns pservers
12148       description: returns pservers
12149       operationId: getCloudInfrastructurePservers
12150       produces:
12151         - application/json
12152         - application/xml
12153       responses:
12154         "200":
12155           description: successful operation
12156           schema:
12157               $ref: "#/getDefinitions/pservers"
12158         "default":
12159           description: Response codes found in [response codes](https://wiki.onap.org/).
12160       parameters:
12161         - name: hostname
12162           in: query
12163           description:
12164           required: false
12165           type: string
12166         - name: inv-status
12167           in: query
12168           description:
12169           required: false
12170           type: string
12171         - name: pserver-id
12172           in: query
12173           description:
12174           required: false
12175           type: string
12176         - name: in-maint
12177           in: query
12178           description:
12179           required: false
12180           type: boolean
12181         - name: pserver-name2
12182           in: query
12183           description:
12184           required: false
12185           type: string
12186   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
12187     put:
12188       tags:
12189         - CloudInfrastructure
12190       summary: see node definition for valid relationships
12191       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12192       consumes:
12193         - application/json
12194         - application/xml
12195       produces:
12196         - application/json
12197         - application/xml
12198       responses:
12199         "default":
12200           description: Response codes found in [response codes](https://wiki.onap.org/).
12201       parameters:
12202         - name: vdc-id
12203           in: path
12204           description: Unique ID of the vdc
12205           required: true
12206           type: string
12207           example: __VDC-ID__
12208         - name: body
12209           in: body
12210           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12211           required: true
12212           schema:
12213             $ref: "#/definitions/relationship"
12214     delete:
12215       tags:
12216         - CloudInfrastructure
12217       summary: delete an existing relationship
12218       description: delete an existing relationship
12219       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12220       consumes:
12221         - application/json
12222         - application/xml
12223       produces:
12224         - application/json
12225         - application/xml
12226       responses:
12227         "default":
12228           description: Response codes found in [response codes](https://wiki.onap.org/).
12229       parameters:
12230         - name: vdc-id
12231           in: path
12232           description: Unique ID of the vdc
12233           required: true
12234           type: string
12235           example: __VDC-ID__
12236   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
12237     get:
12238       tags:
12239         - CloudInfrastructure
12240       summary: returns virtual-data-center
12241       description: returns virtual-data-center
12242       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
12243       produces:
12244         - application/json
12245         - application/xml
12246       responses:
12247         "200":
12248           description: successful operation
12249           schema:
12250               $ref: "#/getDefinitions/virtual-data-center"
12251         "default":
12252           description: Response codes found in [response codes](https://wiki.onap.org/).
12253       parameters:
12254         - name: vdc-id
12255           in: path
12256           description: Unique ID of the vdc
12257           required: true
12258           type: string
12259           example: __VDC-ID__
12260     put:
12261       tags:
12262         - CloudInfrastructure
12263       summary: create or update an existing virtual-data-center
12264       description: |
12265         Create or update an existing virtual-data-center.
12266         #
12267         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12268       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12269       consumes:
12270         - application/json
12271         - application/xml
12272       produces:
12273         - application/json
12274         - application/xml
12275       responses:
12276         "default":
12277           description: Response codes found in [response codes](https://wiki.onap.org/).
12278       parameters:
12279         - name: vdc-id
12280           in: path
12281           description: Unique ID of the vdc
12282           required: true
12283           type: string
12284           example: __VDC-ID__
12285         - name: body
12286           in: body
12287           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12288           required: true
12289           schema:
12290             $ref: "#/definitions/virtual-data-center"
12291     patch:
12292       tags:
12293         - CloudInfrastructure
12294       summary: update an existing virtual-data-center
12295       description: |
12296         Update an existing virtual-data-center
12297         #
12298         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12299         The PUT operation will entirely replace an existing object.
12300         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12301         #
12302         Other differences between PUT and PATCH are:
12303         #
12304         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12305         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12306         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12307       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12308       consumes:
12309         - application/json
12310         - application/xml
12311       produces:
12312         - application/json
12313         - application/xml
12314       responses:
12315         "default":
12316           description: Response codes found in [response codes](https://wiki.onap.org/).
12317       parameters:
12318         - name: vdc-id
12319           in: path
12320           description: Unique ID of the vdc
12321           required: true
12322           type: string
12323           example: __VDC-ID__
12324         - name: body
12325           in: body
12326           description: virtual-data-center object that needs to be updated.
12327           required: true
12328           schema:
12329             $ref: "#/patchDefinitions/virtual-data-center"
12330     delete:
12331       tags:
12332         - CloudInfrastructure
12333       summary: delete an existing virtual-data-center
12334       description: delete an existing virtual-data-center
12335       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
12336       consumes:
12337         - application/json
12338         - application/xml
12339       produces:
12340         - application/json
12341         - application/xml
12342       responses:
12343         "default":
12344           description: Response codes found in [response codes](https://wiki.onap.org/).
12345       parameters:
12346         - name: vdc-id
12347           in: path
12348           description: Unique ID of the vdc
12349           required: true
12350           type: string
12351           example: __VDC-ID__
12352         - name: resource-version
12353           in: query
12354           description: resource-version for concurrency
12355           required: true
12356           type: string
12357   /cloud-infrastructure/virtual-data-centers:
12358     get:
12359       tags:
12360         - CloudInfrastructure
12361       summary: returns virtual-data-centers
12362       description: returns virtual-data-centers
12363       operationId: getCloudInfrastructureVirtualDataCenters
12364       produces:
12365         - application/json
12366         - application/xml
12367       responses:
12368         "200":
12369           description: successful operation
12370           schema:
12371               $ref: "#/getDefinitions/virtual-data-centers"
12372         "default":
12373           description: Response codes found in [response codes](https://wiki.onap.org/).
12374       parameters:
12375         - name: vdc-id
12376           in: query
12377           description:
12378           required: false
12379           type: string
12380         - name: vdc-name
12381           in: query
12382           description:
12383           required: false
12384           type: string
12385   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
12386     put:
12387       tags:
12388         - Business
12389       summary: see node definition for valid relationships
12390       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
12391       consumes:
12392         - application/json
12393         - application/xml
12394       produces:
12395         - application/json
12396         - application/xml
12397       responses:
12398         "default":
12399           description: Response codes found in [response codes](https://wiki.onap.org/).
12400       parameters:
12401         - name: resource-instance-id
12402           in: path
12403           description: Unique id of resource instance.
12404           required: true
12405           type: string
12406           example: __RESOURCE-INSTANCE-ID__
12407         - name: body
12408           in: body
12409           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)
12410           required: true
12411           schema:
12412             $ref: "#/definitions/relationship"
12413     delete:
12414       tags:
12415         - Business
12416       summary: delete an existing relationship
12417       description: delete an existing relationship
12418       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
12419       consumes:
12420         - application/json
12421         - application/xml
12422       produces:
12423         - application/json
12424         - application/xml
12425       responses:
12426         "default":
12427           description: Response codes found in [response codes](https://wiki.onap.org/).
12428       parameters:
12429         - name: resource-instance-id
12430           in: path
12431           description: Unique id of resource instance.
12432           required: true
12433           type: string
12434           example: __RESOURCE-INSTANCE-ID__
12435   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
12436     get:
12437       tags:
12438         - Business
12439       summary: returns metadatum
12440       description: returns metadatum
12441       operationId: getBusinessConnectorsConnectorMetadataMetadatum
12442       produces:
12443         - application/json
12444         - application/xml
12445       responses:
12446         "200":
12447           description: successful operation
12448           schema:
12449               $ref: "#/getDefinitions/metadatum"
12450         "default":
12451           description: Response codes found in [response codes](https://wiki.onap.org/).
12452       parameters:
12453         - name: resource-instance-id
12454           in: path
12455           description: Unique id of resource instance.
12456           required: true
12457           type: string
12458           example: __RESOURCE-INSTANCE-ID__
12459         - name: metaname
12460           in: path
12461           required: true
12462           type: string
12463           example: __METANAME__
12464     put:
12465       tags:
12466         - Business
12467       summary: create or update an existing metadatum
12468       description: |
12469         Create or update an existing metadatum.
12470         #
12471         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12472       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
12473       consumes:
12474         - application/json
12475         - application/xml
12476       produces:
12477         - application/json
12478         - application/xml
12479       responses:
12480         "default":
12481           description: Response codes found in [response codes](https://wiki.onap.org/).
12482       parameters:
12483         - name: resource-instance-id
12484           in: path
12485           description: Unique id of resource instance.
12486           required: true
12487           type: string
12488           example: __RESOURCE-INSTANCE-ID__
12489         - name: metaname
12490           in: path
12491           required: true
12492           type: string
12493           example: __METANAME__
12494         - name: body
12495           in: body
12496           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnectorMetadataMetadatum.json)
12497           required: true
12498           schema:
12499             $ref: "#/definitions/metadatum"
12500     patch:
12501       tags:
12502         - Business
12503       summary: update an existing metadatum
12504       description: |
12505         Update an existing metadatum
12506         #
12507         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12508         The PUT operation will entirely replace an existing object.
12509         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12510         #
12511         Other differences between PUT and PATCH are:
12512         #
12513         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12514         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12515         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12516       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
12517       consumes:
12518         - application/json
12519         - application/xml
12520       produces:
12521         - application/json
12522         - application/xml
12523       responses:
12524         "default":
12525           description: Response codes found in [response codes](https://wiki.onap.org/).
12526       parameters:
12527         - name: resource-instance-id
12528           in: path
12529           description: Unique id of resource instance.
12530           required: true
12531           type: string
12532           example: __RESOURCE-INSTANCE-ID__
12533         - name: metaname
12534           in: path
12535           required: true
12536           type: string
12537           example: __METANAME__
12538         - name: body
12539           in: body
12540           description: metadatum object that needs to be updated.
12541           required: true
12542           schema:
12543             $ref: "#/patchDefinitions/metadatum"
12544     delete:
12545       tags:
12546         - Business
12547       summary: delete an existing metadatum
12548       description: delete an existing metadatum
12549       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
12550       consumes:
12551         - application/json
12552         - application/xml
12553       produces:
12554         - application/json
12555         - application/xml
12556       responses:
12557         "default":
12558           description: Response codes found in [response codes](https://wiki.onap.org/).
12559       parameters:
12560         - name: resource-instance-id
12561           in: path
12562           description: Unique id of resource instance.
12563           required: true
12564           type: string
12565           example: __RESOURCE-INSTANCE-ID__
12566         - name: metaname
12567           in: path
12568           required: true
12569           type: string
12570           example: __METANAME__
12571         - name: resource-version
12572           in: query
12573           description: resource-version for concurrency
12574           required: true
12575           type: string
12576   /business/connectors/connector/{resource-instance-id}/metadata:
12577     get:
12578       tags:
12579         - Business
12580       summary: returns metadata
12581       description: returns metadata
12582       operationId: getBusinessConnectorsConnectorMetadata
12583       produces:
12584         - application/json
12585         - application/xml
12586       responses:
12587         "200":
12588           description: successful operation
12589           schema:
12590               $ref: "#/getDefinitions/metadata"
12591         "default":
12592           description: Response codes found in [response codes](https://wiki.onap.org/).
12593       parameters:
12594         - name: resource-instance-id
12595           in: path
12596           description: Unique id of resource instance.
12597           required: true
12598           type: string
12599           example: __RESOURCE-INSTANCE-ID__
12600         - name: metaname
12601           in: query
12602           description:
12603           required: false
12604           type: string
12605   /business/connectors/connector/{resource-instance-id}:
12606     get:
12607       tags:
12608         - Business
12609       summary: returns connector
12610       description: returns connector
12611       operationId: getBusinessConnectorsConnector
12612       produces:
12613         - application/json
12614         - application/xml
12615       responses:
12616         "200":
12617           description: successful operation
12618           schema:
12619               $ref: "#/getDefinitions/connector"
12620         "default":
12621           description: Response codes found in [response codes](https://wiki.onap.org/).
12622       parameters:
12623         - name: resource-instance-id
12624           in: path
12625           description: Unique id of resource instance.
12626           required: true
12627           type: string
12628           example: __RESOURCE-INSTANCE-ID__
12629     put:
12630       tags:
12631         - Business
12632       summary: create or update an existing connector
12633       description: |
12634         Create or update an existing connector.
12635         #
12636         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12637       operationId: createOrUpdateBusinessConnectorsConnector
12638       consumes:
12639         - application/json
12640         - application/xml
12641       produces:
12642         - application/json
12643         - application/xml
12644       responses:
12645         "default":
12646           description: Response codes found in [response codes](https://wiki.onap.org/).
12647       parameters:
12648         - name: resource-instance-id
12649           in: path
12650           description: Unique id of resource instance.
12651           required: true
12652           type: string
12653           example: __RESOURCE-INSTANCE-ID__
12654         - name: body
12655           in: body
12656           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)
12657           required: true
12658           schema:
12659             $ref: "#/definitions/connector"
12660     patch:
12661       tags:
12662         - Business
12663       summary: update an existing connector
12664       description: |
12665         Update an existing connector
12666         #
12667         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12668         The PUT operation will entirely replace an existing object.
12669         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12670         #
12671         Other differences between PUT and PATCH are:
12672         #
12673         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12674         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12675         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12676       operationId: UpdateBusinessConnectorsConnector
12677       consumes:
12678         - application/json
12679         - application/xml
12680       produces:
12681         - application/json
12682         - application/xml
12683       responses:
12684         "default":
12685           description: Response codes found in [response codes](https://wiki.onap.org/).
12686       parameters:
12687         - name: resource-instance-id
12688           in: path
12689           description: Unique id of resource instance.
12690           required: true
12691           type: string
12692           example: __RESOURCE-INSTANCE-ID__
12693         - name: body
12694           in: body
12695           description: connector object that needs to be updated.
12696           required: true
12697           schema:
12698             $ref: "#/patchDefinitions/connector"
12699     delete:
12700       tags:
12701         - Business
12702       summary: delete an existing connector
12703       description: delete an existing connector
12704       operationId: deleteBusinessConnectorsConnector
12705       consumes:
12706         - application/json
12707         - application/xml
12708       produces:
12709         - application/json
12710         - application/xml
12711       responses:
12712         "default":
12713           description: Response codes found in [response codes](https://wiki.onap.org/).
12714       parameters:
12715         - name: resource-instance-id
12716           in: path
12717           description: Unique id of resource instance.
12718           required: true
12719           type: string
12720           example: __RESOURCE-INSTANCE-ID__
12721         - name: resource-version
12722           in: query
12723           description: resource-version for concurrency
12724           required: true
12725           type: string
12726   /business/connectors:
12727     get:
12728       tags:
12729         - Business
12730       summary: returns connectors
12731       description: returns connectors
12732       operationId: getBusinessConnectors
12733       produces:
12734         - application/json
12735         - application/xml
12736       responses:
12737         "200":
12738           description: successful operation
12739           schema:
12740               $ref: "#/getDefinitions/connectors"
12741         "default":
12742           description: Response codes found in [response codes](https://wiki.onap.org/).
12743       parameters:
12744         - name: resource-instance-id
12745           in: query
12746           description:
12747           required: false
12748           type: string
12749         - name: persona-model-id
12750           in: query
12751           description:
12752           required: false
12753           type: string
12754         - name: persona-model-version
12755           in: query
12756           description:
12757           required: false
12758           type: string
12759         - name: widget-model-id
12760           in: query
12761           description:
12762           required: false
12763           type: string
12764         - name: widget-model-version
12765           in: query
12766           description:
12767           required: false
12768           type: string
12769   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
12770     put:
12771       tags:
12772         - Business
12773       summary: see node definition for valid relationships
12774       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12775       consumes:
12776         - application/json
12777         - application/xml
12778       produces:
12779         - application/json
12780         - application/xml
12781       responses:
12782         "default":
12783           description: Response codes found in [response codes](https://wiki.onap.org/).
12784       parameters:
12785         - name: global-customer-id
12786           in: path
12787           description: Global customer id used across ECOMP to uniquely identify customer.
12788           required: true
12789           type: string
12790           example: __GLOBAL-CUSTOMER-ID__
12791         - name: service-type
12792           in: path
12793           description: Value defined by orchestration to identify this service across ECOMP.
12794           required: true
12795           type: string
12796           example: __SERVICE-TYPE__
12797         - name: service-instance-id
12798           in: path
12799           description: Uniquely identifies this instance of a service
12800           required: true
12801           type: string
12802           example: __SERVICE-INSTANCE-ID__
12803         - name: body
12804           in: body
12805           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
12806           required: true
12807           schema:
12808             $ref: "#/definitions/relationship"
12809     delete:
12810       tags:
12811         - Business
12812       summary: delete an existing relationship
12813       description: delete an existing relationship
12814       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12815       consumes:
12816         - application/json
12817         - application/xml
12818       produces:
12819         - application/json
12820         - application/xml
12821       responses:
12822         "default":
12823           description: Response codes found in [response codes](https://wiki.onap.org/).
12824       parameters:
12825         - name: global-customer-id
12826           in: path
12827           description: Global customer id used across ECOMP to uniquely identify customer.
12828           required: true
12829           type: string
12830           example: __GLOBAL-CUSTOMER-ID__
12831         - name: service-type
12832           in: path
12833           description: Value defined by orchestration to identify this service across ECOMP.
12834           required: true
12835           type: string
12836           example: __SERVICE-TYPE__
12837         - name: service-instance-id
12838           in: path
12839           description: Uniquely identifies this instance of a service
12840           required: true
12841           type: string
12842           example: __SERVICE-INSTANCE-ID__
12843   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
12844     get:
12845       tags:
12846         - Business
12847       summary: returns metadatum
12848       description: returns metadatum
12849       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12850       produces:
12851         - application/json
12852         - application/xml
12853       responses:
12854         "200":
12855           description: successful operation
12856           schema:
12857               $ref: "#/getDefinitions/metadatum"
12858         "default":
12859           description: Response codes found in [response codes](https://wiki.onap.org/).
12860       parameters:
12861         - name: global-customer-id
12862           in: path
12863           description: Global customer id used across ECOMP to uniquely identify customer.
12864           required: true
12865           type: string
12866           example: __GLOBAL-CUSTOMER-ID__
12867         - name: service-type
12868           in: path
12869           description: Value defined by orchestration to identify this service across ECOMP.
12870           required: true
12871           type: string
12872           example: __SERVICE-TYPE__
12873         - name: service-instance-id
12874           in: path
12875           description: Uniquely identifies this instance of a service
12876           required: true
12877           type: string
12878           example: __SERVICE-INSTANCE-ID__
12879         - name: metaname
12880           in: path
12881           required: true
12882           type: string
12883           example: __METANAME__
12884     put:
12885       tags:
12886         - Business
12887       summary: create or update an existing metadatum
12888       description: |
12889         Create or update an existing metadatum.
12890         #
12891         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12892       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12893       consumes:
12894         - application/json
12895         - application/xml
12896       produces:
12897         - application/json
12898         - application/xml
12899       responses:
12900         "default":
12901           description: Response codes found in [response codes](https://wiki.onap.org/).
12902       parameters:
12903         - name: global-customer-id
12904           in: path
12905           description: Global customer id used across ECOMP to uniquely identify customer.
12906           required: true
12907           type: string
12908           example: __GLOBAL-CUSTOMER-ID__
12909         - name: service-type
12910           in: path
12911           description: Value defined by orchestration to identify this service across ECOMP.
12912           required: true
12913           type: string
12914           example: __SERVICE-TYPE__
12915         - name: service-instance-id
12916           in: path
12917           description: Uniquely identifies this instance of a service
12918           required: true
12919           type: string
12920           example: __SERVICE-INSTANCE-ID__
12921         - name: metaname
12922           in: path
12923           required: true
12924           type: string
12925           example: __METANAME__
12926         - name: body
12927           in: body
12928           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
12929           required: true
12930           schema:
12931             $ref: "#/definitions/metadatum"
12932     patch:
12933       tags:
12934         - Business
12935       summary: update an existing metadatum
12936       description: |
12937         Update an existing metadatum
12938         #
12939         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12940         The PUT operation will entirely replace an existing object.
12941         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12942         #
12943         Other differences between PUT and PATCH are:
12944         #
12945         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12946         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12947         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12948       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12949       consumes:
12950         - application/json
12951         - application/xml
12952       produces:
12953         - application/json
12954         - application/xml
12955       responses:
12956         "default":
12957           description: Response codes found in [response codes](https://wiki.onap.org/).
12958       parameters:
12959         - name: global-customer-id
12960           in: path
12961           description: Global customer id used across ECOMP to uniquely identify customer.
12962           required: true
12963           type: string
12964           example: __GLOBAL-CUSTOMER-ID__
12965         - name: service-type
12966           in: path
12967           description: Value defined by orchestration to identify this service across ECOMP.
12968           required: true
12969           type: string
12970           example: __SERVICE-TYPE__
12971         - name: service-instance-id
12972           in: path
12973           description: Uniquely identifies this instance of a service
12974           required: true
12975           type: string
12976           example: __SERVICE-INSTANCE-ID__
12977         - name: metaname
12978           in: path
12979           required: true
12980           type: string
12981           example: __METANAME__
12982         - name: body
12983           in: body
12984           description: metadatum object that needs to be updated.
12985           required: true
12986           schema:
12987             $ref: "#/patchDefinitions/metadatum"
12988     delete:
12989       tags:
12990         - Business
12991       summary: delete an existing metadatum
12992       description: delete an existing metadatum
12993       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12994       consumes:
12995         - application/json
12996         - application/xml
12997       produces:
12998         - application/json
12999         - application/xml
13000       responses:
13001         "default":
13002           description: Response codes found in [response codes](https://wiki.onap.org/).
13003       parameters:
13004         - name: global-customer-id
13005           in: path
13006           description: Global customer id used across ECOMP to uniquely identify customer.
13007           required: true
13008           type: string
13009           example: __GLOBAL-CUSTOMER-ID__
13010         - name: service-type
13011           in: path
13012           description: Value defined by orchestration to identify this service across ECOMP.
13013           required: true
13014           type: string
13015           example: __SERVICE-TYPE__
13016         - name: service-instance-id
13017           in: path
13018           description: Uniquely identifies this instance of a service
13019           required: true
13020           type: string
13021           example: __SERVICE-INSTANCE-ID__
13022         - name: metaname
13023           in: path
13024           required: true
13025           type: string
13026           example: __METANAME__
13027         - name: resource-version
13028           in: query
13029           description: resource-version for concurrency
13030           required: true
13031           type: string
13032   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
13033     get:
13034       tags:
13035         - Business
13036       summary: returns metadata
13037       description: returns metadata
13038       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
13039       produces:
13040         - application/json
13041         - application/xml
13042       responses:
13043         "200":
13044           description: successful operation
13045           schema:
13046               $ref: "#/getDefinitions/metadata"
13047         "default":
13048           description: Response codes found in [response codes](https://wiki.onap.org/).
13049       parameters:
13050         - name: global-customer-id
13051           in: path
13052           description: Global customer id used across ECOMP to uniquely identify customer.
13053           required: true
13054           type: string
13055           example: __GLOBAL-CUSTOMER-ID__
13056         - name: service-type
13057           in: path
13058           description: Value defined by orchestration to identify this service across ECOMP.
13059           required: true
13060           type: string
13061           example: __SERVICE-TYPE__
13062         - name: service-instance-id
13063           in: path
13064           description: Uniquely identifies this instance of a service
13065           required: true
13066           type: string
13067           example: __SERVICE-INSTANCE-ID__
13068         - name: metaname
13069           in: query
13070           description:
13071           required: false
13072           type: string
13073   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
13074     put:
13075       tags:
13076         - Business
13077       summary: see node definition for valid relationships
13078       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
13079       consumes:
13080         - application/json
13081         - application/xml
13082       produces:
13083         - application/json
13084         - application/xml
13085       responses:
13086         "default":
13087           description: Response codes found in [response codes](https://wiki.onap.org/).
13088       parameters:
13089         - name: global-customer-id
13090           in: path
13091           description: Global customer id used across ECOMP to uniquely identify customer.
13092           required: true
13093           type: string
13094           example: __GLOBAL-CUSTOMER-ID__
13095         - name: service-type
13096           in: path
13097           description: Value defined by orchestration to identify this service across ECOMP.
13098           required: true
13099           type: string
13100           example: __SERVICE-TYPE__
13101         - name: service-instance-id
13102           in: path
13103           description: Uniquely identifies this instance of a service
13104           required: true
13105           type: string
13106           example: __SERVICE-INSTANCE-ID__
13107         - name: id
13108           in: path
13109           description: Allotted Resource id UUID assigned to this instance.
13110           required: true
13111           type: string
13112           example: __ID__
13113         - name: id
13114           in: path
13115           description: Allotted Resource id UUID assigned to this instance.
13116           required: true
13117           type: string
13118           example: __ID__
13119         - name: body
13120           in: body
13121           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
13122           required: true
13123           schema:
13124             $ref: "#/definitions/relationship"
13125     delete:
13126       tags:
13127         - Business
13128       summary: delete an existing relationship
13129       description: delete an existing relationship
13130       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
13131       consumes:
13132         - application/json
13133         - application/xml
13134       produces:
13135         - application/json
13136         - application/xml
13137       responses:
13138         "default":
13139           description: Response codes found in [response codes](https://wiki.onap.org/).
13140       parameters:
13141         - name: global-customer-id
13142           in: path
13143           description: Global customer id used across ECOMP to uniquely identify customer.
13144           required: true
13145           type: string
13146           example: __GLOBAL-CUSTOMER-ID__
13147         - name: service-type
13148           in: path
13149           description: Value defined by orchestration to identify this service across ECOMP.
13150           required: true
13151           type: string
13152           example: __SERVICE-TYPE__
13153         - name: service-instance-id
13154           in: path
13155           description: Uniquely identifies this instance of a service
13156           required: true
13157           type: string
13158           example: __SERVICE-INSTANCE-ID__
13159         - name: id
13160           in: path
13161           description: Allotted Resource id UUID assigned to this instance.
13162           required: true
13163           type: string
13164           example: __ID__
13165         - name: id
13166           in: path
13167           description: Allotted Resource id UUID assigned to this instance.
13168           required: true
13169           type: string
13170           example: __ID__
13171   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
13172     get:
13173       tags:
13174         - Business
13175       summary: returns tunnel-xconnect
13176       description: returns tunnel-xconnect
13177       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13178       produces:
13179         - application/json
13180         - application/xml
13181       responses:
13182         "200":
13183           description: successful operation
13184           schema:
13185               $ref: "#/getDefinitions/tunnel-xconnect"
13186         "default":
13187           description: Response codes found in [response codes](https://wiki.onap.org/).
13188       parameters:
13189         - name: global-customer-id
13190           in: path
13191           description: Global customer id used across ECOMP to uniquely identify customer.
13192           required: true
13193           type: string
13194           example: __GLOBAL-CUSTOMER-ID__
13195         - name: service-type
13196           in: path
13197           description: Value defined by orchestration to identify this service across ECOMP.
13198           required: true
13199           type: string
13200           example: __SERVICE-TYPE__
13201         - name: service-instance-id
13202           in: path
13203           description: Uniquely identifies this instance of a service
13204           required: true
13205           type: string
13206           example: __SERVICE-INSTANCE-ID__
13207         - name: id
13208           in: path
13209           description: Allotted Resource id UUID assigned to this instance.
13210           required: true
13211           type: string
13212           example: __ID__
13213         - name: id
13214           in: path
13215           description: Allotted Resource id UUID assigned to this instance.
13216           required: true
13217           type: string
13218           example: __ID__
13219     put:
13220       tags:
13221         - Business
13222       summary: create or update an existing tunnel-xconnect
13223       description: |
13224         Create or update an existing tunnel-xconnect.
13225         #
13226         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13227       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13228       consumes:
13229         - application/json
13230         - application/xml
13231       produces:
13232         - application/json
13233         - application/xml
13234       responses:
13235         "default":
13236           description: Response codes found in [response codes](https://wiki.onap.org/).
13237       parameters:
13238         - name: global-customer-id
13239           in: path
13240           description: Global customer id used across ECOMP to uniquely identify customer.
13241           required: true
13242           type: string
13243           example: __GLOBAL-CUSTOMER-ID__
13244         - name: service-type
13245           in: path
13246           description: Value defined by orchestration to identify this service across ECOMP.
13247           required: true
13248           type: string
13249           example: __SERVICE-TYPE__
13250         - name: service-instance-id
13251           in: path
13252           description: Uniquely identifies this instance of a service
13253           required: true
13254           type: string
13255           example: __SERVICE-INSTANCE-ID__
13256         - name: id
13257           in: path
13258           description: Allotted Resource id UUID assigned to this instance.
13259           required: true
13260           type: string
13261           example: __ID__
13262         - name: id
13263           in: path
13264           description: Allotted Resource id UUID assigned to this instance.
13265           required: true
13266           type: string
13267           example: __ID__
13268         - name: body
13269           in: body
13270           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
13271           required: true
13272           schema:
13273             $ref: "#/definitions/tunnel-xconnect"
13274     patch:
13275       tags:
13276         - Business
13277       summary: update an existing tunnel-xconnect
13278       description: |
13279         Update an existing tunnel-xconnect
13280         #
13281         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13282         The PUT operation will entirely replace an existing object.
13283         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13284         #
13285         Other differences between PUT and PATCH are:
13286         #
13287         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13288         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13289         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13290       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13291       consumes:
13292         - application/json
13293         - application/xml
13294       produces:
13295         - application/json
13296         - application/xml
13297       responses:
13298         "default":
13299           description: Response codes found in [response codes](https://wiki.onap.org/).
13300       parameters:
13301         - name: global-customer-id
13302           in: path
13303           description: Global customer id used across ECOMP to uniquely identify customer.
13304           required: true
13305           type: string
13306           example: __GLOBAL-CUSTOMER-ID__
13307         - name: service-type
13308           in: path
13309           description: Value defined by orchestration to identify this service across ECOMP.
13310           required: true
13311           type: string
13312           example: __SERVICE-TYPE__
13313         - name: service-instance-id
13314           in: path
13315           description: Uniquely identifies this instance of a service
13316           required: true
13317           type: string
13318           example: __SERVICE-INSTANCE-ID__
13319         - name: id
13320           in: path
13321           description: Allotted Resource id UUID assigned to this instance.
13322           required: true
13323           type: string
13324           example: __ID__
13325         - name: id
13326           in: path
13327           description: Allotted Resource id UUID assigned to this instance.
13328           required: true
13329           type: string
13330           example: __ID__
13331         - name: body
13332           in: body
13333           description: tunnel-xconnect object that needs to be updated.
13334           required: true
13335           schema:
13336             $ref: "#/patchDefinitions/tunnel-xconnect"
13337     delete:
13338       tags:
13339         - Business
13340       summary: delete an existing tunnel-xconnect
13341       description: delete an existing tunnel-xconnect
13342       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13343       consumes:
13344         - application/json
13345         - application/xml
13346       produces:
13347         - application/json
13348         - application/xml
13349       responses:
13350         "default":
13351           description: Response codes found in [response codes](https://wiki.onap.org/).
13352       parameters:
13353         - name: global-customer-id
13354           in: path
13355           description: Global customer id used across ECOMP to uniquely identify customer.
13356           required: true
13357           type: string
13358           example: __GLOBAL-CUSTOMER-ID__
13359         - name: service-type
13360           in: path
13361           description: Value defined by orchestration to identify this service across ECOMP.
13362           required: true
13363           type: string
13364           example: __SERVICE-TYPE__
13365         - name: service-instance-id
13366           in: path
13367           description: Uniquely identifies this instance of a service
13368           required: true
13369           type: string
13370           example: __SERVICE-INSTANCE-ID__
13371         - name: id
13372           in: path
13373           description: Allotted Resource id UUID assigned to this instance.
13374           required: true
13375           type: string
13376           example: __ID__
13377         - name: id
13378           in: path
13379           description: Allotted Resource id UUID assigned to this instance.
13380           required: true
13381           type: string
13382           example: __ID__
13383         - name: resource-version
13384           in: query
13385           description: resource-version for concurrency
13386           required: true
13387           type: string
13388   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
13389     get:
13390       tags:
13391         - Business
13392       summary: returns tunnel-xconnects
13393       description: returns tunnel-xconnects
13394       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
13395       produces:
13396         - application/json
13397         - application/xml
13398       responses:
13399         "200":
13400           description: successful operation
13401           schema:
13402               $ref: "#/getDefinitions/tunnel-xconnects"
13403         "default":
13404           description: Response codes found in [response codes](https://wiki.onap.org/).
13405       parameters:
13406         - name: global-customer-id
13407           in: path
13408           description: Global customer id used across ECOMP to uniquely identify customer.
13409           required: true
13410           type: string
13411           example: __GLOBAL-CUSTOMER-ID__
13412         - name: service-type
13413           in: path
13414           description: Value defined by orchestration to identify this service across ECOMP.
13415           required: true
13416           type: string
13417           example: __SERVICE-TYPE__
13418         - name: service-instance-id
13419           in: path
13420           description: Uniquely identifies this instance of a service
13421           required: true
13422           type: string
13423           example: __SERVICE-INSTANCE-ID__
13424         - name: id
13425           in: path
13426           description: Allotted Resource id UUID assigned to this instance.
13427           required: true
13428           type: string
13429           example: __ID__
13430         - name: id
13431           in: query
13432           description:
13433           required: false
13434           type: string
13435   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
13436     put:
13437       tags:
13438         - Business
13439       summary: see node definition for valid relationships
13440       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
13441       consumes:
13442         - application/json
13443         - application/xml
13444       produces:
13445         - application/json
13446         - application/xml
13447       responses:
13448         "default":
13449           description: Response codes found in [response codes](https://wiki.onap.org/).
13450       parameters:
13451         - name: global-customer-id
13452           in: path
13453           description: Global customer id used across ECOMP to uniquely identify customer.
13454           required: true
13455           type: string
13456           example: __GLOBAL-CUSTOMER-ID__
13457         - name: service-type
13458           in: path
13459           description: Value defined by orchestration to identify this service across ECOMP.
13460           required: true
13461           type: string
13462           example: __SERVICE-TYPE__
13463         - name: service-instance-id
13464           in: path
13465           description: Uniquely identifies this instance of a service
13466           required: true
13467           type: string
13468           example: __SERVICE-INSTANCE-ID__
13469         - name: id
13470           in: path
13471           description: Allotted Resource id UUID assigned to this instance.
13472           required: true
13473           type: string
13474           example: __ID__
13475         - name: body
13476           in: body
13477           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
13478           required: true
13479           schema:
13480             $ref: "#/definitions/relationship"
13481     delete:
13482       tags:
13483         - Business
13484       summary: delete an existing relationship
13485       description: delete an existing relationship
13486       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
13487       consumes:
13488         - application/json
13489         - application/xml
13490       produces:
13491         - application/json
13492         - application/xml
13493       responses:
13494         "default":
13495           description: Response codes found in [response codes](https://wiki.onap.org/).
13496       parameters:
13497         - name: global-customer-id
13498           in: path
13499           description: Global customer id used across ECOMP to uniquely identify customer.
13500           required: true
13501           type: string
13502           example: __GLOBAL-CUSTOMER-ID__
13503         - name: service-type
13504           in: path
13505           description: Value defined by orchestration to identify this service across ECOMP.
13506           required: true
13507           type: string
13508           example: __SERVICE-TYPE__
13509         - name: service-instance-id
13510           in: path
13511           description: Uniquely identifies this instance of a service
13512           required: true
13513           type: string
13514           example: __SERVICE-INSTANCE-ID__
13515         - name: id
13516           in: path
13517           description: Allotted Resource id UUID assigned to this instance.
13518           required: true
13519           type: string
13520           example: __ID__
13521   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
13522     get:
13523       tags:
13524         - Business
13525       summary: returns allotted-resource
13526       description: returns allotted-resource
13527       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13528       produces:
13529         - application/json
13530         - application/xml
13531       responses:
13532         "200":
13533           description: successful operation
13534           schema:
13535               $ref: "#/getDefinitions/allotted-resource"
13536         "default":
13537           description: Response codes found in [response codes](https://wiki.onap.org/).
13538       parameters:
13539         - name: global-customer-id
13540           in: path
13541           description: Global customer id used across ECOMP to uniquely identify customer.
13542           required: true
13543           type: string
13544           example: __GLOBAL-CUSTOMER-ID__
13545         - name: service-type
13546           in: path
13547           description: Value defined by orchestration to identify this service across ECOMP.
13548           required: true
13549           type: string
13550           example: __SERVICE-TYPE__
13551         - name: service-instance-id
13552           in: path
13553           description: Uniquely identifies this instance of a service
13554           required: true
13555           type: string
13556           example: __SERVICE-INSTANCE-ID__
13557         - name: id
13558           in: path
13559           description: Allotted Resource id UUID assigned to this instance.
13560           required: true
13561           type: string
13562           example: __ID__
13563     put:
13564       tags:
13565         - Business
13566       summary: create or update an existing allotted-resource
13567       description: |
13568         Create or update an existing allotted-resource.
13569         #
13570         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13571       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13572       consumes:
13573         - application/json
13574         - application/xml
13575       produces:
13576         - application/json
13577         - application/xml
13578       responses:
13579         "default":
13580           description: Response codes found in [response codes](https://wiki.onap.org/).
13581       parameters:
13582         - name: global-customer-id
13583           in: path
13584           description: Global customer id used across ECOMP to uniquely identify customer.
13585           required: true
13586           type: string
13587           example: __GLOBAL-CUSTOMER-ID__
13588         - name: service-type
13589           in: path
13590           description: Value defined by orchestration to identify this service across ECOMP.
13591           required: true
13592           type: string
13593           example: __SERVICE-TYPE__
13594         - name: service-instance-id
13595           in: path
13596           description: Uniquely identifies this instance of a service
13597           required: true
13598           type: string
13599           example: __SERVICE-INSTANCE-ID__
13600         - name: id
13601           in: path
13602           description: Allotted Resource id UUID assigned to this instance.
13603           required: true
13604           type: string
13605           example: __ID__
13606         - name: body
13607           in: body
13608           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
13609           required: true
13610           schema:
13611             $ref: "#/definitions/allotted-resource"
13612     patch:
13613       tags:
13614         - Business
13615       summary: update an existing allotted-resource
13616       description: |
13617         Update an existing allotted-resource
13618         #
13619         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13620         The PUT operation will entirely replace an existing object.
13621         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13622         #
13623         Other differences between PUT and PATCH are:
13624         #
13625         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13626         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13627         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13628       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13629       consumes:
13630         - application/json
13631         - application/xml
13632       produces:
13633         - application/json
13634         - application/xml
13635       responses:
13636         "default":
13637           description: Response codes found in [response codes](https://wiki.onap.org/).
13638       parameters:
13639         - name: global-customer-id
13640           in: path
13641           description: Global customer id used across ECOMP to uniquely identify customer.
13642           required: true
13643           type: string
13644           example: __GLOBAL-CUSTOMER-ID__
13645         - name: service-type
13646           in: path
13647           description: Value defined by orchestration to identify this service across ECOMP.
13648           required: true
13649           type: string
13650           example: __SERVICE-TYPE__
13651         - name: service-instance-id
13652           in: path
13653           description: Uniquely identifies this instance of a service
13654           required: true
13655           type: string
13656           example: __SERVICE-INSTANCE-ID__
13657         - name: id
13658           in: path
13659           description: Allotted Resource id UUID assigned to this instance.
13660           required: true
13661           type: string
13662           example: __ID__
13663         - name: body
13664           in: body
13665           description: allotted-resource object that needs to be updated.
13666           required: true
13667           schema:
13668             $ref: "#/patchDefinitions/allotted-resource"
13669     delete:
13670       tags:
13671         - Business
13672       summary: delete an existing allotted-resource
13673       description: delete an existing allotted-resource
13674       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13675       consumes:
13676         - application/json
13677         - application/xml
13678       produces:
13679         - application/json
13680         - application/xml
13681       responses:
13682         "default":
13683           description: Response codes found in [response codes](https://wiki.onap.org/).
13684       parameters:
13685         - name: global-customer-id
13686           in: path
13687           description: Global customer id used across ECOMP to uniquely identify customer.
13688           required: true
13689           type: string
13690           example: __GLOBAL-CUSTOMER-ID__
13691         - name: service-type
13692           in: path
13693           description: Value defined by orchestration to identify this service across ECOMP.
13694           required: true
13695           type: string
13696           example: __SERVICE-TYPE__
13697         - name: service-instance-id
13698           in: path
13699           description: Uniquely identifies this instance of a service
13700           required: true
13701           type: string
13702           example: __SERVICE-INSTANCE-ID__
13703         - name: id
13704           in: path
13705           description: Allotted Resource id UUID assigned to this instance.
13706           required: true
13707           type: string
13708           example: __ID__
13709         - name: resource-version
13710           in: query
13711           description: resource-version for concurrency
13712           required: true
13713           type: string
13714   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
13715     get:
13716       tags:
13717         - Business
13718       summary: returns allotted-resources
13719       description: returns allotted-resources
13720       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
13721       produces:
13722         - application/json
13723         - application/xml
13724       responses:
13725         "200":
13726           description: successful operation
13727           schema:
13728               $ref: "#/getDefinitions/allotted-resources"
13729         "default":
13730           description: Response codes found in [response codes](https://wiki.onap.org/).
13731       parameters:
13732         - name: global-customer-id
13733           in: path
13734           description: Global customer id used across ECOMP to uniquely identify customer.
13735           required: true
13736           type: string
13737           example: __GLOBAL-CUSTOMER-ID__
13738         - name: service-type
13739           in: path
13740           description: Value defined by orchestration to identify this service across ECOMP.
13741           required: true
13742           type: string
13743           example: __SERVICE-TYPE__
13744         - name: service-instance-id
13745           in: path
13746           description: Uniquely identifies this instance of a service
13747           required: true
13748           type: string
13749           example: __SERVICE-INSTANCE-ID__
13750         - name: id
13751           in: query
13752           description:
13753           required: false
13754           type: string
13755         - name: persona-model-id
13756           in: query
13757           description:
13758           required: false
13759           type: string
13760         - name: persona-model-version
13761           in: query
13762           description:
13763           required: false
13764           type: string
13765   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
13766     get:
13767       tags:
13768         - Business
13769       summary: returns service-instance
13770       description: returns service-instance
13771       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13772       produces:
13773         - application/json
13774         - application/xml
13775       responses:
13776         "200":
13777           description: successful operation
13778           schema:
13779               $ref: "#/getDefinitions/service-instance"
13780         "default":
13781           description: Response codes found in [response codes](https://wiki.onap.org/).
13782       parameters:
13783         - name: global-customer-id
13784           in: path
13785           description: Global customer id used across ECOMP to uniquely identify customer.
13786           required: true
13787           type: string
13788           example: __GLOBAL-CUSTOMER-ID__
13789         - name: service-type
13790           in: path
13791           description: Value defined by orchestration to identify this service across ECOMP.
13792           required: true
13793           type: string
13794           example: __SERVICE-TYPE__
13795         - name: service-instance-id
13796           in: path
13797           description: Uniquely identifies this instance of a service
13798           required: true
13799           type: string
13800           example: __SERVICE-INSTANCE-ID__
13801     put:
13802       tags:
13803         - Business
13804       summary: create or update an existing service-instance
13805       description: |
13806         Create or update an existing service-instance.
13807         #
13808         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13809       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13810       consumes:
13811         - application/json
13812         - application/xml
13813       produces:
13814         - application/json
13815         - application/xml
13816       responses:
13817         "default":
13818           description: Response codes found in [response codes](https://wiki.onap.org/).
13819       parameters:
13820         - name: global-customer-id
13821           in: path
13822           description: Global customer id used across ECOMP to uniquely identify customer.
13823           required: true
13824           type: string
13825           example: __GLOBAL-CUSTOMER-ID__
13826         - name: service-type
13827           in: path
13828           description: Value defined by orchestration to identify this service across ECOMP.
13829           required: true
13830           type: string
13831           example: __SERVICE-TYPE__
13832         - name: service-instance-id
13833           in: path
13834           description: Uniquely identifies this instance of a service
13835           required: true
13836           type: string
13837           example: __SERVICE-INSTANCE-ID__
13838         - name: body
13839           in: body
13840           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
13841           required: true
13842           schema:
13843             $ref: "#/definitions/service-instance"
13844     patch:
13845       tags:
13846         - Business
13847       summary: update an existing service-instance
13848       description: |
13849         Update an existing service-instance
13850         #
13851         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13852         The PUT operation will entirely replace an existing object.
13853         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13854         #
13855         Other differences between PUT and PATCH are:
13856         #
13857         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13858         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13859         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13860       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13861       consumes:
13862         - application/json
13863         - application/xml
13864       produces:
13865         - application/json
13866         - application/xml
13867       responses:
13868         "default":
13869           description: Response codes found in [response codes](https://wiki.onap.org/).
13870       parameters:
13871         - name: global-customer-id
13872           in: path
13873           description: Global customer id used across ECOMP to uniquely identify customer.
13874           required: true
13875           type: string
13876           example: __GLOBAL-CUSTOMER-ID__
13877         - name: service-type
13878           in: path
13879           description: Value defined by orchestration to identify this service across ECOMP.
13880           required: true
13881           type: string
13882           example: __SERVICE-TYPE__
13883         - name: service-instance-id
13884           in: path
13885           description: Uniquely identifies this instance of a service
13886           required: true
13887           type: string
13888           example: __SERVICE-INSTANCE-ID__
13889         - name: body
13890           in: body
13891           description: service-instance object that needs to be updated.
13892           required: true
13893           schema:
13894             $ref: "#/patchDefinitions/service-instance"
13895     delete:
13896       tags:
13897         - Business
13898       summary: delete an existing service-instance
13899       description: delete an existing service-instance
13900       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13901       consumes:
13902         - application/json
13903         - application/xml
13904       produces:
13905         - application/json
13906         - application/xml
13907       responses:
13908         "default":
13909           description: Response codes found in [response codes](https://wiki.onap.org/).
13910       parameters:
13911         - name: global-customer-id
13912           in: path
13913           description: Global customer id used across ECOMP to uniquely identify customer.
13914           required: true
13915           type: string
13916           example: __GLOBAL-CUSTOMER-ID__
13917         - name: service-type
13918           in: path
13919           description: Value defined by orchestration to identify this service across ECOMP.
13920           required: true
13921           type: string
13922           example: __SERVICE-TYPE__
13923         - name: service-instance-id
13924           in: path
13925           description: Uniquely identifies this instance of a service
13926           required: true
13927           type: string
13928           example: __SERVICE-INSTANCE-ID__
13929         - name: resource-version
13930           in: query
13931           description: resource-version for concurrency
13932           required: true
13933           type: string
13934   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
13935     get:
13936       tags:
13937         - Business
13938       summary: returns service-instances
13939       description: returns service-instances
13940       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
13941       produces:
13942         - application/json
13943         - application/xml
13944       responses:
13945         "200":
13946           description: successful operation
13947           schema:
13948               $ref: "#/getDefinitions/service-instances"
13949         "default":
13950           description: Response codes found in [response codes](https://wiki.onap.org/).
13951       parameters:
13952         - name: global-customer-id
13953           in: path
13954           description: Global customer id used across ECOMP to uniquely identify customer.
13955           required: true
13956           type: string
13957           example: __GLOBAL-CUSTOMER-ID__
13958         - name: service-type
13959           in: path
13960           description: Value defined by orchestration to identify this service across ECOMP.
13961           required: true
13962           type: string
13963           example: __SERVICE-TYPE__
13964         - name: service-instance-id
13965           in: query
13966           description:
13967           required: false
13968           type: string
13969         - name: service-instance-name
13970           in: query
13971           description:
13972           required: false
13973           type: string
13974         - name: persona-model-id
13975           in: query
13976           description:
13977           required: false
13978           type: string
13979         - name: persona-model-version
13980           in: query
13981           description:
13982           required: false
13983           type: string
13984         - name: widget-model-id
13985           in: query
13986           description:
13987           required: false
13988           type: string
13989         - name: widget-model-version
13990           in: query
13991           description:
13992           required: false
13993           type: string
13994         - name: service-instance-location-id
13995           in: query
13996           description:
13997           required: false
13998           type: string
13999         - name: orchestration-status
14000           in: query
14001           description:
14002           required: false
14003           type: string
14004   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
14005     put:
14006       tags:
14007         - Business
14008       summary: see node definition for valid relationships
14009       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14010       consumes:
14011         - application/json
14012         - application/xml
14013       produces:
14014         - application/json
14015         - application/xml
14016       responses:
14017         "default":
14018           description: Response codes found in [response codes](https://wiki.onap.org/).
14019       parameters:
14020         - name: global-customer-id
14021           in: path
14022           description: Global customer id used across ECOMP to uniquely identify customer.
14023           required: true
14024           type: string
14025           example: __GLOBAL-CUSTOMER-ID__
14026         - name: service-type
14027           in: path
14028           description: Value defined by orchestration to identify this service across ECOMP.
14029           required: true
14030           type: string
14031           example: __SERVICE-TYPE__
14032         - name: body
14033           in: body
14034           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14035           required: true
14036           schema:
14037             $ref: "#/definitions/relationship"
14038     delete:
14039       tags:
14040         - Business
14041       summary: delete an existing relationship
14042       description: delete an existing relationship
14043       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14044       consumes:
14045         - application/json
14046         - application/xml
14047       produces:
14048         - application/json
14049         - application/xml
14050       responses:
14051         "default":
14052           description: Response codes found in [response codes](https://wiki.onap.org/).
14053       parameters:
14054         - name: global-customer-id
14055           in: path
14056           description: Global customer id used across ECOMP to uniquely identify customer.
14057           required: true
14058           type: string
14059           example: __GLOBAL-CUSTOMER-ID__
14060         - name: service-type
14061           in: path
14062           description: Value defined by orchestration to identify this service across ECOMP.
14063           required: true
14064           type: string
14065           example: __SERVICE-TYPE__
14066   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
14067     get:
14068       tags:
14069         - Business
14070       summary: returns service-subscription
14071       description: returns service-subscription
14072       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14073       produces:
14074         - application/json
14075         - application/xml
14076       responses:
14077         "200":
14078           description: successful operation
14079           schema:
14080               $ref: "#/getDefinitions/service-subscription"
14081         "default":
14082           description: Response codes found in [response codes](https://wiki.onap.org/).
14083       parameters:
14084         - name: global-customer-id
14085           in: path
14086           description: Global customer id used across ECOMP to uniquely identify customer.
14087           required: true
14088           type: string
14089           example: __GLOBAL-CUSTOMER-ID__
14090         - name: service-type
14091           in: path
14092           description: Value defined by orchestration to identify this service across ECOMP.
14093           required: true
14094           type: string
14095           example: __SERVICE-TYPE__
14096     put:
14097       tags:
14098         - Business
14099       summary: create or update an existing service-subscription
14100       description: |
14101         Create or update an existing service-subscription.
14102         #
14103         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14104       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14105       consumes:
14106         - application/json
14107         - application/xml
14108       produces:
14109         - application/json
14110         - application/xml
14111       responses:
14112         "default":
14113           description: Response codes found in [response codes](https://wiki.onap.org/).
14114       parameters:
14115         - name: global-customer-id
14116           in: path
14117           description: Global customer id used across ECOMP to uniquely identify customer.
14118           required: true
14119           type: string
14120           example: __GLOBAL-CUSTOMER-ID__
14121         - name: service-type
14122           in: path
14123           description: Value defined by orchestration to identify this service across ECOMP.
14124           required: true
14125           type: string
14126           example: __SERVICE-TYPE__
14127         - name: body
14128           in: body
14129           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14130           required: true
14131           schema:
14132             $ref: "#/definitions/service-subscription"
14133     patch:
14134       tags:
14135         - Business
14136       summary: update an existing service-subscription
14137       description: |
14138         Update an existing service-subscription
14139         #
14140         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14141         The PUT operation will entirely replace an existing object.
14142         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14143         #
14144         Other differences between PUT and PATCH are:
14145         #
14146         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14147         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14148         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14149       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14150       consumes:
14151         - application/json
14152         - application/xml
14153       produces:
14154         - application/json
14155         - application/xml
14156       responses:
14157         "default":
14158           description: Response codes found in [response codes](https://wiki.onap.org/).
14159       parameters:
14160         - name: global-customer-id
14161           in: path
14162           description: Global customer id used across ECOMP to uniquely identify customer.
14163           required: true
14164           type: string
14165           example: __GLOBAL-CUSTOMER-ID__
14166         - name: service-type
14167           in: path
14168           description: Value defined by orchestration to identify this service across ECOMP.
14169           required: true
14170           type: string
14171           example: __SERVICE-TYPE__
14172         - name: body
14173           in: body
14174           description: service-subscription object that needs to be updated.
14175           required: true
14176           schema:
14177             $ref: "#/patchDefinitions/service-subscription"
14178     delete:
14179       tags:
14180         - Business
14181       summary: delete an existing service-subscription
14182       description: delete an existing service-subscription
14183       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14184       consumes:
14185         - application/json
14186         - application/xml
14187       produces:
14188         - application/json
14189         - application/xml
14190       responses:
14191         "default":
14192           description: Response codes found in [response codes](https://wiki.onap.org/).
14193       parameters:
14194         - name: global-customer-id
14195           in: path
14196           description: Global customer id used across ECOMP to uniquely identify customer.
14197           required: true
14198           type: string
14199           example: __GLOBAL-CUSTOMER-ID__
14200         - name: service-type
14201           in: path
14202           description: Value defined by orchestration to identify this service across ECOMP.
14203           required: true
14204           type: string
14205           example: __SERVICE-TYPE__
14206         - name: resource-version
14207           in: query
14208           description: resource-version for concurrency
14209           required: true
14210           type: string
14211   /business/customers/customer/{global-customer-id}/service-subscriptions:
14212     get:
14213       tags:
14214         - Business
14215       summary: returns service-subscriptions
14216       description: returns service-subscriptions
14217       operationId: getBusinessCustomersCustomerServiceSubscriptions
14218       produces:
14219         - application/json
14220         - application/xml
14221       responses:
14222         "200":
14223           description: successful operation
14224           schema:
14225               $ref: "#/getDefinitions/service-subscriptions"
14226         "default":
14227           description: Response codes found in [response codes](https://wiki.onap.org/).
14228       parameters:
14229         - name: global-customer-id
14230           in: path
14231           description: Global customer id used across ECOMP to uniquely identify customer.
14232           required: true
14233           type: string
14234           example: __GLOBAL-CUSTOMER-ID__
14235         - name: service-type
14236           in: query
14237           description:
14238           required: false
14239           type: string
14240   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
14241     put:
14242       tags:
14243         - Business
14244       summary: see node definition for valid relationships
14245       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
14246       consumes:
14247         - application/json
14248         - application/xml
14249       produces:
14250         - application/json
14251         - application/xml
14252       responses:
14253         "default":
14254           description: Response codes found in [response codes](https://wiki.onap.org/).
14255       parameters:
14256         - name: global-customer-id
14257           in: path
14258           description: Global customer id used across ECOMP to uniquely identify customer.
14259           required: true
14260           type: string
14261           example: __GLOBAL-CUSTOMER-ID__
14262         - name: body
14263           in: body
14264           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)
14265           required: true
14266           schema:
14267             $ref: "#/definitions/relationship"
14268     delete:
14269       tags:
14270         - Business
14271       summary: delete an existing relationship
14272       description: delete an existing relationship
14273       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
14274       consumes:
14275         - application/json
14276         - application/xml
14277       produces:
14278         - application/json
14279         - application/xml
14280       responses:
14281         "default":
14282           description: Response codes found in [response codes](https://wiki.onap.org/).
14283       parameters:
14284         - name: global-customer-id
14285           in: path
14286           description: Global customer id used across ECOMP to uniquely identify customer.
14287           required: true
14288           type: string
14289           example: __GLOBAL-CUSTOMER-ID__
14290   /business/customers/customer/{global-customer-id}:
14291     get:
14292       tags:
14293         - Business
14294       summary: returns customer
14295       description: returns customer
14296       operationId: getBusinessCustomersCustomer
14297       produces:
14298         - application/json
14299         - application/xml
14300       responses:
14301         "200":
14302           description: successful operation
14303           schema:
14304               $ref: "#/getDefinitions/customer"
14305         "default":
14306           description: Response codes found in [response codes](https://wiki.onap.org/).
14307       parameters:
14308         - name: global-customer-id
14309           in: path
14310           description: Global customer id used across ECOMP to uniquely identify customer.
14311           required: true
14312           type: string
14313           example: __GLOBAL-CUSTOMER-ID__
14314     put:
14315       tags:
14316         - Business
14317       summary: create or update an existing customer
14318       description: |
14319         Create or update an existing customer.
14320         #
14321         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14322       operationId: createOrUpdateBusinessCustomersCustomer
14323       consumes:
14324         - application/json
14325         - application/xml
14326       produces:
14327         - application/json
14328         - application/xml
14329       responses:
14330         "default":
14331           description: Response codes found in [response codes](https://wiki.onap.org/).
14332       parameters:
14333         - name: global-customer-id
14334           in: path
14335           description: Global customer id used across ECOMP to uniquely identify customer.
14336           required: true
14337           type: string
14338           example: __GLOBAL-CUSTOMER-ID__
14339         - name: body
14340           in: body
14341           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)
14342           required: true
14343           schema:
14344             $ref: "#/definitions/customer"
14345     patch:
14346       tags:
14347         - Business
14348       summary: update an existing customer
14349       description: |
14350         Update an existing customer
14351         #
14352         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14353         The PUT operation will entirely replace an existing object.
14354         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14355         #
14356         Other differences between PUT and PATCH are:
14357         #
14358         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14359         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14360         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14361       operationId: UpdateBusinessCustomersCustomer
14362       consumes:
14363         - application/json
14364         - application/xml
14365       produces:
14366         - application/json
14367         - application/xml
14368       responses:
14369         "default":
14370           description: Response codes found in [response codes](https://wiki.onap.org/).
14371       parameters:
14372         - name: global-customer-id
14373           in: path
14374           description: Global customer id used across ECOMP to uniquely identify customer.
14375           required: true
14376           type: string
14377           example: __GLOBAL-CUSTOMER-ID__
14378         - name: body
14379           in: body
14380           description: customer object that needs to be updated.
14381           required: true
14382           schema:
14383             $ref: "#/patchDefinitions/customer"
14384     delete:
14385       tags:
14386         - Business
14387       summary: delete an existing customer
14388       description: delete an existing customer
14389       operationId: deleteBusinessCustomersCustomer
14390       consumes:
14391         - application/json
14392         - application/xml
14393       produces:
14394         - application/json
14395         - application/xml
14396       responses:
14397         "default":
14398           description: Response codes found in [response codes](https://wiki.onap.org/).
14399       parameters:
14400         - name: global-customer-id
14401           in: path
14402           description: Global customer id used across ECOMP to uniquely identify customer.
14403           required: true
14404           type: string
14405           example: __GLOBAL-CUSTOMER-ID__
14406         - name: resource-version
14407           in: query
14408           description: resource-version for concurrency
14409           required: true
14410           type: string
14411   /business/customers:
14412     get:
14413       tags:
14414         - Business
14415       summary: returns customers
14416       description: returns customers
14417       operationId: getBusinessCustomers
14418       produces:
14419         - application/json
14420         - application/xml
14421       responses:
14422         "200":
14423           description: successful operation
14424           schema:
14425               $ref: "#/getDefinitions/customers"
14426         "default":
14427           description: Response codes found in [response codes](https://wiki.onap.org/).
14428       parameters:
14429         - name: global-customer-id
14430           in: query
14431           description:
14432           required: false
14433           type: string
14434         - name: subscriber-name
14435           in: query
14436           description:
14437           required: false
14438           type: string
14439         - name: subscriber-type
14440           in: query
14441           description:
14442           required: false
14443           type: string
14444   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
14445     put:
14446       tags:
14447         - ServiceDesignAndCreation
14448       summary: see node definition for valid relationships
14449       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
14450       consumes:
14451         - application/json
14452         - application/xml
14453       produces:
14454         - application/json
14455         - application/xml
14456       responses:
14457         "default":
14458           description: Response codes found in [response codes](https://wiki.onap.org/).
14459       parameters:
14460         - name: vnf-image-uuid
14461           in: path
14462           description: Unique ID of this asset
14463           required: true
14464           type: string
14465           example: __VNF-IMAGE-UUID__
14466         - name: body
14467           in: body
14468           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json)
14469           required: true
14470           schema:
14471             $ref: "#/definitions/relationship"
14472     delete:
14473       tags:
14474         - ServiceDesignAndCreation
14475       summary: delete an existing relationship
14476       description: delete an existing relationship
14477       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
14478       consumes:
14479         - application/json
14480         - application/xml
14481       produces:
14482         - application/json
14483         - application/xml
14484       responses:
14485         "default":
14486           description: Response codes found in [response codes](https://wiki.onap.org/).
14487       parameters:
14488         - name: vnf-image-uuid
14489           in: path
14490           description: Unique ID of this asset
14491           required: true
14492           type: string
14493           example: __VNF-IMAGE-UUID__
14494   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
14495     get:
14496       tags:
14497         - ServiceDesignAndCreation
14498       summary: returns vnf-image
14499       description: returns vnf-image
14500       operationId: getServiceDesignAndCreationVnfImagesVnfImage
14501       produces:
14502         - application/json
14503         - application/xml
14504       responses:
14505         "200":
14506           description: successful operation
14507           schema:
14508               $ref: "#/getDefinitions/vnf-image"
14509         "default":
14510           description: Response codes found in [response codes](https://wiki.onap.org/).
14511       parameters:
14512         - name: vnf-image-uuid
14513           in: path
14514           description: Unique ID of this asset
14515           required: true
14516           type: string
14517           example: __VNF-IMAGE-UUID__
14518     put:
14519       tags:
14520         - ServiceDesignAndCreation
14521       summary: create or update an existing vnf-image
14522       description: |
14523         Create or update an existing vnf-image.
14524         #
14525         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14526       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
14527       consumes:
14528         - application/json
14529         - application/xml
14530       produces:
14531         - application/json
14532         - application/xml
14533       responses:
14534         "default":
14535           description: Response codes found in [response codes](https://wiki.onap.org/).
14536       parameters:
14537         - name: vnf-image-uuid
14538           in: path
14539           description: Unique ID of this asset
14540           required: true
14541           type: string
14542           example: __VNF-IMAGE-UUID__
14543         - name: body
14544           in: body
14545           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json)
14546           required: true
14547           schema:
14548             $ref: "#/definitions/vnf-image"
14549     patch:
14550       tags:
14551         - ServiceDesignAndCreation
14552       summary: update an existing vnf-image
14553       description: |
14554         Update an existing vnf-image
14555         #
14556         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14557         The PUT operation will entirely replace an existing object.
14558         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14559         #
14560         Other differences between PUT and PATCH are:
14561         #
14562         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14563         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14564         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14565       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
14566       consumes:
14567         - application/json
14568         - application/xml
14569       produces:
14570         - application/json
14571         - application/xml
14572       responses:
14573         "default":
14574           description: Response codes found in [response codes](https://wiki.onap.org/).
14575       parameters:
14576         - name: vnf-image-uuid
14577           in: path
14578           description: Unique ID of this asset
14579           required: true
14580           type: string
14581           example: __VNF-IMAGE-UUID__
14582         - name: body
14583           in: body
14584           description: vnf-image object that needs to be updated.
14585           required: true
14586           schema:
14587             $ref: "#/patchDefinitions/vnf-image"
14588     delete:
14589       tags:
14590         - ServiceDesignAndCreation
14591       summary: delete an existing vnf-image
14592       description: delete an existing vnf-image
14593       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
14594       consumes:
14595         - application/json
14596         - application/xml
14597       produces:
14598         - application/json
14599         - application/xml
14600       responses:
14601         "default":
14602           description: Response codes found in [response codes](https://wiki.onap.org/).
14603       parameters:
14604         - name: vnf-image-uuid
14605           in: path
14606           description: Unique ID of this asset
14607           required: true
14608           type: string
14609           example: __VNF-IMAGE-UUID__
14610         - name: resource-version
14611           in: query
14612           description: resource-version for concurrency
14613           required: true
14614           type: string
14615   /service-design-and-creation/vnf-images:
14616     get:
14617       tags:
14618         - ServiceDesignAndCreation
14619       summary: returns vnf-images
14620       description: returns vnf-images
14621       operationId: getServiceDesignAndCreationVnfImages
14622       produces:
14623         - application/json
14624         - application/xml
14625       responses:
14626         "200":
14627           description: successful operation
14628           schema:
14629               $ref: "#/getDefinitions/vnf-images"
14630         "default":
14631           description: Response codes found in [response codes](https://wiki.onap.org/).
14632       parameters:
14633         - name: vnf-image-uuid
14634           in: query
14635           description:
14636           required: false
14637           type: string
14638         - name: application
14639           in: query
14640           description:
14641           required: false
14642           type: string
14643         - name: application-vendor
14644           in: query
14645           description:
14646           required: false
14647           type: string
14648         - name: application-version
14649           in: query
14650           description:
14651           required: false
14652           type: string
14653   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
14654     put:
14655       tags:
14656         - ServiceDesignAndCreation
14657       summary: see node definition for valid relationships
14658       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
14659       consumes:
14660         - application/json
14661         - application/xml
14662       produces:
14663         - application/json
14664         - application/xml
14665       responses:
14666         "default":
14667           description: Response codes found in [response codes](https://wiki.onap.org/).
14668       parameters:
14669         - name: service-id
14670           in: path
14671           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14672           required: true
14673           type: string
14674           example: __SERVICE-ID__
14675         - name: body
14676           in: body
14677           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json)
14678           required: true
14679           schema:
14680             $ref: "#/definitions/relationship"
14681     delete:
14682       tags:
14683         - ServiceDesignAndCreation
14684       summary: delete an existing relationship
14685       description: delete an existing relationship
14686       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
14687       consumes:
14688         - application/json
14689         - application/xml
14690       produces:
14691         - application/json
14692         - application/xml
14693       responses:
14694         "default":
14695           description: Response codes found in [response codes](https://wiki.onap.org/).
14696       parameters:
14697         - name: service-id
14698           in: path
14699           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14700           required: true
14701           type: string
14702           example: __SERVICE-ID__
14703   /service-design-and-creation/services/service/{service-id}:
14704     get:
14705       tags:
14706         - ServiceDesignAndCreation
14707       summary: returns service
14708       description: returns service
14709       operationId: getServiceDesignAndCreationServicesService
14710       produces:
14711         - application/json
14712         - application/xml
14713       responses:
14714         "200":
14715           description: successful operation
14716           schema:
14717               $ref: "#/getDefinitions/service"
14718         "default":
14719           description: Response codes found in [response codes](https://wiki.onap.org/).
14720       parameters:
14721         - name: service-id
14722           in: path
14723           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14724           required: true
14725           type: string
14726           example: __SERVICE-ID__
14727     put:
14728       tags:
14729         - ServiceDesignAndCreation
14730       summary: create or update an existing service
14731       description: |
14732         Create or update an existing service.
14733         #
14734         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14735       operationId: createOrUpdateServiceDesignAndCreationServicesService
14736       consumes:
14737         - application/json
14738         - application/xml
14739       produces:
14740         - application/json
14741         - application/xml
14742       responses:
14743         "default":
14744           description: Response codes found in [response codes](https://wiki.onap.org/).
14745       parameters:
14746         - name: service-id
14747           in: path
14748           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14749           required: true
14750           type: string
14751           example: __SERVICE-ID__
14752         - name: body
14753           in: body
14754           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json)
14755           required: true
14756           schema:
14757             $ref: "#/definitions/service"
14758     patch:
14759       tags:
14760         - ServiceDesignAndCreation
14761       summary: update an existing service
14762       description: |
14763         Update an existing service
14764         #
14765         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14766         The PUT operation will entirely replace an existing object.
14767         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14768         #
14769         Other differences between PUT and PATCH are:
14770         #
14771         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14772         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14773         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14774       operationId: UpdateServiceDesignAndCreationServicesService
14775       consumes:
14776         - application/json
14777         - application/xml
14778       produces:
14779         - application/json
14780         - application/xml
14781       responses:
14782         "default":
14783           description: Response codes found in [response codes](https://wiki.onap.org/).
14784       parameters:
14785         - name: service-id
14786           in: path
14787           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14788           required: true
14789           type: string
14790           example: __SERVICE-ID__
14791         - name: body
14792           in: body
14793           description: service object that needs to be updated.
14794           required: true
14795           schema:
14796             $ref: "#/patchDefinitions/service"
14797     delete:
14798       tags:
14799         - ServiceDesignAndCreation
14800       summary: delete an existing service
14801       description: delete an existing service
14802       operationId: deleteServiceDesignAndCreationServicesService
14803       consumes:
14804         - application/json
14805         - application/xml
14806       produces:
14807         - application/json
14808         - application/xml
14809       responses:
14810         "default":
14811           description: Response codes found in [response codes](https://wiki.onap.org/).
14812       parameters:
14813         - name: service-id
14814           in: path
14815           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14816           required: true
14817           type: string
14818           example: __SERVICE-ID__
14819         - name: resource-version
14820           in: query
14821           description: resource-version for concurrency
14822           required: true
14823           type: string
14824   /service-design-and-creation/services:
14825     get:
14826       tags:
14827         - ServiceDesignAndCreation
14828       summary: returns services
14829       description: returns services
14830       operationId: getServiceDesignAndCreationServices
14831       produces:
14832         - application/json
14833         - application/xml
14834       responses:
14835         "200":
14836           description: successful operation
14837           schema:
14838               $ref: "#/getDefinitions/services"
14839         "default":
14840           description: Response codes found in [response codes](https://wiki.onap.org/).
14841       parameters:
14842         - name: service-id
14843           in: query
14844           description:
14845           required: false
14846           type: string
14847         - name: service-description
14848           in: query
14849           description:
14850           required: false
14851           type: string
14852   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
14853     put:
14854       tags:
14855         - ServiceDesignAndCreation
14856       summary: see node definition for valid relationships
14857       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14858       consumes:
14859         - application/json
14860         - application/xml
14861       produces:
14862         - application/json
14863         - application/xml
14864       responses:
14865         "default":
14866           description: Response codes found in [response codes](https://wiki.onap.org/).
14867       parameters:
14868         - name: service-type
14869           in: path
14870           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14871           required: true
14872           type: string
14873           example: __SERVICE-TYPE__
14874         - name: vnf-type
14875           in: path
14876           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.
14877           required: true
14878           type: string
14879           example: __VNF-TYPE__
14880         - name: body
14881           in: body
14882           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14883           required: true
14884           schema:
14885             $ref: "#/definitions/relationship"
14886     delete:
14887       tags:
14888         - ServiceDesignAndCreation
14889       summary: delete an existing relationship
14890       description: delete an existing relationship
14891       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14892       consumes:
14893         - application/json
14894         - application/xml
14895       produces:
14896         - application/json
14897         - application/xml
14898       responses:
14899         "default":
14900           description: Response codes found in [response codes](https://wiki.onap.org/).
14901       parameters:
14902         - name: service-type
14903           in: path
14904           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14905           required: true
14906           type: string
14907           example: __SERVICE-TYPE__
14908         - name: vnf-type
14909           in: path
14910           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.
14911           required: true
14912           type: string
14913           example: __VNF-TYPE__
14914   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
14915     get:
14916       tags:
14917         - ServiceDesignAndCreation
14918       summary: returns service-capability
14919       description: returns service-capability
14920       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
14921       produces:
14922         - application/json
14923         - application/xml
14924       responses:
14925         "200":
14926           description: successful operation
14927           schema:
14928               $ref: "#/getDefinitions/service-capability"
14929         "default":
14930           description: Response codes found in [response codes](https://wiki.onap.org/).
14931       parameters:
14932         - name: service-type
14933           in: path
14934           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14935           required: true
14936           type: string
14937           example: __SERVICE-TYPE__
14938         - name: vnf-type
14939           in: path
14940           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.
14941           required: true
14942           type: string
14943           example: __VNF-TYPE__
14944     put:
14945       tags:
14946         - ServiceDesignAndCreation
14947       summary: create or update an existing service-capability
14948       description: |
14949         Create or update an existing service-capability.
14950         #
14951         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14952       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14953       consumes:
14954         - application/json
14955         - application/xml
14956       produces:
14957         - application/json
14958         - application/xml
14959       responses:
14960         "default":
14961           description: Response codes found in [response codes](https://wiki.onap.org/).
14962       parameters:
14963         - name: service-type
14964           in: path
14965           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14966           required: true
14967           type: string
14968           example: __SERVICE-TYPE__
14969         - name: vnf-type
14970           in: path
14971           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.
14972           required: true
14973           type: string
14974           example: __VNF-TYPE__
14975         - name: body
14976           in: body
14977           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14978           required: true
14979           schema:
14980             $ref: "#/definitions/service-capability"
14981     patch:
14982       tags:
14983         - ServiceDesignAndCreation
14984       summary: update an existing service-capability
14985       description: |
14986         Update an existing service-capability
14987         #
14988         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14989         The PUT operation will entirely replace an existing object.
14990         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14991         #
14992         Other differences between PUT and PATCH are:
14993         #
14994         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14995         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14996         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14997       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14998       consumes:
14999         - application/json
15000         - application/xml
15001       produces:
15002         - application/json
15003         - application/xml
15004       responses:
15005         "default":
15006           description: Response codes found in [response codes](https://wiki.onap.org/).
15007       parameters:
15008         - name: service-type
15009           in: path
15010           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15011           required: true
15012           type: string
15013           example: __SERVICE-TYPE__
15014         - name: vnf-type
15015           in: path
15016           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.
15017           required: true
15018           type: string
15019           example: __VNF-TYPE__
15020         - name: body
15021           in: body
15022           description: service-capability object that needs to be updated.
15023           required: true
15024           schema:
15025             $ref: "#/patchDefinitions/service-capability"
15026     delete:
15027       tags:
15028         - ServiceDesignAndCreation
15029       summary: delete an existing service-capability
15030       description: delete an existing service-capability
15031       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
15032       consumes:
15033         - application/json
15034         - application/xml
15035       produces:
15036         - application/json
15037         - application/xml
15038       responses:
15039         "default":
15040           description: Response codes found in [response codes](https://wiki.onap.org/).
15041       parameters:
15042         - name: service-type
15043           in: path
15044           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15045           required: true
15046           type: string
15047           example: __SERVICE-TYPE__
15048         - name: vnf-type
15049           in: path
15050           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.
15051           required: true
15052           type: string
15053           example: __VNF-TYPE__
15054         - name: resource-version
15055           in: query
15056           description: resource-version for concurrency
15057           required: true
15058           type: string
15059   /service-design-and-creation/service-capabilities:
15060     get:
15061       tags:
15062         - ServiceDesignAndCreation
15063       summary: returns service-capabilities
15064       description: returns service-capabilities
15065       operationId: getServiceDesignAndCreationServiceCapabilities
15066       produces:
15067         - application/json
15068         - application/xml
15069       responses:
15070         "200":
15071           description: successful operation
15072           schema:
15073               $ref: "#/getDefinitions/service-capabilities"
15074         "default":
15075           description: Response codes found in [response codes](https://wiki.onap.org/).
15076       parameters:
15077         - name: service-type
15078           in: query
15079           description:
15080           required: false
15081           type: string
15082         - name: vnf-type
15083           in: query
15084           description:
15085           required: false
15086           type: string
15087   /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:
15088     put:
15089       tags:
15090         - ServiceDesignAndCreation
15091       summary: see node definition for valid relationships
15092       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
15093       consumes:
15094         - application/json
15095         - application/xml
15096       produces:
15097         - application/json
15098         - application/xml
15099       responses:
15100         "default":
15101           description: Response codes found in [response codes](https://wiki.onap.org/).
15102       parameters:
15103         - name: model-invariant-id
15104           in: path
15105           description: Unique identifier corresponding to the main definition of a model in ASDC
15106           required: true
15107           type: string
15108           example: __MODEL-INVARIANT-ID__
15109         - name: model-version-id
15110           in: path
15111           description: Unique identifier corresponding to one version of a model in ASDC
15112           required: true
15113           type: string
15114           example: __MODEL-VERSION-ID__
15115         - name: model-element-uuid
15116           in: path
15117           required: true
15118           type: string
15119           example: __MODEL-ELEMENT-UUID__
15120         - name: model-constraint-uuid
15121           in: path
15122           required: true
15123           type: string
15124           example: __MODEL-CONSTRAINT-UUID__
15125         - name: constrained-element-set-uuid
15126           in: path
15127           required: true
15128           type: string
15129           example: __CONSTRAINED-ELEMENT-SET-UUID__
15130         - name: element-choice-set-uuid
15131           in: path
15132           required: true
15133           type: string
15134           example: __ELEMENT-CHOICE-SET-UUID__
15135         - name: body
15136           in: body
15137           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
15138           required: true
15139           schema:
15140             $ref: "#/definitions/relationship"
15141     delete:
15142       tags:
15143         - ServiceDesignAndCreation
15144       summary: delete an existing relationship
15145       description: delete an existing relationship
15146       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
15147       consumes:
15148         - application/json
15149         - application/xml
15150       produces:
15151         - application/json
15152         - application/xml
15153       responses:
15154         "default":
15155           description: Response codes found in [response codes](https://wiki.onap.org/).
15156       parameters:
15157         - name: model-invariant-id
15158           in: path
15159           description: Unique identifier corresponding to the main definition of a model in ASDC
15160           required: true
15161           type: string
15162           example: __MODEL-INVARIANT-ID__
15163         - name: model-version-id
15164           in: path
15165           description: Unique identifier corresponding to one version of a model in ASDC
15166           required: true
15167           type: string
15168           example: __MODEL-VERSION-ID__
15169         - name: model-element-uuid
15170           in: path
15171           required: true
15172           type: string
15173           example: __MODEL-ELEMENT-UUID__
15174         - name: model-constraint-uuid
15175           in: path
15176           required: true
15177           type: string
15178           example: __MODEL-CONSTRAINT-UUID__
15179         - name: constrained-element-set-uuid
15180           in: path
15181           required: true
15182           type: string
15183           example: __CONSTRAINED-ELEMENT-SET-UUID__
15184         - name: element-choice-set-uuid
15185           in: path
15186           required: true
15187           type: string
15188           example: __ELEMENT-CHOICE-SET-UUID__
15189   /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}:
15190     get:
15191       tags:
15192         - ServiceDesignAndCreation
15193       summary: returns element-choice-set
15194       description: returns element-choice-set
15195       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15196       produces:
15197         - application/json
15198         - application/xml
15199       responses:
15200         "200":
15201           description: successful operation
15202           schema:
15203               $ref: "#/getDefinitions/element-choice-set"
15204         "default":
15205           description: Response codes found in [response codes](https://wiki.onap.org/).
15206       parameters:
15207         - name: model-invariant-id
15208           in: path
15209           description: Unique identifier corresponding to the main definition of a model in ASDC
15210           required: true
15211           type: string
15212           example: __MODEL-INVARIANT-ID__
15213         - name: model-version-id
15214           in: path
15215           description: Unique identifier corresponding to one version of a model in ASDC
15216           required: true
15217           type: string
15218           example: __MODEL-VERSION-ID__
15219         - name: model-element-uuid
15220           in: path
15221           required: true
15222           type: string
15223           example: __MODEL-ELEMENT-UUID__
15224         - name: model-constraint-uuid
15225           in: path
15226           required: true
15227           type: string
15228           example: __MODEL-CONSTRAINT-UUID__
15229         - name: constrained-element-set-uuid
15230           in: path
15231           required: true
15232           type: string
15233           example: __CONSTRAINED-ELEMENT-SET-UUID__
15234         - name: element-choice-set-uuid
15235           in: path
15236           required: true
15237           type: string
15238           example: __ELEMENT-CHOICE-SET-UUID__
15239     put:
15240       tags:
15241         - ServiceDesignAndCreation
15242       summary: create or update an existing element-choice-set
15243       description: |
15244         Create or update an existing element-choice-set.
15245         #
15246         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15247       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15248       consumes:
15249         - application/json
15250         - application/xml
15251       produces:
15252         - application/json
15253         - application/xml
15254       responses:
15255         "default":
15256           description: Response codes found in [response codes](https://wiki.onap.org/).
15257       parameters:
15258         - name: model-invariant-id
15259           in: path
15260           description: Unique identifier corresponding to the main definition of a model in ASDC
15261           required: true
15262           type: string
15263           example: __MODEL-INVARIANT-ID__
15264         - name: model-version-id
15265           in: path
15266           description: Unique identifier corresponding to one version of a model in ASDC
15267           required: true
15268           type: string
15269           example: __MODEL-VERSION-ID__
15270         - name: model-element-uuid
15271           in: path
15272           required: true
15273           type: string
15274           example: __MODEL-ELEMENT-UUID__
15275         - name: model-constraint-uuid
15276           in: path
15277           required: true
15278           type: string
15279           example: __MODEL-CONSTRAINT-UUID__
15280         - name: constrained-element-set-uuid
15281           in: path
15282           required: true
15283           type: string
15284           example: __CONSTRAINED-ELEMENT-SET-UUID__
15285         - name: element-choice-set-uuid
15286           in: path
15287           required: true
15288           type: string
15289           example: __ELEMENT-CHOICE-SET-UUID__
15290         - name: body
15291           in: body
15292           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
15293           required: true
15294           schema:
15295             $ref: "#/definitions/element-choice-set"
15296     patch:
15297       tags:
15298         - ServiceDesignAndCreation
15299       summary: update an existing element-choice-set
15300       description: |
15301         Update an existing element-choice-set
15302         #
15303         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15304         The PUT operation will entirely replace an existing object.
15305         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15306         #
15307         Other differences between PUT and PATCH are:
15308         #
15309         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15310         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15311         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15312       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15313       consumes:
15314         - application/json
15315         - application/xml
15316       produces:
15317         - application/json
15318         - application/xml
15319       responses:
15320         "default":
15321           description: Response codes found in [response codes](https://wiki.onap.org/).
15322       parameters:
15323         - name: model-invariant-id
15324           in: path
15325           description: Unique identifier corresponding to the main definition of a model in ASDC
15326           required: true
15327           type: string
15328           example: __MODEL-INVARIANT-ID__
15329         - name: model-version-id
15330           in: path
15331           description: Unique identifier corresponding to one version of a model in ASDC
15332           required: true
15333           type: string
15334           example: __MODEL-VERSION-ID__
15335         - name: model-element-uuid
15336           in: path
15337           required: true
15338           type: string
15339           example: __MODEL-ELEMENT-UUID__
15340         - name: model-constraint-uuid
15341           in: path
15342           required: true
15343           type: string
15344           example: __MODEL-CONSTRAINT-UUID__
15345         - name: constrained-element-set-uuid
15346           in: path
15347           required: true
15348           type: string
15349           example: __CONSTRAINED-ELEMENT-SET-UUID__
15350         - name: element-choice-set-uuid
15351           in: path
15352           required: true
15353           type: string
15354           example: __ELEMENT-CHOICE-SET-UUID__
15355         - name: body
15356           in: body
15357           description: element-choice-set object that needs to be updated.
15358           required: true
15359           schema:
15360             $ref: "#/patchDefinitions/element-choice-set"
15361     delete:
15362       tags:
15363         - ServiceDesignAndCreation
15364       summary: delete an existing element-choice-set
15365       description: delete an existing element-choice-set
15366       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15367       consumes:
15368         - application/json
15369         - application/xml
15370       produces:
15371         - application/json
15372         - application/xml
15373       responses:
15374         "default":
15375           description: Response codes found in [response codes](https://wiki.onap.org/).
15376       parameters:
15377         - name: model-invariant-id
15378           in: path
15379           description: Unique identifier corresponding to the main definition of a model in ASDC
15380           required: true
15381           type: string
15382           example: __MODEL-INVARIANT-ID__
15383         - name: model-version-id
15384           in: path
15385           description: Unique identifier corresponding to one version of a model in ASDC
15386           required: true
15387           type: string
15388           example: __MODEL-VERSION-ID__
15389         - name: model-element-uuid
15390           in: path
15391           required: true
15392           type: string
15393           example: __MODEL-ELEMENT-UUID__
15394         - name: model-constraint-uuid
15395           in: path
15396           required: true
15397           type: string
15398           example: __MODEL-CONSTRAINT-UUID__
15399         - name: constrained-element-set-uuid
15400           in: path
15401           required: true
15402           type: string
15403           example: __CONSTRAINED-ELEMENT-SET-UUID__
15404         - name: element-choice-set-uuid
15405           in: path
15406           required: true
15407           type: string
15408           example: __ELEMENT-CHOICE-SET-UUID__
15409         - name: resource-version
15410           in: query
15411           description: resource-version for concurrency
15412           required: true
15413           type: string
15414   /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:
15415     get:
15416       tags:
15417         - ServiceDesignAndCreation
15418       summary: returns element-choice-sets
15419       description: returns element-choice-sets
15420       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
15421       produces:
15422         - application/json
15423         - application/xml
15424       responses:
15425         "200":
15426           description: successful operation
15427           schema:
15428               $ref: "#/getDefinitions/element-choice-sets"
15429         "default":
15430           description: Response codes found in [response codes](https://wiki.onap.org/).
15431       parameters:
15432         - name: model-invariant-id
15433           in: path
15434           description: Unique identifier corresponding to the main definition of a model in ASDC
15435           required: true
15436           type: string
15437           example: __MODEL-INVARIANT-ID__
15438         - name: model-version-id
15439           in: path
15440           description: Unique identifier corresponding to one version of a model in ASDC
15441           required: true
15442           type: string
15443           example: __MODEL-VERSION-ID__
15444         - name: model-element-uuid
15445           in: path
15446           required: true
15447           type: string
15448           example: __MODEL-ELEMENT-UUID__
15449         - name: model-constraint-uuid
15450           in: path
15451           required: true
15452           type: string
15453           example: __MODEL-CONSTRAINT-UUID__
15454         - name: constrained-element-set-uuid
15455           in: path
15456           required: true
15457           type: string
15458           example: __CONSTRAINED-ELEMENT-SET-UUID__
15459         - name: element-choice-set-uuid
15460           in: query
15461           description:
15462           required: false
15463           type: string
15464   /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:
15465     put:
15466       tags:
15467         - ServiceDesignAndCreation
15468       summary: see node definition for valid relationships
15469       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
15470       consumes:
15471         - application/json
15472         - application/xml
15473       produces:
15474         - application/json
15475         - application/xml
15476       responses:
15477         "default":
15478           description: Response codes found in [response codes](https://wiki.onap.org/).
15479       parameters:
15480         - name: model-invariant-id
15481           in: path
15482           description: Unique identifier corresponding to the main definition of a model in ASDC
15483           required: true
15484           type: string
15485           example: __MODEL-INVARIANT-ID__
15486         - name: model-version-id
15487           in: path
15488           description: Unique identifier corresponding to one version of a model in ASDC
15489           required: true
15490           type: string
15491           example: __MODEL-VERSION-ID__
15492         - name: model-element-uuid
15493           in: path
15494           required: true
15495           type: string
15496           example: __MODEL-ELEMENT-UUID__
15497         - name: model-constraint-uuid
15498           in: path
15499           required: true
15500           type: string
15501           example: __MODEL-CONSTRAINT-UUID__
15502         - name: constrained-element-set-uuid
15503           in: path
15504           required: true
15505           type: string
15506           example: __CONSTRAINED-ELEMENT-SET-UUID__
15507         - name: body
15508           in: body
15509           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
15510           required: true
15511           schema:
15512             $ref: "#/definitions/relationship"
15513     delete:
15514       tags:
15515         - ServiceDesignAndCreation
15516       summary: delete an existing relationship
15517       description: delete an existing relationship
15518       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
15519       consumes:
15520         - application/json
15521         - application/xml
15522       produces:
15523         - application/json
15524         - application/xml
15525       responses:
15526         "default":
15527           description: Response codes found in [response codes](https://wiki.onap.org/).
15528       parameters:
15529         - name: model-invariant-id
15530           in: path
15531           description: Unique identifier corresponding to the main definition of a model in ASDC
15532           required: true
15533           type: string
15534           example: __MODEL-INVARIANT-ID__
15535         - name: model-version-id
15536           in: path
15537           description: Unique identifier corresponding to one version of a model in ASDC
15538           required: true
15539           type: string
15540           example: __MODEL-VERSION-ID__
15541         - name: model-element-uuid
15542           in: path
15543           required: true
15544           type: string
15545           example: __MODEL-ELEMENT-UUID__
15546         - name: model-constraint-uuid
15547           in: path
15548           required: true
15549           type: string
15550           example: __MODEL-CONSTRAINT-UUID__
15551         - name: constrained-element-set-uuid
15552           in: path
15553           required: true
15554           type: string
15555           example: __CONSTRAINED-ELEMENT-SET-UUID__
15556   /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}:
15557     get:
15558       tags:
15559         - ServiceDesignAndCreation
15560       summary: returns constrained-element-set
15561       description: returns constrained-element-set
15562       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15563       produces:
15564         - application/json
15565         - application/xml
15566       responses:
15567         "200":
15568           description: successful operation
15569           schema:
15570               $ref: "#/getDefinitions/constrained-element-set"
15571         "default":
15572           description: Response codes found in [response codes](https://wiki.onap.org/).
15573       parameters:
15574         - name: model-invariant-id
15575           in: path
15576           description: Unique identifier corresponding to the main definition of a model in ASDC
15577           required: true
15578           type: string
15579           example: __MODEL-INVARIANT-ID__
15580         - name: model-version-id
15581           in: path
15582           description: Unique identifier corresponding to one version of a model in ASDC
15583           required: true
15584           type: string
15585           example: __MODEL-VERSION-ID__
15586         - name: model-element-uuid
15587           in: path
15588           required: true
15589           type: string
15590           example: __MODEL-ELEMENT-UUID__
15591         - name: model-constraint-uuid
15592           in: path
15593           required: true
15594           type: string
15595           example: __MODEL-CONSTRAINT-UUID__
15596         - name: constrained-element-set-uuid
15597           in: path
15598           required: true
15599           type: string
15600           example: __CONSTRAINED-ELEMENT-SET-UUID__
15601     put:
15602       tags:
15603         - ServiceDesignAndCreation
15604       summary: create or update an existing constrained-element-set
15605       description: |
15606         Create or update an existing constrained-element-set.
15607         #
15608         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15609       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15610       consumes:
15611         - application/json
15612         - application/xml
15613       produces:
15614         - application/json
15615         - application/xml
15616       responses:
15617         "default":
15618           description: Response codes found in [response codes](https://wiki.onap.org/).
15619       parameters:
15620         - name: model-invariant-id
15621           in: path
15622           description: Unique identifier corresponding to the main definition of a model in ASDC
15623           required: true
15624           type: string
15625           example: __MODEL-INVARIANT-ID__
15626         - name: model-version-id
15627           in: path
15628           description: Unique identifier corresponding to one version of a model in ASDC
15629           required: true
15630           type: string
15631           example: __MODEL-VERSION-ID__
15632         - name: model-element-uuid
15633           in: path
15634           required: true
15635           type: string
15636           example: __MODEL-ELEMENT-UUID__
15637         - name: model-constraint-uuid
15638           in: path
15639           required: true
15640           type: string
15641           example: __MODEL-CONSTRAINT-UUID__
15642         - name: constrained-element-set-uuid
15643           in: path
15644           required: true
15645           type: string
15646           example: __CONSTRAINED-ELEMENT-SET-UUID__
15647         - name: body
15648           in: body
15649           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
15650           required: true
15651           schema:
15652             $ref: "#/definitions/constrained-element-set"
15653     patch:
15654       tags:
15655         - ServiceDesignAndCreation
15656       summary: update an existing constrained-element-set
15657       description: |
15658         Update an existing constrained-element-set
15659         #
15660         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15661         The PUT operation will entirely replace an existing object.
15662         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15663         #
15664         Other differences between PUT and PATCH are:
15665         #
15666         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15667         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15668         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15669       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15670       consumes:
15671         - application/json
15672         - application/xml
15673       produces:
15674         - application/json
15675         - application/xml
15676       responses:
15677         "default":
15678           description: Response codes found in [response codes](https://wiki.onap.org/).
15679       parameters:
15680         - name: model-invariant-id
15681           in: path
15682           description: Unique identifier corresponding to the main definition of a model in ASDC
15683           required: true
15684           type: string
15685           example: __MODEL-INVARIANT-ID__
15686         - name: model-version-id
15687           in: path
15688           description: Unique identifier corresponding to one version of a model in ASDC
15689           required: true
15690           type: string
15691           example: __MODEL-VERSION-ID__
15692         - name: model-element-uuid
15693           in: path
15694           required: true
15695           type: string
15696           example: __MODEL-ELEMENT-UUID__
15697         - name: model-constraint-uuid
15698           in: path
15699           required: true
15700           type: string
15701           example: __MODEL-CONSTRAINT-UUID__
15702         - name: constrained-element-set-uuid
15703           in: path
15704           required: true
15705           type: string
15706           example: __CONSTRAINED-ELEMENT-SET-UUID__
15707         - name: body
15708           in: body
15709           description: constrained-element-set object that needs to be updated.
15710           required: true
15711           schema:
15712             $ref: "#/patchDefinitions/constrained-element-set"
15713     delete:
15714       tags:
15715         - ServiceDesignAndCreation
15716       summary: delete an existing constrained-element-set
15717       description: delete an existing constrained-element-set
15718       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15719       consumes:
15720         - application/json
15721         - application/xml
15722       produces:
15723         - application/json
15724         - application/xml
15725       responses:
15726         "default":
15727           description: Response codes found in [response codes](https://wiki.onap.org/).
15728       parameters:
15729         - name: model-invariant-id
15730           in: path
15731           description: Unique identifier corresponding to the main definition of a model in ASDC
15732           required: true
15733           type: string
15734           example: __MODEL-INVARIANT-ID__
15735         - name: model-version-id
15736           in: path
15737           description: Unique identifier corresponding to one version of a model in ASDC
15738           required: true
15739           type: string
15740           example: __MODEL-VERSION-ID__
15741         - name: model-element-uuid
15742           in: path
15743           required: true
15744           type: string
15745           example: __MODEL-ELEMENT-UUID__
15746         - name: model-constraint-uuid
15747           in: path
15748           required: true
15749           type: string
15750           example: __MODEL-CONSTRAINT-UUID__
15751         - name: constrained-element-set-uuid
15752           in: path
15753           required: true
15754           type: string
15755           example: __CONSTRAINED-ELEMENT-SET-UUID__
15756         - name: resource-version
15757           in: query
15758           description: resource-version for concurrency
15759           required: true
15760           type: string
15761   /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:
15762     get:
15763       tags:
15764         - ServiceDesignAndCreation
15765       summary: returns constrained-element-sets
15766       description: returns constrained-element-sets
15767       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
15768       produces:
15769         - application/json
15770         - application/xml
15771       responses:
15772         "200":
15773           description: successful operation
15774           schema:
15775               $ref: "#/getDefinitions/constrained-element-sets"
15776         "default":
15777           description: Response codes found in [response codes](https://wiki.onap.org/).
15778       parameters:
15779         - name: model-invariant-id
15780           in: path
15781           description: Unique identifier corresponding to the main definition of a model in ASDC
15782           required: true
15783           type: string
15784           example: __MODEL-INVARIANT-ID__
15785         - name: model-version-id
15786           in: path
15787           description: Unique identifier corresponding to one version of a model in ASDC
15788           required: true
15789           type: string
15790           example: __MODEL-VERSION-ID__
15791         - name: model-element-uuid
15792           in: path
15793           required: true
15794           type: string
15795           example: __MODEL-ELEMENT-UUID__
15796         - name: model-constraint-uuid
15797           in: path
15798           required: true
15799           type: string
15800           example: __MODEL-CONSTRAINT-UUID__
15801         - name: constrained-element-set-uuid
15802           in: query
15803           description:
15804           required: false
15805           type: string
15806   /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}:
15807     get:
15808       tags:
15809         - ServiceDesignAndCreation
15810       summary: returns model-constraint
15811       description: returns model-constraint
15812       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15813       produces:
15814         - application/json
15815         - application/xml
15816       responses:
15817         "200":
15818           description: successful operation
15819           schema:
15820               $ref: "#/getDefinitions/model-constraint"
15821         "default":
15822           description: Response codes found in [response codes](https://wiki.onap.org/).
15823       parameters:
15824         - name: model-invariant-id
15825           in: path
15826           description: Unique identifier corresponding to the main definition of a model in ASDC
15827           required: true
15828           type: string
15829           example: __MODEL-INVARIANT-ID__
15830         - name: model-version-id
15831           in: path
15832           description: Unique identifier corresponding to one version of a model in ASDC
15833           required: true
15834           type: string
15835           example: __MODEL-VERSION-ID__
15836         - name: model-element-uuid
15837           in: path
15838           required: true
15839           type: string
15840           example: __MODEL-ELEMENT-UUID__
15841         - name: model-constraint-uuid
15842           in: path
15843           required: true
15844           type: string
15845           example: __MODEL-CONSTRAINT-UUID__
15846     put:
15847       tags:
15848         - ServiceDesignAndCreation
15849       summary: create or update an existing model-constraint
15850       description: |
15851         Create or update an existing model-constraint.
15852         #
15853         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15854       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15855       consumes:
15856         - application/json
15857         - application/xml
15858       produces:
15859         - application/json
15860         - application/xml
15861       responses:
15862         "default":
15863           description: Response codes found in [response codes](https://wiki.onap.org/).
15864       parameters:
15865         - name: model-invariant-id
15866           in: path
15867           description: Unique identifier corresponding to the main definition of a model in ASDC
15868           required: true
15869           type: string
15870           example: __MODEL-INVARIANT-ID__
15871         - name: model-version-id
15872           in: path
15873           description: Unique identifier corresponding to one version of a model in ASDC
15874           required: true
15875           type: string
15876           example: __MODEL-VERSION-ID__
15877         - name: model-element-uuid
15878           in: path
15879           required: true
15880           type: string
15881           example: __MODEL-ELEMENT-UUID__
15882         - name: model-constraint-uuid
15883           in: path
15884           required: true
15885           type: string
15886           example: __MODEL-CONSTRAINT-UUID__
15887         - name: body
15888           in: body
15889           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
15890           required: true
15891           schema:
15892             $ref: "#/definitions/model-constraint"
15893     patch:
15894       tags:
15895         - ServiceDesignAndCreation
15896       summary: update an existing model-constraint
15897       description: |
15898         Update an existing model-constraint
15899         #
15900         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15901         The PUT operation will entirely replace an existing object.
15902         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15903         #
15904         Other differences between PUT and PATCH are:
15905         #
15906         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15907         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15908         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15909       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15910       consumes:
15911         - application/json
15912         - application/xml
15913       produces:
15914         - application/json
15915         - application/xml
15916       responses:
15917         "default":
15918           description: Response codes found in [response codes](https://wiki.onap.org/).
15919       parameters:
15920         - name: model-invariant-id
15921           in: path
15922           description: Unique identifier corresponding to the main definition of a model in ASDC
15923           required: true
15924           type: string
15925           example: __MODEL-INVARIANT-ID__
15926         - name: model-version-id
15927           in: path
15928           description: Unique identifier corresponding to one version of a model in ASDC
15929           required: true
15930           type: string
15931           example: __MODEL-VERSION-ID__
15932         - name: model-element-uuid
15933           in: path
15934           required: true
15935           type: string
15936           example: __MODEL-ELEMENT-UUID__
15937         - name: model-constraint-uuid
15938           in: path
15939           required: true
15940           type: string
15941           example: __MODEL-CONSTRAINT-UUID__
15942         - name: body
15943           in: body
15944           description: model-constraint object that needs to be updated.
15945           required: true
15946           schema:
15947             $ref: "#/patchDefinitions/model-constraint"
15948     delete:
15949       tags:
15950         - ServiceDesignAndCreation
15951       summary: delete an existing model-constraint
15952       description: delete an existing model-constraint
15953       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15954       consumes:
15955         - application/json
15956         - application/xml
15957       produces:
15958         - application/json
15959         - application/xml
15960       responses:
15961         "default":
15962           description: Response codes found in [response codes](https://wiki.onap.org/).
15963       parameters:
15964         - name: model-invariant-id
15965           in: path
15966           description: Unique identifier corresponding to the main definition of a model in ASDC
15967           required: true
15968           type: string
15969           example: __MODEL-INVARIANT-ID__
15970         - name: model-version-id
15971           in: path
15972           description: Unique identifier corresponding to one version of a model in ASDC
15973           required: true
15974           type: string
15975           example: __MODEL-VERSION-ID__
15976         - name: model-element-uuid
15977           in: path
15978           required: true
15979           type: string
15980           example: __MODEL-ELEMENT-UUID__
15981         - name: model-constraint-uuid
15982           in: path
15983           required: true
15984           type: string
15985           example: __MODEL-CONSTRAINT-UUID__
15986         - name: resource-version
15987           in: query
15988           description: resource-version for concurrency
15989           required: true
15990           type: string
15991   /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:
15992     get:
15993       tags:
15994         - ServiceDesignAndCreation
15995       summary: returns model-constraints
15996       description: returns model-constraints
15997       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
15998       produces:
15999         - application/json
16000         - application/xml
16001       responses:
16002         "200":
16003           description: successful operation
16004           schema:
16005               $ref: "#/getDefinitions/model-constraints"
16006         "default":
16007           description: Response codes found in [response codes](https://wiki.onap.org/).
16008       parameters:
16009         - name: model-invariant-id
16010           in: path
16011           description: Unique identifier corresponding to the main definition of a model in ASDC
16012           required: true
16013           type: string
16014           example: __MODEL-INVARIANT-ID__
16015         - name: model-version-id
16016           in: path
16017           description: Unique identifier corresponding to one version of a model in ASDC
16018           required: true
16019           type: string
16020           example: __MODEL-VERSION-ID__
16021         - name: model-element-uuid
16022           in: path
16023           required: true
16024           type: string
16025           example: __MODEL-ELEMENT-UUID__
16026         - name: model-constraint-uuid
16027           in: query
16028           description:
16029           required: false
16030           type: string
16031   /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:
16032     put:
16033       tags:
16034         - ServiceDesignAndCreation
16035       summary: see node definition for valid relationships
16036       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
16037       consumes:
16038         - application/json
16039         - application/xml
16040       produces:
16041         - application/json
16042         - application/xml
16043       responses:
16044         "default":
16045           description: Response codes found in [response codes](https://wiki.onap.org/).
16046       parameters:
16047         - name: model-invariant-id
16048           in: path
16049           description: Unique identifier corresponding to the main definition of a model in ASDC
16050           required: true
16051           type: string
16052           example: __MODEL-INVARIANT-ID__
16053         - name: model-version-id
16054           in: path
16055           description: Unique identifier corresponding to one version of a model in ASDC
16056           required: true
16057           type: string
16058           example: __MODEL-VERSION-ID__
16059         - name: model-element-uuid
16060           in: path
16061           required: true
16062           type: string
16063           example: __MODEL-ELEMENT-UUID__
16064         - name: body
16065           in: body
16066           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
16067           required: true
16068           schema:
16069             $ref: "#/definitions/relationship"
16070     delete:
16071       tags:
16072         - ServiceDesignAndCreation
16073       summary: delete an existing relationship
16074       description: delete an existing relationship
16075       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
16076       consumes:
16077         - application/json
16078         - application/xml
16079       produces:
16080         - application/json
16081         - application/xml
16082       responses:
16083         "default":
16084           description: Response codes found in [response codes](https://wiki.onap.org/).
16085       parameters:
16086         - name: model-invariant-id
16087           in: path
16088           description: Unique identifier corresponding to the main definition of a model in ASDC
16089           required: true
16090           type: string
16091           example: __MODEL-INVARIANT-ID__
16092         - name: model-version-id
16093           in: path
16094           description: Unique identifier corresponding to one version of a model in ASDC
16095           required: true
16096           type: string
16097           example: __MODEL-VERSION-ID__
16098         - name: model-element-uuid
16099           in: path
16100           required: true
16101           type: string
16102           example: __MODEL-ELEMENT-UUID__
16103   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
16104     get:
16105       tags:
16106         - ServiceDesignAndCreation
16107       summary: returns model-element
16108       description: returns model-element
16109       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16110       produces:
16111         - application/json
16112         - application/xml
16113       responses:
16114         "200":
16115           description: successful operation
16116           schema:
16117               $ref: "#/getDefinitions/model-element"
16118         "default":
16119           description: Response codes found in [response codes](https://wiki.onap.org/).
16120       parameters:
16121         - name: model-invariant-id
16122           in: path
16123           description: Unique identifier corresponding to the main definition of a model in ASDC
16124           required: true
16125           type: string
16126           example: __MODEL-INVARIANT-ID__
16127         - name: model-version-id
16128           in: path
16129           description: Unique identifier corresponding to one version of a model in ASDC
16130           required: true
16131           type: string
16132           example: __MODEL-VERSION-ID__
16133         - name: model-element-uuid
16134           in: path
16135           required: true
16136           type: string
16137           example: __MODEL-ELEMENT-UUID__
16138     put:
16139       tags:
16140         - ServiceDesignAndCreation
16141       summary: create or update an existing model-element
16142       description: |
16143         Create or update an existing model-element.
16144         #
16145         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16146       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16147       consumes:
16148         - application/json
16149         - application/xml
16150       produces:
16151         - application/json
16152         - application/xml
16153       responses:
16154         "default":
16155           description: Response codes found in [response codes](https://wiki.onap.org/).
16156       parameters:
16157         - name: model-invariant-id
16158           in: path
16159           description: Unique identifier corresponding to the main definition of a model in ASDC
16160           required: true
16161           type: string
16162           example: __MODEL-INVARIANT-ID__
16163         - name: model-version-id
16164           in: path
16165           description: Unique identifier corresponding to one version of a model in ASDC
16166           required: true
16167           type: string
16168           example: __MODEL-VERSION-ID__
16169         - name: model-element-uuid
16170           in: path
16171           required: true
16172           type: string
16173           example: __MODEL-ELEMENT-UUID__
16174         - name: body
16175           in: body
16176           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
16177           required: true
16178           schema:
16179             $ref: "#/definitions/model-element"
16180     patch:
16181       tags:
16182         - ServiceDesignAndCreation
16183       summary: update an existing model-element
16184       description: |
16185         Update an existing model-element
16186         #
16187         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16188         The PUT operation will entirely replace an existing object.
16189         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16190         #
16191         Other differences between PUT and PATCH are:
16192         #
16193         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16194         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16195         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16196       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16197       consumes:
16198         - application/json
16199         - application/xml
16200       produces:
16201         - application/json
16202         - application/xml
16203       responses:
16204         "default":
16205           description: Response codes found in [response codes](https://wiki.onap.org/).
16206       parameters:
16207         - name: model-invariant-id
16208           in: path
16209           description: Unique identifier corresponding to the main definition of a model in ASDC
16210           required: true
16211           type: string
16212           example: __MODEL-INVARIANT-ID__
16213         - name: model-version-id
16214           in: path
16215           description: Unique identifier corresponding to one version of a model in ASDC
16216           required: true
16217           type: string
16218           example: __MODEL-VERSION-ID__
16219         - name: model-element-uuid
16220           in: path
16221           required: true
16222           type: string
16223           example: __MODEL-ELEMENT-UUID__
16224         - name: body
16225           in: body
16226           description: model-element object that needs to be updated.
16227           required: true
16228           schema:
16229             $ref: "#/patchDefinitions/model-element"
16230     delete:
16231       tags:
16232         - ServiceDesignAndCreation
16233       summary: delete an existing model-element
16234       description: delete an existing model-element
16235       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16236       consumes:
16237         - application/json
16238         - application/xml
16239       produces:
16240         - application/json
16241         - application/xml
16242       responses:
16243         "default":
16244           description: Response codes found in [response codes](https://wiki.onap.org/).
16245       parameters:
16246         - name: model-invariant-id
16247           in: path
16248           description: Unique identifier corresponding to the main definition of a model in ASDC
16249           required: true
16250           type: string
16251           example: __MODEL-INVARIANT-ID__
16252         - name: model-version-id
16253           in: path
16254           description: Unique identifier corresponding to one version of a model in ASDC
16255           required: true
16256           type: string
16257           example: __MODEL-VERSION-ID__
16258         - name: model-element-uuid
16259           in: path
16260           required: true
16261           type: string
16262           example: __MODEL-ELEMENT-UUID__
16263         - name: resource-version
16264           in: query
16265           description: resource-version for concurrency
16266           required: true
16267           type: string
16268   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
16269     get:
16270       tags:
16271         - ServiceDesignAndCreation
16272       summary: returns model-elements
16273       description: returns model-elements
16274       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
16275       produces:
16276         - application/json
16277         - application/xml
16278       responses:
16279         "200":
16280           description: successful operation
16281           schema:
16282               $ref: "#/getDefinitions/model-elements"
16283         "default":
16284           description: Response codes found in [response codes](https://wiki.onap.org/).
16285       parameters:
16286         - name: model-invariant-id
16287           in: path
16288           description: Unique identifier corresponding to the main definition of a model in ASDC
16289           required: true
16290           type: string
16291           example: __MODEL-INVARIANT-ID__
16292         - name: model-version-id
16293           in: path
16294           description: Unique identifier corresponding to one version of a model in ASDC
16295           required: true
16296           type: string
16297           example: __MODEL-VERSION-ID__
16298         - name: model-element-uuid
16299           in: query
16300           description:
16301           required: false
16302           type: string
16303   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
16304     get:
16305       tags:
16306         - ServiceDesignAndCreation
16307       summary: returns metadatum
16308       description: returns metadatum
16309       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16310       produces:
16311         - application/json
16312         - application/xml
16313       responses:
16314         "200":
16315           description: successful operation
16316           schema:
16317               $ref: "#/getDefinitions/metadatum"
16318         "default":
16319           description: Response codes found in [response codes](https://wiki.onap.org/).
16320       parameters:
16321         - name: model-invariant-id
16322           in: path
16323           description: Unique identifier corresponding to the main definition of a model in ASDC
16324           required: true
16325           type: string
16326           example: __MODEL-INVARIANT-ID__
16327         - name: model-version-id
16328           in: path
16329           description: Unique identifier corresponding to one version of a model in ASDC
16330           required: true
16331           type: string
16332           example: __MODEL-VERSION-ID__
16333         - name: metaname
16334           in: path
16335           required: true
16336           type: string
16337           example: __METANAME__
16338     put:
16339       tags:
16340         - ServiceDesignAndCreation
16341       summary: create or update an existing metadatum
16342       description: |
16343         Create or update an existing metadatum.
16344         #
16345         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16346       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16347       consumes:
16348         - application/json
16349         - application/xml
16350       produces:
16351         - application/json
16352         - application/xml
16353       responses:
16354         "default":
16355           description: Response codes found in [response codes](https://wiki.onap.org/).
16356       parameters:
16357         - name: model-invariant-id
16358           in: path
16359           description: Unique identifier corresponding to the main definition of a model in ASDC
16360           required: true
16361           type: string
16362           example: __MODEL-INVARIANT-ID__
16363         - name: model-version-id
16364           in: path
16365           description: Unique identifier corresponding to one version of a model in ASDC
16366           required: true
16367           type: string
16368           example: __MODEL-VERSION-ID__
16369         - name: metaname
16370           in: path
16371           required: true
16372           type: string
16373           example: __METANAME__
16374         - name: body
16375           in: body
16376           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
16377           required: true
16378           schema:
16379             $ref: "#/definitions/metadatum"
16380     patch:
16381       tags:
16382         - ServiceDesignAndCreation
16383       summary: update an existing metadatum
16384       description: |
16385         Update an existing metadatum
16386         #
16387         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16388         The PUT operation will entirely replace an existing object.
16389         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16390         #
16391         Other differences between PUT and PATCH are:
16392         #
16393         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16394         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16395         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16396       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16397       consumes:
16398         - application/json
16399         - application/xml
16400       produces:
16401         - application/json
16402         - application/xml
16403       responses:
16404         "default":
16405           description: Response codes found in [response codes](https://wiki.onap.org/).
16406       parameters:
16407         - name: model-invariant-id
16408           in: path
16409           description: Unique identifier corresponding to the main definition of a model in ASDC
16410           required: true
16411           type: string
16412           example: __MODEL-INVARIANT-ID__
16413         - name: model-version-id
16414           in: path
16415           description: Unique identifier corresponding to one version of a model in ASDC
16416           required: true
16417           type: string
16418           example: __MODEL-VERSION-ID__
16419         - name: metaname
16420           in: path
16421           required: true
16422           type: string
16423           example: __METANAME__
16424         - name: body
16425           in: body
16426           description: metadatum object that needs to be updated.
16427           required: true
16428           schema:
16429             $ref: "#/patchDefinitions/metadatum"
16430     delete:
16431       tags:
16432         - ServiceDesignAndCreation
16433       summary: delete an existing metadatum
16434       description: delete an existing metadatum
16435       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16436       consumes:
16437         - application/json
16438         - application/xml
16439       produces:
16440         - application/json
16441         - application/xml
16442       responses:
16443         "default":
16444           description: Response codes found in [response codes](https://wiki.onap.org/).
16445       parameters:
16446         - name: model-invariant-id
16447           in: path
16448           description: Unique identifier corresponding to the main definition of a model in ASDC
16449           required: true
16450           type: string
16451           example: __MODEL-INVARIANT-ID__
16452         - name: model-version-id
16453           in: path
16454           description: Unique identifier corresponding to one version of a model in ASDC
16455           required: true
16456           type: string
16457           example: __MODEL-VERSION-ID__
16458         - name: metaname
16459           in: path
16460           required: true
16461           type: string
16462           example: __METANAME__
16463         - name: resource-version
16464           in: query
16465           description: resource-version for concurrency
16466           required: true
16467           type: string
16468   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
16469     get:
16470       tags:
16471         - ServiceDesignAndCreation
16472       summary: returns metadata
16473       description: returns metadata
16474       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
16475       produces:
16476         - application/json
16477         - application/xml
16478       responses:
16479         "200":
16480           description: successful operation
16481           schema:
16482               $ref: "#/getDefinitions/metadata"
16483         "default":
16484           description: Response codes found in [response codes](https://wiki.onap.org/).
16485       parameters:
16486         - name: model-invariant-id
16487           in: path
16488           description: Unique identifier corresponding to the main definition of a model in ASDC
16489           required: true
16490           type: string
16491           example: __MODEL-INVARIANT-ID__
16492         - name: model-version-id
16493           in: path
16494           description: Unique identifier corresponding to one version of a model in ASDC
16495           required: true
16496           type: string
16497           example: __MODEL-VERSION-ID__
16498         - name: metaname
16499           in: query
16500           description:
16501           required: false
16502           type: string
16503   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
16504     put:
16505       tags:
16506         - ServiceDesignAndCreation
16507       summary: see node definition for valid relationships
16508       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
16509       consumes:
16510         - application/json
16511         - application/xml
16512       produces:
16513         - application/json
16514         - application/xml
16515       responses:
16516         "default":
16517           description: Response codes found in [response codes](https://wiki.onap.org/).
16518       parameters:
16519         - name: model-invariant-id
16520           in: path
16521           description: Unique identifier corresponding to the main definition of a model in ASDC
16522           required: true
16523           type: string
16524           example: __MODEL-INVARIANT-ID__
16525         - name: model-version-id
16526           in: path
16527           description: Unique identifier corresponding to one version of a model in ASDC
16528           required: true
16529           type: string
16530           example: __MODEL-VERSION-ID__
16531         - name: body
16532           in: body
16533           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
16534           required: true
16535           schema:
16536             $ref: "#/definitions/relationship"
16537     delete:
16538       tags:
16539         - ServiceDesignAndCreation
16540       summary: delete an existing relationship
16541       description: delete an existing relationship
16542       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
16543       consumes:
16544         - application/json
16545         - application/xml
16546       produces:
16547         - application/json
16548         - application/xml
16549       responses:
16550         "default":
16551           description: Response codes found in [response codes](https://wiki.onap.org/).
16552       parameters:
16553         - name: model-invariant-id
16554           in: path
16555           description: Unique identifier corresponding to the main definition of a model in ASDC
16556           required: true
16557           type: string
16558           example: __MODEL-INVARIANT-ID__
16559         - name: model-version-id
16560           in: path
16561           description: Unique identifier corresponding to one version of a model in ASDC
16562           required: true
16563           type: string
16564           example: __MODEL-VERSION-ID__
16565   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
16566     get:
16567       tags:
16568         - ServiceDesignAndCreation
16569       summary: returns model-ver
16570       description: returns model-ver
16571       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
16572       produces:
16573         - application/json
16574         - application/xml
16575       responses:
16576         "200":
16577           description: successful operation
16578           schema:
16579               $ref: "#/getDefinitions/model-ver"
16580         "default":
16581           description: Response codes found in [response codes](https://wiki.onap.org/).
16582       parameters:
16583         - name: model-invariant-id
16584           in: path
16585           description: Unique identifier corresponding to the main definition of a model in ASDC
16586           required: true
16587           type: string
16588           example: __MODEL-INVARIANT-ID__
16589         - name: model-version-id
16590           in: path
16591           description: Unique identifier corresponding to one version of a model in ASDC
16592           required: true
16593           type: string
16594           example: __MODEL-VERSION-ID__
16595     put:
16596       tags:
16597         - ServiceDesignAndCreation
16598       summary: create or update an existing model-ver
16599       description: |
16600         Create or update an existing model-ver.
16601         #
16602         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16603       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
16604       consumes:
16605         - application/json
16606         - application/xml
16607       produces:
16608         - application/json
16609         - application/xml
16610       responses:
16611         "default":
16612           description: Response codes found in [response codes](https://wiki.onap.org/).
16613       parameters:
16614         - name: model-invariant-id
16615           in: path
16616           description: Unique identifier corresponding to the main definition of a model in ASDC
16617           required: true
16618           type: string
16619           example: __MODEL-INVARIANT-ID__
16620         - name: model-version-id
16621           in: path
16622           description: Unique identifier corresponding to one version of a model in ASDC
16623           required: true
16624           type: string
16625           example: __MODEL-VERSION-ID__
16626         - name: body
16627           in: body
16628           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
16629           required: true
16630           schema:
16631             $ref: "#/definitions/model-ver"
16632     patch:
16633       tags:
16634         - ServiceDesignAndCreation
16635       summary: update an existing model-ver
16636       description: |
16637         Update an existing model-ver
16638         #
16639         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16640         The PUT operation will entirely replace an existing object.
16641         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16642         #
16643         Other differences between PUT and PATCH are:
16644         #
16645         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16646         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16647         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16648       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
16649       consumes:
16650         - application/json
16651         - application/xml
16652       produces:
16653         - application/json
16654         - application/xml
16655       responses:
16656         "default":
16657           description: Response codes found in [response codes](https://wiki.onap.org/).
16658       parameters:
16659         - name: model-invariant-id
16660           in: path
16661           description: Unique identifier corresponding to the main definition of a model in ASDC
16662           required: true
16663           type: string
16664           example: __MODEL-INVARIANT-ID__
16665         - name: model-version-id
16666           in: path
16667           description: Unique identifier corresponding to one version of a model in ASDC
16668           required: true
16669           type: string
16670           example: __MODEL-VERSION-ID__
16671         - name: body
16672           in: body
16673           description: model-ver object that needs to be updated.
16674           required: true
16675           schema:
16676             $ref: "#/patchDefinitions/model-ver"
16677     delete:
16678       tags:
16679         - ServiceDesignAndCreation
16680       summary: delete an existing model-ver
16681       description: delete an existing model-ver
16682       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
16683       consumes:
16684         - application/json
16685         - application/xml
16686       produces:
16687         - application/json
16688         - application/xml
16689       responses:
16690         "default":
16691           description: Response codes found in [response codes](https://wiki.onap.org/).
16692       parameters:
16693         - name: model-invariant-id
16694           in: path
16695           description: Unique identifier corresponding to the main definition of a model in ASDC
16696           required: true
16697           type: string
16698           example: __MODEL-INVARIANT-ID__
16699         - name: model-version-id
16700           in: path
16701           description: Unique identifier corresponding to one version of a model in ASDC
16702           required: true
16703           type: string
16704           example: __MODEL-VERSION-ID__
16705         - name: resource-version
16706           in: query
16707           description: resource-version for concurrency
16708           required: true
16709           type: string
16710   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
16711     get:
16712       tags:
16713         - ServiceDesignAndCreation
16714       summary: returns model-vers
16715       description: returns model-vers
16716       operationId: getServiceDesignAndCreationModelsModelModelVers
16717       produces:
16718         - application/json
16719         - application/xml
16720       responses:
16721         "200":
16722           description: successful operation
16723           schema:
16724               $ref: "#/getDefinitions/model-vers"
16725         "default":
16726           description: Response codes found in [response codes](https://wiki.onap.org/).
16727       parameters:
16728         - name: model-invariant-id
16729           in: path
16730           description: Unique identifier corresponding to the main definition of a model in ASDC
16731           required: true
16732           type: string
16733           example: __MODEL-INVARIANT-ID__
16734         - name: model-version-id
16735           in: query
16736           description:
16737           required: false
16738           type: string
16739         - name: model-name
16740           in: query
16741           description:
16742           required: false
16743           type: string
16744         - name: model-version
16745           in: query
16746           description:
16747           required: false
16748           type: string
16749   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
16750     put:
16751       tags:
16752         - ServiceDesignAndCreation
16753       summary: see node definition for valid relationships
16754       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
16755       consumes:
16756         - application/json
16757         - application/xml
16758       produces:
16759         - application/json
16760         - application/xml
16761       responses:
16762         "default":
16763           description: Response codes found in [response codes](https://wiki.onap.org/).
16764       parameters:
16765         - name: model-invariant-id
16766           in: path
16767           description: Unique identifier corresponding to the main definition of a model in ASDC
16768           required: true
16769           type: string
16770           example: __MODEL-INVARIANT-ID__
16771         - name: body
16772           in: body
16773           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModel.json)
16774           required: true
16775           schema:
16776             $ref: "#/definitions/relationship"
16777     delete:
16778       tags:
16779         - ServiceDesignAndCreation
16780       summary: delete an existing relationship
16781       description: delete an existing relationship
16782       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
16783       consumes:
16784         - application/json
16785         - application/xml
16786       produces:
16787         - application/json
16788         - application/xml
16789       responses:
16790         "default":
16791           description: Response codes found in [response codes](https://wiki.onap.org/).
16792       parameters:
16793         - name: model-invariant-id
16794           in: path
16795           description: Unique identifier corresponding to the main definition of a model in ASDC
16796           required: true
16797           type: string
16798           example: __MODEL-INVARIANT-ID__
16799   /service-design-and-creation/models/model/{model-invariant-id}:
16800     get:
16801       tags:
16802         - ServiceDesignAndCreation
16803       summary: returns model
16804       description: returns model
16805       operationId: getServiceDesignAndCreationModelsModel
16806       produces:
16807         - application/json
16808         - application/xml
16809       responses:
16810         "200":
16811           description: successful operation
16812           schema:
16813               $ref: "#/getDefinitions/model"
16814         "default":
16815           description: Response codes found in [response codes](https://wiki.onap.org/).
16816       parameters:
16817         - name: model-invariant-id
16818           in: path
16819           description: Unique identifier corresponding to the main definition of a model in ASDC
16820           required: true
16821           type: string
16822           example: __MODEL-INVARIANT-ID__
16823     put:
16824       tags:
16825         - ServiceDesignAndCreation
16826       summary: create or update an existing model
16827       description: |
16828         Create or update an existing model.
16829         #
16830         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16831       operationId: createOrUpdateServiceDesignAndCreationModelsModel
16832       consumes:
16833         - application/json
16834         - application/xml
16835       produces:
16836         - application/json
16837         - application/xml
16838       responses:
16839         "default":
16840           description: Response codes found in [response codes](https://wiki.onap.org/).
16841       parameters:
16842         - name: model-invariant-id
16843           in: path
16844           description: Unique identifier corresponding to the main definition of a model in ASDC
16845           required: true
16846           type: string
16847           example: __MODEL-INVARIANT-ID__
16848         - name: body
16849           in: body
16850           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModel.json)
16851           required: true
16852           schema:
16853             $ref: "#/definitions/model"
16854     patch:
16855       tags:
16856         - ServiceDesignAndCreation
16857       summary: update an existing model
16858       description: |
16859         Update an existing model
16860         #
16861         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16862         The PUT operation will entirely replace an existing object.
16863         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16864         #
16865         Other differences between PUT and PATCH are:
16866         #
16867         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16868         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16869         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16870       operationId: UpdateServiceDesignAndCreationModelsModel
16871       consumes:
16872         - application/json
16873         - application/xml
16874       produces:
16875         - application/json
16876         - application/xml
16877       responses:
16878         "default":
16879           description: Response codes found in [response codes](https://wiki.onap.org/).
16880       parameters:
16881         - name: model-invariant-id
16882           in: path
16883           description: Unique identifier corresponding to the main definition of a model in ASDC
16884           required: true
16885           type: string
16886           example: __MODEL-INVARIANT-ID__
16887         - name: body
16888           in: body
16889           description: model object that needs to be updated.
16890           required: true
16891           schema:
16892             $ref: "#/patchDefinitions/model"
16893     delete:
16894       tags:
16895         - ServiceDesignAndCreation
16896       summary: delete an existing model
16897       description: delete an existing model
16898       operationId: deleteServiceDesignAndCreationModelsModel
16899       consumes:
16900         - application/json
16901         - application/xml
16902       produces:
16903         - application/json
16904         - application/xml
16905       responses:
16906         "default":
16907           description: Response codes found in [response codes](https://wiki.onap.org/).
16908       parameters:
16909         - name: model-invariant-id
16910           in: path
16911           description: Unique identifier corresponding to the main definition of a model in ASDC
16912           required: true
16913           type: string
16914           example: __MODEL-INVARIANT-ID__
16915         - name: resource-version
16916           in: query
16917           description: resource-version for concurrency
16918           required: true
16919           type: string
16920   /service-design-and-creation/models:
16921     get:
16922       tags:
16923         - ServiceDesignAndCreation
16924       summary: returns models
16925       description: returns models
16926       operationId: getServiceDesignAndCreationModels
16927       produces:
16928         - application/json
16929         - application/xml
16930       responses:
16931         "200":
16932           description: successful operation
16933           schema:
16934               $ref: "#/getDefinitions/models"
16935         "default":
16936           description: Response codes found in [response codes](https://wiki.onap.org/).
16937       parameters:
16938         - name: model-invariant-id
16939           in: query
16940           description:
16941           required: false
16942           type: string
16943         - name: model-type
16944           in: query
16945           description:
16946           required: false
16947           type: string
16948   /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:
16949     put:
16950       tags:
16951         - ServiceDesignAndCreation
16952       summary: see node definition for valid relationships
16953       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
16954       consumes:
16955         - application/json
16956         - application/xml
16957       produces:
16958         - application/json
16959         - application/xml
16960       responses:
16961         "default":
16962           description: Response codes found in [response codes](https://wiki.onap.org/).
16963       parameters:
16964         - name: named-query-uuid
16965           in: path
16966           required: true
16967           type: string
16968           example: __NAMED-QUERY-UUID__
16969         - name: named-query-element-uuid
16970           in: path
16971           required: true
16972           type: string
16973           example: __NAMED-QUERY-ELEMENT-UUID__
16974         - name: related-lookup-uuid
16975           in: path
16976           required: true
16977           type: string
16978           example: __RELATED-LOOKUP-UUID__
16979         - name: body
16980           in: body
16981           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
16982           required: true
16983           schema:
16984             $ref: "#/definitions/relationship"
16985     delete:
16986       tags:
16987         - ServiceDesignAndCreation
16988       summary: delete an existing relationship
16989       description: delete an existing relationship
16990       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
16991       consumes:
16992         - application/json
16993         - application/xml
16994       produces:
16995         - application/json
16996         - application/xml
16997       responses:
16998         "default":
16999           description: Response codes found in [response codes](https://wiki.onap.org/).
17000       parameters:
17001         - name: named-query-uuid
17002           in: path
17003           required: true
17004           type: string
17005           example: __NAMED-QUERY-UUID__
17006         - name: named-query-element-uuid
17007           in: path
17008           required: true
17009           type: string
17010           example: __NAMED-QUERY-ELEMENT-UUID__
17011         - name: related-lookup-uuid
17012           in: path
17013           required: true
17014           type: string
17015           example: __RELATED-LOOKUP-UUID__
17016   /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}:
17017     get:
17018       tags:
17019         - ServiceDesignAndCreation
17020       summary: returns related-lookup
17021       description: returns related-lookup
17022       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17023       produces:
17024         - application/json
17025         - application/xml
17026       responses:
17027         "200":
17028           description: successful operation
17029           schema:
17030               $ref: "#/getDefinitions/related-lookup"
17031         "default":
17032           description: Response codes found in [response codes](https://wiki.onap.org/).
17033       parameters:
17034         - name: named-query-uuid
17035           in: path
17036           required: true
17037           type: string
17038           example: __NAMED-QUERY-UUID__
17039         - name: named-query-element-uuid
17040           in: path
17041           required: true
17042           type: string
17043           example: __NAMED-QUERY-ELEMENT-UUID__
17044         - name: related-lookup-uuid
17045           in: path
17046           required: true
17047           type: string
17048           example: __RELATED-LOOKUP-UUID__
17049     put:
17050       tags:
17051         - ServiceDesignAndCreation
17052       summary: create or update an existing related-lookup
17053       description: |
17054         Create or update an existing related-lookup.
17055         #
17056         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17057       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17058       consumes:
17059         - application/json
17060         - application/xml
17061       produces:
17062         - application/json
17063         - application/xml
17064       responses:
17065         "default":
17066           description: Response codes found in [response codes](https://wiki.onap.org/).
17067       parameters:
17068         - name: named-query-uuid
17069           in: path
17070           required: true
17071           type: string
17072           example: __NAMED-QUERY-UUID__
17073         - name: named-query-element-uuid
17074           in: path
17075           required: true
17076           type: string
17077           example: __NAMED-QUERY-ELEMENT-UUID__
17078         - name: related-lookup-uuid
17079           in: path
17080           required: true
17081           type: string
17082           example: __RELATED-LOOKUP-UUID__
17083         - name: body
17084           in: body
17085           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
17086           required: true
17087           schema:
17088             $ref: "#/definitions/related-lookup"
17089     patch:
17090       tags:
17091         - ServiceDesignAndCreation
17092       summary: update an existing related-lookup
17093       description: |
17094         Update an existing related-lookup
17095         #
17096         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17097         The PUT operation will entirely replace an existing object.
17098         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17099         #
17100         Other differences between PUT and PATCH are:
17101         #
17102         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17103         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17104         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17105       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17106       consumes:
17107         - application/json
17108         - application/xml
17109       produces:
17110         - application/json
17111         - application/xml
17112       responses:
17113         "default":
17114           description: Response codes found in [response codes](https://wiki.onap.org/).
17115       parameters:
17116         - name: named-query-uuid
17117           in: path
17118           required: true
17119           type: string
17120           example: __NAMED-QUERY-UUID__
17121         - name: named-query-element-uuid
17122           in: path
17123           required: true
17124           type: string
17125           example: __NAMED-QUERY-ELEMENT-UUID__
17126         - name: related-lookup-uuid
17127           in: path
17128           required: true
17129           type: string
17130           example: __RELATED-LOOKUP-UUID__
17131         - name: body
17132           in: body
17133           description: related-lookup object that needs to be updated.
17134           required: true
17135           schema:
17136             $ref: "#/patchDefinitions/related-lookup"
17137     delete:
17138       tags:
17139         - ServiceDesignAndCreation
17140       summary: delete an existing related-lookup
17141       description: delete an existing related-lookup
17142       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17143       consumes:
17144         - application/json
17145         - application/xml
17146       produces:
17147         - application/json
17148         - application/xml
17149       responses:
17150         "default":
17151           description: Response codes found in [response codes](https://wiki.onap.org/).
17152       parameters:
17153         - name: named-query-uuid
17154           in: path
17155           required: true
17156           type: string
17157           example: __NAMED-QUERY-UUID__
17158         - name: named-query-element-uuid
17159           in: path
17160           required: true
17161           type: string
17162           example: __NAMED-QUERY-ELEMENT-UUID__
17163         - name: related-lookup-uuid
17164           in: path
17165           required: true
17166           type: string
17167           example: __RELATED-LOOKUP-UUID__
17168         - name: resource-version
17169           in: query
17170           description: resource-version for concurrency
17171           required: true
17172           type: string
17173   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
17174     get:
17175       tags:
17176         - ServiceDesignAndCreation
17177       summary: returns related-lookups
17178       description: returns related-lookups
17179       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
17180       produces:
17181         - application/json
17182         - application/xml
17183       responses:
17184         "200":
17185           description: successful operation
17186           schema:
17187               $ref: "#/getDefinitions/related-lookups"
17188         "default":
17189           description: Response codes found in [response codes](https://wiki.onap.org/).
17190       parameters:
17191         - name: named-query-uuid
17192           in: path
17193           required: true
17194           type: string
17195           example: __NAMED-QUERY-UUID__
17196         - name: named-query-element-uuid
17197           in: path
17198           required: true
17199           type: string
17200           example: __NAMED-QUERY-ELEMENT-UUID__
17201         - name: related-lookup-uuid
17202           in: query
17203           description:
17204           required: false
17205           type: string
17206   /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}:
17207     get:
17208       tags:
17209         - ServiceDesignAndCreation
17210       summary: returns property-constraint
17211       description: returns property-constraint
17212       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17213       produces:
17214         - application/json
17215         - application/xml
17216       responses:
17217         "200":
17218           description: successful operation
17219           schema:
17220               $ref: "#/getDefinitions/property-constraint"
17221         "default":
17222           description: Response codes found in [response codes](https://wiki.onap.org/).
17223       parameters:
17224         - name: named-query-uuid
17225           in: path
17226           required: true
17227           type: string
17228           example: __NAMED-QUERY-UUID__
17229         - name: named-query-element-uuid
17230           in: path
17231           required: true
17232           type: string
17233           example: __NAMED-QUERY-ELEMENT-UUID__
17234         - name: property-constraint-uuid
17235           in: path
17236           required: true
17237           type: string
17238           example: __PROPERTY-CONSTRAINT-UUID__
17239     put:
17240       tags:
17241         - ServiceDesignAndCreation
17242       summary: create or update an existing property-constraint
17243       description: |
17244         Create or update an existing property-constraint.
17245         #
17246         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17247       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17248       consumes:
17249         - application/json
17250         - application/xml
17251       produces:
17252         - application/json
17253         - application/xml
17254       responses:
17255         "default":
17256           description: Response codes found in [response codes](https://wiki.onap.org/).
17257       parameters:
17258         - name: named-query-uuid
17259           in: path
17260           required: true
17261           type: string
17262           example: __NAMED-QUERY-UUID__
17263         - name: named-query-element-uuid
17264           in: path
17265           required: true
17266           type: string
17267           example: __NAMED-QUERY-ELEMENT-UUID__
17268         - name: property-constraint-uuid
17269           in: path
17270           required: true
17271           type: string
17272           example: __PROPERTY-CONSTRAINT-UUID__
17273         - name: body
17274           in: body
17275           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
17276           required: true
17277           schema:
17278             $ref: "#/definitions/property-constraint"
17279     patch:
17280       tags:
17281         - ServiceDesignAndCreation
17282       summary: update an existing property-constraint
17283       description: |
17284         Update an existing property-constraint
17285         #
17286         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17287         The PUT operation will entirely replace an existing object.
17288         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17289         #
17290         Other differences between PUT and PATCH are:
17291         #
17292         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17293         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17294         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17295       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17296       consumes:
17297         - application/json
17298         - application/xml
17299       produces:
17300         - application/json
17301         - application/xml
17302       responses:
17303         "default":
17304           description: Response codes found in [response codes](https://wiki.onap.org/).
17305       parameters:
17306         - name: named-query-uuid
17307           in: path
17308           required: true
17309           type: string
17310           example: __NAMED-QUERY-UUID__
17311         - name: named-query-element-uuid
17312           in: path
17313           required: true
17314           type: string
17315           example: __NAMED-QUERY-ELEMENT-UUID__
17316         - name: property-constraint-uuid
17317           in: path
17318           required: true
17319           type: string
17320           example: __PROPERTY-CONSTRAINT-UUID__
17321         - name: body
17322           in: body
17323           description: property-constraint object that needs to be updated.
17324           required: true
17325           schema:
17326             $ref: "#/patchDefinitions/property-constraint"
17327     delete:
17328       tags:
17329         - ServiceDesignAndCreation
17330       summary: delete an existing property-constraint
17331       description: delete an existing property-constraint
17332       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17333       consumes:
17334         - application/json
17335         - application/xml
17336       produces:
17337         - application/json
17338         - application/xml
17339       responses:
17340         "default":
17341           description: Response codes found in [response codes](https://wiki.onap.org/).
17342       parameters:
17343         - name: named-query-uuid
17344           in: path
17345           required: true
17346           type: string
17347           example: __NAMED-QUERY-UUID__
17348         - name: named-query-element-uuid
17349           in: path
17350           required: true
17351           type: string
17352           example: __NAMED-QUERY-ELEMENT-UUID__
17353         - name: property-constraint-uuid
17354           in: path
17355           required: true
17356           type: string
17357           example: __PROPERTY-CONSTRAINT-UUID__
17358         - name: resource-version
17359           in: query
17360           description: resource-version for concurrency
17361           required: true
17362           type: string
17363   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
17364     get:
17365       tags:
17366         - ServiceDesignAndCreation
17367       summary: returns property-constraints
17368       description: returns property-constraints
17369       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
17370       produces:
17371         - application/json
17372         - application/xml
17373       responses:
17374         "200":
17375           description: successful operation
17376           schema:
17377               $ref: "#/getDefinitions/property-constraints"
17378         "default":
17379           description: Response codes found in [response codes](https://wiki.onap.org/).
17380       parameters:
17381         - name: named-query-uuid
17382           in: path
17383           required: true
17384           type: string
17385           example: __NAMED-QUERY-UUID__
17386         - name: named-query-element-uuid
17387           in: path
17388           required: true
17389           type: string
17390           example: __NAMED-QUERY-ELEMENT-UUID__
17391         - name: property-constraint-uuid
17392           in: query
17393           description:
17394           required: false
17395           type: string
17396   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
17397     put:
17398       tags:
17399         - ServiceDesignAndCreation
17400       summary: see node definition for valid relationships
17401       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
17402       consumes:
17403         - application/json
17404         - application/xml
17405       produces:
17406         - application/json
17407         - application/xml
17408       responses:
17409         "default":
17410           description: Response codes found in [response codes](https://wiki.onap.org/).
17411       parameters:
17412         - name: named-query-uuid
17413           in: path
17414           required: true
17415           type: string
17416           example: __NAMED-QUERY-UUID__
17417         - name: named-query-element-uuid
17418           in: path
17419           required: true
17420           type: string
17421           example: __NAMED-QUERY-ELEMENT-UUID__
17422         - name: body
17423           in: body
17424           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
17425           required: true
17426           schema:
17427             $ref: "#/definitions/relationship"
17428     delete:
17429       tags:
17430         - ServiceDesignAndCreation
17431       summary: delete an existing relationship
17432       description: delete an existing relationship
17433       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
17434       consumes:
17435         - application/json
17436         - application/xml
17437       produces:
17438         - application/json
17439         - application/xml
17440       responses:
17441         "default":
17442           description: Response codes found in [response codes](https://wiki.onap.org/).
17443       parameters:
17444         - name: named-query-uuid
17445           in: path
17446           required: true
17447           type: string
17448           example: __NAMED-QUERY-UUID__
17449         - name: named-query-element-uuid
17450           in: path
17451           required: true
17452           type: string
17453           example: __NAMED-QUERY-ELEMENT-UUID__
17454   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
17455     get:
17456       tags:
17457         - ServiceDesignAndCreation
17458       summary: returns named-query-element
17459       description: returns named-query-element
17460       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17461       produces:
17462         - application/json
17463         - application/xml
17464       responses:
17465         "200":
17466           description: successful operation
17467           schema:
17468               $ref: "#/getDefinitions/named-query-element"
17469         "default":
17470           description: Response codes found in [response codes](https://wiki.onap.org/).
17471       parameters:
17472         - name: named-query-uuid
17473           in: path
17474           required: true
17475           type: string
17476           example: __NAMED-QUERY-UUID__
17477         - name: named-query-element-uuid
17478           in: path
17479           required: true
17480           type: string
17481           example: __NAMED-QUERY-ELEMENT-UUID__
17482     put:
17483       tags:
17484         - ServiceDesignAndCreation
17485       summary: create or update an existing named-query-element
17486       description: |
17487         Create or update an existing named-query-element.
17488         #
17489         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17490       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17491       consumes:
17492         - application/json
17493         - application/xml
17494       produces:
17495         - application/json
17496         - application/xml
17497       responses:
17498         "default":
17499           description: Response codes found in [response codes](https://wiki.onap.org/).
17500       parameters:
17501         - name: named-query-uuid
17502           in: path
17503           required: true
17504           type: string
17505           example: __NAMED-QUERY-UUID__
17506         - name: named-query-element-uuid
17507           in: path
17508           required: true
17509           type: string
17510           example: __NAMED-QUERY-ELEMENT-UUID__
17511         - name: body
17512           in: body
17513           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
17514           required: true
17515           schema:
17516             $ref: "#/definitions/named-query-element"
17517     patch:
17518       tags:
17519         - ServiceDesignAndCreation
17520       summary: update an existing named-query-element
17521       description: |
17522         Update an existing named-query-element
17523         #
17524         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17525         The PUT operation will entirely replace an existing object.
17526         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17527         #
17528         Other differences between PUT and PATCH are:
17529         #
17530         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17531         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17532         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17533       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17534       consumes:
17535         - application/json
17536         - application/xml
17537       produces:
17538         - application/json
17539         - application/xml
17540       responses:
17541         "default":
17542           description: Response codes found in [response codes](https://wiki.onap.org/).
17543       parameters:
17544         - name: named-query-uuid
17545           in: path
17546           required: true
17547           type: string
17548           example: __NAMED-QUERY-UUID__
17549         - name: named-query-element-uuid
17550           in: path
17551           required: true
17552           type: string
17553           example: __NAMED-QUERY-ELEMENT-UUID__
17554         - name: body
17555           in: body
17556           description: named-query-element object that needs to be updated.
17557           required: true
17558           schema:
17559             $ref: "#/patchDefinitions/named-query-element"
17560     delete:
17561       tags:
17562         - ServiceDesignAndCreation
17563       summary: delete an existing named-query-element
17564       description: delete an existing named-query-element
17565       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17566       consumes:
17567         - application/json
17568         - application/xml
17569       produces:
17570         - application/json
17571         - application/xml
17572       responses:
17573         "default":
17574           description: Response codes found in [response codes](https://wiki.onap.org/).
17575       parameters:
17576         - name: named-query-uuid
17577           in: path
17578           required: true
17579           type: string
17580           example: __NAMED-QUERY-UUID__
17581         - name: named-query-element-uuid
17582           in: path
17583           required: true
17584           type: string
17585           example: __NAMED-QUERY-ELEMENT-UUID__
17586         - name: resource-version
17587           in: query
17588           description: resource-version for concurrency
17589           required: true
17590           type: string
17591   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
17592     get:
17593       tags:
17594         - ServiceDesignAndCreation
17595       summary: returns named-query-elements
17596       description: returns named-query-elements
17597       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
17598       produces:
17599         - application/json
17600         - application/xml
17601       responses:
17602         "200":
17603           description: successful operation
17604           schema:
17605               $ref: "#/getDefinitions/named-query-elements"
17606         "default":
17607           description: Response codes found in [response codes](https://wiki.onap.org/).
17608       parameters:
17609         - name: named-query-uuid
17610           in: path
17611           required: true
17612           type: string
17613           example: __NAMED-QUERY-UUID__
17614         - name: named-query-element-uuid
17615           in: query
17616           description:
17617           required: false
17618           type: string
17619   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
17620     put:
17621       tags:
17622         - ServiceDesignAndCreation
17623       summary: see node definition for valid relationships
17624       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
17625       consumes:
17626         - application/json
17627         - application/xml
17628       produces:
17629         - application/json
17630         - application/xml
17631       responses:
17632         "default":
17633           description: Response codes found in [response codes](https://wiki.onap.org/).
17634       parameters:
17635         - name: named-query-uuid
17636           in: path
17637           required: true
17638           type: string
17639           example: __NAMED-QUERY-UUID__
17640         - name: body
17641           in: body
17642           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
17643           required: true
17644           schema:
17645             $ref: "#/definitions/relationship"
17646     delete:
17647       tags:
17648         - ServiceDesignAndCreation
17649       summary: delete an existing relationship
17650       description: delete an existing relationship
17651       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
17652       consumes:
17653         - application/json
17654         - application/xml
17655       produces:
17656         - application/json
17657         - application/xml
17658       responses:
17659         "default":
17660           description: Response codes found in [response codes](https://wiki.onap.org/).
17661       parameters:
17662         - name: named-query-uuid
17663           in: path
17664           required: true
17665           type: string
17666           example: __NAMED-QUERY-UUID__
17667   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
17668     get:
17669       tags:
17670         - ServiceDesignAndCreation
17671       summary: returns named-query
17672       description: returns named-query
17673       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
17674       produces:
17675         - application/json
17676         - application/xml
17677       responses:
17678         "200":
17679           description: successful operation
17680           schema:
17681               $ref: "#/getDefinitions/named-query"
17682         "default":
17683           description: Response codes found in [response codes](https://wiki.onap.org/).
17684       parameters:
17685         - name: named-query-uuid
17686           in: path
17687           required: true
17688           type: string
17689           example: __NAMED-QUERY-UUID__
17690     put:
17691       tags:
17692         - ServiceDesignAndCreation
17693       summary: create or update an existing named-query
17694       description: |
17695         Create or update an existing named-query.
17696         #
17697         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17698       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
17699       consumes:
17700         - application/json
17701         - application/xml
17702       produces:
17703         - application/json
17704         - application/xml
17705       responses:
17706         "default":
17707           description: Response codes found in [response codes](https://wiki.onap.org/).
17708       parameters:
17709         - name: named-query-uuid
17710           in: path
17711           required: true
17712           type: string
17713           example: __NAMED-QUERY-UUID__
17714         - name: body
17715           in: body
17716           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
17717           required: true
17718           schema:
17719             $ref: "#/definitions/named-query"
17720     patch:
17721       tags:
17722         - ServiceDesignAndCreation
17723       summary: update an existing named-query
17724       description: |
17725         Update an existing named-query
17726         #
17727         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17728         The PUT operation will entirely replace an existing object.
17729         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17730         #
17731         Other differences between PUT and PATCH are:
17732         #
17733         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17734         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17735         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17736       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
17737       consumes:
17738         - application/json
17739         - application/xml
17740       produces:
17741         - application/json
17742         - application/xml
17743       responses:
17744         "default":
17745           description: Response codes found in [response codes](https://wiki.onap.org/).
17746       parameters:
17747         - name: named-query-uuid
17748           in: path
17749           required: true
17750           type: string
17751           example: __NAMED-QUERY-UUID__
17752         - name: body
17753           in: body
17754           description: named-query object that needs to be updated.
17755           required: true
17756           schema:
17757             $ref: "#/patchDefinitions/named-query"
17758     delete:
17759       tags:
17760         - ServiceDesignAndCreation
17761       summary: delete an existing named-query
17762       description: delete an existing named-query
17763       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
17764       consumes:
17765         - application/json
17766         - application/xml
17767       produces:
17768         - application/json
17769         - application/xml
17770       responses:
17771         "default":
17772           description: Response codes found in [response codes](https://wiki.onap.org/).
17773       parameters:
17774         - name: named-query-uuid
17775           in: path
17776           required: true
17777           type: string
17778           example: __NAMED-QUERY-UUID__
17779         - name: resource-version
17780           in: query
17781           description: resource-version for concurrency
17782           required: true
17783           type: string
17784   /service-design-and-creation/named-queries:
17785     get:
17786       tags:
17787         - ServiceDesignAndCreation
17788       summary: returns named-queries
17789       description: returns named-queries
17790       operationId: getServiceDesignAndCreationNamedQueries
17791       produces:
17792         - application/json
17793         - application/xml
17794       responses:
17795         "200":
17796           description: successful operation
17797           schema:
17798               $ref: "#/getDefinitions/named-queries"
17799         "default":
17800           description: Response codes found in [response codes](https://wiki.onap.org/).
17801       parameters:
17802         - name: named-query-uuid
17803           in: query
17804           description:
17805           required: false
17806           type: string
17807         - name: named-query-name
17808           in: query
17809           description:
17810           required: false
17811           type: string
17812   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
17813     put:
17814       tags:
17815         - Network
17816       summary: see node definition for valid relationships
17817       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
17818       consumes:
17819         - application/json
17820         - application/xml
17821       produces:
17822         - application/json
17823         - application/xml
17824       responses:
17825         "default":
17826           description: Response codes found in [response codes](https://wiki.onap.org/).
17827       parameters:
17828         - name: link-name
17829           in: path
17830           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17831           required: true
17832           type: string
17833           example: __LINK-NAME__
17834         - name: body
17835           in: body
17836           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)
17837           required: true
17838           schema:
17839             $ref: "#/definitions/relationship"
17840     delete:
17841       tags:
17842         - Network
17843       summary: delete an existing relationship
17844       description: delete an existing relationship
17845       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
17846       consumes:
17847         - application/json
17848         - application/xml
17849       produces:
17850         - application/json
17851         - application/xml
17852       responses:
17853         "default":
17854           description: Response codes found in [response codes](https://wiki.onap.org/).
17855       parameters:
17856         - name: link-name
17857           in: path
17858           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17859           required: true
17860           type: string
17861           example: __LINK-NAME__
17862   /network/logical-links/logical-link/{link-name}:
17863     get:
17864       tags:
17865         - Network
17866       summary: returns logical-link
17867       description: returns logical-link
17868       operationId: getNetworkLogicalLinksLogicalLink
17869       produces:
17870         - application/json
17871         - application/xml
17872       responses:
17873         "200":
17874           description: successful operation
17875           schema:
17876               $ref: "#/getDefinitions/logical-link"
17877         "default":
17878           description: Response codes found in [response codes](https://wiki.onap.org/).
17879       parameters:
17880         - name: link-name
17881           in: path
17882           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17883           required: true
17884           type: string
17885           example: __LINK-NAME__
17886     put:
17887       tags:
17888         - Network
17889       summary: create or update an existing logical-link
17890       description: |
17891         Create or update an existing logical-link.
17892         #
17893         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17894       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
17895       consumes:
17896         - application/json
17897         - application/xml
17898       produces:
17899         - application/json
17900         - application/xml
17901       responses:
17902         "default":
17903           description: Response codes found in [response codes](https://wiki.onap.org/).
17904       parameters:
17905         - name: link-name
17906           in: path
17907           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17908           required: true
17909           type: string
17910           example: __LINK-NAME__
17911         - name: body
17912           in: body
17913           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)
17914           required: true
17915           schema:
17916             $ref: "#/definitions/logical-link"
17917     patch:
17918       tags:
17919         - Network
17920       summary: update an existing logical-link
17921       description: |
17922         Update an existing logical-link
17923         #
17924         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17925         The PUT operation will entirely replace an existing object.
17926         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17927         #
17928         Other differences between PUT and PATCH are:
17929         #
17930         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17931         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17932         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17933       operationId: UpdateNetworkLogicalLinksLogicalLink
17934       consumes:
17935         - application/json
17936         - application/xml
17937       produces:
17938         - application/json
17939         - application/xml
17940       responses:
17941         "default":
17942           description: Response codes found in [response codes](https://wiki.onap.org/).
17943       parameters:
17944         - name: link-name
17945           in: path
17946           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17947           required: true
17948           type: string
17949           example: __LINK-NAME__
17950         - name: body
17951           in: body
17952           description: logical-link object that needs to be updated.
17953           required: true
17954           schema:
17955             $ref: "#/patchDefinitions/logical-link"
17956     delete:
17957       tags:
17958         - Network
17959       summary: delete an existing logical-link
17960       description: delete an existing logical-link
17961       operationId: deleteNetworkLogicalLinksLogicalLink
17962       consumes:
17963         - application/json
17964         - application/xml
17965       produces:
17966         - application/json
17967         - application/xml
17968       responses:
17969         "default":
17970           description: Response codes found in [response codes](https://wiki.onap.org/).
17971       parameters:
17972         - name: link-name
17973           in: path
17974           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17975           required: true
17976           type: string
17977           example: __LINK-NAME__
17978         - name: resource-version
17979           in: query
17980           description: resource-version for concurrency
17981           required: true
17982           type: string
17983   /network/logical-links:
17984     get:
17985       tags:
17986         - Network
17987       summary: returns logical-links
17988       description: returns logical-links
17989       operationId: getNetworkLogicalLinks
17990       produces:
17991         - application/json
17992         - application/xml
17993       responses:
17994         "200":
17995           description: successful operation
17996           schema:
17997               $ref: "#/getDefinitions/logical-links"
17998         "default":
17999           description: Response codes found in [response codes](https://wiki.onap.org/).
18000       parameters:
18001         - name: link-name
18002           in: query
18003           description:
18004           required: false
18005           type: string
18006         - name: persona-model-id
18007           in: query
18008           description:
18009           required: false
18010           type: string
18011         - name: persona-model-version
18012           in: query
18013           description:
18014           required: false
18015           type: string
18016         - name: widget-model-id
18017           in: query
18018           description:
18019           required: false
18020           type: string
18021         - name: widget-model-version
18022           in: query
18023           description:
18024           required: false
18025           type: string
18026         - name: prov-status
18027           in: query
18028           description:
18029           required: false
18030           type: string
18031         - name: link-id
18032           in: query
18033           description:
18034           required: false
18035           type: string
18036         - name: circuit-id
18037           in: query
18038           description:
18039           required: false
18040           type: string
18041         - name: purpose
18042           in: query
18043           description:
18044           required: false
18045           type: string
18046   /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:
18047     put:
18048       tags:
18049         - Network
18050       summary: see node definition for valid relationships
18051       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18052       consumes:
18053         - application/json
18054         - application/xml
18055       produces:
18056         - application/json
18057         - application/xml
18058       responses:
18059         "default":
18060           description: Response codes found in [response codes](https://wiki.onap.org/).
18061       parameters:
18062         - name: site-pair-set-id
18063           in: path
18064           description: Unique id of site pair set.
18065           required: true
18066           type: string
18067           example: __SITE-PAIR-SET-ID__
18068         - name: routing-instance-id
18069           in: path
18070           description: Unique id of routing instance
18071           required: true
18072           type: string
18073           example: __ROUTING-INSTANCE-ID__
18074         - name: site-pair-id
18075           in: path
18076           description: unique identifier of probe
18077           required: true
18078           type: string
18079           example: __SITE-PAIR-ID__
18080         - name: cos
18081           in: path
18082           description: unique identifier of probe
18083           required: true
18084           type: string
18085           example: __COS__
18086         - name: body
18087           in: body
18088           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18089           required: true
18090           schema:
18091             $ref: "#/definitions/relationship"
18092     delete:
18093       tags:
18094         - Network
18095       summary: delete an existing relationship
18096       description: delete an existing relationship
18097       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18098       consumes:
18099         - application/json
18100         - application/xml
18101       produces:
18102         - application/json
18103         - application/xml
18104       responses:
18105         "default":
18106           description: Response codes found in [response codes](https://wiki.onap.org/).
18107       parameters:
18108         - name: site-pair-set-id
18109           in: path
18110           description: Unique id of site pair set.
18111           required: true
18112           type: string
18113           example: __SITE-PAIR-SET-ID__
18114         - name: routing-instance-id
18115           in: path
18116           description: Unique id of routing instance
18117           required: true
18118           type: string
18119           example: __ROUTING-INSTANCE-ID__
18120         - name: site-pair-id
18121           in: path
18122           description: unique identifier of probe
18123           required: true
18124           type: string
18125           example: __SITE-PAIR-ID__
18126         - name: cos
18127           in: path
18128           description: unique identifier of probe
18129           required: true
18130           type: string
18131           example: __COS__
18132   /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}:
18133     get:
18134       tags:
18135         - Network
18136       summary: returns class-of-service
18137       description: returns class-of-service
18138       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18139       produces:
18140         - application/json
18141         - application/xml
18142       responses:
18143         "200":
18144           description: successful operation
18145           schema:
18146               $ref: "#/getDefinitions/class-of-service"
18147         "default":
18148           description: Response codes found in [response codes](https://wiki.onap.org/).
18149       parameters:
18150         - name: site-pair-set-id
18151           in: path
18152           description: Unique id of site pair set.
18153           required: true
18154           type: string
18155           example: __SITE-PAIR-SET-ID__
18156         - name: routing-instance-id
18157           in: path
18158           description: Unique id of routing instance
18159           required: true
18160           type: string
18161           example: __ROUTING-INSTANCE-ID__
18162         - name: site-pair-id
18163           in: path
18164           description: unique identifier of probe
18165           required: true
18166           type: string
18167           example: __SITE-PAIR-ID__
18168         - name: cos
18169           in: path
18170           description: unique identifier of probe
18171           required: true
18172           type: string
18173           example: __COS__
18174     put:
18175       tags:
18176         - Network
18177       summary: create or update an existing class-of-service
18178       description: |
18179         Create or update an existing class-of-service.
18180         #
18181         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18182       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18183       consumes:
18184         - application/json
18185         - application/xml
18186       produces:
18187         - application/json
18188         - application/xml
18189       responses:
18190         "default":
18191           description: Response codes found in [response codes](https://wiki.onap.org/).
18192       parameters:
18193         - name: site-pair-set-id
18194           in: path
18195           description: Unique id of site pair set.
18196           required: true
18197           type: string
18198           example: __SITE-PAIR-SET-ID__
18199         - name: routing-instance-id
18200           in: path
18201           description: Unique id of routing instance
18202           required: true
18203           type: string
18204           example: __ROUTING-INSTANCE-ID__
18205         - name: site-pair-id
18206           in: path
18207           description: unique identifier of probe
18208           required: true
18209           type: string
18210           example: __SITE-PAIR-ID__
18211         - name: cos
18212           in: path
18213           description: unique identifier of probe
18214           required: true
18215           type: string
18216           example: __COS__
18217         - name: body
18218           in: body
18219           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18220           required: true
18221           schema:
18222             $ref: "#/definitions/class-of-service"
18223     patch:
18224       tags:
18225         - Network
18226       summary: update an existing class-of-service
18227       description: |
18228         Update an existing class-of-service
18229         #
18230         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18231         The PUT operation will entirely replace an existing object.
18232         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18233         #
18234         Other differences between PUT and PATCH are:
18235         #
18236         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18237         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18238         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18239       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18240       consumes:
18241         - application/json
18242         - application/xml
18243       produces:
18244         - application/json
18245         - application/xml
18246       responses:
18247         "default":
18248           description: Response codes found in [response codes](https://wiki.onap.org/).
18249       parameters:
18250         - name: site-pair-set-id
18251           in: path
18252           description: Unique id of site pair set.
18253           required: true
18254           type: string
18255           example: __SITE-PAIR-SET-ID__
18256         - name: routing-instance-id
18257           in: path
18258           description: Unique id of routing instance
18259           required: true
18260           type: string
18261           example: __ROUTING-INSTANCE-ID__
18262         - name: site-pair-id
18263           in: path
18264           description: unique identifier of probe
18265           required: true
18266           type: string
18267           example: __SITE-PAIR-ID__
18268         - name: cos
18269           in: path
18270           description: unique identifier of probe
18271           required: true
18272           type: string
18273           example: __COS__
18274         - name: body
18275           in: body
18276           description: class-of-service object that needs to be updated.
18277           required: true
18278           schema:
18279             $ref: "#/patchDefinitions/class-of-service"
18280     delete:
18281       tags:
18282         - Network
18283       summary: delete an existing class-of-service
18284       description: delete an existing class-of-service
18285       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18286       consumes:
18287         - application/json
18288         - application/xml
18289       produces:
18290         - application/json
18291         - application/xml
18292       responses:
18293         "default":
18294           description: Response codes found in [response codes](https://wiki.onap.org/).
18295       parameters:
18296         - name: site-pair-set-id
18297           in: path
18298           description: Unique id of site pair set.
18299           required: true
18300           type: string
18301           example: __SITE-PAIR-SET-ID__
18302         - name: routing-instance-id
18303           in: path
18304           description: Unique id of routing instance
18305           required: true
18306           type: string
18307           example: __ROUTING-INSTANCE-ID__
18308         - name: site-pair-id
18309           in: path
18310           description: unique identifier of probe
18311           required: true
18312           type: string
18313           example: __SITE-PAIR-ID__
18314         - name: cos
18315           in: path
18316           description: unique identifier of probe
18317           required: true
18318           type: string
18319           example: __COS__
18320         - name: resource-version
18321           in: query
18322           description: resource-version for concurrency
18323           required: true
18324           type: string
18325   /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:
18326     get:
18327       tags:
18328         - Network
18329       summary: returns classes-of-service
18330       description: returns classes-of-service
18331       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
18332       produces:
18333         - application/json
18334         - application/xml
18335       responses:
18336         "200":
18337           description: successful operation
18338           schema:
18339               $ref: "#/getDefinitions/classes-of-service"
18340         "default":
18341           description: Response codes found in [response codes](https://wiki.onap.org/).
18342       parameters:
18343         - name: site-pair-set-id
18344           in: path
18345           description: Unique id of site pair set.
18346           required: true
18347           type: string
18348           example: __SITE-PAIR-SET-ID__
18349         - name: routing-instance-id
18350           in: path
18351           description: Unique id of routing instance
18352           required: true
18353           type: string
18354           example: __ROUTING-INSTANCE-ID__
18355         - name: site-pair-id
18356           in: path
18357           description: unique identifier of probe
18358           required: true
18359           type: string
18360           example: __SITE-PAIR-ID__
18361         - name: cos
18362           in: query
18363           description:
18364           required: false
18365           type: string
18366   /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:
18367     put:
18368       tags:
18369         - Network
18370       summary: see node definition for valid relationships
18371       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
18372       consumes:
18373         - application/json
18374         - application/xml
18375       produces:
18376         - application/json
18377         - application/xml
18378       responses:
18379         "default":
18380           description: Response codes found in [response codes](https://wiki.onap.org/).
18381       parameters:
18382         - name: site-pair-set-id
18383           in: path
18384           description: Unique id of site pair set.
18385           required: true
18386           type: string
18387           example: __SITE-PAIR-SET-ID__
18388         - name: routing-instance-id
18389           in: path
18390           description: Unique id of routing instance
18391           required: true
18392           type: string
18393           example: __ROUTING-INSTANCE-ID__
18394         - name: site-pair-id
18395           in: path
18396           description: unique identifier of probe
18397           required: true
18398           type: string
18399           example: __SITE-PAIR-ID__
18400         - name: body
18401           in: body
18402           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
18403           required: true
18404           schema:
18405             $ref: "#/definitions/relationship"
18406     delete:
18407       tags:
18408         - Network
18409       summary: delete an existing relationship
18410       description: delete an existing relationship
18411       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
18412       consumes:
18413         - application/json
18414         - application/xml
18415       produces:
18416         - application/json
18417         - application/xml
18418       responses:
18419         "default":
18420           description: Response codes found in [response codes](https://wiki.onap.org/).
18421       parameters:
18422         - name: site-pair-set-id
18423           in: path
18424           description: Unique id of site pair set.
18425           required: true
18426           type: string
18427           example: __SITE-PAIR-SET-ID__
18428         - name: routing-instance-id
18429           in: path
18430           description: Unique id of routing instance
18431           required: true
18432           type: string
18433           example: __ROUTING-INSTANCE-ID__
18434         - name: site-pair-id
18435           in: path
18436           description: unique identifier of probe
18437           required: true
18438           type: string
18439           example: __SITE-PAIR-ID__
18440   /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}:
18441     get:
18442       tags:
18443         - Network
18444       summary: returns site-pair
18445       description: returns site-pair
18446       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18447       produces:
18448         - application/json
18449         - application/xml
18450       responses:
18451         "200":
18452           description: successful operation
18453           schema:
18454               $ref: "#/getDefinitions/site-pair"
18455         "default":
18456           description: Response codes found in [response codes](https://wiki.onap.org/).
18457       parameters:
18458         - name: site-pair-set-id
18459           in: path
18460           description: Unique id of site pair set.
18461           required: true
18462           type: string
18463           example: __SITE-PAIR-SET-ID__
18464         - name: routing-instance-id
18465           in: path
18466           description: Unique id of routing instance
18467           required: true
18468           type: string
18469           example: __ROUTING-INSTANCE-ID__
18470         - name: site-pair-id
18471           in: path
18472           description: unique identifier of probe
18473           required: true
18474           type: string
18475           example: __SITE-PAIR-ID__
18476     put:
18477       tags:
18478         - Network
18479       summary: create or update an existing site-pair
18480       description: |
18481         Create or update an existing site-pair.
18482         #
18483         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18484       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18485       consumes:
18486         - application/json
18487         - application/xml
18488       produces:
18489         - application/json
18490         - application/xml
18491       responses:
18492         "default":
18493           description: Response codes found in [response codes](https://wiki.onap.org/).
18494       parameters:
18495         - name: site-pair-set-id
18496           in: path
18497           description: Unique id of site pair set.
18498           required: true
18499           type: string
18500           example: __SITE-PAIR-SET-ID__
18501         - name: routing-instance-id
18502           in: path
18503           description: Unique id of routing instance
18504           required: true
18505           type: string
18506           example: __ROUTING-INSTANCE-ID__
18507         - name: site-pair-id
18508           in: path
18509           description: unique identifier of probe
18510           required: true
18511           type: string
18512           example: __SITE-PAIR-ID__
18513         - name: body
18514           in: body
18515           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
18516           required: true
18517           schema:
18518             $ref: "#/definitions/site-pair"
18519     patch:
18520       tags:
18521         - Network
18522       summary: update an existing site-pair
18523       description: |
18524         Update an existing site-pair
18525         #
18526         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18527         The PUT operation will entirely replace an existing object.
18528         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18529         #
18530         Other differences between PUT and PATCH are:
18531         #
18532         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18533         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18534         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18535       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
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: site-pair-set-id
18547           in: path
18548           description: Unique id of site pair set.
18549           required: true
18550           type: string
18551           example: __SITE-PAIR-SET-ID__
18552         - name: routing-instance-id
18553           in: path
18554           description: Unique id of routing instance
18555           required: true
18556           type: string
18557           example: __ROUTING-INSTANCE-ID__
18558         - name: site-pair-id
18559           in: path
18560           description: unique identifier of probe
18561           required: true
18562           type: string
18563           example: __SITE-PAIR-ID__
18564         - name: body
18565           in: body
18566           description: site-pair object that needs to be updated.
18567           required: true
18568           schema:
18569             $ref: "#/patchDefinitions/site-pair"
18570     delete:
18571       tags:
18572         - Network
18573       summary: delete an existing site-pair
18574       description: delete an existing site-pair
18575       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18576       consumes:
18577         - application/json
18578         - application/xml
18579       produces:
18580         - application/json
18581         - application/xml
18582       responses:
18583         "default":
18584           description: Response codes found in [response codes](https://wiki.onap.org/).
18585       parameters:
18586         - name: site-pair-set-id
18587           in: path
18588           description: Unique id of site pair set.
18589           required: true
18590           type: string
18591           example: __SITE-PAIR-SET-ID__
18592         - name: routing-instance-id
18593           in: path
18594           description: Unique id of routing instance
18595           required: true
18596           type: string
18597           example: __ROUTING-INSTANCE-ID__
18598         - name: site-pair-id
18599           in: path
18600           description: unique identifier of probe
18601           required: true
18602           type: string
18603           example: __SITE-PAIR-ID__
18604         - name: resource-version
18605           in: query
18606           description: resource-version for concurrency
18607           required: true
18608           type: string
18609   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
18610     get:
18611       tags:
18612         - Network
18613       summary: returns site-pairs
18614       description: returns site-pairs
18615       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
18616       produces:
18617         - application/json
18618         - application/xml
18619       responses:
18620         "200":
18621           description: successful operation
18622           schema:
18623               $ref: "#/getDefinitions/site-pairs"
18624         "default":
18625           description: Response codes found in [response codes](https://wiki.onap.org/).
18626       parameters:
18627         - name: site-pair-set-id
18628           in: path
18629           description: Unique id of site pair set.
18630           required: true
18631           type: string
18632           example: __SITE-PAIR-SET-ID__
18633         - name: routing-instance-id
18634           in: path
18635           description: Unique id of routing instance
18636           required: true
18637           type: string
18638           example: __ROUTING-INSTANCE-ID__
18639         - name: site-pair-id
18640           in: query
18641           description:
18642           required: false
18643           type: string
18644   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
18645     put:
18646       tags:
18647         - Network
18648       summary: see node definition for valid relationships
18649       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
18650       consumes:
18651         - application/json
18652         - application/xml
18653       produces:
18654         - application/json
18655         - application/xml
18656       responses:
18657         "default":
18658           description: Response codes found in [response codes](https://wiki.onap.org/).
18659       parameters:
18660         - name: site-pair-set-id
18661           in: path
18662           description: Unique id of site pair set.
18663           required: true
18664           type: string
18665           example: __SITE-PAIR-SET-ID__
18666         - name: routing-instance-id
18667           in: path
18668           description: Unique id of routing instance
18669           required: true
18670           type: string
18671           example: __ROUTING-INSTANCE-ID__
18672         - name: body
18673           in: body
18674           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
18675           required: true
18676           schema:
18677             $ref: "#/definitions/relationship"
18678     delete:
18679       tags:
18680         - Network
18681       summary: delete an existing relationship
18682       description: delete an existing relationship
18683       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
18684       consumes:
18685         - application/json
18686         - application/xml
18687       produces:
18688         - application/json
18689         - application/xml
18690       responses:
18691         "default":
18692           description: Response codes found in [response codes](https://wiki.onap.org/).
18693       parameters:
18694         - name: site-pair-set-id
18695           in: path
18696           description: Unique id of site pair set.
18697           required: true
18698           type: string
18699           example: __SITE-PAIR-SET-ID__
18700         - name: routing-instance-id
18701           in: path
18702           description: Unique id of routing instance
18703           required: true
18704           type: string
18705           example: __ROUTING-INSTANCE-ID__
18706   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
18707     get:
18708       tags:
18709         - Network
18710       summary: returns routing-instance
18711       description: returns routing-instance
18712       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18713       produces:
18714         - application/json
18715         - application/xml
18716       responses:
18717         "200":
18718           description: successful operation
18719           schema:
18720               $ref: "#/getDefinitions/routing-instance"
18721         "default":
18722           description: Response codes found in [response codes](https://wiki.onap.org/).
18723       parameters:
18724         - name: site-pair-set-id
18725           in: path
18726           description: Unique id of site pair set.
18727           required: true
18728           type: string
18729           example: __SITE-PAIR-SET-ID__
18730         - name: routing-instance-id
18731           in: path
18732           description: Unique id of routing instance
18733           required: true
18734           type: string
18735           example: __ROUTING-INSTANCE-ID__
18736     put:
18737       tags:
18738         - Network
18739       summary: create or update an existing routing-instance
18740       description: |
18741         Create or update an existing routing-instance.
18742         #
18743         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18744       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18745       consumes:
18746         - application/json
18747         - application/xml
18748       produces:
18749         - application/json
18750         - application/xml
18751       responses:
18752         "default":
18753           description: Response codes found in [response codes](https://wiki.onap.org/).
18754       parameters:
18755         - name: site-pair-set-id
18756           in: path
18757           description: Unique id of site pair set.
18758           required: true
18759           type: string
18760           example: __SITE-PAIR-SET-ID__
18761         - name: routing-instance-id
18762           in: path
18763           description: Unique id of routing instance
18764           required: true
18765           type: string
18766           example: __ROUTING-INSTANCE-ID__
18767         - name: body
18768           in: body
18769           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
18770           required: true
18771           schema:
18772             $ref: "#/definitions/routing-instance"
18773     patch:
18774       tags:
18775         - Network
18776       summary: update an existing routing-instance
18777       description: |
18778         Update an existing routing-instance
18779         #
18780         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18781         The PUT operation will entirely replace an existing object.
18782         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18783         #
18784         Other differences between PUT and PATCH are:
18785         #
18786         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18787         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18788         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18789       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18790       consumes:
18791         - application/json
18792         - application/xml
18793       produces:
18794         - application/json
18795         - application/xml
18796       responses:
18797         "default":
18798           description: Response codes found in [response codes](https://wiki.onap.org/).
18799       parameters:
18800         - name: site-pair-set-id
18801           in: path
18802           description: Unique id of site pair set.
18803           required: true
18804           type: string
18805           example: __SITE-PAIR-SET-ID__
18806         - name: routing-instance-id
18807           in: path
18808           description: Unique id of routing instance
18809           required: true
18810           type: string
18811           example: __ROUTING-INSTANCE-ID__
18812         - name: body
18813           in: body
18814           description: routing-instance object that needs to be updated.
18815           required: true
18816           schema:
18817             $ref: "#/patchDefinitions/routing-instance"
18818     delete:
18819       tags:
18820         - Network
18821       summary: delete an existing routing-instance
18822       description: delete an existing routing-instance
18823       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18824       consumes:
18825         - application/json
18826         - application/xml
18827       produces:
18828         - application/json
18829         - application/xml
18830       responses:
18831         "default":
18832           description: Response codes found in [response codes](https://wiki.onap.org/).
18833       parameters:
18834         - name: site-pair-set-id
18835           in: path
18836           description: Unique id of site pair set.
18837           required: true
18838           type: string
18839           example: __SITE-PAIR-SET-ID__
18840         - name: routing-instance-id
18841           in: path
18842           description: Unique id of routing instance
18843           required: true
18844           type: string
18845           example: __ROUTING-INSTANCE-ID__
18846         - name: resource-version
18847           in: query
18848           description: resource-version for concurrency
18849           required: true
18850           type: string
18851   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
18852     get:
18853       tags:
18854         - Network
18855       summary: returns routing-instances
18856       description: returns routing-instances
18857       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
18858       produces:
18859         - application/json
18860         - application/xml
18861       responses:
18862         "200":
18863           description: successful operation
18864           schema:
18865               $ref: "#/getDefinitions/routing-instances"
18866         "default":
18867           description: Response codes found in [response codes](https://wiki.onap.org/).
18868       parameters:
18869         - name: site-pair-set-id
18870           in: path
18871           description: Unique id of site pair set.
18872           required: true
18873           type: string
18874           example: __SITE-PAIR-SET-ID__
18875         - name: routing-instance-id
18876           in: query
18877           description:
18878           required: false
18879           type: string
18880   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
18881     put:
18882       tags:
18883         - Network
18884       summary: see node definition for valid relationships
18885       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
18886       consumes:
18887         - application/json
18888         - application/xml
18889       produces:
18890         - application/json
18891         - application/xml
18892       responses:
18893         "default":
18894           description: Response codes found in [response codes](https://wiki.onap.org/).
18895       parameters:
18896         - name: site-pair-set-id
18897           in: path
18898           description: Unique id of site pair set.
18899           required: true
18900           type: string
18901           example: __SITE-PAIR-SET-ID__
18902         - name: body
18903           in: body
18904           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)
18905           required: true
18906           schema:
18907             $ref: "#/definitions/relationship"
18908     delete:
18909       tags:
18910         - Network
18911       summary: delete an existing relationship
18912       description: delete an existing relationship
18913       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
18914       consumes:
18915         - application/json
18916         - application/xml
18917       produces:
18918         - application/json
18919         - application/xml
18920       responses:
18921         "default":
18922           description: Response codes found in [response codes](https://wiki.onap.org/).
18923       parameters:
18924         - name: site-pair-set-id
18925           in: path
18926           description: Unique id of site pair set.
18927           required: true
18928           type: string
18929           example: __SITE-PAIR-SET-ID__
18930   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
18931     get:
18932       tags:
18933         - Network
18934       summary: returns site-pair-set
18935       description: returns site-pair-set
18936       operationId: getNetworkSitePairSetsSitePairSet
18937       produces:
18938         - application/json
18939         - application/xml
18940       responses:
18941         "200":
18942           description: successful operation
18943           schema:
18944               $ref: "#/getDefinitions/site-pair-set"
18945         "default":
18946           description: Response codes found in [response codes](https://wiki.onap.org/).
18947       parameters:
18948         - name: site-pair-set-id
18949           in: path
18950           description: Unique id of site pair set.
18951           required: true
18952           type: string
18953           example: __SITE-PAIR-SET-ID__
18954     put:
18955       tags:
18956         - Network
18957       summary: create or update an existing site-pair-set
18958       description: |
18959         Create or update an existing site-pair-set.
18960         #
18961         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18962       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
18963       consumes:
18964         - application/json
18965         - application/xml
18966       produces:
18967         - application/json
18968         - application/xml
18969       responses:
18970         "default":
18971           description: Response codes found in [response codes](https://wiki.onap.org/).
18972       parameters:
18973         - name: site-pair-set-id
18974           in: path
18975           description: Unique id of site pair set.
18976           required: true
18977           type: string
18978           example: __SITE-PAIR-SET-ID__
18979         - name: body
18980           in: body
18981           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)
18982           required: true
18983           schema:
18984             $ref: "#/definitions/site-pair-set"
18985     patch:
18986       tags:
18987         - Network
18988       summary: update an existing site-pair-set
18989       description: |
18990         Update an existing site-pair-set
18991         #
18992         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18993         The PUT operation will entirely replace an existing object.
18994         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18995         #
18996         Other differences between PUT and PATCH are:
18997         #
18998         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18999         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19000         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19001       operationId: UpdateNetworkSitePairSetsSitePairSet
19002       consumes:
19003         - application/json
19004         - application/xml
19005       produces:
19006         - application/json
19007         - application/xml
19008       responses:
19009         "default":
19010           description: Response codes found in [response codes](https://wiki.onap.org/).
19011       parameters:
19012         - name: site-pair-set-id
19013           in: path
19014           description: Unique id of site pair set.
19015           required: true
19016           type: string
19017           example: __SITE-PAIR-SET-ID__
19018         - name: body
19019           in: body
19020           description: site-pair-set object that needs to be updated.
19021           required: true
19022           schema:
19023             $ref: "#/patchDefinitions/site-pair-set"
19024     delete:
19025       tags:
19026         - Network
19027       summary: delete an existing site-pair-set
19028       description: delete an existing site-pair-set
19029       operationId: deleteNetworkSitePairSetsSitePairSet
19030       consumes:
19031         - application/json
19032         - application/xml
19033       produces:
19034         - application/json
19035         - application/xml
19036       responses:
19037         "default":
19038           description: Response codes found in [response codes](https://wiki.onap.org/).
19039       parameters:
19040         - name: site-pair-set-id
19041           in: path
19042           description: Unique id of site pair set.
19043           required: true
19044           type: string
19045           example: __SITE-PAIR-SET-ID__
19046         - name: resource-version
19047           in: query
19048           description: resource-version for concurrency
19049           required: true
19050           type: string
19051   /network/site-pair-sets:
19052     get:
19053       tags:
19054         - Network
19055       summary: returns site-pair-sets
19056       description: returns site-pair-sets
19057       operationId: getNetworkSitePairSets
19058       produces:
19059         - application/json
19060         - application/xml
19061       responses:
19062         "200":
19063           description: successful operation
19064           schema:
19065               $ref: "#/getDefinitions/site-pair-sets"
19066         "default":
19067           description: Response codes found in [response codes](https://wiki.onap.org/).
19068       parameters:
19069         - name: site-pair-set-id
19070           in: query
19071           description:
19072           required: false
19073           type: string
19074   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
19075     put:
19076       tags:
19077         - Network
19078       summary: see node definition for valid relationships
19079       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
19080       consumes:
19081         - application/json
19082         - application/xml
19083       produces:
19084         - application/json
19085         - application/xml
19086       responses:
19087         "default":
19088           description: Response codes found in [response codes](https://wiki.onap.org/).
19089       parameters:
19090         - name: vpn-id
19091           in: path
19092           description: VPN ID, globally unique within A&AI
19093           required: true
19094           type: string
19095           example: __VPN-ID__
19096         - name: body
19097           in: body
19098           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json)
19099           required: true
19100           schema:
19101             $ref: "#/definitions/relationship"
19102     delete:
19103       tags:
19104         - Network
19105       summary: delete an existing relationship
19106       description: delete an existing relationship
19107       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
19108       consumes:
19109         - application/json
19110         - application/xml
19111       produces:
19112         - application/json
19113         - application/xml
19114       responses:
19115         "default":
19116           description: Response codes found in [response codes](https://wiki.onap.org/).
19117       parameters:
19118         - name: vpn-id
19119           in: path
19120           description: VPN ID, globally unique within A&AI
19121           required: true
19122           type: string
19123           example: __VPN-ID__
19124   /network/vpn-bindings/vpn-binding/{vpn-id}:
19125     get:
19126       tags:
19127         - Network
19128       summary: returns vpn-binding
19129       description: returns vpn-binding
19130       operationId: getNetworkVpnBindingsVpnBinding
19131       produces:
19132         - application/json
19133         - application/xml
19134       responses:
19135         "200":
19136           description: successful operation
19137           schema:
19138               $ref: "#/getDefinitions/vpn-binding"
19139         "default":
19140           description: Response codes found in [response codes](https://wiki.onap.org/).
19141       parameters:
19142         - name: vpn-id
19143           in: path
19144           description: VPN ID, globally unique within A&AI
19145           required: true
19146           type: string
19147           example: __VPN-ID__
19148     put:
19149       tags:
19150         - Network
19151       summary: create or update an existing vpn-binding
19152       description: |
19153         Create or update an existing vpn-binding.
19154         #
19155         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19156       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
19157       consumes:
19158         - application/json
19159         - application/xml
19160       produces:
19161         - application/json
19162         - application/xml
19163       responses:
19164         "default":
19165           description: Response codes found in [response codes](https://wiki.onap.org/).
19166       parameters:
19167         - name: vpn-id
19168           in: path
19169           description: VPN ID, globally unique within A&AI
19170           required: true
19171           type: string
19172           example: __VPN-ID__
19173         - name: body
19174           in: body
19175           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json)
19176           required: true
19177           schema:
19178             $ref: "#/definitions/vpn-binding"
19179     patch:
19180       tags:
19181         - Network
19182       summary: update an existing vpn-binding
19183       description: |
19184         Update an existing vpn-binding
19185         #
19186         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19187         The PUT operation will entirely replace an existing object.
19188         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19189         #
19190         Other differences between PUT and PATCH are:
19191         #
19192         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19193         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19194         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19195       operationId: UpdateNetworkVpnBindingsVpnBinding
19196       consumes:
19197         - application/json
19198         - application/xml
19199       produces:
19200         - application/json
19201         - application/xml
19202       responses:
19203         "default":
19204           description: Response codes found in [response codes](https://wiki.onap.org/).
19205       parameters:
19206         - name: vpn-id
19207           in: path
19208           description: VPN ID, globally unique within A&AI
19209           required: true
19210           type: string
19211           example: __VPN-ID__
19212         - name: body
19213           in: body
19214           description: vpn-binding object that needs to be updated.
19215           required: true
19216           schema:
19217             $ref: "#/patchDefinitions/vpn-binding"
19218     delete:
19219       tags:
19220         - Network
19221       summary: delete an existing vpn-binding
19222       description: delete an existing vpn-binding
19223       operationId: deleteNetworkVpnBindingsVpnBinding
19224       consumes:
19225         - application/json
19226         - application/xml
19227       produces:
19228         - application/json
19229         - application/xml
19230       responses:
19231         "default":
19232           description: Response codes found in [response codes](https://wiki.onap.org/).
19233       parameters:
19234         - name: vpn-id
19235           in: path
19236           description: VPN ID, globally unique within A&AI
19237           required: true
19238           type: string
19239           example: __VPN-ID__
19240         - name: resource-version
19241           in: query
19242           description: resource-version for concurrency
19243           required: true
19244           type: string
19245   /network/vpn-bindings:
19246     get:
19247       tags:
19248         - Network
19249       summary: returns vpn-bindings
19250       description: returns vpn-bindings
19251       operationId: getNetworkVpnBindings
19252       produces:
19253         - application/json
19254         - application/xml
19255       responses:
19256         "200":
19257           description: successful operation
19258           schema:
19259               $ref: "#/getDefinitions/vpn-bindings"
19260         "default":
19261           description: Response codes found in [response codes](https://wiki.onap.org/).
19262       parameters:
19263         - name: vpn-id
19264           in: query
19265           description:
19266           required: false
19267           type: string
19268         - name: vpn-name
19269           in: query
19270           description:
19271           required: false
19272           type: string
19273         - name: global-route-target
19274           in: query
19275           description:
19276           required: false
19277           type: string
19278         - name: vpn-type
19279           in: query
19280           description:
19281           required: false
19282           type: string
19283   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
19284     put:
19285       tags:
19286         - Network
19287       summary: see node definition for valid relationships
19288       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
19289       consumes:
19290         - application/json
19291         - application/xml
19292       produces:
19293         - application/json
19294         - application/xml
19295       responses:
19296         "default":
19297           description: Response codes found in [response codes](https://wiki.onap.org/).
19298       parameters:
19299         - name: equipment-name
19300           in: path
19301           required: true
19302           type: string
19303           example: __EQUIPMENT-NAME__
19304         - name: body
19305           in: body
19306           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)
19307           required: true
19308           schema:
19309             $ref: "#/definitions/relationship"
19310     delete:
19311       tags:
19312         - Network
19313       summary: delete an existing relationship
19314       description: delete an existing relationship
19315       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
19316       consumes:
19317         - application/json
19318         - application/xml
19319       produces:
19320         - application/json
19321         - application/xml
19322       responses:
19323         "default":
19324           description: Response codes found in [response codes](https://wiki.onap.org/).
19325       parameters:
19326         - name: equipment-name
19327           in: path
19328           required: true
19329           type: string
19330           example: __EQUIPMENT-NAME__
19331   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
19332     put:
19333       tags:
19334         - Network
19335       summary: see node definition for valid relationships
19336       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19337       consumes:
19338         - application/json
19339         - application/xml
19340       produces:
19341         - application/json
19342         - application/xml
19343       responses:
19344         "default":
19345           description: Response codes found in [response codes](https://wiki.onap.org/).
19346       parameters:
19347         - name: equipment-name
19348           in: path
19349           required: true
19350           type: string
19351           example: __EQUIPMENT-NAME__
19352         - name: interface-name
19353           in: path
19354           description: Name that identifies the physical interface
19355           required: true
19356           type: string
19357           example: __INTERFACE-NAME__
19358         - name: body
19359           in: body
19360           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)
19361           required: true
19362           schema:
19363             $ref: "#/definitions/relationship"
19364     delete:
19365       tags:
19366         - Network
19367       summary: delete an existing relationship
19368       description: delete an existing relationship
19369       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19370       consumes:
19371         - application/json
19372         - application/xml
19373       produces:
19374         - application/json
19375         - application/xml
19376       responses:
19377         "default":
19378           description: Response codes found in [response codes](https://wiki.onap.org/).
19379       parameters:
19380         - name: equipment-name
19381           in: path
19382           required: true
19383           type: string
19384           example: __EQUIPMENT-NAME__
19385         - name: interface-name
19386           in: path
19387           description: Name that identifies the physical interface
19388           required: true
19389           type: string
19390           example: __INTERFACE-NAME__
19391   /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:
19392     put:
19393       tags:
19394         - Network
19395       summary: see node definition for valid relationships
19396       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
19397       consumes:
19398         - application/json
19399         - application/xml
19400       produces:
19401         - application/json
19402         - application/xml
19403       responses:
19404         "default":
19405           description: Response codes found in [response codes](https://wiki.onap.org/).
19406       parameters:
19407         - name: equipment-name
19408           in: path
19409           required: true
19410           type: string
19411           example: __EQUIPMENT-NAME__
19412         - name: interface-name
19413           in: path
19414           description: Name that identifies the physical interface
19415           required: true
19416           type: string
19417           example: __INTERFACE-NAME__
19418         - name: interface-name
19419           in: path
19420           description: Name given to the interface
19421           required: true
19422           type: string
19423           example: __INTERFACE-NAME__
19424         - name: vlan-interface
19425           in: path
19426           description: String that identifies the interface
19427           required: true
19428           type: string
19429           example: __VLAN-INTERFACE__
19430         - name: body
19431           in: body
19432           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
19433           required: true
19434           schema:
19435             $ref: "#/definitions/relationship"
19436     delete:
19437       tags:
19438         - Network
19439       summary: delete an existing relationship
19440       description: delete an existing relationship
19441       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
19442       consumes:
19443         - application/json
19444         - application/xml
19445       produces:
19446         - application/json
19447         - application/xml
19448       responses:
19449         "default":
19450           description: Response codes found in [response codes](https://wiki.onap.org/).
19451       parameters:
19452         - name: equipment-name
19453           in: path
19454           required: true
19455           type: string
19456           example: __EQUIPMENT-NAME__
19457         - name: interface-name
19458           in: path
19459           description: Name that identifies the physical interface
19460           required: true
19461           type: string
19462           example: __INTERFACE-NAME__
19463         - name: interface-name
19464           in: path
19465           description: Name given to the interface
19466           required: true
19467           type: string
19468           example: __INTERFACE-NAME__
19469         - name: vlan-interface
19470           in: path
19471           description: String that identifies the interface
19472           required: true
19473           type: string
19474           example: __VLAN-INTERFACE__
19475   /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:
19476     put:
19477       tags:
19478         - Network
19479       summary: see node definition for valid relationships
19480       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
19481       consumes:
19482         - application/json
19483         - application/xml
19484       produces:
19485         - application/json
19486         - application/xml
19487       responses:
19488         "default":
19489           description: Response codes found in [response codes](https://wiki.onap.org/).
19490       parameters:
19491         - name: equipment-name
19492           in: path
19493           required: true
19494           type: string
19495           example: __EQUIPMENT-NAME__
19496         - name: interface-name
19497           in: path
19498           description: Name that identifies the physical interface
19499           required: true
19500           type: string
19501           example: __INTERFACE-NAME__
19502         - name: interface-name
19503           in: path
19504           description: Name given to the interface
19505           required: true
19506           type: string
19507           example: __INTERFACE-NAME__
19508         - name: vlan-interface
19509           in: path
19510           description: String that identifies the interface
19511           required: true
19512           type: string
19513           example: __VLAN-INTERFACE__
19514         - name: l3-interface-ipv4-address
19515           in: path
19516           description: IP address
19517           required: true
19518           type: string
19519           example: __L3-INTERFACE-IPV4-ADDRESS__
19520         - name: body
19521           in: body
19522           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
19523           required: true
19524           schema:
19525             $ref: "#/definitions/relationship"
19526     delete:
19527       tags:
19528         - Network
19529       summary: delete an existing relationship
19530       description: delete an existing relationship
19531       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
19532       consumes:
19533         - application/json
19534         - application/xml
19535       produces:
19536         - application/json
19537         - application/xml
19538       responses:
19539         "default":
19540           description: Response codes found in [response codes](https://wiki.onap.org/).
19541       parameters:
19542         - name: equipment-name
19543           in: path
19544           required: true
19545           type: string
19546           example: __EQUIPMENT-NAME__
19547         - name: interface-name
19548           in: path
19549           description: Name that identifies the physical interface
19550           required: true
19551           type: string
19552           example: __INTERFACE-NAME__
19553         - name: interface-name
19554           in: path
19555           description: Name given to the interface
19556           required: true
19557           type: string
19558           example: __INTERFACE-NAME__
19559         - name: vlan-interface
19560           in: path
19561           description: String that identifies the interface
19562           required: true
19563           type: string
19564           example: __VLAN-INTERFACE__
19565         - name: l3-interface-ipv4-address
19566           in: path
19567           description: IP address
19568           required: true
19569           type: string
19570           example: __L3-INTERFACE-IPV4-ADDRESS__
19571   /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}:
19572     get:
19573       tags:
19574         - Network
19575       summary: returns l3-interface-ipv4-address-list
19576       description: returns l3-interface-ipv4-address-list
19577       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19578       produces:
19579         - application/json
19580         - application/xml
19581       responses:
19582         "200":
19583           description: successful operation
19584           schema:
19585               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
19586         "default":
19587           description: Response codes found in [response codes](https://wiki.onap.org/).
19588       parameters:
19589         - name: equipment-name
19590           in: path
19591           required: true
19592           type: string
19593           example: __EQUIPMENT-NAME__
19594         - name: interface-name
19595           in: path
19596           description: Name that identifies the physical interface
19597           required: true
19598           type: string
19599           example: __INTERFACE-NAME__
19600         - name: interface-name
19601           in: path
19602           description: Name given to the interface
19603           required: true
19604           type: string
19605           example: __INTERFACE-NAME__
19606         - name: vlan-interface
19607           in: path
19608           description: String that identifies the interface
19609           required: true
19610           type: string
19611           example: __VLAN-INTERFACE__
19612         - name: l3-interface-ipv4-address
19613           in: path
19614           description: IP address
19615           required: true
19616           type: string
19617           example: __L3-INTERFACE-IPV4-ADDRESS__
19618     put:
19619       tags:
19620         - Network
19621       summary: create or update an existing l3-interface-ipv4-address-list
19622       description: |
19623         Create or update an existing l3-interface-ipv4-address-list.
19624         #
19625         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19626       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19627       consumes:
19628         - application/json
19629         - application/xml
19630       produces:
19631         - application/json
19632         - application/xml
19633       responses:
19634         "default":
19635           description: Response codes found in [response codes](https://wiki.onap.org/).
19636       parameters:
19637         - name: equipment-name
19638           in: path
19639           required: true
19640           type: string
19641           example: __EQUIPMENT-NAME__
19642         - name: interface-name
19643           in: path
19644           description: Name that identifies the physical interface
19645           required: true
19646           type: string
19647           example: __INTERFACE-NAME__
19648         - name: interface-name
19649           in: path
19650           description: Name given to the interface
19651           required: true
19652           type: string
19653           example: __INTERFACE-NAME__
19654         - name: vlan-interface
19655           in: path
19656           description: String that identifies the interface
19657           required: true
19658           type: string
19659           example: __VLAN-INTERFACE__
19660         - name: l3-interface-ipv4-address
19661           in: path
19662           description: IP address
19663           required: true
19664           type: string
19665           example: __L3-INTERFACE-IPV4-ADDRESS__
19666         - name: body
19667           in: body
19668           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
19669           required: true
19670           schema:
19671             $ref: "#/definitions/l3-interface-ipv4-address-list"
19672     patch:
19673       tags:
19674         - Network
19675       summary: update an existing l3-interface-ipv4-address-list
19676       description: |
19677         Update an existing l3-interface-ipv4-address-list
19678         #
19679         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19680         The PUT operation will entirely replace an existing object.
19681         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19682         #
19683         Other differences between PUT and PATCH are:
19684         #
19685         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19686         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19687         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19688       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19689       consumes:
19690         - application/json
19691         - application/xml
19692       produces:
19693         - application/json
19694         - application/xml
19695       responses:
19696         "default":
19697           description: Response codes found in [response codes](https://wiki.onap.org/).
19698       parameters:
19699         - name: equipment-name
19700           in: path
19701           required: true
19702           type: string
19703           example: __EQUIPMENT-NAME__
19704         - name: interface-name
19705           in: path
19706           description: Name that identifies the physical interface
19707           required: true
19708           type: string
19709           example: __INTERFACE-NAME__
19710         - name: interface-name
19711           in: path
19712           description: Name given to the interface
19713           required: true
19714           type: string
19715           example: __INTERFACE-NAME__
19716         - name: vlan-interface
19717           in: path
19718           description: String that identifies the interface
19719           required: true
19720           type: string
19721           example: __VLAN-INTERFACE__
19722         - name: l3-interface-ipv4-address
19723           in: path
19724           description: IP address
19725           required: true
19726           type: string
19727           example: __L3-INTERFACE-IPV4-ADDRESS__
19728         - name: body
19729           in: body
19730           description: l3-interface-ipv4-address-list object that needs to be updated.
19731           required: true
19732           schema:
19733             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
19734     delete:
19735       tags:
19736         - Network
19737       summary: delete an existing l3-interface-ipv4-address-list
19738       description: delete an existing l3-interface-ipv4-address-list
19739       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19740       consumes:
19741         - application/json
19742         - application/xml
19743       produces:
19744         - application/json
19745         - application/xml
19746       responses:
19747         "default":
19748           description: Response codes found in [response codes](https://wiki.onap.org/).
19749       parameters:
19750         - name: equipment-name
19751           in: path
19752           required: true
19753           type: string
19754           example: __EQUIPMENT-NAME__
19755         - name: interface-name
19756           in: path
19757           description: Name that identifies the physical interface
19758           required: true
19759           type: string
19760           example: __INTERFACE-NAME__
19761         - name: interface-name
19762           in: path
19763           description: Name given to the interface
19764           required: true
19765           type: string
19766           example: __INTERFACE-NAME__
19767         - name: vlan-interface
19768           in: path
19769           description: String that identifies the interface
19770           required: true
19771           type: string
19772           example: __VLAN-INTERFACE__
19773         - name: l3-interface-ipv4-address
19774           in: path
19775           description: IP address
19776           required: true
19777           type: string
19778           example: __L3-INTERFACE-IPV4-ADDRESS__
19779         - name: resource-version
19780           in: query
19781           description: resource-version for concurrency
19782           required: true
19783           type: string
19784   /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:
19785     put:
19786       tags:
19787         - Network
19788       summary: see node definition for valid relationships
19789       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
19790       consumes:
19791         - application/json
19792         - application/xml
19793       produces:
19794         - application/json
19795         - application/xml
19796       responses:
19797         "default":
19798           description: Response codes found in [response codes](https://wiki.onap.org/).
19799       parameters:
19800         - name: equipment-name
19801           in: path
19802           required: true
19803           type: string
19804           example: __EQUIPMENT-NAME__
19805         - name: interface-name
19806           in: path
19807           description: Name that identifies the physical interface
19808           required: true
19809           type: string
19810           example: __INTERFACE-NAME__
19811         - name: interface-name
19812           in: path
19813           description: Name given to the interface
19814           required: true
19815           type: string
19816           example: __INTERFACE-NAME__
19817         - name: vlan-interface
19818           in: path
19819           description: String that identifies the interface
19820           required: true
19821           type: string
19822           example: __VLAN-INTERFACE__
19823         - name: l3-interface-ipv6-address
19824           in: path
19825           description: IP address
19826           required: true
19827           type: string
19828           example: __L3-INTERFACE-IPV6-ADDRESS__
19829         - name: body
19830           in: body
19831           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
19832           required: true
19833           schema:
19834             $ref: "#/definitions/relationship"
19835     delete:
19836       tags:
19837         - Network
19838       summary: delete an existing relationship
19839       description: delete an existing relationship
19840       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
19841       consumes:
19842         - application/json
19843         - application/xml
19844       produces:
19845         - application/json
19846         - application/xml
19847       responses:
19848         "default":
19849           description: Response codes found in [response codes](https://wiki.onap.org/).
19850       parameters:
19851         - name: equipment-name
19852           in: path
19853           required: true
19854           type: string
19855           example: __EQUIPMENT-NAME__
19856         - name: interface-name
19857           in: path
19858           description: Name that identifies the physical interface
19859           required: true
19860           type: string
19861           example: __INTERFACE-NAME__
19862         - name: interface-name
19863           in: path
19864           description: Name given to the interface
19865           required: true
19866           type: string
19867           example: __INTERFACE-NAME__
19868         - name: vlan-interface
19869           in: path
19870           description: String that identifies the interface
19871           required: true
19872           type: string
19873           example: __VLAN-INTERFACE__
19874         - name: l3-interface-ipv6-address
19875           in: path
19876           description: IP address
19877           required: true
19878           type: string
19879           example: __L3-INTERFACE-IPV6-ADDRESS__
19880   /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}:
19881     get:
19882       tags:
19883         - Network
19884       summary: returns l3-interface-ipv6-address-list
19885       description: returns l3-interface-ipv6-address-list
19886       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
19887       produces:
19888         - application/json
19889         - application/xml
19890       responses:
19891         "200":
19892           description: successful operation
19893           schema:
19894               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
19895         "default":
19896           description: Response codes found in [response codes](https://wiki.onap.org/).
19897       parameters:
19898         - name: equipment-name
19899           in: path
19900           required: true
19901           type: string
19902           example: __EQUIPMENT-NAME__
19903         - name: interface-name
19904           in: path
19905           description: Name that identifies the physical interface
19906           required: true
19907           type: string
19908           example: __INTERFACE-NAME__
19909         - name: interface-name
19910           in: path
19911           description: Name given to the interface
19912           required: true
19913           type: string
19914           example: __INTERFACE-NAME__
19915         - name: vlan-interface
19916           in: path
19917           description: String that identifies the interface
19918           required: true
19919           type: string
19920           example: __VLAN-INTERFACE__
19921         - name: l3-interface-ipv6-address
19922           in: path
19923           description: IP address
19924           required: true
19925           type: string
19926           example: __L3-INTERFACE-IPV6-ADDRESS__
19927     put:
19928       tags:
19929         - Network
19930       summary: create or update an existing l3-interface-ipv6-address-list
19931       description: |
19932         Create or update an existing l3-interface-ipv6-address-list.
19933         #
19934         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19935       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
19936       consumes:
19937         - application/json
19938         - application/xml
19939       produces:
19940         - application/json
19941         - application/xml
19942       responses:
19943         "default":
19944           description: Response codes found in [response codes](https://wiki.onap.org/).
19945       parameters:
19946         - name: equipment-name
19947           in: path
19948           required: true
19949           type: string
19950           example: __EQUIPMENT-NAME__
19951         - name: interface-name
19952           in: path
19953           description: Name that identifies the physical interface
19954           required: true
19955           type: string
19956           example: __INTERFACE-NAME__
19957         - name: interface-name
19958           in: path
19959           description: Name given to the interface
19960           required: true
19961           type: string
19962           example: __INTERFACE-NAME__
19963         - name: vlan-interface
19964           in: path
19965           description: String that identifies the interface
19966           required: true
19967           type: string
19968           example: __VLAN-INTERFACE__
19969         - name: l3-interface-ipv6-address
19970           in: path
19971           description: IP address
19972           required: true
19973           type: string
19974           example: __L3-INTERFACE-IPV6-ADDRESS__
19975         - name: body
19976           in: body
19977           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
19978           required: true
19979           schema:
19980             $ref: "#/definitions/l3-interface-ipv6-address-list"
19981     patch:
19982       tags:
19983         - Network
19984       summary: update an existing l3-interface-ipv6-address-list
19985       description: |
19986         Update an existing l3-interface-ipv6-address-list
19987         #
19988         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19989         The PUT operation will entirely replace an existing object.
19990         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19991         #
19992         Other differences between PUT and PATCH are:
19993         #
19994         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19995         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19996         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19997       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
19998       consumes:
19999         - application/json
20000         - application/xml
20001       produces:
20002         - application/json
20003         - application/xml
20004       responses:
20005         "default":
20006           description: Response codes found in [response codes](https://wiki.onap.org/).
20007       parameters:
20008         - name: equipment-name
20009           in: path
20010           required: true
20011           type: string
20012           example: __EQUIPMENT-NAME__
20013         - name: interface-name
20014           in: path
20015           description: Name that identifies the physical interface
20016           required: true
20017           type: string
20018           example: __INTERFACE-NAME__
20019         - name: interface-name
20020           in: path
20021           description: Name given to the interface
20022           required: true
20023           type: string
20024           example: __INTERFACE-NAME__
20025         - name: vlan-interface
20026           in: path
20027           description: String that identifies the interface
20028           required: true
20029           type: string
20030           example: __VLAN-INTERFACE__
20031         - name: l3-interface-ipv6-address
20032           in: path
20033           description: IP address
20034           required: true
20035           type: string
20036           example: __L3-INTERFACE-IPV6-ADDRESS__
20037         - name: body
20038           in: body
20039           description: l3-interface-ipv6-address-list object that needs to be updated.
20040           required: true
20041           schema:
20042             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
20043     delete:
20044       tags:
20045         - Network
20046       summary: delete an existing l3-interface-ipv6-address-list
20047       description: delete an existing l3-interface-ipv6-address-list
20048       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20049       consumes:
20050         - application/json
20051         - application/xml
20052       produces:
20053         - application/json
20054         - application/xml
20055       responses:
20056         "default":
20057           description: Response codes found in [response codes](https://wiki.onap.org/).
20058       parameters:
20059         - name: equipment-name
20060           in: path
20061           required: true
20062           type: string
20063           example: __EQUIPMENT-NAME__
20064         - name: interface-name
20065           in: path
20066           description: Name that identifies the physical interface
20067           required: true
20068           type: string
20069           example: __INTERFACE-NAME__
20070         - name: interface-name
20071           in: path
20072           description: Name given to the interface
20073           required: true
20074           type: string
20075           example: __INTERFACE-NAME__
20076         - name: vlan-interface
20077           in: path
20078           description: String that identifies the interface
20079           required: true
20080           type: string
20081           example: __VLAN-INTERFACE__
20082         - name: l3-interface-ipv6-address
20083           in: path
20084           description: IP address
20085           required: true
20086           type: string
20087           example: __L3-INTERFACE-IPV6-ADDRESS__
20088         - name: resource-version
20089           in: query
20090           description: resource-version for concurrency
20091           required: true
20092           type: string
20093   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
20094     get:
20095       tags:
20096         - Network
20097       summary: returns vlan
20098       description: returns vlan
20099       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20100       produces:
20101         - application/json
20102         - application/xml
20103       responses:
20104         "200":
20105           description: successful operation
20106           schema:
20107               $ref: "#/getDefinitions/vlan"
20108         "default":
20109           description: Response codes found in [response codes](https://wiki.onap.org/).
20110       parameters:
20111         - name: equipment-name
20112           in: path
20113           required: true
20114           type: string
20115           example: __EQUIPMENT-NAME__
20116         - name: interface-name
20117           in: path
20118           description: Name that identifies the physical interface
20119           required: true
20120           type: string
20121           example: __INTERFACE-NAME__
20122         - name: interface-name
20123           in: path
20124           description: Name given to the interface
20125           required: true
20126           type: string
20127           example: __INTERFACE-NAME__
20128         - name: vlan-interface
20129           in: path
20130           description: String that identifies the interface
20131           required: true
20132           type: string
20133           example: __VLAN-INTERFACE__
20134     put:
20135       tags:
20136         - Network
20137       summary: create or update an existing vlan
20138       description: |
20139         Create or update an existing vlan.
20140         #
20141         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20142       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20143       consumes:
20144         - application/json
20145         - application/xml
20146       produces:
20147         - application/json
20148         - application/xml
20149       responses:
20150         "default":
20151           description: Response codes found in [response codes](https://wiki.onap.org/).
20152       parameters:
20153         - name: equipment-name
20154           in: path
20155           required: true
20156           type: string
20157           example: __EQUIPMENT-NAME__
20158         - name: interface-name
20159           in: path
20160           description: Name that identifies the physical interface
20161           required: true
20162           type: string
20163           example: __INTERFACE-NAME__
20164         - name: interface-name
20165           in: path
20166           description: Name given to the interface
20167           required: true
20168           type: string
20169           example: __INTERFACE-NAME__
20170         - name: vlan-interface
20171           in: path
20172           description: String that identifies the interface
20173           required: true
20174           type: string
20175           example: __VLAN-INTERFACE__
20176         - name: body
20177           in: body
20178           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
20179           required: true
20180           schema:
20181             $ref: "#/definitions/vlan"
20182     patch:
20183       tags:
20184         - Network
20185       summary: update an existing vlan
20186       description: |
20187         Update an existing vlan
20188         #
20189         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20190         The PUT operation will entirely replace an existing object.
20191         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20192         #
20193         Other differences between PUT and PATCH are:
20194         #
20195         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20196         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20197         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20198       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20199       consumes:
20200         - application/json
20201         - application/xml
20202       produces:
20203         - application/json
20204         - application/xml
20205       responses:
20206         "default":
20207           description: Response codes found in [response codes](https://wiki.onap.org/).
20208       parameters:
20209         - name: equipment-name
20210           in: path
20211           required: true
20212           type: string
20213           example: __EQUIPMENT-NAME__
20214         - name: interface-name
20215           in: path
20216           description: Name that identifies the physical interface
20217           required: true
20218           type: string
20219           example: __INTERFACE-NAME__
20220         - name: interface-name
20221           in: path
20222           description: Name given to the interface
20223           required: true
20224           type: string
20225           example: __INTERFACE-NAME__
20226         - name: vlan-interface
20227           in: path
20228           description: String that identifies the interface
20229           required: true
20230           type: string
20231           example: __VLAN-INTERFACE__
20232         - name: body
20233           in: body
20234           description: vlan object that needs to be updated.
20235           required: true
20236           schema:
20237             $ref: "#/patchDefinitions/vlan"
20238     delete:
20239       tags:
20240         - Network
20241       summary: delete an existing vlan
20242       description: delete an existing vlan
20243       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20244       consumes:
20245         - application/json
20246         - application/xml
20247       produces:
20248         - application/json
20249         - application/xml
20250       responses:
20251         "default":
20252           description: Response codes found in [response codes](https://wiki.onap.org/).
20253       parameters:
20254         - name: equipment-name
20255           in: path
20256           required: true
20257           type: string
20258           example: __EQUIPMENT-NAME__
20259         - name: interface-name
20260           in: path
20261           description: Name that identifies the physical interface
20262           required: true
20263           type: string
20264           example: __INTERFACE-NAME__
20265         - name: interface-name
20266           in: path
20267           description: Name given to the interface
20268           required: true
20269           type: string
20270           example: __INTERFACE-NAME__
20271         - name: vlan-interface
20272           in: path
20273           description: String that identifies the interface
20274           required: true
20275           type: string
20276           example: __VLAN-INTERFACE__
20277         - name: resource-version
20278           in: query
20279           description: resource-version for concurrency
20280           required: true
20281           type: string
20282   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
20283     get:
20284       tags:
20285         - Network
20286       summary: returns vlans
20287       description: returns vlans
20288       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
20289       produces:
20290         - application/json
20291         - application/xml
20292       responses:
20293         "200":
20294           description: successful operation
20295           schema:
20296               $ref: "#/getDefinitions/vlans"
20297         "default":
20298           description: Response codes found in [response codes](https://wiki.onap.org/).
20299       parameters:
20300         - name: equipment-name
20301           in: path
20302           required: true
20303           type: string
20304           example: __EQUIPMENT-NAME__
20305         - name: interface-name
20306           in: path
20307           description: Name that identifies the physical interface
20308           required: true
20309           type: string
20310           example: __INTERFACE-NAME__
20311         - name: interface-name
20312           in: path
20313           description: Name given to the interface
20314           required: true
20315           type: string
20316           example: __INTERFACE-NAME__
20317         - name: vlan-interface
20318           in: query
20319           description:
20320           required: false
20321           type: string
20322         - name: vlan-id-inner
20323           in: query
20324           description:
20325           required: false
20326           type: integer
20327           format: int64
20328         - name: vpn-id
20329           in: query
20330           description:
20331           required: false
20332           type: string
20333   /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:
20334     put:
20335       tags:
20336         - Network
20337       summary: see node definition for valid relationships
20338       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
20339       consumes:
20340         - application/json
20341         - application/xml
20342       produces:
20343         - application/json
20344         - application/xml
20345       responses:
20346         "default":
20347           description: Response codes found in [response codes](https://wiki.onap.org/).
20348       parameters:
20349         - name: equipment-name
20350           in: path
20351           required: true
20352           type: string
20353           example: __EQUIPMENT-NAME__
20354         - name: interface-name
20355           in: path
20356           description: Name that identifies the physical interface
20357           required: true
20358           type: string
20359           example: __INTERFACE-NAME__
20360         - name: interface-name
20361           in: path
20362           description: Name given to the interface
20363           required: true
20364           type: string
20365           example: __INTERFACE-NAME__
20366         - name: pci-id
20367           in: path
20368           description: PCI ID used to identify the sriov-vf
20369           required: true
20370           type: string
20371           example: __PCI-ID__
20372         - name: body
20373           in: body
20374           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
20375           required: true
20376           schema:
20377             $ref: "#/definitions/relationship"
20378     delete:
20379       tags:
20380         - Network
20381       summary: delete an existing relationship
20382       description: delete an existing relationship
20383       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
20384       consumes:
20385         - application/json
20386         - application/xml
20387       produces:
20388         - application/json
20389         - application/xml
20390       responses:
20391         "default":
20392           description: Response codes found in [response codes](https://wiki.onap.org/).
20393       parameters:
20394         - name: equipment-name
20395           in: path
20396           required: true
20397           type: string
20398           example: __EQUIPMENT-NAME__
20399         - name: interface-name
20400           in: path
20401           description: Name that identifies the physical interface
20402           required: true
20403           type: string
20404           example: __INTERFACE-NAME__
20405         - name: interface-name
20406           in: path
20407           description: Name given to the interface
20408           required: true
20409           type: string
20410           example: __INTERFACE-NAME__
20411         - name: pci-id
20412           in: path
20413           description: PCI ID used to identify the sriov-vf
20414           required: true
20415           type: string
20416           example: __PCI-ID__
20417   /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}:
20418     get:
20419       tags:
20420         - Network
20421       summary: returns sriov-vf
20422       description: returns sriov-vf
20423       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20424       produces:
20425         - application/json
20426         - application/xml
20427       responses:
20428         "200":
20429           description: successful operation
20430           schema:
20431               $ref: "#/getDefinitions/sriov-vf"
20432         "default":
20433           description: Response codes found in [response codes](https://wiki.onap.org/).
20434       parameters:
20435         - name: equipment-name
20436           in: path
20437           required: true
20438           type: string
20439           example: __EQUIPMENT-NAME__
20440         - name: interface-name
20441           in: path
20442           description: Name that identifies the physical interface
20443           required: true
20444           type: string
20445           example: __INTERFACE-NAME__
20446         - name: interface-name
20447           in: path
20448           description: Name given to the interface
20449           required: true
20450           type: string
20451           example: __INTERFACE-NAME__
20452         - name: pci-id
20453           in: path
20454           description: PCI ID used to identify the sriov-vf
20455           required: true
20456           type: string
20457           example: __PCI-ID__
20458     put:
20459       tags:
20460         - Network
20461       summary: create or update an existing sriov-vf
20462       description: |
20463         Create or update an existing sriov-vf.
20464         #
20465         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20466       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20467       consumes:
20468         - application/json
20469         - application/xml
20470       produces:
20471         - application/json
20472         - application/xml
20473       responses:
20474         "default":
20475           description: Response codes found in [response codes](https://wiki.onap.org/).
20476       parameters:
20477         - name: equipment-name
20478           in: path
20479           required: true
20480           type: string
20481           example: __EQUIPMENT-NAME__
20482         - name: interface-name
20483           in: path
20484           description: Name that identifies the physical interface
20485           required: true
20486           type: string
20487           example: __INTERFACE-NAME__
20488         - name: interface-name
20489           in: path
20490           description: Name given to the interface
20491           required: true
20492           type: string
20493           example: __INTERFACE-NAME__
20494         - name: pci-id
20495           in: path
20496           description: PCI ID used to identify the sriov-vf
20497           required: true
20498           type: string
20499           example: __PCI-ID__
20500         - name: body
20501           in: body
20502           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
20503           required: true
20504           schema:
20505             $ref: "#/definitions/sriov-vf"
20506     patch:
20507       tags:
20508         - Network
20509       summary: update an existing sriov-vf
20510       description: |
20511         Update an existing sriov-vf
20512         #
20513         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20514         The PUT operation will entirely replace an existing object.
20515         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20516         #
20517         Other differences between PUT and PATCH are:
20518         #
20519         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20520         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20521         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20522       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20523       consumes:
20524         - application/json
20525         - application/xml
20526       produces:
20527         - application/json
20528         - application/xml
20529       responses:
20530         "default":
20531           description: Response codes found in [response codes](https://wiki.onap.org/).
20532       parameters:
20533         - name: equipment-name
20534           in: path
20535           required: true
20536           type: string
20537           example: __EQUIPMENT-NAME__
20538         - name: interface-name
20539           in: path
20540           description: Name that identifies the physical interface
20541           required: true
20542           type: string
20543           example: __INTERFACE-NAME__
20544         - name: interface-name
20545           in: path
20546           description: Name given to the interface
20547           required: true
20548           type: string
20549           example: __INTERFACE-NAME__
20550         - name: pci-id
20551           in: path
20552           description: PCI ID used to identify the sriov-vf
20553           required: true
20554           type: string
20555           example: __PCI-ID__
20556         - name: body
20557           in: body
20558           description: sriov-vf object that needs to be updated.
20559           required: true
20560           schema:
20561             $ref: "#/patchDefinitions/sriov-vf"
20562     delete:
20563       tags:
20564         - Network
20565       summary: delete an existing sriov-vf
20566       description: delete an existing sriov-vf
20567       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20568       consumes:
20569         - application/json
20570         - application/xml
20571       produces:
20572         - application/json
20573         - application/xml
20574       responses:
20575         "default":
20576           description: Response codes found in [response codes](https://wiki.onap.org/).
20577       parameters:
20578         - name: equipment-name
20579           in: path
20580           required: true
20581           type: string
20582           example: __EQUIPMENT-NAME__
20583         - name: interface-name
20584           in: path
20585           description: Name that identifies the physical interface
20586           required: true
20587           type: string
20588           example: __INTERFACE-NAME__
20589         - name: interface-name
20590           in: path
20591           description: Name given to the interface
20592           required: true
20593           type: string
20594           example: __INTERFACE-NAME__
20595         - name: pci-id
20596           in: path
20597           description: PCI ID used to identify the sriov-vf
20598           required: true
20599           type: string
20600           example: __PCI-ID__
20601         - name: resource-version
20602           in: query
20603           description: resource-version for concurrency
20604           required: true
20605           type: string
20606   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
20607     get:
20608       tags:
20609         - Network
20610       summary: returns sriov-vfs
20611       description: returns sriov-vfs
20612       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
20613       produces:
20614         - application/json
20615         - application/xml
20616       responses:
20617         "200":
20618           description: successful operation
20619           schema:
20620               $ref: "#/getDefinitions/sriov-vfs"
20621         "default":
20622           description: Response codes found in [response codes](https://wiki.onap.org/).
20623       parameters:
20624         - name: equipment-name
20625           in: path
20626           required: true
20627           type: string
20628           example: __EQUIPMENT-NAME__
20629         - name: interface-name
20630           in: path
20631           description: Name that identifies the physical interface
20632           required: true
20633           type: string
20634           example: __INTERFACE-NAME__
20635         - name: interface-name
20636           in: path
20637           description: Name given to the interface
20638           required: true
20639           type: string
20640           example: __INTERFACE-NAME__
20641         - name: pci-id
20642           in: query
20643           description:
20644           required: false
20645           type: string
20646         - name: vf-vlan-filter
20647           in: query
20648           description:
20649           required: false
20650           type: string
20651         - name: vf-mac-filter
20652           in: query
20653           description:
20654           required: false
20655           type: string
20656         - name: vf-vlan-strip
20657           in: query
20658           description:
20659           required: false
20660           type: boolean
20661         - name: neutron-network-id
20662           in: query
20663           description:
20664           required: false
20665           type: string
20666   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
20667     put:
20668       tags:
20669         - Network
20670       summary: see node definition for valid relationships
20671       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
20672       consumes:
20673         - application/json
20674         - application/xml
20675       produces:
20676         - application/json
20677         - application/xml
20678       responses:
20679         "default":
20680           description: Response codes found in [response codes](https://wiki.onap.org/).
20681       parameters:
20682         - name: equipment-name
20683           in: path
20684           required: true
20685           type: string
20686           example: __EQUIPMENT-NAME__
20687         - name: interface-name
20688           in: path
20689           description: Name that identifies the physical interface
20690           required: true
20691           type: string
20692           example: __INTERFACE-NAME__
20693         - name: interface-name
20694           in: path
20695           description: Name given to the interface
20696           required: true
20697           type: string
20698           example: __INTERFACE-NAME__
20699         - name: body
20700           in: body
20701           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
20702           required: true
20703           schema:
20704             $ref: "#/definitions/relationship"
20705     delete:
20706       tags:
20707         - Network
20708       summary: delete an existing relationship
20709       description: delete an existing relationship
20710       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
20711       consumes:
20712         - application/json
20713         - application/xml
20714       produces:
20715         - application/json
20716         - application/xml
20717       responses:
20718         "default":
20719           description: Response codes found in [response codes](https://wiki.onap.org/).
20720       parameters:
20721         - name: equipment-name
20722           in: path
20723           required: true
20724           type: string
20725           example: __EQUIPMENT-NAME__
20726         - name: interface-name
20727           in: path
20728           description: Name that identifies the physical interface
20729           required: true
20730           type: string
20731           example: __INTERFACE-NAME__
20732         - name: interface-name
20733           in: path
20734           description: Name given to the interface
20735           required: true
20736           type: string
20737           example: __INTERFACE-NAME__
20738   /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:
20739     put:
20740       tags:
20741         - Network
20742       summary: see node definition for valid relationships
20743       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
20744       consumes:
20745         - application/json
20746         - application/xml
20747       produces:
20748         - application/json
20749         - application/xml
20750       responses:
20751         "default":
20752           description: Response codes found in [response codes](https://wiki.onap.org/).
20753       parameters:
20754         - name: equipment-name
20755           in: path
20756           required: true
20757           type: string
20758           example: __EQUIPMENT-NAME__
20759         - name: interface-name
20760           in: path
20761           description: Name that identifies the physical interface
20762           required: true
20763           type: string
20764           example: __INTERFACE-NAME__
20765         - name: interface-name
20766           in: path
20767           description: Name given to the interface
20768           required: true
20769           type: string
20770           example: __INTERFACE-NAME__
20771         - name: l3-interface-ipv4-address
20772           in: path
20773           description: IP address
20774           required: true
20775           type: string
20776           example: __L3-INTERFACE-IPV4-ADDRESS__
20777         - name: body
20778           in: body
20779           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
20780           required: true
20781           schema:
20782             $ref: "#/definitions/relationship"
20783     delete:
20784       tags:
20785         - Network
20786       summary: delete an existing relationship
20787       description: delete an existing relationship
20788       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
20789       consumes:
20790         - application/json
20791         - application/xml
20792       produces:
20793         - application/json
20794         - application/xml
20795       responses:
20796         "default":
20797           description: Response codes found in [response codes](https://wiki.onap.org/).
20798       parameters:
20799         - name: equipment-name
20800           in: path
20801           required: true
20802           type: string
20803           example: __EQUIPMENT-NAME__
20804         - name: interface-name
20805           in: path
20806           description: Name that identifies the physical interface
20807           required: true
20808           type: string
20809           example: __INTERFACE-NAME__
20810         - name: interface-name
20811           in: path
20812           description: Name given to the interface
20813           required: true
20814           type: string
20815           example: __INTERFACE-NAME__
20816         - name: l3-interface-ipv4-address
20817           in: path
20818           description: IP address
20819           required: true
20820           type: string
20821           example: __L3-INTERFACE-IPV4-ADDRESS__
20822   /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}:
20823     get:
20824       tags:
20825         - Network
20826       summary: returns l3-interface-ipv4-address-list
20827       description: returns l3-interface-ipv4-address-list
20828       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
20829       produces:
20830         - application/json
20831         - application/xml
20832       responses:
20833         "200":
20834           description: successful operation
20835           schema:
20836               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
20837         "default":
20838           description: Response codes found in [response codes](https://wiki.onap.org/).
20839       parameters:
20840         - name: equipment-name
20841           in: path
20842           required: true
20843           type: string
20844           example: __EQUIPMENT-NAME__
20845         - name: interface-name
20846           in: path
20847           description: Name that identifies the physical interface
20848           required: true
20849           type: string
20850           example: __INTERFACE-NAME__
20851         - name: interface-name
20852           in: path
20853           description: Name given to the interface
20854           required: true
20855           type: string
20856           example: __INTERFACE-NAME__
20857         - name: l3-interface-ipv4-address
20858           in: path
20859           description: IP address
20860           required: true
20861           type: string
20862           example: __L3-INTERFACE-IPV4-ADDRESS__
20863     put:
20864       tags:
20865         - Network
20866       summary: create or update an existing l3-interface-ipv4-address-list
20867       description: |
20868         Create or update an existing l3-interface-ipv4-address-list.
20869         #
20870         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20871       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
20872       consumes:
20873         - application/json
20874         - application/xml
20875       produces:
20876         - application/json
20877         - application/xml
20878       responses:
20879         "default":
20880           description: Response codes found in [response codes](https://wiki.onap.org/).
20881       parameters:
20882         - name: equipment-name
20883           in: path
20884           required: true
20885           type: string
20886           example: __EQUIPMENT-NAME__
20887         - name: interface-name
20888           in: path
20889           description: Name that identifies the physical interface
20890           required: true
20891           type: string
20892           example: __INTERFACE-NAME__
20893         - name: interface-name
20894           in: path
20895           description: Name given to the interface
20896           required: true
20897           type: string
20898           example: __INTERFACE-NAME__
20899         - name: l3-interface-ipv4-address
20900           in: path
20901           description: IP address
20902           required: true
20903           type: string
20904           example: __L3-INTERFACE-IPV4-ADDRESS__
20905         - name: body
20906           in: body
20907           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
20908           required: true
20909           schema:
20910             $ref: "#/definitions/l3-interface-ipv4-address-list"
20911     patch:
20912       tags:
20913         - Network
20914       summary: update an existing l3-interface-ipv4-address-list
20915       description: |
20916         Update an existing l3-interface-ipv4-address-list
20917         #
20918         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20919         The PUT operation will entirely replace an existing object.
20920         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20921         #
20922         Other differences between PUT and PATCH are:
20923         #
20924         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20925         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20926         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20927       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
20928       consumes:
20929         - application/json
20930         - application/xml
20931       produces:
20932         - application/json
20933         - application/xml
20934       responses:
20935         "default":
20936           description: Response codes found in [response codes](https://wiki.onap.org/).
20937       parameters:
20938         - name: equipment-name
20939           in: path
20940           required: true
20941           type: string
20942           example: __EQUIPMENT-NAME__
20943         - name: interface-name
20944           in: path
20945           description: Name that identifies the physical interface
20946           required: true
20947           type: string
20948           example: __INTERFACE-NAME__
20949         - name: interface-name
20950           in: path
20951           description: Name given to the interface
20952           required: true
20953           type: string
20954           example: __INTERFACE-NAME__
20955         - name: l3-interface-ipv4-address
20956           in: path
20957           description: IP address
20958           required: true
20959           type: string
20960           example: __L3-INTERFACE-IPV4-ADDRESS__
20961         - name: body
20962           in: body
20963           description: l3-interface-ipv4-address-list object that needs to be updated.
20964           required: true
20965           schema:
20966             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
20967     delete:
20968       tags:
20969         - Network
20970       summary: delete an existing l3-interface-ipv4-address-list
20971       description: delete an existing l3-interface-ipv4-address-list
20972       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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: equipment-name
20984           in: path
20985           required: true
20986           type: string
20987           example: __EQUIPMENT-NAME__
20988         - name: interface-name
20989           in: path
20990           description: Name that identifies the physical interface
20991           required: true
20992           type: string
20993           example: __INTERFACE-NAME__
20994         - name: interface-name
20995           in: path
20996           description: Name given to the interface
20997           required: true
20998           type: string
20999           example: __INTERFACE-NAME__
21000         - name: l3-interface-ipv4-address
21001           in: path
21002           description: IP address
21003           required: true
21004           type: string
21005           example: __L3-INTERFACE-IPV4-ADDRESS__
21006         - name: resource-version
21007           in: query
21008           description: resource-version for concurrency
21009           required: true
21010           type: string
21011   /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:
21012     put:
21013       tags:
21014         - Network
21015       summary: see node definition for valid relationships
21016       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21017       consumes:
21018         - application/json
21019         - application/xml
21020       produces:
21021         - application/json
21022         - application/xml
21023       responses:
21024         "default":
21025           description: Response codes found in [response codes](https://wiki.onap.org/).
21026       parameters:
21027         - name: equipment-name
21028           in: path
21029           required: true
21030           type: string
21031           example: __EQUIPMENT-NAME__
21032         - name: interface-name
21033           in: path
21034           description: Name that identifies the physical interface
21035           required: true
21036           type: string
21037           example: __INTERFACE-NAME__
21038         - name: interface-name
21039           in: path
21040           description: Name given to the interface
21041           required: true
21042           type: string
21043           example: __INTERFACE-NAME__
21044         - name: l3-interface-ipv6-address
21045           in: path
21046           description: IP address
21047           required: true
21048           type: string
21049           example: __L3-INTERFACE-IPV6-ADDRESS__
21050         - name: body
21051           in: body
21052           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21053           required: true
21054           schema:
21055             $ref: "#/definitions/relationship"
21056     delete:
21057       tags:
21058         - Network
21059       summary: delete an existing relationship
21060       description: delete an existing relationship
21061       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21062       consumes:
21063         - application/json
21064         - application/xml
21065       produces:
21066         - application/json
21067         - application/xml
21068       responses:
21069         "default":
21070           description: Response codes found in [response codes](https://wiki.onap.org/).
21071       parameters:
21072         - name: equipment-name
21073           in: path
21074           required: true
21075           type: string
21076           example: __EQUIPMENT-NAME__
21077         - name: interface-name
21078           in: path
21079           description: Name that identifies the physical interface
21080           required: true
21081           type: string
21082           example: __INTERFACE-NAME__
21083         - name: interface-name
21084           in: path
21085           description: Name given to the interface
21086           required: true
21087           type: string
21088           example: __INTERFACE-NAME__
21089         - name: l3-interface-ipv6-address
21090           in: path
21091           description: IP address
21092           required: true
21093           type: string
21094           example: __L3-INTERFACE-IPV6-ADDRESS__
21095   /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}:
21096     get:
21097       tags:
21098         - Network
21099       summary: returns l3-interface-ipv6-address-list
21100       description: returns l3-interface-ipv6-address-list
21101       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21102       produces:
21103         - application/json
21104         - application/xml
21105       responses:
21106         "200":
21107           description: successful operation
21108           schema:
21109               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
21110         "default":
21111           description: Response codes found in [response codes](https://wiki.onap.org/).
21112       parameters:
21113         - name: equipment-name
21114           in: path
21115           required: true
21116           type: string
21117           example: __EQUIPMENT-NAME__
21118         - name: interface-name
21119           in: path
21120           description: Name that identifies the physical interface
21121           required: true
21122           type: string
21123           example: __INTERFACE-NAME__
21124         - name: interface-name
21125           in: path
21126           description: Name given to the interface
21127           required: true
21128           type: string
21129           example: __INTERFACE-NAME__
21130         - name: l3-interface-ipv6-address
21131           in: path
21132           description: IP address
21133           required: true
21134           type: string
21135           example: __L3-INTERFACE-IPV6-ADDRESS__
21136     put:
21137       tags:
21138         - Network
21139       summary: create or update an existing l3-interface-ipv6-address-list
21140       description: |
21141         Create or update an existing l3-interface-ipv6-address-list.
21142         #
21143         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21144       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21145       consumes:
21146         - application/json
21147         - application/xml
21148       produces:
21149         - application/json
21150         - application/xml
21151       responses:
21152         "default":
21153           description: Response codes found in [response codes](https://wiki.onap.org/).
21154       parameters:
21155         - name: equipment-name
21156           in: path
21157           required: true
21158           type: string
21159           example: __EQUIPMENT-NAME__
21160         - name: interface-name
21161           in: path
21162           description: Name that identifies the physical interface
21163           required: true
21164           type: string
21165           example: __INTERFACE-NAME__
21166         - name: interface-name
21167           in: path
21168           description: Name given to the interface
21169           required: true
21170           type: string
21171           example: __INTERFACE-NAME__
21172         - name: l3-interface-ipv6-address
21173           in: path
21174           description: IP address
21175           required: true
21176           type: string
21177           example: __L3-INTERFACE-IPV6-ADDRESS__
21178         - name: body
21179           in: body
21180           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21181           required: true
21182           schema:
21183             $ref: "#/definitions/l3-interface-ipv6-address-list"
21184     patch:
21185       tags:
21186         - Network
21187       summary: update an existing l3-interface-ipv6-address-list
21188       description: |
21189         Update an existing l3-interface-ipv6-address-list
21190         #
21191         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21192         The PUT operation will entirely replace an existing object.
21193         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21194         #
21195         Other differences between PUT and PATCH are:
21196         #
21197         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21198         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21199         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21200       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21201       consumes:
21202         - application/json
21203         - application/xml
21204       produces:
21205         - application/json
21206         - application/xml
21207       responses:
21208         "default":
21209           description: Response codes found in [response codes](https://wiki.onap.org/).
21210       parameters:
21211         - name: equipment-name
21212           in: path
21213           required: true
21214           type: string
21215           example: __EQUIPMENT-NAME__
21216         - name: interface-name
21217           in: path
21218           description: Name that identifies the physical interface
21219           required: true
21220           type: string
21221           example: __INTERFACE-NAME__
21222         - name: interface-name
21223           in: path
21224           description: Name given to the interface
21225           required: true
21226           type: string
21227           example: __INTERFACE-NAME__
21228         - name: l3-interface-ipv6-address
21229           in: path
21230           description: IP address
21231           required: true
21232           type: string
21233           example: __L3-INTERFACE-IPV6-ADDRESS__
21234         - name: body
21235           in: body
21236           description: l3-interface-ipv6-address-list object that needs to be updated.
21237           required: true
21238           schema:
21239             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
21240     delete:
21241       tags:
21242         - Network
21243       summary: delete an existing l3-interface-ipv6-address-list
21244       description: delete an existing l3-interface-ipv6-address-list
21245       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21246       consumes:
21247         - application/json
21248         - application/xml
21249       produces:
21250         - application/json
21251         - application/xml
21252       responses:
21253         "default":
21254           description: Response codes found in [response codes](https://wiki.onap.org/).
21255       parameters:
21256         - name: equipment-name
21257           in: path
21258           required: true
21259           type: string
21260           example: __EQUIPMENT-NAME__
21261         - name: interface-name
21262           in: path
21263           description: Name that identifies the physical interface
21264           required: true
21265           type: string
21266           example: __INTERFACE-NAME__
21267         - name: interface-name
21268           in: path
21269           description: Name given to the interface
21270           required: true
21271           type: string
21272           example: __INTERFACE-NAME__
21273         - name: l3-interface-ipv6-address
21274           in: path
21275           description: IP address
21276           required: true
21277           type: string
21278           example: __L3-INTERFACE-IPV6-ADDRESS__
21279         - name: resource-version
21280           in: query
21281           description: resource-version for concurrency
21282           required: true
21283           type: string
21284   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
21285     get:
21286       tags:
21287         - Network
21288       summary: returns l-interface
21289       description: returns l-interface
21290       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21291       produces:
21292         - application/json
21293         - application/xml
21294       responses:
21295         "200":
21296           description: successful operation
21297           schema:
21298               $ref: "#/getDefinitions/l-interface"
21299         "default":
21300           description: Response codes found in [response codes](https://wiki.onap.org/).
21301       parameters:
21302         - name: equipment-name
21303           in: path
21304           required: true
21305           type: string
21306           example: __EQUIPMENT-NAME__
21307         - name: interface-name
21308           in: path
21309           description: Name that identifies the physical interface
21310           required: true
21311           type: string
21312           example: __INTERFACE-NAME__
21313         - name: interface-name
21314           in: path
21315           description: Name given to the interface
21316           required: true
21317           type: string
21318           example: __INTERFACE-NAME__
21319     put:
21320       tags:
21321         - Network
21322       summary: create or update an existing l-interface
21323       description: |
21324         Create or update an existing l-interface.
21325         #
21326         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21327       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21328       consumes:
21329         - application/json
21330         - application/xml
21331       produces:
21332         - application/json
21333         - application/xml
21334       responses:
21335         "default":
21336           description: Response codes found in [response codes](https://wiki.onap.org/).
21337       parameters:
21338         - name: equipment-name
21339           in: path
21340           required: true
21341           type: string
21342           example: __EQUIPMENT-NAME__
21343         - name: interface-name
21344           in: path
21345           description: Name that identifies the physical interface
21346           required: true
21347           type: string
21348           example: __INTERFACE-NAME__
21349         - name: interface-name
21350           in: path
21351           description: Name given to the interface
21352           required: true
21353           type: string
21354           example: __INTERFACE-NAME__
21355         - name: body
21356           in: body
21357           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
21358           required: true
21359           schema:
21360             $ref: "#/definitions/l-interface"
21361     patch:
21362       tags:
21363         - Network
21364       summary: update an existing l-interface
21365       description: |
21366         Update an existing l-interface
21367         #
21368         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21369         The PUT operation will entirely replace an existing object.
21370         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21371         #
21372         Other differences between PUT and PATCH are:
21373         #
21374         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21375         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21376         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21377       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21378       consumes:
21379         - application/json
21380         - application/xml
21381       produces:
21382         - application/json
21383         - application/xml
21384       responses:
21385         "default":
21386           description: Response codes found in [response codes](https://wiki.onap.org/).
21387       parameters:
21388         - name: equipment-name
21389           in: path
21390           required: true
21391           type: string
21392           example: __EQUIPMENT-NAME__
21393         - name: interface-name
21394           in: path
21395           description: Name that identifies the physical interface
21396           required: true
21397           type: string
21398           example: __INTERFACE-NAME__
21399         - name: interface-name
21400           in: path
21401           description: Name given to the interface
21402           required: true
21403           type: string
21404           example: __INTERFACE-NAME__
21405         - name: body
21406           in: body
21407           description: l-interface object that needs to be updated.
21408           required: true
21409           schema:
21410             $ref: "#/patchDefinitions/l-interface"
21411     delete:
21412       tags:
21413         - Network
21414       summary: delete an existing l-interface
21415       description: delete an existing l-interface
21416       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21417       consumes:
21418         - application/json
21419         - application/xml
21420       produces:
21421         - application/json
21422         - application/xml
21423       responses:
21424         "default":
21425           description: Response codes found in [response codes](https://wiki.onap.org/).
21426       parameters:
21427         - name: equipment-name
21428           in: path
21429           required: true
21430           type: string
21431           example: __EQUIPMENT-NAME__
21432         - name: interface-name
21433           in: path
21434           description: Name that identifies the physical interface
21435           required: true
21436           type: string
21437           example: __INTERFACE-NAME__
21438         - name: interface-name
21439           in: path
21440           description: Name given to the interface
21441           required: true
21442           type: string
21443           example: __INTERFACE-NAME__
21444         - name: resource-version
21445           in: query
21446           description: resource-version for concurrency
21447           required: true
21448           type: string
21449   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
21450     get:
21451       tags:
21452         - Network
21453       summary: returns l-interfaces
21454       description: returns l-interfaces
21455       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
21456       produces:
21457         - application/json
21458         - application/xml
21459       responses:
21460         "200":
21461           description: successful operation
21462           schema:
21463               $ref: "#/getDefinitions/l-interfaces"
21464         "default":
21465           description: Response codes found in [response codes](https://wiki.onap.org/).
21466       parameters:
21467         - name: equipment-name
21468           in: path
21469           required: true
21470           type: string
21471           example: __EQUIPMENT-NAME__
21472         - name: interface-name
21473           in: path
21474           description: Name that identifies the physical interface
21475           required: true
21476           type: string
21477           example: __INTERFACE-NAME__
21478         - name: interface-name
21479           in: query
21480           description:
21481           required: false
21482           type: string
21483         - name: interface-id
21484           in: query
21485           description:
21486           required: false
21487           type: string
21488         - name: macaddr
21489           in: query
21490           description:
21491           required: false
21492           type: string
21493         - name: network-name
21494           in: query
21495           description:
21496           required: false
21497           type: string
21498   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
21499     get:
21500       tags:
21501         - Network
21502       summary: returns p-interface
21503       description: returns p-interface
21504       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
21505       produces:
21506         - application/json
21507         - application/xml
21508       responses:
21509         "200":
21510           description: successful operation
21511           schema:
21512               $ref: "#/getDefinitions/p-interface"
21513         "default":
21514           description: Response codes found in [response codes](https://wiki.onap.org/).
21515       parameters:
21516         - name: equipment-name
21517           in: path
21518           required: true
21519           type: string
21520           example: __EQUIPMENT-NAME__
21521         - name: interface-name
21522           in: path
21523           description: Name that identifies the physical interface
21524           required: true
21525           type: string
21526           example: __INTERFACE-NAME__
21527     put:
21528       tags:
21529         - Network
21530       summary: create or update an existing p-interface
21531       description: |
21532         Create or update an existing p-interface.
21533         #
21534         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21535       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
21536       consumes:
21537         - application/json
21538         - application/xml
21539       produces:
21540         - application/json
21541         - application/xml
21542       responses:
21543         "default":
21544           description: Response codes found in [response codes](https://wiki.onap.org/).
21545       parameters:
21546         - name: equipment-name
21547           in: path
21548           required: true
21549           type: string
21550           example: __EQUIPMENT-NAME__
21551         - name: interface-name
21552           in: path
21553           description: Name that identifies the physical interface
21554           required: true
21555           type: string
21556           example: __INTERFACE-NAME__
21557         - name: body
21558           in: body
21559           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)
21560           required: true
21561           schema:
21562             $ref: "#/definitions/p-interface"
21563     patch:
21564       tags:
21565         - Network
21566       summary: update an existing p-interface
21567       description: |
21568         Update an existing p-interface
21569         #
21570         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21571         The PUT operation will entirely replace an existing object.
21572         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21573         #
21574         Other differences between PUT and PATCH are:
21575         #
21576         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21577         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21578         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21579       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
21580       consumes:
21581         - application/json
21582         - application/xml
21583       produces:
21584         - application/json
21585         - application/xml
21586       responses:
21587         "default":
21588           description: Response codes found in [response codes](https://wiki.onap.org/).
21589       parameters:
21590         - name: equipment-name
21591           in: path
21592           required: true
21593           type: string
21594           example: __EQUIPMENT-NAME__
21595         - name: interface-name
21596           in: path
21597           description: Name that identifies the physical interface
21598           required: true
21599           type: string
21600           example: __INTERFACE-NAME__
21601         - name: body
21602           in: body
21603           description: p-interface object that needs to be updated.
21604           required: true
21605           schema:
21606             $ref: "#/patchDefinitions/p-interface"
21607     delete:
21608       tags:
21609         - Network
21610       summary: delete an existing p-interface
21611       description: delete an existing p-interface
21612       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
21613       consumes:
21614         - application/json
21615         - application/xml
21616       produces:
21617         - application/json
21618         - application/xml
21619       responses:
21620         "default":
21621           description: Response codes found in [response codes](https://wiki.onap.org/).
21622       parameters:
21623         - name: equipment-name
21624           in: path
21625           required: true
21626           type: string
21627           example: __EQUIPMENT-NAME__
21628         - name: interface-name
21629           in: path
21630           description: Name that identifies the physical interface
21631           required: true
21632           type: string
21633           example: __INTERFACE-NAME__
21634         - name: resource-version
21635           in: query
21636           description: resource-version for concurrency
21637           required: true
21638           type: string
21639   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
21640     get:
21641       tags:
21642         - Network
21643       summary: returns p-interfaces
21644       description: returns p-interfaces
21645       operationId: getNetworkVplsPesVplsPePInterfaces
21646       produces:
21647         - application/json
21648         - application/xml
21649       responses:
21650         "200":
21651           description: successful operation
21652           schema:
21653               $ref: "#/getDefinitions/p-interfaces"
21654         "default":
21655           description: Response codes found in [response codes](https://wiki.onap.org/).
21656       parameters:
21657         - name: equipment-name
21658           in: path
21659           required: true
21660           type: string
21661           example: __EQUIPMENT-NAME__
21662         - name: interface-name
21663           in: query
21664           description:
21665           required: false
21666           type: string
21667         - name: prov-status
21668           in: query
21669           description:
21670           required: false
21671           type: string
21672   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
21673     put:
21674       tags:
21675         - Network
21676       summary: see node definition for valid relationships
21677       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
21678       consumes:
21679         - application/json
21680         - application/xml
21681       produces:
21682         - application/json
21683         - application/xml
21684       responses:
21685         "default":
21686           description: Response codes found in [response codes](https://wiki.onap.org/).
21687       parameters:
21688         - name: equipment-name
21689           in: path
21690           required: true
21691           type: string
21692           example: __EQUIPMENT-NAME__
21693         - name: interface-name
21694           in: path
21695           description: Name that identifies the link aggregate interface
21696           required: true
21697           type: string
21698           example: __INTERFACE-NAME__
21699         - name: body
21700           in: body
21701           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
21702           required: true
21703           schema:
21704             $ref: "#/definitions/relationship"
21705     delete:
21706       tags:
21707         - Network
21708       summary: delete an existing relationship
21709       description: delete an existing relationship
21710       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
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 link aggregate interface
21729           required: true
21730           type: string
21731           example: __INTERFACE-NAME__
21732   /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:
21733     put:
21734       tags:
21735         - Network
21736       summary: see node definition for valid relationships
21737       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21738       consumes:
21739         - application/json
21740         - application/xml
21741       produces:
21742         - application/json
21743         - application/xml
21744       responses:
21745         "default":
21746           description: Response codes found in [response codes](https://wiki.onap.org/).
21747       parameters:
21748         - name: equipment-name
21749           in: path
21750           required: true
21751           type: string
21752           example: __EQUIPMENT-NAME__
21753         - name: interface-name
21754           in: path
21755           description: Name that identifies the link aggregate interface
21756           required: true
21757           type: string
21758           example: __INTERFACE-NAME__
21759         - name: interface-name
21760           in: path
21761           description: Name given to the interface
21762           required: true
21763           type: string
21764           example: __INTERFACE-NAME__
21765         - name: vlan-interface
21766           in: path
21767           description: String that identifies the interface
21768           required: true
21769           type: string
21770           example: __VLAN-INTERFACE__
21771         - name: body
21772           in: body
21773           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
21774           required: true
21775           schema:
21776             $ref: "#/definitions/relationship"
21777     delete:
21778       tags:
21779         - Network
21780       summary: delete an existing relationship
21781       description: delete an existing relationship
21782       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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 link aggregate 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   /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:
21817     put:
21818       tags:
21819         - Network
21820       summary: see node definition for valid relationships
21821       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21822       consumes:
21823         - application/json
21824         - application/xml
21825       produces:
21826         - application/json
21827         - application/xml
21828       responses:
21829         "default":
21830           description: Response codes found in [response codes](https://wiki.onap.org/).
21831       parameters:
21832         - name: equipment-name
21833           in: path
21834           required: true
21835           type: string
21836           example: __EQUIPMENT-NAME__
21837         - name: interface-name
21838           in: path
21839           description: Name that identifies the link aggregate interface
21840           required: true
21841           type: string
21842           example: __INTERFACE-NAME__
21843         - name: interface-name
21844           in: path
21845           description: Name given to the interface
21846           required: true
21847           type: string
21848           example: __INTERFACE-NAME__
21849         - name: vlan-interface
21850           in: path
21851           description: String that identifies the interface
21852           required: true
21853           type: string
21854           example: __VLAN-INTERFACE__
21855         - name: l3-interface-ipv4-address
21856           in: path
21857           description: IP address
21858           required: true
21859           type: string
21860           example: __L3-INTERFACE-IPV4-ADDRESS__
21861         - name: body
21862           in: body
21863           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
21864           required: true
21865           schema:
21866             $ref: "#/definitions/relationship"
21867     delete:
21868       tags:
21869         - Network
21870       summary: delete an existing relationship
21871       description: delete an existing relationship
21872       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21873       consumes:
21874         - application/json
21875         - application/xml
21876       produces:
21877         - application/json
21878         - application/xml
21879       responses:
21880         "default":
21881           description: Response codes found in [response codes](https://wiki.onap.org/).
21882       parameters:
21883         - name: equipment-name
21884           in: path
21885           required: true
21886           type: string
21887           example: __EQUIPMENT-NAME__
21888         - name: interface-name
21889           in: path
21890           description: Name that identifies the link aggregate interface
21891           required: true
21892           type: string
21893           example: __INTERFACE-NAME__
21894         - name: interface-name
21895           in: path
21896           description: Name given to the interface
21897           required: true
21898           type: string
21899           example: __INTERFACE-NAME__
21900         - name: vlan-interface
21901           in: path
21902           description: String that identifies the interface
21903           required: true
21904           type: string
21905           example: __VLAN-INTERFACE__
21906         - name: l3-interface-ipv4-address
21907           in: path
21908           description: IP address
21909           required: true
21910           type: string
21911           example: __L3-INTERFACE-IPV4-ADDRESS__
21912   /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}:
21913     get:
21914       tags:
21915         - Network
21916       summary: returns l3-interface-ipv4-address-list
21917       description: returns l3-interface-ipv4-address-list
21918       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21919       produces:
21920         - application/json
21921         - application/xml
21922       responses:
21923         "200":
21924           description: successful operation
21925           schema:
21926               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21927         "default":
21928           description: Response codes found in [response codes](https://wiki.onap.org/).
21929       parameters:
21930         - name: equipment-name
21931           in: path
21932           required: true
21933           type: string
21934           example: __EQUIPMENT-NAME__
21935         - name: interface-name
21936           in: path
21937           description: Name that identifies the link aggregate interface
21938           required: true
21939           type: string
21940           example: __INTERFACE-NAME__
21941         - name: interface-name
21942           in: path
21943           description: Name given to the interface
21944           required: true
21945           type: string
21946           example: __INTERFACE-NAME__
21947         - name: vlan-interface
21948           in: path
21949           description: String that identifies the interface
21950           required: true
21951           type: string
21952           example: __VLAN-INTERFACE__
21953         - name: l3-interface-ipv4-address
21954           in: path
21955           description: IP address
21956           required: true
21957           type: string
21958           example: __L3-INTERFACE-IPV4-ADDRESS__
21959     put:
21960       tags:
21961         - Network
21962       summary: create or update an existing l3-interface-ipv4-address-list
21963       description: |
21964         Create or update an existing l3-interface-ipv4-address-list.
21965         #
21966         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21967       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21968       consumes:
21969         - application/json
21970         - application/xml
21971       produces:
21972         - application/json
21973         - application/xml
21974       responses:
21975         "default":
21976           description: Response codes found in [response codes](https://wiki.onap.org/).
21977       parameters:
21978         - name: equipment-name
21979           in: path
21980           required: true
21981           type: string
21982           example: __EQUIPMENT-NAME__
21983         - name: interface-name
21984           in: path
21985           description: Name that identifies the link aggregate interface
21986           required: true
21987           type: string
21988           example: __INTERFACE-NAME__
21989         - name: interface-name
21990           in: path
21991           description: Name given to the interface
21992           required: true
21993           type: string
21994           example: __INTERFACE-NAME__
21995         - name: vlan-interface
21996           in: path
21997           description: String that identifies the interface
21998           required: true
21999           type: string
22000           example: __VLAN-INTERFACE__
22001         - name: l3-interface-ipv4-address
22002           in: path
22003           description: IP address
22004           required: true
22005           type: string
22006           example: __L3-INTERFACE-IPV4-ADDRESS__
22007         - name: body
22008           in: body
22009           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22010           required: true
22011           schema:
22012             $ref: "#/definitions/l3-interface-ipv4-address-list"
22013     patch:
22014       tags:
22015         - Network
22016       summary: update an existing l3-interface-ipv4-address-list
22017       description: |
22018         Update an existing l3-interface-ipv4-address-list
22019         #
22020         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22021         The PUT operation will entirely replace an existing object.
22022         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22023         #
22024         Other differences between PUT and PATCH are:
22025         #
22026         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22027         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22028         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22029       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22030       consumes:
22031         - application/json
22032         - application/xml
22033       produces:
22034         - application/json
22035         - application/xml
22036       responses:
22037         "default":
22038           description: Response codes found in [response codes](https://wiki.onap.org/).
22039       parameters:
22040         - name: equipment-name
22041           in: path
22042           required: true
22043           type: string
22044           example: __EQUIPMENT-NAME__
22045         - name: interface-name
22046           in: path
22047           description: Name that identifies the link aggregate interface
22048           required: true
22049           type: string
22050           example: __INTERFACE-NAME__
22051         - name: interface-name
22052           in: path
22053           description: Name given to the interface
22054           required: true
22055           type: string
22056           example: __INTERFACE-NAME__
22057         - name: vlan-interface
22058           in: path
22059           description: String that identifies the interface
22060           required: true
22061           type: string
22062           example: __VLAN-INTERFACE__
22063         - name: l3-interface-ipv4-address
22064           in: path
22065           description: IP address
22066           required: true
22067           type: string
22068           example: __L3-INTERFACE-IPV4-ADDRESS__
22069         - name: body
22070           in: body
22071           description: l3-interface-ipv4-address-list object that needs to be updated.
22072           required: true
22073           schema:
22074             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22075     delete:
22076       tags:
22077         - Network
22078       summary: delete an existing l3-interface-ipv4-address-list
22079       description: delete an existing l3-interface-ipv4-address-list
22080       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22081       consumes:
22082         - application/json
22083         - application/xml
22084       produces:
22085         - application/json
22086         - application/xml
22087       responses:
22088         "default":
22089           description: Response codes found in [response codes](https://wiki.onap.org/).
22090       parameters:
22091         - name: equipment-name
22092           in: path
22093           required: true
22094           type: string
22095           example: __EQUIPMENT-NAME__
22096         - name: interface-name
22097           in: path
22098           description: Name that identifies the link aggregate interface
22099           required: true
22100           type: string
22101           example: __INTERFACE-NAME__
22102         - name: interface-name
22103           in: path
22104           description: Name given to the interface
22105           required: true
22106           type: string
22107           example: __INTERFACE-NAME__
22108         - name: vlan-interface
22109           in: path
22110           description: String that identifies the interface
22111           required: true
22112           type: string
22113           example: __VLAN-INTERFACE__
22114         - name: l3-interface-ipv4-address
22115           in: path
22116           description: IP address
22117           required: true
22118           type: string
22119           example: __L3-INTERFACE-IPV4-ADDRESS__
22120         - name: resource-version
22121           in: query
22122           description: resource-version for concurrency
22123           required: true
22124           type: string
22125   /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:
22126     put:
22127       tags:
22128         - Network
22129       summary: see node definition for valid relationships
22130       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22131       consumes:
22132         - application/json
22133         - application/xml
22134       produces:
22135         - application/json
22136         - application/xml
22137       responses:
22138         "default":
22139           description: Response codes found in [response codes](https://wiki.onap.org/).
22140       parameters:
22141         - name: equipment-name
22142           in: path
22143           required: true
22144           type: string
22145           example: __EQUIPMENT-NAME__
22146         - name: interface-name
22147           in: path
22148           description: Name that identifies the link aggregate interface
22149           required: true
22150           type: string
22151           example: __INTERFACE-NAME__
22152         - name: interface-name
22153           in: path
22154           description: Name given to the interface
22155           required: true
22156           type: string
22157           example: __INTERFACE-NAME__
22158         - name: vlan-interface
22159           in: path
22160           description: String that identifies the interface
22161           required: true
22162           type: string
22163           example: __VLAN-INTERFACE__
22164         - name: l3-interface-ipv6-address
22165           in: path
22166           description: IP address
22167           required: true
22168           type: string
22169           example: __L3-INTERFACE-IPV6-ADDRESS__
22170         - name: body
22171           in: body
22172           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22173           required: true
22174           schema:
22175             $ref: "#/definitions/relationship"
22176     delete:
22177       tags:
22178         - Network
22179       summary: delete an existing relationship
22180       description: delete an existing relationship
22181       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22182       consumes:
22183         - application/json
22184         - application/xml
22185       produces:
22186         - application/json
22187         - application/xml
22188       responses:
22189         "default":
22190           description: Response codes found in [response codes](https://wiki.onap.org/).
22191       parameters:
22192         - name: equipment-name
22193           in: path
22194           required: true
22195           type: string
22196           example: __EQUIPMENT-NAME__
22197         - name: interface-name
22198           in: path
22199           description: Name that identifies the link aggregate interface
22200           required: true
22201           type: string
22202           example: __INTERFACE-NAME__
22203         - name: interface-name
22204           in: path
22205           description: Name given to the interface
22206           required: true
22207           type: string
22208           example: __INTERFACE-NAME__
22209         - name: vlan-interface
22210           in: path
22211           description: String that identifies the interface
22212           required: true
22213           type: string
22214           example: __VLAN-INTERFACE__
22215         - name: l3-interface-ipv6-address
22216           in: path
22217           description: IP address
22218           required: true
22219           type: string
22220           example: __L3-INTERFACE-IPV6-ADDRESS__
22221   /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}:
22222     get:
22223       tags:
22224         - Network
22225       summary: returns l3-interface-ipv6-address-list
22226       description: returns l3-interface-ipv6-address-list
22227       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22228       produces:
22229         - application/json
22230         - application/xml
22231       responses:
22232         "200":
22233           description: successful operation
22234           schema:
22235               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22236         "default":
22237           description: Response codes found in [response codes](https://wiki.onap.org/).
22238       parameters:
22239         - name: equipment-name
22240           in: path
22241           required: true
22242           type: string
22243           example: __EQUIPMENT-NAME__
22244         - name: interface-name
22245           in: path
22246           description: Name that identifies the link aggregate interface
22247           required: true
22248           type: string
22249           example: __INTERFACE-NAME__
22250         - name: interface-name
22251           in: path
22252           description: Name given to the interface
22253           required: true
22254           type: string
22255           example: __INTERFACE-NAME__
22256         - name: vlan-interface
22257           in: path
22258           description: String that identifies the interface
22259           required: true
22260           type: string
22261           example: __VLAN-INTERFACE__
22262         - name: l3-interface-ipv6-address
22263           in: path
22264           description: IP address
22265           required: true
22266           type: string
22267           example: __L3-INTERFACE-IPV6-ADDRESS__
22268     put:
22269       tags:
22270         - Network
22271       summary: create or update an existing l3-interface-ipv6-address-list
22272       description: |
22273         Create or update an existing l3-interface-ipv6-address-list.
22274         #
22275         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22276       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22277       consumes:
22278         - application/json
22279         - application/xml
22280       produces:
22281         - application/json
22282         - application/xml
22283       responses:
22284         "default":
22285           description: Response codes found in [response codes](https://wiki.onap.org/).
22286       parameters:
22287         - name: equipment-name
22288           in: path
22289           required: true
22290           type: string
22291           example: __EQUIPMENT-NAME__
22292         - name: interface-name
22293           in: path
22294           description: Name that identifies the link aggregate interface
22295           required: true
22296           type: string
22297           example: __INTERFACE-NAME__
22298         - name: interface-name
22299           in: path
22300           description: Name given to the interface
22301           required: true
22302           type: string
22303           example: __INTERFACE-NAME__
22304         - name: vlan-interface
22305           in: path
22306           description: String that identifies the interface
22307           required: true
22308           type: string
22309           example: __VLAN-INTERFACE__
22310         - name: l3-interface-ipv6-address
22311           in: path
22312           description: IP address
22313           required: true
22314           type: string
22315           example: __L3-INTERFACE-IPV6-ADDRESS__
22316         - name: body
22317           in: body
22318           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22319           required: true
22320           schema:
22321             $ref: "#/definitions/l3-interface-ipv6-address-list"
22322     patch:
22323       tags:
22324         - Network
22325       summary: update an existing l3-interface-ipv6-address-list
22326       description: |
22327         Update an existing l3-interface-ipv6-address-list
22328         #
22329         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22330         The PUT operation will entirely replace an existing object.
22331         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22332         #
22333         Other differences between PUT and PATCH are:
22334         #
22335         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22336         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22337         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22338       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22339       consumes:
22340         - application/json
22341         - application/xml
22342       produces:
22343         - application/json
22344         - application/xml
22345       responses:
22346         "default":
22347           description: Response codes found in [response codes](https://wiki.onap.org/).
22348       parameters:
22349         - name: equipment-name
22350           in: path
22351           required: true
22352           type: string
22353           example: __EQUIPMENT-NAME__
22354         - name: interface-name
22355           in: path
22356           description: Name that identifies the link aggregate interface
22357           required: true
22358           type: string
22359           example: __INTERFACE-NAME__
22360         - name: interface-name
22361           in: path
22362           description: Name given to the interface
22363           required: true
22364           type: string
22365           example: __INTERFACE-NAME__
22366         - name: vlan-interface
22367           in: path
22368           description: String that identifies the interface
22369           required: true
22370           type: string
22371           example: __VLAN-INTERFACE__
22372         - name: l3-interface-ipv6-address
22373           in: path
22374           description: IP address
22375           required: true
22376           type: string
22377           example: __L3-INTERFACE-IPV6-ADDRESS__
22378         - name: body
22379           in: body
22380           description: l3-interface-ipv6-address-list object that needs to be updated.
22381           required: true
22382           schema:
22383             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22384     delete:
22385       tags:
22386         - Network
22387       summary: delete an existing l3-interface-ipv6-address-list
22388       description: delete an existing l3-interface-ipv6-address-list
22389       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22390       consumes:
22391         - application/json
22392         - application/xml
22393       produces:
22394         - application/json
22395         - application/xml
22396       responses:
22397         "default":
22398           description: Response codes found in [response codes](https://wiki.onap.org/).
22399       parameters:
22400         - name: equipment-name
22401           in: path
22402           required: true
22403           type: string
22404           example: __EQUIPMENT-NAME__
22405         - name: interface-name
22406           in: path
22407           description: Name that identifies the link aggregate interface
22408           required: true
22409           type: string
22410           example: __INTERFACE-NAME__
22411         - name: interface-name
22412           in: path
22413           description: Name given to the interface
22414           required: true
22415           type: string
22416           example: __INTERFACE-NAME__
22417         - name: vlan-interface
22418           in: path
22419           description: String that identifies the interface
22420           required: true
22421           type: string
22422           example: __VLAN-INTERFACE__
22423         - name: l3-interface-ipv6-address
22424           in: path
22425           description: IP address
22426           required: true
22427           type: string
22428           example: __L3-INTERFACE-IPV6-ADDRESS__
22429         - name: resource-version
22430           in: query
22431           description: resource-version for concurrency
22432           required: true
22433           type: string
22434   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22435     get:
22436       tags:
22437         - Network
22438       summary: returns vlan
22439       description: returns vlan
22440       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22441       produces:
22442         - application/json
22443         - application/xml
22444       responses:
22445         "200":
22446           description: successful operation
22447           schema:
22448               $ref: "#/getDefinitions/vlan"
22449         "default":
22450           description: Response codes found in [response codes](https://wiki.onap.org/).
22451       parameters:
22452         - name: equipment-name
22453           in: path
22454           required: true
22455           type: string
22456           example: __EQUIPMENT-NAME__
22457         - name: interface-name
22458           in: path
22459           description: Name that identifies the link aggregate interface
22460           required: true
22461           type: string
22462           example: __INTERFACE-NAME__
22463         - name: interface-name
22464           in: path
22465           description: Name given to the interface
22466           required: true
22467           type: string
22468           example: __INTERFACE-NAME__
22469         - name: vlan-interface
22470           in: path
22471           description: String that identifies the interface
22472           required: true
22473           type: string
22474           example: __VLAN-INTERFACE__
22475     put:
22476       tags:
22477         - Network
22478       summary: create or update an existing vlan
22479       description: |
22480         Create or update an existing vlan.
22481         #
22482         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22483       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22484       consumes:
22485         - application/json
22486         - application/xml
22487       produces:
22488         - application/json
22489         - application/xml
22490       responses:
22491         "default":
22492           description: Response codes found in [response codes](https://wiki.onap.org/).
22493       parameters:
22494         - name: equipment-name
22495           in: path
22496           required: true
22497           type: string
22498           example: __EQUIPMENT-NAME__
22499         - name: interface-name
22500           in: path
22501           description: Name that identifies the link aggregate interface
22502           required: true
22503           type: string
22504           example: __INTERFACE-NAME__
22505         - name: interface-name
22506           in: path
22507           description: Name given to the interface
22508           required: true
22509           type: string
22510           example: __INTERFACE-NAME__
22511         - name: vlan-interface
22512           in: path
22513           description: String that identifies the interface
22514           required: true
22515           type: string
22516           example: __VLAN-INTERFACE__
22517         - name: body
22518           in: body
22519           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
22520           required: true
22521           schema:
22522             $ref: "#/definitions/vlan"
22523     patch:
22524       tags:
22525         - Network
22526       summary: update an existing vlan
22527       description: |
22528         Update an existing vlan
22529         #
22530         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22531         The PUT operation will entirely replace an existing object.
22532         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22533         #
22534         Other differences between PUT and PATCH are:
22535         #
22536         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22537         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22538         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22539       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22540       consumes:
22541         - application/json
22542         - application/xml
22543       produces:
22544         - application/json
22545         - application/xml
22546       responses:
22547         "default":
22548           description: Response codes found in [response codes](https://wiki.onap.org/).
22549       parameters:
22550         - name: equipment-name
22551           in: path
22552           required: true
22553           type: string
22554           example: __EQUIPMENT-NAME__
22555         - name: interface-name
22556           in: path
22557           description: Name that identifies the link aggregate interface
22558           required: true
22559           type: string
22560           example: __INTERFACE-NAME__
22561         - name: interface-name
22562           in: path
22563           description: Name given to the interface
22564           required: true
22565           type: string
22566           example: __INTERFACE-NAME__
22567         - name: vlan-interface
22568           in: path
22569           description: String that identifies the interface
22570           required: true
22571           type: string
22572           example: __VLAN-INTERFACE__
22573         - name: body
22574           in: body
22575           description: vlan object that needs to be updated.
22576           required: true
22577           schema:
22578             $ref: "#/patchDefinitions/vlan"
22579     delete:
22580       tags:
22581         - Network
22582       summary: delete an existing vlan
22583       description: delete an existing vlan
22584       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
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 link aggregate 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: resource-version
22619           in: query
22620           description: resource-version for concurrency
22621           required: true
22622           type: string
22623   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22624     get:
22625       tags:
22626         - Network
22627       summary: returns vlans
22628       description: returns vlans
22629       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
22630       produces:
22631         - application/json
22632         - application/xml
22633       responses:
22634         "200":
22635           description: successful operation
22636           schema:
22637               $ref: "#/getDefinitions/vlans"
22638         "default":
22639           description: Response codes found in [response codes](https://wiki.onap.org/).
22640       parameters:
22641         - name: equipment-name
22642           in: path
22643           required: true
22644           type: string
22645           example: __EQUIPMENT-NAME__
22646         - name: interface-name
22647           in: path
22648           description: Name that identifies the link aggregate interface
22649           required: true
22650           type: string
22651           example: __INTERFACE-NAME__
22652         - name: interface-name
22653           in: path
22654           description: Name given to the interface
22655           required: true
22656           type: string
22657           example: __INTERFACE-NAME__
22658         - name: vlan-interface
22659           in: query
22660           description:
22661           required: false
22662           type: string
22663         - name: vlan-id-inner
22664           in: query
22665           description:
22666           required: false
22667           type: integer
22668           format: int64
22669         - name: vpn-id
22670           in: query
22671           description:
22672           required: false
22673           type: string
22674   /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:
22675     put:
22676       tags:
22677         - Network
22678       summary: see node definition for valid relationships
22679       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22680       consumes:
22681         - application/json
22682         - application/xml
22683       produces:
22684         - application/json
22685         - application/xml
22686       responses:
22687         "default":
22688           description: Response codes found in [response codes](https://wiki.onap.org/).
22689       parameters:
22690         - name: equipment-name
22691           in: path
22692           required: true
22693           type: string
22694           example: __EQUIPMENT-NAME__
22695         - name: interface-name
22696           in: path
22697           description: Name that identifies the link aggregate interface
22698           required: true
22699           type: string
22700           example: __INTERFACE-NAME__
22701         - name: interface-name
22702           in: path
22703           description: Name given to the interface
22704           required: true
22705           type: string
22706           example: __INTERFACE-NAME__
22707         - name: pci-id
22708           in: path
22709           description: PCI ID used to identify the sriov-vf
22710           required: true
22711           type: string
22712           example: __PCI-ID__
22713         - name: body
22714           in: body
22715           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22716           required: true
22717           schema:
22718             $ref: "#/definitions/relationship"
22719     delete:
22720       tags:
22721         - Network
22722       summary: delete an existing relationship
22723       description: delete an existing relationship
22724       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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 link aggregate 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   /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}:
22759     get:
22760       tags:
22761         - Network
22762       summary: returns sriov-vf
22763       description: returns sriov-vf
22764       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22765       produces:
22766         - application/json
22767         - application/xml
22768       responses:
22769         "200":
22770           description: successful operation
22771           schema:
22772               $ref: "#/getDefinitions/sriov-vf"
22773         "default":
22774           description: Response codes found in [response codes](https://wiki.onap.org/).
22775       parameters:
22776         - name: equipment-name
22777           in: path
22778           required: true
22779           type: string
22780           example: __EQUIPMENT-NAME__
22781         - name: interface-name
22782           in: path
22783           description: Name that identifies the link aggregate interface
22784           required: true
22785           type: string
22786           example: __INTERFACE-NAME__
22787         - name: interface-name
22788           in: path
22789           description: Name given to the interface
22790           required: true
22791           type: string
22792           example: __INTERFACE-NAME__
22793         - name: pci-id
22794           in: path
22795           description: PCI ID used to identify the sriov-vf
22796           required: true
22797           type: string
22798           example: __PCI-ID__
22799     put:
22800       tags:
22801         - Network
22802       summary: create or update an existing sriov-vf
22803       description: |
22804         Create or update an existing sriov-vf.
22805         #
22806         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22807       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22808       consumes:
22809         - application/json
22810         - application/xml
22811       produces:
22812         - application/json
22813         - application/xml
22814       responses:
22815         "default":
22816           description: Response codes found in [response codes](https://wiki.onap.org/).
22817       parameters:
22818         - name: equipment-name
22819           in: path
22820           required: true
22821           type: string
22822           example: __EQUIPMENT-NAME__
22823         - name: interface-name
22824           in: path
22825           description: Name that identifies the link aggregate interface
22826           required: true
22827           type: string
22828           example: __INTERFACE-NAME__
22829         - name: interface-name
22830           in: path
22831           description: Name given to the interface
22832           required: true
22833           type: string
22834           example: __INTERFACE-NAME__
22835         - name: pci-id
22836           in: path
22837           description: PCI ID used to identify the sriov-vf
22838           required: true
22839           type: string
22840           example: __PCI-ID__
22841         - name: body
22842           in: body
22843           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22844           required: true
22845           schema:
22846             $ref: "#/definitions/sriov-vf"
22847     patch:
22848       tags:
22849         - Network
22850       summary: update an existing sriov-vf
22851       description: |
22852         Update an existing sriov-vf
22853         #
22854         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22855         The PUT operation will entirely replace an existing object.
22856         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22857         #
22858         Other differences between PUT and PATCH are:
22859         #
22860         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22861         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22862         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22863       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22864       consumes:
22865         - application/json
22866         - application/xml
22867       produces:
22868         - application/json
22869         - application/xml
22870       responses:
22871         "default":
22872           description: Response codes found in [response codes](https://wiki.onap.org/).
22873       parameters:
22874         - name: equipment-name
22875           in: path
22876           required: true
22877           type: string
22878           example: __EQUIPMENT-NAME__
22879         - name: interface-name
22880           in: path
22881           description: Name that identifies the link aggregate interface
22882           required: true
22883           type: string
22884           example: __INTERFACE-NAME__
22885         - name: interface-name
22886           in: path
22887           description: Name given to the interface
22888           required: true
22889           type: string
22890           example: __INTERFACE-NAME__
22891         - name: pci-id
22892           in: path
22893           description: PCI ID used to identify the sriov-vf
22894           required: true
22895           type: string
22896           example: __PCI-ID__
22897         - name: body
22898           in: body
22899           description: sriov-vf object that needs to be updated.
22900           required: true
22901           schema:
22902             $ref: "#/patchDefinitions/sriov-vf"
22903     delete:
22904       tags:
22905         - Network
22906       summary: delete an existing sriov-vf
22907       description: delete an existing sriov-vf
22908       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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 link aggregate 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: resource-version
22943           in: query
22944           description: resource-version for concurrency
22945           required: true
22946           type: string
22947   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
22948     get:
22949       tags:
22950         - Network
22951       summary: returns sriov-vfs
22952       description: returns sriov-vfs
22953       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
22954       produces:
22955         - application/json
22956         - application/xml
22957       responses:
22958         "200":
22959           description: successful operation
22960           schema:
22961               $ref: "#/getDefinitions/sriov-vfs"
22962         "default":
22963           description: Response codes found in [response codes](https://wiki.onap.org/).
22964       parameters:
22965         - name: equipment-name
22966           in: path
22967           required: true
22968           type: string
22969           example: __EQUIPMENT-NAME__
22970         - name: interface-name
22971           in: path
22972           description: Name that identifies the link aggregate interface
22973           required: true
22974           type: string
22975           example: __INTERFACE-NAME__
22976         - name: interface-name
22977           in: path
22978           description: Name given to the interface
22979           required: true
22980           type: string
22981           example: __INTERFACE-NAME__
22982         - name: pci-id
22983           in: query
22984           description:
22985           required: false
22986           type: string
22987         - name: vf-vlan-filter
22988           in: query
22989           description:
22990           required: false
22991           type: string
22992         - name: vf-mac-filter
22993           in: query
22994           description:
22995           required: false
22996           type: string
22997         - name: vf-vlan-strip
22998           in: query
22999           description:
23000           required: false
23001           type: boolean
23002         - name: neutron-network-id
23003           in: query
23004           description:
23005           required: false
23006           type: string
23007   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23008     put:
23009       tags:
23010         - Network
23011       summary: see node definition for valid relationships
23012       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
23013       consumes:
23014         - application/json
23015         - application/xml
23016       produces:
23017         - application/json
23018         - application/xml
23019       responses:
23020         "default":
23021           description: Response codes found in [response codes](https://wiki.onap.org/).
23022       parameters:
23023         - name: equipment-name
23024           in: path
23025           required: true
23026           type: string
23027           example: __EQUIPMENT-NAME__
23028         - name: interface-name
23029           in: path
23030           description: Name that identifies the link aggregate interface
23031           required: true
23032           type: string
23033           example: __INTERFACE-NAME__
23034         - name: interface-name
23035           in: path
23036           description: Name given to the interface
23037           required: true
23038           type: string
23039           example: __INTERFACE-NAME__
23040         - name: body
23041           in: body
23042           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
23043           required: true
23044           schema:
23045             $ref: "#/definitions/relationship"
23046     delete:
23047       tags:
23048         - Network
23049       summary: delete an existing relationship
23050       description: delete an existing relationship
23051       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
23052       consumes:
23053         - application/json
23054         - application/xml
23055       produces:
23056         - application/json
23057         - application/xml
23058       responses:
23059         "default":
23060           description: Response codes found in [response codes](https://wiki.onap.org/).
23061       parameters:
23062         - name: equipment-name
23063           in: path
23064           required: true
23065           type: string
23066           example: __EQUIPMENT-NAME__
23067         - name: interface-name
23068           in: path
23069           description: Name that identifies the link aggregate interface
23070           required: true
23071           type: string
23072           example: __INTERFACE-NAME__
23073         - name: interface-name
23074           in: path
23075           description: Name given to the interface
23076           required: true
23077           type: string
23078           example: __INTERFACE-NAME__
23079   /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:
23080     put:
23081       tags:
23082         - Network
23083       summary: see node definition for valid relationships
23084       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23085       consumes:
23086         - application/json
23087         - application/xml
23088       produces:
23089         - application/json
23090         - application/xml
23091       responses:
23092         "default":
23093           description: Response codes found in [response codes](https://wiki.onap.org/).
23094       parameters:
23095         - name: equipment-name
23096           in: path
23097           required: true
23098           type: string
23099           example: __EQUIPMENT-NAME__
23100         - name: interface-name
23101           in: path
23102           description: Name that identifies the link aggregate interface
23103           required: true
23104           type: string
23105           example: __INTERFACE-NAME__
23106         - name: interface-name
23107           in: path
23108           description: Name given to the interface
23109           required: true
23110           type: string
23111           example: __INTERFACE-NAME__
23112         - name: l3-interface-ipv4-address
23113           in: path
23114           description: IP address
23115           required: true
23116           type: string
23117           example: __L3-INTERFACE-IPV4-ADDRESS__
23118         - name: body
23119           in: body
23120           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23121           required: true
23122           schema:
23123             $ref: "#/definitions/relationship"
23124     delete:
23125       tags:
23126         - Network
23127       summary: delete an existing relationship
23128       description: delete an existing relationship
23129       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
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 link aggregate 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   /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}:
23164     get:
23165       tags:
23166         - Network
23167       summary: returns l3-interface-ipv4-address-list
23168       description: returns l3-interface-ipv4-address-list
23169       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23170       produces:
23171         - application/json
23172         - application/xml
23173       responses:
23174         "200":
23175           description: successful operation
23176           schema:
23177               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23178         "default":
23179           description: Response codes found in [response codes](https://wiki.onap.org/).
23180       parameters:
23181         - name: equipment-name
23182           in: path
23183           required: true
23184           type: string
23185           example: __EQUIPMENT-NAME__
23186         - name: interface-name
23187           in: path
23188           description: Name that identifies the link aggregate interface
23189           required: true
23190           type: string
23191           example: __INTERFACE-NAME__
23192         - name: interface-name
23193           in: path
23194           description: Name given to the interface
23195           required: true
23196           type: string
23197           example: __INTERFACE-NAME__
23198         - name: l3-interface-ipv4-address
23199           in: path
23200           description: IP address
23201           required: true
23202           type: string
23203           example: __L3-INTERFACE-IPV4-ADDRESS__
23204     put:
23205       tags:
23206         - Network
23207       summary: create or update an existing l3-interface-ipv4-address-list
23208       description: |
23209         Create or update an existing l3-interface-ipv4-address-list.
23210         #
23211         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23212       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23213       consumes:
23214         - application/json
23215         - application/xml
23216       produces:
23217         - application/json
23218         - application/xml
23219       responses:
23220         "default":
23221           description: Response codes found in [response codes](https://wiki.onap.org/).
23222       parameters:
23223         - name: equipment-name
23224           in: path
23225           required: true
23226           type: string
23227           example: __EQUIPMENT-NAME__
23228         - name: interface-name
23229           in: path
23230           description: Name that identifies the link aggregate interface
23231           required: true
23232           type: string
23233           example: __INTERFACE-NAME__
23234         - name: interface-name
23235           in: path
23236           description: Name given to the interface
23237           required: true
23238           type: string
23239           example: __INTERFACE-NAME__
23240         - name: l3-interface-ipv4-address
23241           in: path
23242           description: IP address
23243           required: true
23244           type: string
23245           example: __L3-INTERFACE-IPV4-ADDRESS__
23246         - name: body
23247           in: body
23248           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23249           required: true
23250           schema:
23251             $ref: "#/definitions/l3-interface-ipv4-address-list"
23252     patch:
23253       tags:
23254         - Network
23255       summary: update an existing l3-interface-ipv4-address-list
23256       description: |
23257         Update an existing l3-interface-ipv4-address-list
23258         #
23259         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23260         The PUT operation will entirely replace an existing object.
23261         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23262         #
23263         Other differences between PUT and PATCH are:
23264         #
23265         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23266         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23267         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23268       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23269       consumes:
23270         - application/json
23271         - application/xml
23272       produces:
23273         - application/json
23274         - application/xml
23275       responses:
23276         "default":
23277           description: Response codes found in [response codes](https://wiki.onap.org/).
23278       parameters:
23279         - name: equipment-name
23280           in: path
23281           required: true
23282           type: string
23283           example: __EQUIPMENT-NAME__
23284         - name: interface-name
23285           in: path
23286           description: Name that identifies the link aggregate interface
23287           required: true
23288           type: string
23289           example: __INTERFACE-NAME__
23290         - name: interface-name
23291           in: path
23292           description: Name given to the interface
23293           required: true
23294           type: string
23295           example: __INTERFACE-NAME__
23296         - name: l3-interface-ipv4-address
23297           in: path
23298           description: IP address
23299           required: true
23300           type: string
23301           example: __L3-INTERFACE-IPV4-ADDRESS__
23302         - name: body
23303           in: body
23304           description: l3-interface-ipv4-address-list object that needs to be updated.
23305           required: true
23306           schema:
23307             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23308     delete:
23309       tags:
23310         - Network
23311       summary: delete an existing l3-interface-ipv4-address-list
23312       description: delete an existing l3-interface-ipv4-address-list
23313       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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 link aggregate 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: resource-version
23348           in: query
23349           description: resource-version for concurrency
23350           required: true
23351           type: string
23352   /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:
23353     put:
23354       tags:
23355         - Network
23356       summary: see node definition for valid relationships
23357       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23358       consumes:
23359         - application/json
23360         - application/xml
23361       produces:
23362         - application/json
23363         - application/xml
23364       responses:
23365         "default":
23366           description: Response codes found in [response codes](https://wiki.onap.org/).
23367       parameters:
23368         - name: equipment-name
23369           in: path
23370           required: true
23371           type: string
23372           example: __EQUIPMENT-NAME__
23373         - name: interface-name
23374           in: path
23375           description: Name that identifies the link aggregate interface
23376           required: true
23377           type: string
23378           example: __INTERFACE-NAME__
23379         - name: interface-name
23380           in: path
23381           description: Name given to the interface
23382           required: true
23383           type: string
23384           example: __INTERFACE-NAME__
23385         - name: l3-interface-ipv6-address
23386           in: path
23387           description: IP address
23388           required: true
23389           type: string
23390           example: __L3-INTERFACE-IPV6-ADDRESS__
23391         - name: body
23392           in: body
23393           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23394           required: true
23395           schema:
23396             $ref: "#/definitions/relationship"
23397     delete:
23398       tags:
23399         - Network
23400       summary: delete an existing relationship
23401       description: delete an existing relationship
23402       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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 link aggregate 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   /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}:
23437     get:
23438       tags:
23439         - Network
23440       summary: returns l3-interface-ipv6-address-list
23441       description: returns l3-interface-ipv6-address-list
23442       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23443       produces:
23444         - application/json
23445         - application/xml
23446       responses:
23447         "200":
23448           description: successful operation
23449           schema:
23450               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23451         "default":
23452           description: Response codes found in [response codes](https://wiki.onap.org/).
23453       parameters:
23454         - name: equipment-name
23455           in: path
23456           required: true
23457           type: string
23458           example: __EQUIPMENT-NAME__
23459         - name: interface-name
23460           in: path
23461           description: Name that identifies the link aggregate interface
23462           required: true
23463           type: string
23464           example: __INTERFACE-NAME__
23465         - name: interface-name
23466           in: path
23467           description: Name given to the interface
23468           required: true
23469           type: string
23470           example: __INTERFACE-NAME__
23471         - name: l3-interface-ipv6-address
23472           in: path
23473           description: IP address
23474           required: true
23475           type: string
23476           example: __L3-INTERFACE-IPV6-ADDRESS__
23477     put:
23478       tags:
23479         - Network
23480       summary: create or update an existing l3-interface-ipv6-address-list
23481       description: |
23482         Create or update an existing l3-interface-ipv6-address-list.
23483         #
23484         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23485       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23486       consumes:
23487         - application/json
23488         - application/xml
23489       produces:
23490         - application/json
23491         - application/xml
23492       responses:
23493         "default":
23494           description: Response codes found in [response codes](https://wiki.onap.org/).
23495       parameters:
23496         - name: equipment-name
23497           in: path
23498           required: true
23499           type: string
23500           example: __EQUIPMENT-NAME__
23501         - name: interface-name
23502           in: path
23503           description: Name that identifies the link aggregate interface
23504           required: true
23505           type: string
23506           example: __INTERFACE-NAME__
23507         - name: interface-name
23508           in: path
23509           description: Name given to the interface
23510           required: true
23511           type: string
23512           example: __INTERFACE-NAME__
23513         - name: l3-interface-ipv6-address
23514           in: path
23515           description: IP address
23516           required: true
23517           type: string
23518           example: __L3-INTERFACE-IPV6-ADDRESS__
23519         - name: body
23520           in: body
23521           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23522           required: true
23523           schema:
23524             $ref: "#/definitions/l3-interface-ipv6-address-list"
23525     patch:
23526       tags:
23527         - Network
23528       summary: update an existing l3-interface-ipv6-address-list
23529       description: |
23530         Update an existing l3-interface-ipv6-address-list
23531         #
23532         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23533         The PUT operation will entirely replace an existing object.
23534         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23535         #
23536         Other differences between PUT and PATCH are:
23537         #
23538         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23539         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23540         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23541       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23542       consumes:
23543         - application/json
23544         - application/xml
23545       produces:
23546         - application/json
23547         - application/xml
23548       responses:
23549         "default":
23550           description: Response codes found in [response codes](https://wiki.onap.org/).
23551       parameters:
23552         - name: equipment-name
23553           in: path
23554           required: true
23555           type: string
23556           example: __EQUIPMENT-NAME__
23557         - name: interface-name
23558           in: path
23559           description: Name that identifies the link aggregate interface
23560           required: true
23561           type: string
23562           example: __INTERFACE-NAME__
23563         - name: interface-name
23564           in: path
23565           description: Name given to the interface
23566           required: true
23567           type: string
23568           example: __INTERFACE-NAME__
23569         - name: l3-interface-ipv6-address
23570           in: path
23571           description: IP address
23572           required: true
23573           type: string
23574           example: __L3-INTERFACE-IPV6-ADDRESS__
23575         - name: body
23576           in: body
23577           description: l3-interface-ipv6-address-list object that needs to be updated.
23578           required: true
23579           schema:
23580             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23581     delete:
23582       tags:
23583         - Network
23584       summary: delete an existing l3-interface-ipv6-address-list
23585       description: delete an existing l3-interface-ipv6-address-list
23586       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
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 link aggregate 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: resource-version
23621           in: query
23622           description: resource-version for concurrency
23623           required: true
23624           type: string
23625   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
23626     get:
23627       tags:
23628         - Network
23629       summary: returns l-interface
23630       description: returns l-interface
23631       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23632       produces:
23633         - application/json
23634         - application/xml
23635       responses:
23636         "200":
23637           description: successful operation
23638           schema:
23639               $ref: "#/getDefinitions/l-interface"
23640         "default":
23641           description: Response codes found in [response codes](https://wiki.onap.org/).
23642       parameters:
23643         - name: equipment-name
23644           in: path
23645           required: true
23646           type: string
23647           example: __EQUIPMENT-NAME__
23648         - name: interface-name
23649           in: path
23650           description: Name that identifies the link aggregate interface
23651           required: true
23652           type: string
23653           example: __INTERFACE-NAME__
23654         - name: interface-name
23655           in: path
23656           description: Name given to the interface
23657           required: true
23658           type: string
23659           example: __INTERFACE-NAME__
23660     put:
23661       tags:
23662         - Network
23663       summary: create or update an existing l-interface
23664       description: |
23665         Create or update an existing l-interface.
23666         #
23667         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23668       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23669       consumes:
23670         - application/json
23671         - application/xml
23672       produces:
23673         - application/json
23674         - application/xml
23675       responses:
23676         "default":
23677           description: Response codes found in [response codes](https://wiki.onap.org/).
23678       parameters:
23679         - name: equipment-name
23680           in: path
23681           required: true
23682           type: string
23683           example: __EQUIPMENT-NAME__
23684         - name: interface-name
23685           in: path
23686           description: Name that identifies the link aggregate interface
23687           required: true
23688           type: string
23689           example: __INTERFACE-NAME__
23690         - name: interface-name
23691           in: path
23692           description: Name given to the interface
23693           required: true
23694           type: string
23695           example: __INTERFACE-NAME__
23696         - name: body
23697           in: body
23698           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
23699           required: true
23700           schema:
23701             $ref: "#/definitions/l-interface"
23702     patch:
23703       tags:
23704         - Network
23705       summary: update an existing l-interface
23706       description: |
23707         Update an existing l-interface
23708         #
23709         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23710         The PUT operation will entirely replace an existing object.
23711         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23712         #
23713         Other differences between PUT and PATCH are:
23714         #
23715         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23716         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23717         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23718       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23719       consumes:
23720         - application/json
23721         - application/xml
23722       produces:
23723         - application/json
23724         - application/xml
23725       responses:
23726         "default":
23727           description: Response codes found in [response codes](https://wiki.onap.org/).
23728       parameters:
23729         - name: equipment-name
23730           in: path
23731           required: true
23732           type: string
23733           example: __EQUIPMENT-NAME__
23734         - name: interface-name
23735           in: path
23736           description: Name that identifies the link aggregate interface
23737           required: true
23738           type: string
23739           example: __INTERFACE-NAME__
23740         - name: interface-name
23741           in: path
23742           description: Name given to the interface
23743           required: true
23744           type: string
23745           example: __INTERFACE-NAME__
23746         - name: body
23747           in: body
23748           description: l-interface object that needs to be updated.
23749           required: true
23750           schema:
23751             $ref: "#/patchDefinitions/l-interface"
23752     delete:
23753       tags:
23754         - Network
23755       summary: delete an existing l-interface
23756       description: delete an existing l-interface
23757       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23758       consumes:
23759         - application/json
23760         - application/xml
23761       produces:
23762         - application/json
23763         - application/xml
23764       responses:
23765         "default":
23766           description: Response codes found in [response codes](https://wiki.onap.org/).
23767       parameters:
23768         - name: equipment-name
23769           in: path
23770           required: true
23771           type: string
23772           example: __EQUIPMENT-NAME__
23773         - name: interface-name
23774           in: path
23775           description: Name that identifies the link aggregate interface
23776           required: true
23777           type: string
23778           example: __INTERFACE-NAME__
23779         - name: interface-name
23780           in: path
23781           description: Name given to the interface
23782           required: true
23783           type: string
23784           example: __INTERFACE-NAME__
23785         - name: resource-version
23786           in: query
23787           description: resource-version for concurrency
23788           required: true
23789           type: string
23790   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
23791     get:
23792       tags:
23793         - Network
23794       summary: returns l-interfaces
23795       description: returns l-interfaces
23796       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
23797       produces:
23798         - application/json
23799         - application/xml
23800       responses:
23801         "200":
23802           description: successful operation
23803           schema:
23804               $ref: "#/getDefinitions/l-interfaces"
23805         "default":
23806           description: Response codes found in [response codes](https://wiki.onap.org/).
23807       parameters:
23808         - name: equipment-name
23809           in: path
23810           required: true
23811           type: string
23812           example: __EQUIPMENT-NAME__
23813         - name: interface-name
23814           in: path
23815           description: Name that identifies the link aggregate interface
23816           required: true
23817           type: string
23818           example: __INTERFACE-NAME__
23819         - name: interface-name
23820           in: query
23821           description:
23822           required: false
23823           type: string
23824         - name: interface-id
23825           in: query
23826           description:
23827           required: false
23828           type: string
23829         - name: macaddr
23830           in: query
23831           description:
23832           required: false
23833           type: string
23834         - name: network-name
23835           in: query
23836           description:
23837           required: false
23838           type: string
23839   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
23840     get:
23841       tags:
23842         - Network
23843       summary: returns lag-interface
23844       description: returns lag-interface
23845       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
23846       produces:
23847         - application/json
23848         - application/xml
23849       responses:
23850         "200":
23851           description: successful operation
23852           schema:
23853               $ref: "#/getDefinitions/lag-interface"
23854         "default":
23855           description: Response codes found in [response codes](https://wiki.onap.org/).
23856       parameters:
23857         - name: equipment-name
23858           in: path
23859           required: true
23860           type: string
23861           example: __EQUIPMENT-NAME__
23862         - name: interface-name
23863           in: path
23864           description: Name that identifies the link aggregate interface
23865           required: true
23866           type: string
23867           example: __INTERFACE-NAME__
23868     put:
23869       tags:
23870         - Network
23871       summary: create or update an existing lag-interface
23872       description: |
23873         Create or update an existing lag-interface.
23874         #
23875         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23876       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
23877       consumes:
23878         - application/json
23879         - application/xml
23880       produces:
23881         - application/json
23882         - application/xml
23883       responses:
23884         "default":
23885           description: Response codes found in [response codes](https://wiki.onap.org/).
23886       parameters:
23887         - name: equipment-name
23888           in: path
23889           required: true
23890           type: string
23891           example: __EQUIPMENT-NAME__
23892         - name: interface-name
23893           in: path
23894           description: Name that identifies the link aggregate interface
23895           required: true
23896           type: string
23897           example: __INTERFACE-NAME__
23898         - name: body
23899           in: body
23900           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
23901           required: true
23902           schema:
23903             $ref: "#/definitions/lag-interface"
23904     patch:
23905       tags:
23906         - Network
23907       summary: update an existing lag-interface
23908       description: |
23909         Update an existing lag-interface
23910         #
23911         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23912         The PUT operation will entirely replace an existing object.
23913         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23914         #
23915         Other differences between PUT and PATCH are:
23916         #
23917         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23918         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23919         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23920       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
23921       consumes:
23922         - application/json
23923         - application/xml
23924       produces:
23925         - application/json
23926         - application/xml
23927       responses:
23928         "default":
23929           description: Response codes found in [response codes](https://wiki.onap.org/).
23930       parameters:
23931         - name: equipment-name
23932           in: path
23933           required: true
23934           type: string
23935           example: __EQUIPMENT-NAME__
23936         - name: interface-name
23937           in: path
23938           description: Name that identifies the link aggregate interface
23939           required: true
23940           type: string
23941           example: __INTERFACE-NAME__
23942         - name: body
23943           in: body
23944           description: lag-interface object that needs to be updated.
23945           required: true
23946           schema:
23947             $ref: "#/patchDefinitions/lag-interface"
23948     delete:
23949       tags:
23950         - Network
23951       summary: delete an existing lag-interface
23952       description: delete an existing lag-interface
23953       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
23954       consumes:
23955         - application/json
23956         - application/xml
23957       produces:
23958         - application/json
23959         - application/xml
23960       responses:
23961         "default":
23962           description: Response codes found in [response codes](https://wiki.onap.org/).
23963       parameters:
23964         - name: equipment-name
23965           in: path
23966           required: true
23967           type: string
23968           example: __EQUIPMENT-NAME__
23969         - name: interface-name
23970           in: path
23971           description: Name that identifies the link aggregate interface
23972           required: true
23973           type: string
23974           example: __INTERFACE-NAME__
23975         - name: resource-version
23976           in: query
23977           description: resource-version for concurrency
23978           required: true
23979           type: string
23980   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
23981     get:
23982       tags:
23983         - Network
23984       summary: returns lag-interfaces
23985       description: returns lag-interfaces
23986       operationId: getNetworkVplsPesVplsPeLagInterfaces
23987       produces:
23988         - application/json
23989         - application/xml
23990       responses:
23991         "200":
23992           description: successful operation
23993           schema:
23994               $ref: "#/getDefinitions/lag-interfaces"
23995         "default":
23996           description: Response codes found in [response codes](https://wiki.onap.org/).
23997       parameters:
23998         - name: equipment-name
23999           in: path
24000           required: true
24001           type: string
24002           example: __EQUIPMENT-NAME__
24003         - name: interface-name
24004           in: query
24005           description:
24006           required: false
24007           type: string
24008         - name: interface-id
24009           in: query
24010           description:
24011           required: false
24012           type: string
24013         - name: interface-role
24014           in: query
24015           description:
24016           required: false
24017           type: string
24018   /network/vpls-pes/vpls-pe/{equipment-name}:
24019     get:
24020       tags:
24021         - Network
24022       summary: returns vpls-pe
24023       description: returns vpls-pe
24024       operationId: getNetworkVplsPesVplsPe
24025       produces:
24026         - application/json
24027         - application/xml
24028       responses:
24029         "200":
24030           description: successful operation
24031           schema:
24032               $ref: "#/getDefinitions/vpls-pe"
24033         "default":
24034           description: Response codes found in [response codes](https://wiki.onap.org/).
24035       parameters:
24036         - name: equipment-name
24037           in: path
24038           required: true
24039           type: string
24040           example: __EQUIPMENT-NAME__
24041     put:
24042       tags:
24043         - Network
24044       summary: create or update an existing vpls-pe
24045       description: |
24046         Create or update an existing vpls-pe.
24047         #
24048         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24049       operationId: createOrUpdateNetworkVplsPesVplsPe
24050       consumes:
24051         - application/json
24052         - application/xml
24053       produces:
24054         - application/json
24055         - application/xml
24056       responses:
24057         "default":
24058           description: Response codes found in [response codes](https://wiki.onap.org/).
24059       parameters:
24060         - name: equipment-name
24061           in: path
24062           required: true
24063           type: string
24064           example: __EQUIPMENT-NAME__
24065         - name: body
24066           in: body
24067           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)
24068           required: true
24069           schema:
24070             $ref: "#/definitions/vpls-pe"
24071     patch:
24072       tags:
24073         - Network
24074       summary: update an existing vpls-pe
24075       description: |
24076         Update an existing vpls-pe
24077         #
24078         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24079         The PUT operation will entirely replace an existing object.
24080         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24081         #
24082         Other differences between PUT and PATCH are:
24083         #
24084         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24085         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24086         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24087       operationId: UpdateNetworkVplsPesVplsPe
24088       consumes:
24089         - application/json
24090         - application/xml
24091       produces:
24092         - application/json
24093         - application/xml
24094       responses:
24095         "default":
24096           description: Response codes found in [response codes](https://wiki.onap.org/).
24097       parameters:
24098         - name: equipment-name
24099           in: path
24100           required: true
24101           type: string
24102           example: __EQUIPMENT-NAME__
24103         - name: body
24104           in: body
24105           description: vpls-pe object that needs to be updated.
24106           required: true
24107           schema:
24108             $ref: "#/patchDefinitions/vpls-pe"
24109     delete:
24110       tags:
24111         - Network
24112       summary: delete an existing vpls-pe
24113       description: delete an existing vpls-pe
24114       operationId: deleteNetworkVplsPesVplsPe
24115       consumes:
24116         - application/json
24117         - application/xml
24118       produces:
24119         - application/json
24120         - application/xml
24121       responses:
24122         "default":
24123           description: Response codes found in [response codes](https://wiki.onap.org/).
24124       parameters:
24125         - name: equipment-name
24126           in: path
24127           required: true
24128           type: string
24129           example: __EQUIPMENT-NAME__
24130         - name: resource-version
24131           in: query
24132           description: resource-version for concurrency
24133           required: true
24134           type: string
24135   /network/vpls-pes:
24136     get:
24137       tags:
24138         - Network
24139       summary: returns vpls-pes
24140       description: returns vpls-pes
24141       operationId: getNetworkVplsPes
24142       produces:
24143         - application/json
24144         - application/xml
24145       responses:
24146         "200":
24147           description: successful operation
24148           schema:
24149               $ref: "#/getDefinitions/vpls-pes"
24150         "default":
24151           description: Response codes found in [response codes](https://wiki.onap.org/).
24152       parameters:
24153         - name: equipment-name
24154           in: query
24155           description:
24156           required: false
24157           type: string
24158         - name: prov-status
24159           in: query
24160           description:
24161           required: false
24162           type: string
24163   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
24164     put:
24165       tags:
24166         - Network
24167       summary: see node definition for valid relationships
24168       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
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: multicast-configuration-id
24180           in: path
24181           description: Unique id of multicast configuration.
24182           required: true
24183           type: string
24184           example: __MULTICAST-CONFIGURATION-ID__
24185         - name: body
24186           in: body
24187           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)
24188           required: true
24189           schema:
24190             $ref: "#/definitions/relationship"
24191     delete:
24192       tags:
24193         - Network
24194       summary: delete an existing relationship
24195       description: delete an existing relationship
24196       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
24197       consumes:
24198         - application/json
24199         - application/xml
24200       produces:
24201         - application/json
24202         - application/xml
24203       responses:
24204         "default":
24205           description: Response codes found in [response codes](https://wiki.onap.org/).
24206       parameters:
24207         - name: multicast-configuration-id
24208           in: path
24209           description: Unique id of multicast configuration.
24210           required: true
24211           type: string
24212           example: __MULTICAST-CONFIGURATION-ID__
24213   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
24214     get:
24215       tags:
24216         - Network
24217       summary: returns multicast-configuration
24218       description: returns multicast-configuration
24219       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
24220       produces:
24221         - application/json
24222         - application/xml
24223       responses:
24224         "200":
24225           description: successful operation
24226           schema:
24227               $ref: "#/getDefinitions/multicast-configuration"
24228         "default":
24229           description: Response codes found in [response codes](https://wiki.onap.org/).
24230       parameters:
24231         - name: multicast-configuration-id
24232           in: path
24233           description: Unique id of multicast configuration.
24234           required: true
24235           type: string
24236           example: __MULTICAST-CONFIGURATION-ID__
24237     put:
24238       tags:
24239         - Network
24240       summary: create or update an existing multicast-configuration
24241       description: |
24242         Create or update an existing multicast-configuration.
24243         #
24244         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24245       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
24246       consumes:
24247         - application/json
24248         - application/xml
24249       produces:
24250         - application/json
24251         - application/xml
24252       responses:
24253         "default":
24254           description: Response codes found in [response codes](https://wiki.onap.org/).
24255       parameters:
24256         - name: multicast-configuration-id
24257           in: path
24258           description: Unique id of multicast configuration.
24259           required: true
24260           type: string
24261           example: __MULTICAST-CONFIGURATION-ID__
24262         - name: body
24263           in: body
24264           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)
24265           required: true
24266           schema:
24267             $ref: "#/definitions/multicast-configuration"
24268     patch:
24269       tags:
24270         - Network
24271       summary: update an existing multicast-configuration
24272       description: |
24273         Update an existing multicast-configuration
24274         #
24275         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24276         The PUT operation will entirely replace an existing object.
24277         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24278         #
24279         Other differences between PUT and PATCH are:
24280         #
24281         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24282         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24283         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24284       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
24285       consumes:
24286         - application/json
24287         - application/xml
24288       produces:
24289         - application/json
24290         - application/xml
24291       responses:
24292         "default":
24293           description: Response codes found in [response codes](https://wiki.onap.org/).
24294       parameters:
24295         - name: multicast-configuration-id
24296           in: path
24297           description: Unique id of multicast configuration.
24298           required: true
24299           type: string
24300           example: __MULTICAST-CONFIGURATION-ID__
24301         - name: body
24302           in: body
24303           description: multicast-configuration object that needs to be updated.
24304           required: true
24305           schema:
24306             $ref: "#/patchDefinitions/multicast-configuration"
24307     delete:
24308       tags:
24309         - Network
24310       summary: delete an existing multicast-configuration
24311       description: delete an existing multicast-configuration
24312       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
24313       consumes:
24314         - application/json
24315         - application/xml
24316       produces:
24317         - application/json
24318         - application/xml
24319       responses:
24320         "default":
24321           description: Response codes found in [response codes](https://wiki.onap.org/).
24322       parameters:
24323         - name: multicast-configuration-id
24324           in: path
24325           description: Unique id of multicast configuration.
24326           required: true
24327           type: string
24328           example: __MULTICAST-CONFIGURATION-ID__
24329         - name: resource-version
24330           in: query
24331           description: resource-version for concurrency
24332           required: true
24333           type: string
24334   /network/multicast-configurations:
24335     get:
24336       tags:
24337         - Network
24338       summary: returns multicast-configurations
24339       description: returns multicast-configurations
24340       operationId: getNetworkMulticastConfigurations
24341       produces:
24342         - application/json
24343         - application/xml
24344       responses:
24345         "200":
24346           description: successful operation
24347           schema:
24348               $ref: "#/getDefinitions/multicast-configurations"
24349         "default":
24350           description: Response codes found in [response codes](https://wiki.onap.org/).
24351       parameters:
24352         - name: multicast-configuration-id
24353           in: query
24354           description:
24355           required: false
24356           type: string
24357   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
24358     put:
24359       tags:
24360         - Network
24361       summary: see node definition for valid relationships
24362       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
24363       consumes:
24364         - application/json
24365         - application/xml
24366       produces:
24367         - application/json
24368         - application/xml
24369       responses:
24370         "default":
24371           description: Response codes found in [response codes](https://wiki.onap.org/).
24372       parameters:
24373         - name: vnf-id
24374           in: path
24375           description: Unique id of VNF.  This is unique across the graph.
24376           required: true
24377           type: string
24378           example: __VNF-ID__
24379         - name: interface-id
24380           in: path
24381           description: Unique ID of the interface
24382           required: true
24383           type: string
24384           example: __INTERFACE-ID__
24385         - name: cvlan-tag
24386           in: path
24387           description: See mis-na-virtualization-platform.yang
24388           required: true
24389           type: integer
24390           format: int64
24391           example: __CVLAN-TAG__
24392         - name: body
24393           in: body
24394           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
24395           required: true
24396           schema:
24397             $ref: "#/definitions/relationship"
24398     delete:
24399       tags:
24400         - Network
24401       summary: delete an existing relationship
24402       description: delete an existing relationship
24403       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
24404       consumes:
24405         - application/json
24406         - application/xml
24407       produces:
24408         - application/json
24409         - application/xml
24410       responses:
24411         "default":
24412           description: Response codes found in [response codes](https://wiki.onap.org/).
24413       parameters:
24414         - name: vnf-id
24415           in: path
24416           description: Unique id of VNF.  This is unique across the graph.
24417           required: true
24418           type: string
24419           example: __VNF-ID__
24420         - name: interface-id
24421           in: path
24422           description: Unique ID of the interface
24423           required: true
24424           type: string
24425           example: __INTERFACE-ID__
24426         - name: cvlan-tag
24427           in: path
24428           description: See mis-na-virtualization-platform.yang
24429           required: true
24430           type: integer
24431           format: int64
24432           example: __CVLAN-TAG__
24433   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
24434     get:
24435       tags:
24436         - Network
24437       summary: returns cvlan-tag-entry
24438       description: returns cvlan-tag-entry
24439       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24440       produces:
24441         - application/json
24442         - application/xml
24443       responses:
24444         "200":
24445           description: successful operation
24446           schema:
24447               $ref: "#/getDefinitions/cvlan-tag-entry"
24448         "default":
24449           description: Response codes found in [response codes](https://wiki.onap.org/).
24450       parameters:
24451         - name: vnf-id
24452           in: path
24453           description: Unique id of VNF.  This is unique across the graph.
24454           required: true
24455           type: string
24456           example: __VNF-ID__
24457         - name: interface-id
24458           in: path
24459           description: Unique ID of the interface
24460           required: true
24461           type: string
24462           example: __INTERFACE-ID__
24463         - name: cvlan-tag
24464           in: path
24465           description: See mis-na-virtualization-platform.yang
24466           required: true
24467           type: integer
24468           format: int64
24469           example: __CVLAN-TAG__
24470     put:
24471       tags:
24472         - Network
24473       summary: create or update an existing cvlan-tag-entry
24474       description: |
24475         Create or update an existing cvlan-tag-entry.
24476         #
24477         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24478       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24479       consumes:
24480         - application/json
24481         - application/xml
24482       produces:
24483         - application/json
24484         - application/xml
24485       responses:
24486         "default":
24487           description: Response codes found in [response codes](https://wiki.onap.org/).
24488       parameters:
24489         - name: vnf-id
24490           in: path
24491           description: Unique id of VNF.  This is unique across the graph.
24492           required: true
24493           type: string
24494           example: __VNF-ID__
24495         - name: interface-id
24496           in: path
24497           description: Unique ID of the interface
24498           required: true
24499           type: string
24500           example: __INTERFACE-ID__
24501         - name: cvlan-tag
24502           in: path
24503           description: See mis-na-virtualization-platform.yang
24504           required: true
24505           type: integer
24506           format: int64
24507           example: __CVLAN-TAG__
24508         - name: body
24509           in: body
24510           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
24511           required: true
24512           schema:
24513             $ref: "#/definitions/cvlan-tag-entry"
24514     patch:
24515       tags:
24516         - Network
24517       summary: update an existing cvlan-tag-entry
24518       description: |
24519         Update an existing cvlan-tag-entry
24520         #
24521         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24522         The PUT operation will entirely replace an existing object.
24523         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24524         #
24525         Other differences between PUT and PATCH are:
24526         #
24527         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24528         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24529         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24530       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24531       consumes:
24532         - application/json
24533         - application/xml
24534       produces:
24535         - application/json
24536         - application/xml
24537       responses:
24538         "default":
24539           description: Response codes found in [response codes](https://wiki.onap.org/).
24540       parameters:
24541         - name: vnf-id
24542           in: path
24543           description: Unique id of VNF.  This is unique across the graph.
24544           required: true
24545           type: string
24546           example: __VNF-ID__
24547         - name: interface-id
24548           in: path
24549           description: Unique ID of the interface
24550           required: true
24551           type: string
24552           example: __INTERFACE-ID__
24553         - name: cvlan-tag
24554           in: path
24555           description: See mis-na-virtualization-platform.yang
24556           required: true
24557           type: integer
24558           format: int64
24559           example: __CVLAN-TAG__
24560         - name: body
24561           in: body
24562           description: cvlan-tag-entry object that needs to be updated.
24563           required: true
24564           schema:
24565             $ref: "#/patchDefinitions/cvlan-tag-entry"
24566     delete:
24567       tags:
24568         - Network
24569       summary: delete an existing cvlan-tag-entry
24570       description: delete an existing cvlan-tag-entry
24571       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24572       consumes:
24573         - application/json
24574         - application/xml
24575       produces:
24576         - application/json
24577         - application/xml
24578       responses:
24579         "default":
24580           description: Response codes found in [response codes](https://wiki.onap.org/).
24581       parameters:
24582         - name: vnf-id
24583           in: path
24584           description: Unique id of VNF.  This is unique across the graph.
24585           required: true
24586           type: string
24587           example: __VNF-ID__
24588         - name: interface-id
24589           in: path
24590           description: Unique ID of the interface
24591           required: true
24592           type: string
24593           example: __INTERFACE-ID__
24594         - name: cvlan-tag
24595           in: path
24596           description: See mis-na-virtualization-platform.yang
24597           required: true
24598           type: integer
24599           format: int64
24600           example: __CVLAN-TAG__
24601         - name: resource-version
24602           in: query
24603           description: resource-version for concurrency
24604           required: true
24605           type: string
24606   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
24607     get:
24608       tags:
24609         - Network
24610       summary: returns cvlan-tags
24611       description: returns cvlan-tags
24612       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
24613       produces:
24614         - application/json
24615         - application/xml
24616       responses:
24617         "200":
24618           description: successful operation
24619           schema:
24620               $ref: "#/getDefinitions/cvlan-tags"
24621         "default":
24622           description: Response codes found in [response codes](https://wiki.onap.org/).
24623       parameters:
24624         - name: vnf-id
24625           in: path
24626           description: Unique id of VNF.  This is unique across the graph.
24627           required: true
24628           type: string
24629           example: __VNF-ID__
24630         - name: interface-id
24631           in: path
24632           description: Unique ID of the interface
24633           required: true
24634           type: string
24635           example: __INTERFACE-ID__
24636         - name: cvlan-tag
24637           in: query
24638           description:
24639           required: false
24640           type: integer
24641           format: int64
24642   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
24643     put:
24644       tags:
24645         - Network
24646       summary: see node definition for valid relationships
24647       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
24648       consumes:
24649         - application/json
24650         - application/xml
24651       produces:
24652         - application/json
24653         - application/xml
24654       responses:
24655         "default":
24656           description: Response codes found in [response codes](https://wiki.onap.org/).
24657       parameters:
24658         - name: vnf-id
24659           in: path
24660           description: Unique id of VNF.  This is unique across the graph.
24661           required: true
24662           type: string
24663           example: __VNF-ID__
24664         - name: interface-id
24665           in: path
24666           description: Unique ID of the interface
24667           required: true
24668           type: string
24669           example: __INTERFACE-ID__
24670         - name: body
24671           in: body
24672           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)
24673           required: true
24674           schema:
24675             $ref: "#/definitions/relationship"
24676     delete:
24677       tags:
24678         - Network
24679       summary: delete an existing relationship
24680       description: delete an existing relationship
24681       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
24682       consumes:
24683         - application/json
24684         - application/xml
24685       produces:
24686         - application/json
24687         - application/xml
24688       responses:
24689         "default":
24690           description: Response codes found in [response codes](https://wiki.onap.org/).
24691       parameters:
24692         - name: vnf-id
24693           in: path
24694           description: Unique id of VNF.  This is unique across the graph.
24695           required: true
24696           type: string
24697           example: __VNF-ID__
24698         - name: interface-id
24699           in: path
24700           description: Unique ID of the interface
24701           required: true
24702           type: string
24703           example: __INTERFACE-ID__
24704   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
24705     get:
24706       tags:
24707         - Network
24708       summary: returns port-group
24709       description: returns port-group
24710       operationId: getNetworkVcesVcePortGroupsPortGroup
24711       produces:
24712         - application/json
24713         - application/xml
24714       responses:
24715         "200":
24716           description: successful operation
24717           schema:
24718               $ref: "#/getDefinitions/port-group"
24719         "default":
24720           description: Response codes found in [response codes](https://wiki.onap.org/).
24721       parameters:
24722         - name: vnf-id
24723           in: path
24724           description: Unique id of VNF.  This is unique across the graph.
24725           required: true
24726           type: string
24727           example: __VNF-ID__
24728         - name: interface-id
24729           in: path
24730           description: Unique ID of the interface
24731           required: true
24732           type: string
24733           example: __INTERFACE-ID__
24734     put:
24735       tags:
24736         - Network
24737       summary: create or update an existing port-group
24738       description: |
24739         Create or update an existing port-group.
24740         #
24741         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24742       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
24743       consumes:
24744         - application/json
24745         - application/xml
24746       produces:
24747         - application/json
24748         - application/xml
24749       responses:
24750         "default":
24751           description: Response codes found in [response codes](https://wiki.onap.org/).
24752       parameters:
24753         - name: vnf-id
24754           in: path
24755           description: Unique id of VNF.  This is unique across the graph.
24756           required: true
24757           type: string
24758           example: __VNF-ID__
24759         - name: interface-id
24760           in: path
24761           description: Unique ID of the interface
24762           required: true
24763           type: string
24764           example: __INTERFACE-ID__
24765         - name: body
24766           in: body
24767           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)
24768           required: true
24769           schema:
24770             $ref: "#/definitions/port-group"
24771     patch:
24772       tags:
24773         - Network
24774       summary: update an existing port-group
24775       description: |
24776         Update an existing port-group
24777         #
24778         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24779         The PUT operation will entirely replace an existing object.
24780         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24781         #
24782         Other differences between PUT and PATCH are:
24783         #
24784         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24785         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24786         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24787       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
24788       consumes:
24789         - application/json
24790         - application/xml
24791       produces:
24792         - application/json
24793         - application/xml
24794       responses:
24795         "default":
24796           description: Response codes found in [response codes](https://wiki.onap.org/).
24797       parameters:
24798         - name: vnf-id
24799           in: path
24800           description: Unique id of VNF.  This is unique across the graph.
24801           required: true
24802           type: string
24803           example: __VNF-ID__
24804         - name: interface-id
24805           in: path
24806           description: Unique ID of the interface
24807           required: true
24808           type: string
24809           example: __INTERFACE-ID__
24810         - name: body
24811           in: body
24812           description: port-group object that needs to be updated.
24813           required: true
24814           schema:
24815             $ref: "#/patchDefinitions/port-group"
24816     delete:
24817       tags:
24818         - Network
24819       summary: delete an existing port-group
24820       description: delete an existing port-group
24821       operationId: deleteNetworkVcesVcePortGroupsPortGroup
24822       consumes:
24823         - application/json
24824         - application/xml
24825       produces:
24826         - application/json
24827         - application/xml
24828       responses:
24829         "default":
24830           description: Response codes found in [response codes](https://wiki.onap.org/).
24831       parameters:
24832         - name: vnf-id
24833           in: path
24834           description: Unique id of VNF.  This is unique across the graph.
24835           required: true
24836           type: string
24837           example: __VNF-ID__
24838         - name: interface-id
24839           in: path
24840           description: Unique ID of the interface
24841           required: true
24842           type: string
24843           example: __INTERFACE-ID__
24844         - name: resource-version
24845           in: query
24846           description: resource-version for concurrency
24847           required: true
24848           type: string
24849   /network/vces/vce/{vnf-id}/port-groups:
24850     get:
24851       tags:
24852         - Network
24853       summary: returns port-groups
24854       description: returns port-groups
24855       operationId: getNetworkVcesVcePortGroups
24856       produces:
24857         - application/json
24858         - application/xml
24859       responses:
24860         "200":
24861           description: successful operation
24862           schema:
24863               $ref: "#/getDefinitions/port-groups"
24864         "default":
24865           description: Response codes found in [response codes](https://wiki.onap.org/).
24866       parameters:
24867         - name: vnf-id
24868           in: path
24869           description: Unique id of VNF.  This is unique across the graph.
24870           required: true
24871           type: string
24872           example: __VNF-ID__
24873         - name: interface-id
24874           in: query
24875           description:
24876           required: false
24877           type: string
24878         - name: port-group-id
24879           in: query
24880           description:
24881           required: false
24882           type: string
24883         - name: switch-name
24884           in: query
24885           description:
24886           required: false
24887           type: string
24888         - name: heat-stack-id
24889           in: query
24890           description:
24891           required: false
24892           type: string
24893   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
24894     put:
24895       tags:
24896         - Network
24897       summary: see node definition for valid relationships
24898       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
24899       consumes:
24900         - application/json
24901         - application/xml
24902       produces:
24903         - application/json
24904         - application/xml
24905       responses:
24906         "default":
24907           description: Response codes found in [response codes](https://wiki.onap.org/).
24908       parameters:
24909         - name: vnf-id
24910           in: path
24911           description: Unique id of VNF.  This is unique across the graph.
24912           required: true
24913           type: string
24914           example: __VNF-ID__
24915         - name: group-uuid
24916           in: path
24917           description: Unique ID for the license group the resource belongs to, should be uuid.
24918           required: true
24919           type: string
24920           example: __GROUP-UUID__
24921         - name: resource-uuid
24922           in: path
24923           description: Unique ID of a license resource.
24924           required: true
24925           type: string
24926           example: __RESOURCE-UUID__
24927         - name: body
24928           in: body
24929           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)
24930           required: true
24931           schema:
24932             $ref: "#/definitions/relationship"
24933     delete:
24934       tags:
24935         - Network
24936       summary: delete an existing relationship
24937       description: delete an existing relationship
24938       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
24939       consumes:
24940         - application/json
24941         - application/xml
24942       produces:
24943         - application/json
24944         - application/xml
24945       responses:
24946         "default":
24947           description: Response codes found in [response codes](https://wiki.onap.org/).
24948       parameters:
24949         - name: vnf-id
24950           in: path
24951           description: Unique id of VNF.  This is unique across the graph.
24952           required: true
24953           type: string
24954           example: __VNF-ID__
24955         - name: group-uuid
24956           in: path
24957           description: Unique ID for the license group the resource belongs to, should be uuid.
24958           required: true
24959           type: string
24960           example: __GROUP-UUID__
24961         - name: resource-uuid
24962           in: path
24963           description: Unique ID of a license resource.
24964           required: true
24965           type: string
24966           example: __RESOURCE-UUID__
24967   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
24968     get:
24969       tags:
24970         - Network
24971       summary: returns license
24972       description: returns license
24973       operationId: getNetworkVcesVceLicensesLicense
24974       produces:
24975         - application/json
24976         - application/xml
24977       responses:
24978         "200":
24979           description: successful operation
24980           schema:
24981               $ref: "#/getDefinitions/license"
24982         "default":
24983           description: Response codes found in [response codes](https://wiki.onap.org/).
24984       parameters:
24985         - name: vnf-id
24986           in: path
24987           description: Unique id of VNF.  This is unique across the graph.
24988           required: true
24989           type: string
24990           example: __VNF-ID__
24991         - name: group-uuid
24992           in: path
24993           description: Unique ID for the license group the resource belongs to, should be uuid.
24994           required: true
24995           type: string
24996           example: __GROUP-UUID__
24997         - name: resource-uuid
24998           in: path
24999           description: Unique ID of a license resource.
25000           required: true
25001           type: string
25002           example: __RESOURCE-UUID__
25003     put:
25004       tags:
25005         - Network
25006       summary: create or update an existing license
25007       description: |
25008         Create or update an existing license.
25009         #
25010         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25011       operationId: createOrUpdateNetworkVcesVceLicensesLicense
25012       consumes:
25013         - application/json
25014         - application/xml
25015       produces:
25016         - application/json
25017         - application/xml
25018       responses:
25019         "default":
25020           description: Response codes found in [response codes](https://wiki.onap.org/).
25021       parameters:
25022         - name: vnf-id
25023           in: path
25024           description: Unique id of VNF.  This is unique across the graph.
25025           required: true
25026           type: string
25027           example: __VNF-ID__
25028         - name: group-uuid
25029           in: path
25030           description: Unique ID for the license group the resource belongs to, should be uuid.
25031           required: true
25032           type: string
25033           example: __GROUP-UUID__
25034         - name: resource-uuid
25035           in: path
25036           description: Unique ID of a license resource.
25037           required: true
25038           type: string
25039           example: __RESOURCE-UUID__
25040         - name: body
25041           in: body
25042           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)
25043           required: true
25044           schema:
25045             $ref: "#/definitions/license"
25046     patch:
25047       tags:
25048         - Network
25049       summary: update an existing license
25050       description: |
25051         Update an existing license
25052         #
25053         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25054         The PUT operation will entirely replace an existing object.
25055         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25056         #
25057         Other differences between PUT and PATCH are:
25058         #
25059         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25060         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25061         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25062       operationId: UpdateNetworkVcesVceLicensesLicense
25063       consumes:
25064         - application/json
25065         - application/xml
25066       produces:
25067         - application/json
25068         - application/xml
25069       responses:
25070         "default":
25071           description: Response codes found in [response codes](https://wiki.onap.org/).
25072       parameters:
25073         - name: vnf-id
25074           in: path
25075           description: Unique id of VNF.  This is unique across the graph.
25076           required: true
25077           type: string
25078           example: __VNF-ID__
25079         - name: group-uuid
25080           in: path
25081           description: Unique ID for the license group the resource belongs to, should be uuid.
25082           required: true
25083           type: string
25084           example: __GROUP-UUID__
25085         - name: resource-uuid
25086           in: path
25087           description: Unique ID of a license resource.
25088           required: true
25089           type: string
25090           example: __RESOURCE-UUID__
25091         - name: body
25092           in: body
25093           description: license object that needs to be updated.
25094           required: true
25095           schema:
25096             $ref: "#/patchDefinitions/license"
25097     delete:
25098       tags:
25099         - Network
25100       summary: delete an existing license
25101       description: delete an existing license
25102       operationId: deleteNetworkVcesVceLicensesLicense
25103       consumes:
25104         - application/json
25105         - application/xml
25106       produces:
25107         - application/json
25108         - application/xml
25109       responses:
25110         "default":
25111           description: Response codes found in [response codes](https://wiki.onap.org/).
25112       parameters:
25113         - name: vnf-id
25114           in: path
25115           description: Unique id of VNF.  This is unique across the graph.
25116           required: true
25117           type: string
25118           example: __VNF-ID__
25119         - name: group-uuid
25120           in: path
25121           description: Unique ID for the license group the resource belongs to, should be uuid.
25122           required: true
25123           type: string
25124           example: __GROUP-UUID__
25125         - name: resource-uuid
25126           in: path
25127           description: Unique ID of a license resource.
25128           required: true
25129           type: string
25130           example: __RESOURCE-UUID__
25131         - name: resource-version
25132           in: query
25133           description: resource-version for concurrency
25134           required: true
25135           type: string
25136   /network/vces/vce/{vnf-id}/licenses:
25137     get:
25138       tags:
25139         - Network
25140       summary: returns licenses
25141       description: returns licenses
25142       operationId: getNetworkVcesVceLicenses
25143       produces:
25144         - application/json
25145         - application/xml
25146       responses:
25147         "200":
25148           description: successful operation
25149           schema:
25150               $ref: "#/getDefinitions/licenses"
25151         "default":
25152           description: Response codes found in [response codes](https://wiki.onap.org/).
25153       parameters:
25154         - name: vnf-id
25155           in: path
25156           description: Unique id of VNF.  This is unique across the graph.
25157           required: true
25158           type: string
25159           example: __VNF-ID__
25160         - name: group-uuid
25161           in: query
25162           description:
25163           required: false
25164           type: string
25165         - name: resource-uuid
25166           in: query
25167           description:
25168           required: false
25169           type: string
25170   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
25171     put:
25172       tags:
25173         - Network
25174       summary: see node definition for valid relationships
25175       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
25176       consumes:
25177         - application/json
25178         - application/xml
25179       produces:
25180         - application/json
25181         - application/xml
25182       responses:
25183         "default":
25184           description: Response codes found in [response codes](https://wiki.onap.org/).
25185       parameters:
25186         - name: vnf-id
25187           in: path
25188           description: Unique id of VNF.  This is unique across the graph.
25189           required: true
25190           type: string
25191           example: __VNF-ID__
25192         - name: group-uuid
25193           in: path
25194           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25195           required: true
25196           type: string
25197           example: __GROUP-UUID__
25198         - name: resource-uuid
25199           in: path
25200           description: Unique ID of an entitlement resource.
25201           required: true
25202           type: string
25203           example: __RESOURCE-UUID__
25204         - name: body
25205           in: body
25206           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)
25207           required: true
25208           schema:
25209             $ref: "#/definitions/relationship"
25210     delete:
25211       tags:
25212         - Network
25213       summary: delete an existing relationship
25214       description: delete an existing relationship
25215       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
25216       consumes:
25217         - application/json
25218         - application/xml
25219       produces:
25220         - application/json
25221         - application/xml
25222       responses:
25223         "default":
25224           description: Response codes found in [response codes](https://wiki.onap.org/).
25225       parameters:
25226         - name: vnf-id
25227           in: path
25228           description: Unique id of VNF.  This is unique across the graph.
25229           required: true
25230           type: string
25231           example: __VNF-ID__
25232         - name: group-uuid
25233           in: path
25234           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25235           required: true
25236           type: string
25237           example: __GROUP-UUID__
25238         - name: resource-uuid
25239           in: path
25240           description: Unique ID of an entitlement resource.
25241           required: true
25242           type: string
25243           example: __RESOURCE-UUID__
25244   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
25245     get:
25246       tags:
25247         - Network
25248       summary: returns entitlement
25249       description: returns entitlement
25250       operationId: getNetworkVcesVceEntitlementsEntitlement
25251       produces:
25252         - application/json
25253         - application/xml
25254       responses:
25255         "200":
25256           description: successful operation
25257           schema:
25258               $ref: "#/getDefinitions/entitlement"
25259         "default":
25260           description: Response codes found in [response codes](https://wiki.onap.org/).
25261       parameters:
25262         - name: vnf-id
25263           in: path
25264           description: Unique id of VNF.  This is unique across the graph.
25265           required: true
25266           type: string
25267           example: __VNF-ID__
25268         - name: group-uuid
25269           in: path
25270           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25271           required: true
25272           type: string
25273           example: __GROUP-UUID__
25274         - name: resource-uuid
25275           in: path
25276           description: Unique ID of an entitlement resource.
25277           required: true
25278           type: string
25279           example: __RESOURCE-UUID__
25280     put:
25281       tags:
25282         - Network
25283       summary: create or update an existing entitlement
25284       description: |
25285         Create or update an existing entitlement.
25286         #
25287         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25288       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
25289       consumes:
25290         - application/json
25291         - application/xml
25292       produces:
25293         - application/json
25294         - application/xml
25295       responses:
25296         "default":
25297           description: Response codes found in [response codes](https://wiki.onap.org/).
25298       parameters:
25299         - name: vnf-id
25300           in: path
25301           description: Unique id of VNF.  This is unique across the graph.
25302           required: true
25303           type: string
25304           example: __VNF-ID__
25305         - name: group-uuid
25306           in: path
25307           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25308           required: true
25309           type: string
25310           example: __GROUP-UUID__
25311         - name: resource-uuid
25312           in: path
25313           description: Unique ID of an entitlement resource.
25314           required: true
25315           type: string
25316           example: __RESOURCE-UUID__
25317         - name: body
25318           in: body
25319           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)
25320           required: true
25321           schema:
25322             $ref: "#/definitions/entitlement"
25323     patch:
25324       tags:
25325         - Network
25326       summary: update an existing entitlement
25327       description: |
25328         Update an existing entitlement
25329         #
25330         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25331         The PUT operation will entirely replace an existing object.
25332         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25333         #
25334         Other differences between PUT and PATCH are:
25335         #
25336         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25337         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25338         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25339       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
25340       consumes:
25341         - application/json
25342         - application/xml
25343       produces:
25344         - application/json
25345         - application/xml
25346       responses:
25347         "default":
25348           description: Response codes found in [response codes](https://wiki.onap.org/).
25349       parameters:
25350         - name: vnf-id
25351           in: path
25352           description: Unique id of VNF.  This is unique across the graph.
25353           required: true
25354           type: string
25355           example: __VNF-ID__
25356         - name: group-uuid
25357           in: path
25358           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25359           required: true
25360           type: string
25361           example: __GROUP-UUID__
25362         - name: resource-uuid
25363           in: path
25364           description: Unique ID of an entitlement resource.
25365           required: true
25366           type: string
25367           example: __RESOURCE-UUID__
25368         - name: body
25369           in: body
25370           description: entitlement object that needs to be updated.
25371           required: true
25372           schema:
25373             $ref: "#/patchDefinitions/entitlement"
25374     delete:
25375       tags:
25376         - Network
25377       summary: delete an existing entitlement
25378       description: delete an existing entitlement
25379       operationId: deleteNetworkVcesVceEntitlementsEntitlement
25380       consumes:
25381         - application/json
25382         - application/xml
25383       produces:
25384         - application/json
25385         - application/xml
25386       responses:
25387         "default":
25388           description: Response codes found in [response codes](https://wiki.onap.org/).
25389       parameters:
25390         - name: vnf-id
25391           in: path
25392           description: Unique id of VNF.  This is unique across the graph.
25393           required: true
25394           type: string
25395           example: __VNF-ID__
25396         - name: group-uuid
25397           in: path
25398           description: Unique ID for the entitlement group the resource comes from, should be uuid.
25399           required: true
25400           type: string
25401           example: __GROUP-UUID__
25402         - name: resource-uuid
25403           in: path
25404           description: Unique ID of an entitlement resource.
25405           required: true
25406           type: string
25407           example: __RESOURCE-UUID__
25408         - name: resource-version
25409           in: query
25410           description: resource-version for concurrency
25411           required: true
25412           type: string
25413   /network/vces/vce/{vnf-id}/entitlements:
25414     get:
25415       tags:
25416         - Network
25417       summary: returns entitlements
25418       description: returns entitlements
25419       operationId: getNetworkVcesVceEntitlements
25420       produces:
25421         - application/json
25422         - application/xml
25423       responses:
25424         "200":
25425           description: successful operation
25426           schema:
25427               $ref: "#/getDefinitions/entitlements"
25428         "default":
25429           description: Response codes found in [response codes](https://wiki.onap.org/).
25430       parameters:
25431         - name: vnf-id
25432           in: path
25433           description: Unique id of VNF.  This is unique across the graph.
25434           required: true
25435           type: string
25436           example: __VNF-ID__
25437         - name: group-uuid
25438           in: query
25439           description:
25440           required: false
25441           type: string
25442         - name: resource-uuid
25443           in: query
25444           description:
25445           required: false
25446           type: string
25447   /network/vces/vce/{vnf-id}/relationship-list/relationship:
25448     put:
25449       tags:
25450         - Network
25451       summary: see node definition for valid relationships
25452       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
25453       consumes:
25454         - application/json
25455         - application/xml
25456       produces:
25457         - application/json
25458         - application/xml
25459       responses:
25460         "default":
25461           description: Response codes found in [response codes](https://wiki.onap.org/).
25462       parameters:
25463         - name: vnf-id
25464           in: path
25465           description: Unique id of VNF.  This is unique across the graph.
25466           required: true
25467           type: string
25468           example: __VNF-ID__
25469         - name: body
25470           in: body
25471           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVce.json)
25472           required: true
25473           schema:
25474             $ref: "#/definitions/relationship"
25475     delete:
25476       tags:
25477         - Network
25478       summary: delete an existing relationship
25479       description: delete an existing relationship
25480       operationId: deleteNetworkVcesVceRelationshipListRelationship
25481       consumes:
25482         - application/json
25483         - application/xml
25484       produces:
25485         - application/json
25486         - application/xml
25487       responses:
25488         "default":
25489           description: Response codes found in [response codes](https://wiki.onap.org/).
25490       parameters:
25491         - name: vnf-id
25492           in: path
25493           description: Unique id of VNF.  This is unique across the graph.
25494           required: true
25495           type: string
25496           example: __VNF-ID__
25497   /network/vces/vce/{vnf-id}:
25498     get:
25499       tags:
25500         - Network
25501       summary: returns vce
25502       description: returns vce
25503       operationId: getNetworkVcesVce
25504       produces:
25505         - application/json
25506         - application/xml
25507       responses:
25508         "200":
25509           description: successful operation
25510           schema:
25511               $ref: "#/getDefinitions/vce"
25512         "default":
25513           description: Response codes found in [response codes](https://wiki.onap.org/).
25514       parameters:
25515         - name: vnf-id
25516           in: path
25517           description: Unique id of VNF.  This is unique across the graph.
25518           required: true
25519           type: string
25520           example: __VNF-ID__
25521     put:
25522       tags:
25523         - Network
25524       summary: create or update an existing vce
25525       description: |
25526         Create or update an existing vce.
25527         #
25528         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25529       operationId: createOrUpdateNetworkVcesVce
25530       consumes:
25531         - application/json
25532         - application/xml
25533       produces:
25534         - application/json
25535         - application/xml
25536       responses:
25537         "default":
25538           description: Response codes found in [response codes](https://wiki.onap.org/).
25539       parameters:
25540         - name: vnf-id
25541           in: path
25542           description: Unique id of VNF.  This is unique across the graph.
25543           required: true
25544           type: string
25545           example: __VNF-ID__
25546         - name: body
25547           in: body
25548           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVce.json)
25549           required: true
25550           schema:
25551             $ref: "#/definitions/vce"
25552     patch:
25553       tags:
25554         - Network
25555       summary: update an existing vce
25556       description: |
25557         Update an existing vce
25558         #
25559         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25560         The PUT operation will entirely replace an existing object.
25561         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25562         #
25563         Other differences between PUT and PATCH are:
25564         #
25565         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25566         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25567         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25568       operationId: UpdateNetworkVcesVce
25569       consumes:
25570         - application/json
25571         - application/xml
25572       produces:
25573         - application/json
25574         - application/xml
25575       responses:
25576         "default":
25577           description: Response codes found in [response codes](https://wiki.onap.org/).
25578       parameters:
25579         - name: vnf-id
25580           in: path
25581           description: Unique id of VNF.  This is unique across the graph.
25582           required: true
25583           type: string
25584           example: __VNF-ID__
25585         - name: body
25586           in: body
25587           description: vce object that needs to be updated.
25588           required: true
25589           schema:
25590             $ref: "#/patchDefinitions/vce"
25591     delete:
25592       tags:
25593         - Network
25594       summary: delete an existing vce
25595       description: delete an existing vce
25596       operationId: deleteNetworkVcesVce
25597       consumes:
25598         - application/json
25599         - application/xml
25600       produces:
25601         - application/json
25602         - application/xml
25603       responses:
25604         "default":
25605           description: Response codes found in [response codes](https://wiki.onap.org/).
25606       parameters:
25607         - name: vnf-id
25608           in: path
25609           description: Unique id of VNF.  This is unique across the graph.
25610           required: true
25611           type: string
25612           example: __VNF-ID__
25613         - name: resource-version
25614           in: query
25615           description: resource-version for concurrency
25616           required: true
25617           type: string
25618   /network/vces:
25619     get:
25620       tags:
25621         - Network
25622       summary: returns vces
25623       description: returns vces
25624       operationId: getNetworkVces
25625       produces:
25626         - application/json
25627         - application/xml
25628       responses:
25629         "200":
25630           description: successful operation
25631           schema:
25632               $ref: "#/getDefinitions/vces"
25633         "default":
25634           description: Response codes found in [response codes](https://wiki.onap.org/).
25635       parameters:
25636         - name: vnf-id
25637           in: query
25638           description:
25639           required: false
25640           type: string
25641         - name: vnf-name
25642           in: query
25643           description:
25644           required: false
25645           type: string
25646         - name: vnf-name2
25647           in: query
25648           description:
25649           required: false
25650           type: string
25651         - name: vnf-type
25652           in: query
25653           description:
25654           required: false
25655           type: string
25656         - name: service-id
25657           in: query
25658           description:
25659           required: false
25660           type: string
25661         - name: regional-resource-zone
25662           in: query
25663           description:
25664           required: false
25665           type: string
25666         - name: prov-status
25667           in: query
25668           description:
25669           required: false
25670           type: string
25671         - name: heat-stack-id
25672           in: query
25673           description:
25674           required: false
25675           type: string
25676         - name: vpe-id
25677           in: query
25678           description:
25679           required: false
25680           type: string
25681   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
25682     put:
25683       tags:
25684         - Network
25685       summary: see node definition for valid relationships
25686       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
25687       consumes:
25688         - application/json
25689         - application/xml
25690       produces:
25691         - application/json
25692         - application/xml
25693       responses:
25694         "default":
25695           description: Response codes found in [response codes](https://wiki.onap.org/).
25696       parameters:
25697         - name: vnfc-name
25698           in: path
25699           description: Unique ID of vnfc.
25700           required: true
25701           type: string
25702           example: __VNFC-NAME__
25703         - name: body
25704           in: body
25705           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)
25706           required: true
25707           schema:
25708             $ref: "#/definitions/relationship"
25709     delete:
25710       tags:
25711         - Network
25712       summary: delete an existing relationship
25713       description: delete an existing relationship
25714       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
25715       consumes:
25716         - application/json
25717         - application/xml
25718       produces:
25719         - application/json
25720         - application/xml
25721       responses:
25722         "default":
25723           description: Response codes found in [response codes](https://wiki.onap.org/).
25724       parameters:
25725         - name: vnfc-name
25726           in: path
25727           description: Unique ID of vnfc.
25728           required: true
25729           type: string
25730           example: __VNFC-NAME__
25731   /network/vnfcs/vnfc/{vnfc-name}:
25732     get:
25733       tags:
25734         - Network
25735       summary: returns vnfc
25736       description: returns vnfc
25737       operationId: getNetworkVnfcsVnfc
25738       produces:
25739         - application/json
25740         - application/xml
25741       responses:
25742         "200":
25743           description: successful operation
25744           schema:
25745               $ref: "#/getDefinitions/vnfc"
25746         "default":
25747           description: Response codes found in [response codes](https://wiki.onap.org/).
25748       parameters:
25749         - name: vnfc-name
25750           in: path
25751           description: Unique ID of vnfc.
25752           required: true
25753           type: string
25754           example: __VNFC-NAME__
25755     put:
25756       tags:
25757         - Network
25758       summary: create or update an existing vnfc
25759       description: |
25760         Create or update an existing vnfc.
25761         #
25762         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25763       operationId: createOrUpdateNetworkVnfcsVnfc
25764       consumes:
25765         - application/json
25766         - application/xml
25767       produces:
25768         - application/json
25769         - application/xml
25770       responses:
25771         "default":
25772           description: Response codes found in [response codes](https://wiki.onap.org/).
25773       parameters:
25774         - name: vnfc-name
25775           in: path
25776           description: Unique ID of vnfc.
25777           required: true
25778           type: string
25779           example: __VNFC-NAME__
25780         - name: body
25781           in: body
25782           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)
25783           required: true
25784           schema:
25785             $ref: "#/definitions/vnfc"
25786     patch:
25787       tags:
25788         - Network
25789       summary: update an existing vnfc
25790       description: |
25791         Update an existing vnfc
25792         #
25793         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25794         The PUT operation will entirely replace an existing object.
25795         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25796         #
25797         Other differences between PUT and PATCH are:
25798         #
25799         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25800         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25801         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25802       operationId: UpdateNetworkVnfcsVnfc
25803       consumes:
25804         - application/json
25805         - application/xml
25806       produces:
25807         - application/json
25808         - application/xml
25809       responses:
25810         "default":
25811           description: Response codes found in [response codes](https://wiki.onap.org/).
25812       parameters:
25813         - name: vnfc-name
25814           in: path
25815           description: Unique ID of vnfc.
25816           required: true
25817           type: string
25818           example: __VNFC-NAME__
25819         - name: body
25820           in: body
25821           description: vnfc object that needs to be updated.
25822           required: true
25823           schema:
25824             $ref: "#/patchDefinitions/vnfc"
25825     delete:
25826       tags:
25827         - Network
25828       summary: delete an existing vnfc
25829       description: delete an existing vnfc
25830       operationId: deleteNetworkVnfcsVnfc
25831       consumes:
25832         - application/json
25833         - application/xml
25834       produces:
25835         - application/json
25836         - application/xml
25837       responses:
25838         "default":
25839           description: Response codes found in [response codes](https://wiki.onap.org/).
25840       parameters:
25841         - name: vnfc-name
25842           in: path
25843           description: Unique ID of vnfc.
25844           required: true
25845           type: string
25846           example: __VNFC-NAME__
25847         - name: resource-version
25848           in: query
25849           description: resource-version for concurrency
25850           required: true
25851           type: string
25852   /network/vnfcs:
25853     get:
25854       tags:
25855         - Network
25856       summary: returns vnfcs
25857       description: returns vnfcs
25858       operationId: getNetworkVnfcs
25859       produces:
25860         - application/json
25861         - application/xml
25862       responses:
25863         "200":
25864           description: successful operation
25865           schema:
25866               $ref: "#/getDefinitions/vnfcs"
25867         "default":
25868           description: Response codes found in [response codes](https://wiki.onap.org/).
25869       parameters:
25870         - name: vnfc-name
25871           in: query
25872           description:
25873           required: false
25874           type: string
25875         - name: vnfc-function-code
25876           in: query
25877           description:
25878           required: false
25879           type: string
25880         - name: vnfc-type
25881           in: query
25882           description:
25883           required: false
25884           type: string
25885         - name: prov-status
25886           in: query
25887           description:
25888           required: false
25889           type: string
25890         - name: ipaddress-v4-oam-vip
25891           in: query
25892           description:
25893           required: false
25894           type: string
25895         - name: in-maint
25896           in: query
25897           description:
25898           required: false
25899           type: boolean
25900         - name: is-closed-loop-disabled
25901           in: query
25902           description:
25903           required: false
25904           type: boolean
25905         - name: group-notation
25906           in: query
25907           description:
25908           required: false
25909           type: string
25910   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
25911     put:
25912       tags:
25913         - Network
25914       summary: see node definition for valid relationships
25915       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
25916       consumes:
25917         - application/json
25918         - application/xml
25919       produces:
25920         - application/json
25921         - application/xml
25922       responses:
25923         "default":
25924           description: Response codes found in [response codes](https://wiki.onap.org/).
25925       parameters:
25926         - name: network-id
25927           in: path
25928           description: Network ID, should be uuid. Unique across A&AI.
25929           required: true
25930           type: string
25931           example: __NETWORK-ID__
25932         - name: subnet-id
25933           in: path
25934           description: Subnet ID, should be UUID.
25935           required: true
25936           type: string
25937           example: __SUBNET-ID__
25938         - name: body
25939           in: body
25940           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
25941           required: true
25942           schema:
25943             $ref: "#/definitions/relationship"
25944     delete:
25945       tags:
25946         - Network
25947       summary: delete an existing relationship
25948       description: delete an existing relationship
25949       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
25950       consumes:
25951         - application/json
25952         - application/xml
25953       produces:
25954         - application/json
25955         - application/xml
25956       responses:
25957         "default":
25958           description: Response codes found in [response codes](https://wiki.onap.org/).
25959       parameters:
25960         - name: network-id
25961           in: path
25962           description: Network ID, should be uuid. Unique across A&AI.
25963           required: true
25964           type: string
25965           example: __NETWORK-ID__
25966         - name: subnet-id
25967           in: path
25968           description: Subnet ID, should be UUID.
25969           required: true
25970           type: string
25971           example: __SUBNET-ID__
25972   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
25973     get:
25974       tags:
25975         - Network
25976       summary: returns subnet
25977       description: returns subnet
25978       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
25979       produces:
25980         - application/json
25981         - application/xml
25982       responses:
25983         "200":
25984           description: successful operation
25985           schema:
25986               $ref: "#/getDefinitions/subnet"
25987         "default":
25988           description: Response codes found in [response codes](https://wiki.onap.org/).
25989       parameters:
25990         - name: network-id
25991           in: path
25992           description: Network ID, should be uuid. Unique across A&AI.
25993           required: true
25994           type: string
25995           example: __NETWORK-ID__
25996         - name: subnet-id
25997           in: path
25998           description: Subnet ID, should be UUID.
25999           required: true
26000           type: string
26001           example: __SUBNET-ID__
26002     put:
26003       tags:
26004         - Network
26005       summary: create or update an existing subnet
26006       description: |
26007         Create or update an existing subnet.
26008         #
26009         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26010       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26011       consumes:
26012         - application/json
26013         - application/xml
26014       produces:
26015         - application/json
26016         - application/xml
26017       responses:
26018         "default":
26019           description: Response codes found in [response codes](https://wiki.onap.org/).
26020       parameters:
26021         - name: network-id
26022           in: path
26023           description: Network ID, should be uuid. Unique across A&AI.
26024           required: true
26025           type: string
26026           example: __NETWORK-ID__
26027         - name: subnet-id
26028           in: path
26029           description: Subnet ID, should be UUID.
26030           required: true
26031           type: string
26032           example: __SUBNET-ID__
26033         - name: body
26034           in: body
26035           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26036           required: true
26037           schema:
26038             $ref: "#/definitions/subnet"
26039     patch:
26040       tags:
26041         - Network
26042       summary: update an existing subnet
26043       description: |
26044         Update an existing subnet
26045         #
26046         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26047         The PUT operation will entirely replace an existing object.
26048         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26049         #
26050         Other differences between PUT and PATCH are:
26051         #
26052         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26053         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26054         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26055       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26056       consumes:
26057         - application/json
26058         - application/xml
26059       produces:
26060         - application/json
26061         - application/xml
26062       responses:
26063         "default":
26064           description: Response codes found in [response codes](https://wiki.onap.org/).
26065       parameters:
26066         - name: network-id
26067           in: path
26068           description: Network ID, should be uuid. Unique across A&AI.
26069           required: true
26070           type: string
26071           example: __NETWORK-ID__
26072         - name: subnet-id
26073           in: path
26074           description: Subnet ID, should be UUID.
26075           required: true
26076           type: string
26077           example: __SUBNET-ID__
26078         - name: body
26079           in: body
26080           description: subnet object that needs to be updated.
26081           required: true
26082           schema:
26083             $ref: "#/patchDefinitions/subnet"
26084     delete:
26085       tags:
26086         - Network
26087       summary: delete an existing subnet
26088       description: delete an existing subnet
26089       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
26090       consumes:
26091         - application/json
26092         - application/xml
26093       produces:
26094         - application/json
26095         - application/xml
26096       responses:
26097         "default":
26098           description: Response codes found in [response codes](https://wiki.onap.org/).
26099       parameters:
26100         - name: network-id
26101           in: path
26102           description: Network ID, should be uuid. Unique across A&AI.
26103           required: true
26104           type: string
26105           example: __NETWORK-ID__
26106         - name: subnet-id
26107           in: path
26108           description: Subnet ID, should be UUID.
26109           required: true
26110           type: string
26111           example: __SUBNET-ID__
26112         - name: resource-version
26113           in: query
26114           description: resource-version for concurrency
26115           required: true
26116           type: string
26117   /network/l3-networks/l3-network/{network-id}/subnets:
26118     get:
26119       tags:
26120         - Network
26121       summary: returns subnets
26122       description: returns subnets
26123       operationId: getNetworkL3NetworksL3NetworkSubnets
26124       produces:
26125         - application/json
26126         - application/xml
26127       responses:
26128         "200":
26129           description: successful operation
26130           schema:
26131               $ref: "#/getDefinitions/subnets"
26132         "default":
26133           description: Response codes found in [response codes](https://wiki.onap.org/).
26134       parameters:
26135         - name: network-id
26136           in: path
26137           description: Network ID, should be uuid. Unique across A&AI.
26138           required: true
26139           type: string
26140           example: __NETWORK-ID__
26141         - name: subnet-id
26142           in: query
26143           description:
26144           required: false
26145           type: string
26146         - name: subnet-name
26147           in: query
26148           description:
26149           required: false
26150           type: string
26151   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
26152     put:
26153       tags:
26154         - Network
26155       summary: see node definition for valid relationships
26156       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26157       consumes:
26158         - application/json
26159         - application/xml
26160       produces:
26161         - application/json
26162         - application/xml
26163       responses:
26164         "default":
26165           description: Response codes found in [response codes](https://wiki.onap.org/).
26166       parameters:
26167         - name: network-id
26168           in: path
26169           description: Network ID, should be uuid. Unique across A&AI.
26170           required: true
26171           type: string
26172           example: __NETWORK-ID__
26173         - name: vlan-id-inner
26174           in: path
26175           description: id.
26176           required: true
26177           type: integer
26178           format: int64
26179           example: __VLAN-ID-INNER__
26180         - name: body
26181           in: body
26182           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26183           required: true
26184           schema:
26185             $ref: "#/definitions/relationship"
26186     delete:
26187       tags:
26188         - Network
26189       summary: delete an existing relationship
26190       description: delete an existing relationship
26191       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26192       consumes:
26193         - application/json
26194         - application/xml
26195       produces:
26196         - application/json
26197         - application/xml
26198       responses:
26199         "default":
26200           description: Response codes found in [response codes](https://wiki.onap.org/).
26201       parameters:
26202         - name: network-id
26203           in: path
26204           description: Network ID, should be uuid. Unique across A&AI.
26205           required: true
26206           type: string
26207           example: __NETWORK-ID__
26208         - name: vlan-id-inner
26209           in: path
26210           description: id.
26211           required: true
26212           type: integer
26213           format: int64
26214           example: __VLAN-ID-INNER__
26215   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
26216     get:
26217       tags:
26218         - Network
26219       summary: returns ctag-assignment
26220       description: returns ctag-assignment
26221       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26222       produces:
26223         - application/json
26224         - application/xml
26225       responses:
26226         "200":
26227           description: successful operation
26228           schema:
26229               $ref: "#/getDefinitions/ctag-assignment"
26230         "default":
26231           description: Response codes found in [response codes](https://wiki.onap.org/).
26232       parameters:
26233         - name: network-id
26234           in: path
26235           description: Network ID, should be uuid. Unique across A&AI.
26236           required: true
26237           type: string
26238           example: __NETWORK-ID__
26239         - name: vlan-id-inner
26240           in: path
26241           description: id.
26242           required: true
26243           type: integer
26244           format: int64
26245           example: __VLAN-ID-INNER__
26246     put:
26247       tags:
26248         - Network
26249       summary: create or update an existing ctag-assignment
26250       description: |
26251         Create or update an existing ctag-assignment.
26252         #
26253         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26254       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26255       consumes:
26256         - application/json
26257         - application/xml
26258       produces:
26259         - application/json
26260         - application/xml
26261       responses:
26262         "default":
26263           description: Response codes found in [response codes](https://wiki.onap.org/).
26264       parameters:
26265         - name: network-id
26266           in: path
26267           description: Network ID, should be uuid. Unique across A&AI.
26268           required: true
26269           type: string
26270           example: __NETWORK-ID__
26271         - name: vlan-id-inner
26272           in: path
26273           description: id.
26274           required: true
26275           type: integer
26276           format: int64
26277           example: __VLAN-ID-INNER__
26278         - name: body
26279           in: body
26280           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26281           required: true
26282           schema:
26283             $ref: "#/definitions/ctag-assignment"
26284     patch:
26285       tags:
26286         - Network
26287       summary: update an existing ctag-assignment
26288       description: |
26289         Update an existing ctag-assignment
26290         #
26291         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26292         The PUT operation will entirely replace an existing object.
26293         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26294         #
26295         Other differences between PUT and PATCH are:
26296         #
26297         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26298         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26299         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26300       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26301       consumes:
26302         - application/json
26303         - application/xml
26304       produces:
26305         - application/json
26306         - application/xml
26307       responses:
26308         "default":
26309           description: Response codes found in [response codes](https://wiki.onap.org/).
26310       parameters:
26311         - name: network-id
26312           in: path
26313           description: Network ID, should be uuid. Unique across A&AI.
26314           required: true
26315           type: string
26316           example: __NETWORK-ID__
26317         - name: vlan-id-inner
26318           in: path
26319           description: id.
26320           required: true
26321           type: integer
26322           format: int64
26323           example: __VLAN-ID-INNER__
26324         - name: body
26325           in: body
26326           description: ctag-assignment object that needs to be updated.
26327           required: true
26328           schema:
26329             $ref: "#/patchDefinitions/ctag-assignment"
26330     delete:
26331       tags:
26332         - Network
26333       summary: delete an existing ctag-assignment
26334       description: delete an existing ctag-assignment
26335       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26336       consumes:
26337         - application/json
26338         - application/xml
26339       produces:
26340         - application/json
26341         - application/xml
26342       responses:
26343         "default":
26344           description: Response codes found in [response codes](https://wiki.onap.org/).
26345       parameters:
26346         - name: network-id
26347           in: path
26348           description: Network ID, should be uuid. Unique across A&AI.
26349           required: true
26350           type: string
26351           example: __NETWORK-ID__
26352         - name: vlan-id-inner
26353           in: path
26354           description: id.
26355           required: true
26356           type: integer
26357           format: int64
26358           example: __VLAN-ID-INNER__
26359         - name: resource-version
26360           in: query
26361           description: resource-version for concurrency
26362           required: true
26363           type: string
26364   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
26365     get:
26366       tags:
26367         - Network
26368       summary: returns ctag-assignments
26369       description: returns ctag-assignments
26370       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
26371       produces:
26372         - application/json
26373         - application/xml
26374       responses:
26375         "200":
26376           description: successful operation
26377           schema:
26378               $ref: "#/getDefinitions/ctag-assignments"
26379         "default":
26380           description: Response codes found in [response codes](https://wiki.onap.org/).
26381       parameters:
26382         - name: network-id
26383           in: path
26384           description: Network ID, should be uuid. Unique across A&AI.
26385           required: true
26386           type: string
26387           example: __NETWORK-ID__
26388         - name: vlan-id-inner
26389           in: query
26390           description:
26391           required: false
26392           type: integer
26393           format: int64
26394   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
26395     put:
26396       tags:
26397         - Network
26398       summary: see node definition for valid relationships
26399       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
26400       consumes:
26401         - application/json
26402         - application/xml
26403       produces:
26404         - application/json
26405         - application/xml
26406       responses:
26407         "default":
26408           description: Response codes found in [response codes](https://wiki.onap.org/).
26409       parameters:
26410         - name: network-id
26411           in: path
26412           description: Network ID, should be uuid. Unique across A&AI.
26413           required: true
26414           type: string
26415           example: __NETWORK-ID__
26416         - name: segmentation-id
26417           in: path
26418           description: Route Table Reference id, UUID assigned to this instance.
26419           required: true
26420           type: string
26421           example: __SEGMENTATION-ID__
26422         - name: body
26423           in: body
26424           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
26425           required: true
26426           schema:
26427             $ref: "#/definitions/relationship"
26428     delete:
26429       tags:
26430         - Network
26431       summary: delete an existing relationship
26432       description: delete an existing relationship
26433       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
26434       consumes:
26435         - application/json
26436         - application/xml
26437       produces:
26438         - application/json
26439         - application/xml
26440       responses:
26441         "default":
26442           description: Response codes found in [response codes](https://wiki.onap.org/).
26443       parameters:
26444         - name: network-id
26445           in: path
26446           description: Network ID, should be uuid. Unique across A&AI.
26447           required: true
26448           type: string
26449           example: __NETWORK-ID__
26450         - name: segmentation-id
26451           in: path
26452           description: Route Table Reference id, UUID assigned to this instance.
26453           required: true
26454           type: string
26455           example: __SEGMENTATION-ID__
26456   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
26457     get:
26458       tags:
26459         - Network
26460       summary: returns segmentation-assignment
26461       description: returns segmentation-assignment
26462       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26463       produces:
26464         - application/json
26465         - application/xml
26466       responses:
26467         "200":
26468           description: successful operation
26469           schema:
26470               $ref: "#/getDefinitions/segmentation-assignment"
26471         "default":
26472           description: Response codes found in [response codes](https://wiki.onap.org/).
26473       parameters:
26474         - name: network-id
26475           in: path
26476           description: Network ID, should be uuid. Unique across A&AI.
26477           required: true
26478           type: string
26479           example: __NETWORK-ID__
26480         - name: segmentation-id
26481           in: path
26482           description: Route Table Reference id, UUID assigned to this instance.
26483           required: true
26484           type: string
26485           example: __SEGMENTATION-ID__
26486     put:
26487       tags:
26488         - Network
26489       summary: create or update an existing segmentation-assignment
26490       description: |
26491         Create or update an existing segmentation-assignment.
26492         #
26493         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26494       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26495       consumes:
26496         - application/json
26497         - application/xml
26498       produces:
26499         - application/json
26500         - application/xml
26501       responses:
26502         "default":
26503           description: Response codes found in [response codes](https://wiki.onap.org/).
26504       parameters:
26505         - name: network-id
26506           in: path
26507           description: Network ID, should be uuid. Unique across A&AI.
26508           required: true
26509           type: string
26510           example: __NETWORK-ID__
26511         - name: segmentation-id
26512           in: path
26513           description: Route Table Reference id, UUID assigned to this instance.
26514           required: true
26515           type: string
26516           example: __SEGMENTATION-ID__
26517         - name: body
26518           in: body
26519           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
26520           required: true
26521           schema:
26522             $ref: "#/definitions/segmentation-assignment"
26523     patch:
26524       tags:
26525         - Network
26526       summary: update an existing segmentation-assignment
26527       description: |
26528         Update an existing segmentation-assignment
26529         #
26530         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26531         The PUT operation will entirely replace an existing object.
26532         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26533         #
26534         Other differences between PUT and PATCH are:
26535         #
26536         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26537         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26538         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26539       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26540       consumes:
26541         - application/json
26542         - application/xml
26543       produces:
26544         - application/json
26545         - application/xml
26546       responses:
26547         "default":
26548           description: Response codes found in [response codes](https://wiki.onap.org/).
26549       parameters:
26550         - name: network-id
26551           in: path
26552           description: Network ID, should be uuid. Unique across A&AI.
26553           required: true
26554           type: string
26555           example: __NETWORK-ID__
26556         - name: segmentation-id
26557           in: path
26558           description: Route Table Reference id, UUID assigned to this instance.
26559           required: true
26560           type: string
26561           example: __SEGMENTATION-ID__
26562         - name: body
26563           in: body
26564           description: segmentation-assignment object that needs to be updated.
26565           required: true
26566           schema:
26567             $ref: "#/patchDefinitions/segmentation-assignment"
26568     delete:
26569       tags:
26570         - Network
26571       summary: delete an existing segmentation-assignment
26572       description: delete an existing segmentation-assignment
26573       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26574       consumes:
26575         - application/json
26576         - application/xml
26577       produces:
26578         - application/json
26579         - application/xml
26580       responses:
26581         "default":
26582           description: Response codes found in [response codes](https://wiki.onap.org/).
26583       parameters:
26584         - name: network-id
26585           in: path
26586           description: Network ID, should be uuid. Unique across A&AI.
26587           required: true
26588           type: string
26589           example: __NETWORK-ID__
26590         - name: segmentation-id
26591           in: path
26592           description: Route Table Reference id, UUID assigned to this instance.
26593           required: true
26594           type: string
26595           example: __SEGMENTATION-ID__
26596         - name: resource-version
26597           in: query
26598           description: resource-version for concurrency
26599           required: true
26600           type: string
26601   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
26602     get:
26603       tags:
26604         - Network
26605       summary: returns segmentation-assignments
26606       description: returns segmentation-assignments
26607       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
26608       produces:
26609         - application/json
26610         - application/xml
26611       responses:
26612         "200":
26613           description: successful operation
26614           schema:
26615               $ref: "#/getDefinitions/segmentation-assignments"
26616         "default":
26617           description: Response codes found in [response codes](https://wiki.onap.org/).
26618       parameters:
26619         - name: network-id
26620           in: path
26621           description: Network ID, should be uuid. Unique across A&AI.
26622           required: true
26623           type: string
26624           example: __NETWORK-ID__
26625         - name: segmentation-id
26626           in: query
26627           description:
26628           required: false
26629           type: string
26630   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
26631     put:
26632       tags:
26633         - Network
26634       summary: see node definition for valid relationships
26635       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
26636       consumes:
26637         - application/json
26638         - application/xml
26639       produces:
26640         - application/json
26641         - application/xml
26642       responses:
26643         "default":
26644           description: Response codes found in [response codes](https://wiki.onap.org/).
26645       parameters:
26646         - name: network-id
26647           in: path
26648           description: Network ID, should be uuid. Unique across A&AI.
26649           required: true
26650           type: string
26651           example: __NETWORK-ID__
26652         - name: body
26653           in: body
26654           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)
26655           required: true
26656           schema:
26657             $ref: "#/definitions/relationship"
26658     delete:
26659       tags:
26660         - Network
26661       summary: delete an existing relationship
26662       description: delete an existing relationship
26663       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
26664       consumes:
26665         - application/json
26666         - application/xml
26667       produces:
26668         - application/json
26669         - application/xml
26670       responses:
26671         "default":
26672           description: Response codes found in [response codes](https://wiki.onap.org/).
26673       parameters:
26674         - name: network-id
26675           in: path
26676           description: Network ID, should be uuid. Unique across A&AI.
26677           required: true
26678           type: string
26679           example: __NETWORK-ID__
26680   /network/l3-networks/l3-network/{network-id}:
26681     get:
26682       tags:
26683         - Network
26684       summary: returns l3-network
26685       description: returns l3-network
26686       operationId: getNetworkL3NetworksL3Network
26687       produces:
26688         - application/json
26689         - application/xml
26690       responses:
26691         "200":
26692           description: successful operation
26693           schema:
26694               $ref: "#/getDefinitions/l3-network"
26695         "default":
26696           description: Response codes found in [response codes](https://wiki.onap.org/).
26697       parameters:
26698         - name: network-id
26699           in: path
26700           description: Network ID, should be uuid. Unique across A&AI.
26701           required: true
26702           type: string
26703           example: __NETWORK-ID__
26704     put:
26705       tags:
26706         - Network
26707       summary: create or update an existing l3-network
26708       description: |
26709         Create or update an existing l3-network.
26710         #
26711         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26712       operationId: createOrUpdateNetworkL3NetworksL3Network
26713       consumes:
26714         - application/json
26715         - application/xml
26716       produces:
26717         - application/json
26718         - application/xml
26719       responses:
26720         "default":
26721           description: Response codes found in [response codes](https://wiki.onap.org/).
26722       parameters:
26723         - name: network-id
26724           in: path
26725           description: Network ID, should be uuid. Unique across A&AI.
26726           required: true
26727           type: string
26728           example: __NETWORK-ID__
26729         - name: body
26730           in: body
26731           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)
26732           required: true
26733           schema:
26734             $ref: "#/definitions/l3-network"
26735     patch:
26736       tags:
26737         - Network
26738       summary: update an existing l3-network
26739       description: |
26740         Update an existing l3-network
26741         #
26742         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26743         The PUT operation will entirely replace an existing object.
26744         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26745         #
26746         Other differences between PUT and PATCH are:
26747         #
26748         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26749         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26750         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26751       operationId: UpdateNetworkL3NetworksL3Network
26752       consumes:
26753         - application/json
26754         - application/xml
26755       produces:
26756         - application/json
26757         - application/xml
26758       responses:
26759         "default":
26760           description: Response codes found in [response codes](https://wiki.onap.org/).
26761       parameters:
26762         - name: network-id
26763           in: path
26764           description: Network ID, should be uuid. Unique across A&AI.
26765           required: true
26766           type: string
26767           example: __NETWORK-ID__
26768         - name: body
26769           in: body
26770           description: l3-network object that needs to be updated.
26771           required: true
26772           schema:
26773             $ref: "#/patchDefinitions/l3-network"
26774     delete:
26775       tags:
26776         - Network
26777       summary: delete an existing l3-network
26778       description: delete an existing l3-network
26779       operationId: deleteNetworkL3NetworksL3Network
26780       consumes:
26781         - application/json
26782         - application/xml
26783       produces:
26784         - application/json
26785         - application/xml
26786       responses:
26787         "default":
26788           description: Response codes found in [response codes](https://wiki.onap.org/).
26789       parameters:
26790         - name: network-id
26791           in: path
26792           description: Network ID, should be uuid. Unique across A&AI.
26793           required: true
26794           type: string
26795           example: __NETWORK-ID__
26796         - name: resource-version
26797           in: query
26798           description: resource-version for concurrency
26799           required: true
26800           type: string
26801   /network/l3-networks:
26802     get:
26803       tags:
26804         - Network
26805       summary: returns l3-networks
26806       description: returns l3-networks
26807       operationId: getNetworkL3Networks
26808       produces:
26809         - application/json
26810         - application/xml
26811       responses:
26812         "200":
26813           description: successful operation
26814           schema:
26815               $ref: "#/getDefinitions/l3-networks"
26816         "default":
26817           description: Response codes found in [response codes](https://wiki.onap.org/).
26818       parameters:
26819         - name: network-id
26820           in: query
26821           description:
26822           required: false
26823           type: string
26824         - name: network-name
26825           in: query
26826           description:
26827           required: false
26828           type: string
26829         - name: network-role
26830           in: query
26831           description:
26832           required: false
26833           type: string
26834         - name: service-id
26835           in: query
26836           description:
26837           required: false
26838           type: string
26839         - name: heat-stack-id
26840           in: query
26841           description:
26842           required: false
26843           type: string
26844         - name: contrail-network-fqdn
26845           in: query
26846           description:
26847           required: false
26848           type: string
26849         - name: persona-model-id
26850           in: query
26851           description:
26852           required: false
26853           type: string
26854         - name: persona-model-version
26855           in: query
26856           description:
26857           required: false
26858           type: string
26859         - name: widget-model-id
26860           in: query
26861           description:
26862           required: false
26863           type: string
26864         - name: widget-model-version
26865           in: query
26866           description:
26867           required: false
26868           type: string
26869   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
26870     put:
26871       tags:
26872         - Network
26873       summary: see node definition for valid relationships
26874       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
26875       consumes:
26876         - application/json
26877         - application/xml
26878       produces:
26879         - application/json
26880         - application/xml
26881       responses:
26882         "default":
26883           description: Response codes found in [response codes](https://wiki.onap.org/).
26884       parameters:
26885         - name: network-policy-id
26886           in: path
26887           description: UUID representing unique key to this instance
26888           required: true
26889           type: string
26890           example: __NETWORK-POLICY-ID__
26891         - name: body
26892           in: body
26893           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)
26894           required: true
26895           schema:
26896             $ref: "#/definitions/relationship"
26897     delete:
26898       tags:
26899         - Network
26900       summary: delete an existing relationship
26901       description: delete an existing relationship
26902       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
26903       consumes:
26904         - application/json
26905         - application/xml
26906       produces:
26907         - application/json
26908         - application/xml
26909       responses:
26910         "default":
26911           description: Response codes found in [response codes](https://wiki.onap.org/).
26912       parameters:
26913         - name: network-policy-id
26914           in: path
26915           description: UUID representing unique key to this instance
26916           required: true
26917           type: string
26918           example: __NETWORK-POLICY-ID__
26919   /network/network-policies/network-policy/{network-policy-id}:
26920     get:
26921       tags:
26922         - Network
26923       summary: returns network-policy
26924       description: returns network-policy
26925       operationId: getNetworkNetworkPoliciesNetworkPolicy
26926       produces:
26927         - application/json
26928         - application/xml
26929       responses:
26930         "200":
26931           description: successful operation
26932           schema:
26933               $ref: "#/getDefinitions/network-policy"
26934         "default":
26935           description: Response codes found in [response codes](https://wiki.onap.org/).
26936       parameters:
26937         - name: network-policy-id
26938           in: path
26939           description: UUID representing unique key to this instance
26940           required: true
26941           type: string
26942           example: __NETWORK-POLICY-ID__
26943     put:
26944       tags:
26945         - Network
26946       summary: create or update an existing network-policy
26947       description: |
26948         Create or update an existing network-policy.
26949         #
26950         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26951       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
26952       consumes:
26953         - application/json
26954         - application/xml
26955       produces:
26956         - application/json
26957         - application/xml
26958       responses:
26959         "default":
26960           description: Response codes found in [response codes](https://wiki.onap.org/).
26961       parameters:
26962         - name: network-policy-id
26963           in: path
26964           description: UUID representing unique key to this instance
26965           required: true
26966           type: string
26967           example: __NETWORK-POLICY-ID__
26968         - name: body
26969           in: body
26970           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)
26971           required: true
26972           schema:
26973             $ref: "#/definitions/network-policy"
26974     patch:
26975       tags:
26976         - Network
26977       summary: update an existing network-policy
26978       description: |
26979         Update an existing network-policy
26980         #
26981         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26982         The PUT operation will entirely replace an existing object.
26983         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26984         #
26985         Other differences between PUT and PATCH are:
26986         #
26987         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26988         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26989         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26990       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
26991       consumes:
26992         - application/json
26993         - application/xml
26994       produces:
26995         - application/json
26996         - application/xml
26997       responses:
26998         "default":
26999           description: Response codes found in [response codes](https://wiki.onap.org/).
27000       parameters:
27001         - name: network-policy-id
27002           in: path
27003           description: UUID representing unique key to this instance
27004           required: true
27005           type: string
27006           example: __NETWORK-POLICY-ID__
27007         - name: body
27008           in: body
27009           description: network-policy object that needs to be updated.
27010           required: true
27011           schema:
27012             $ref: "#/patchDefinitions/network-policy"
27013     delete:
27014       tags:
27015         - Network
27016       summary: delete an existing network-policy
27017       description: delete an existing network-policy
27018       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
27019       consumes:
27020         - application/json
27021         - application/xml
27022       produces:
27023         - application/json
27024         - application/xml
27025       responses:
27026         "default":
27027           description: Response codes found in [response codes](https://wiki.onap.org/).
27028       parameters:
27029         - name: network-policy-id
27030           in: path
27031           description: UUID representing unique key to this instance
27032           required: true
27033           type: string
27034           example: __NETWORK-POLICY-ID__
27035         - name: resource-version
27036           in: query
27037           description: resource-version for concurrency
27038           required: true
27039           type: string
27040   /network/network-policies:
27041     get:
27042       tags:
27043         - Network
27044       summary: returns network-policies
27045       description: returns network-policies
27046       operationId: getNetworkNetworkPolicies
27047       produces:
27048         - application/json
27049         - application/xml
27050       responses:
27051         "200":
27052           description: successful operation
27053           schema:
27054               $ref: "#/getDefinitions/network-policies"
27055         "default":
27056           description: Response codes found in [response codes](https://wiki.onap.org/).
27057       parameters:
27058         - name: network-policy-id
27059           in: query
27060           description:
27061           required: false
27062           type: string
27063         - name: network-policy-fqdn
27064           in: query
27065           description:
27066           required: false
27067           type: string
27068   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
27069     put:
27070       tags:
27071         - Network
27072       summary: see node definition for valid relationships
27073       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
27074       consumes:
27075         - application/json
27076         - application/xml
27077       produces:
27078         - application/json
27079         - application/xml
27080       responses:
27081         "default":
27082           description: Response codes found in [response codes](https://wiki.onap.org/).
27083       parameters:
27084         - name: vnf-id
27085           in: path
27086           description: Unique id of VNF.  This is unique across the graph.
27087           required: true
27088           type: string
27089           example: __VNF-ID__
27090         - name: body
27091           in: body
27092           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)
27093           required: true
27094           schema:
27095             $ref: "#/definitions/relationship"
27096     delete:
27097       tags:
27098         - Network
27099       summary: delete an existing relationship
27100       description: delete an existing relationship
27101       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
27102       consumes:
27103         - application/json
27104         - application/xml
27105       produces:
27106         - application/json
27107         - application/xml
27108       responses:
27109         "default":
27110           description: Response codes found in [response codes](https://wiki.onap.org/).
27111       parameters:
27112         - name: vnf-id
27113           in: path
27114           description: Unique id of VNF.  This is unique across the graph.
27115           required: true
27116           type: string
27117           example: __VNF-ID__
27118   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
27119     put:
27120       tags:
27121         - Network
27122       summary: see node definition for valid relationships
27123       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27124       consumes:
27125         - application/json
27126         - application/xml
27127       produces:
27128         - application/json
27129         - application/xml
27130       responses:
27131         "default":
27132           description: Response codes found in [response codes](https://wiki.onap.org/).
27133       parameters:
27134         - name: vnf-id
27135           in: path
27136           description: Unique id of VNF.  This is unique across the graph.
27137           required: true
27138           type: string
27139           example: __VNF-ID__
27140         - name: interface-name
27141           in: path
27142           description: Name given to the interface
27143           required: true
27144           type: string
27145           example: __INTERFACE-NAME__
27146         - name: vlan-interface
27147           in: path
27148           description: String that identifies the interface
27149           required: true
27150           type: string
27151           example: __VLAN-INTERFACE__
27152         - name: body
27153           in: body
27154           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
27155           required: true
27156           schema:
27157             $ref: "#/definitions/relationship"
27158     delete:
27159       tags:
27160         - Network
27161       summary: delete an existing relationship
27162       description: delete an existing relationship
27163       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27164       consumes:
27165         - application/json
27166         - application/xml
27167       produces:
27168         - application/json
27169         - application/xml
27170       responses:
27171         "default":
27172           description: Response codes found in [response codes](https://wiki.onap.org/).
27173       parameters:
27174         - name: vnf-id
27175           in: path
27176           description: Unique id of VNF.  This is unique across the graph.
27177           required: true
27178           type: string
27179           example: __VNF-ID__
27180         - name: interface-name
27181           in: path
27182           description: Name given to the interface
27183           required: true
27184           type: string
27185           example: __INTERFACE-NAME__
27186         - name: vlan-interface
27187           in: path
27188           description: String that identifies the interface
27189           required: true
27190           type: string
27191           example: __VLAN-INTERFACE__
27192   /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:
27193     put:
27194       tags:
27195         - Network
27196       summary: see node definition for valid relationships
27197       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27198       consumes:
27199         - application/json
27200         - application/xml
27201       produces:
27202         - application/json
27203         - application/xml
27204       responses:
27205         "default":
27206           description: Response codes found in [response codes](https://wiki.onap.org/).
27207       parameters:
27208         - name: vnf-id
27209           in: path
27210           description: Unique id of VNF.  This is unique across the graph.
27211           required: true
27212           type: string
27213           example: __VNF-ID__
27214         - name: interface-name
27215           in: path
27216           description: Name given to the interface
27217           required: true
27218           type: string
27219           example: __INTERFACE-NAME__
27220         - name: vlan-interface
27221           in: path
27222           description: String that identifies the interface
27223           required: true
27224           type: string
27225           example: __VLAN-INTERFACE__
27226         - name: l3-interface-ipv4-address
27227           in: path
27228           description: IP address
27229           required: true
27230           type: string
27231           example: __L3-INTERFACE-IPV4-ADDRESS__
27232         - name: body
27233           in: body
27234           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27235           required: true
27236           schema:
27237             $ref: "#/definitions/relationship"
27238     delete:
27239       tags:
27240         - Network
27241       summary: delete an existing relationship
27242       description: delete an existing relationship
27243       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27244       consumes:
27245         - application/json
27246         - application/xml
27247       produces:
27248         - application/json
27249         - application/xml
27250       responses:
27251         "default":
27252           description: Response codes found in [response codes](https://wiki.onap.org/).
27253       parameters:
27254         - name: vnf-id
27255           in: path
27256           description: Unique id of VNF.  This is unique across the graph.
27257           required: true
27258           type: string
27259           example: __VNF-ID__
27260         - name: interface-name
27261           in: path
27262           description: Name given to the interface
27263           required: true
27264           type: string
27265           example: __INTERFACE-NAME__
27266         - name: vlan-interface
27267           in: path
27268           description: String that identifies the interface
27269           required: true
27270           type: string
27271           example: __VLAN-INTERFACE__
27272         - name: l3-interface-ipv4-address
27273           in: path
27274           description: IP address
27275           required: true
27276           type: string
27277           example: __L3-INTERFACE-IPV4-ADDRESS__
27278   /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}:
27279     get:
27280       tags:
27281         - Network
27282       summary: returns l3-interface-ipv4-address-list
27283       description: returns l3-interface-ipv4-address-list
27284       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27285       produces:
27286         - application/json
27287         - application/xml
27288       responses:
27289         "200":
27290           description: successful operation
27291           schema:
27292               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27293         "default":
27294           description: Response codes found in [response codes](https://wiki.onap.org/).
27295       parameters:
27296         - name: vnf-id
27297           in: path
27298           description: Unique id of VNF.  This is unique across the graph.
27299           required: true
27300           type: string
27301           example: __VNF-ID__
27302         - name: interface-name
27303           in: path
27304           description: Name given to the interface
27305           required: true
27306           type: string
27307           example: __INTERFACE-NAME__
27308         - name: vlan-interface
27309           in: path
27310           description: String that identifies the interface
27311           required: true
27312           type: string
27313           example: __VLAN-INTERFACE__
27314         - name: l3-interface-ipv4-address
27315           in: path
27316           description: IP address
27317           required: true
27318           type: string
27319           example: __L3-INTERFACE-IPV4-ADDRESS__
27320     put:
27321       tags:
27322         - Network
27323       summary: create or update an existing l3-interface-ipv4-address-list
27324       description: |
27325         Create or update an existing l3-interface-ipv4-address-list.
27326         #
27327         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27328       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27329       consumes:
27330         - application/json
27331         - application/xml
27332       produces:
27333         - application/json
27334         - application/xml
27335       responses:
27336         "default":
27337           description: Response codes found in [response codes](https://wiki.onap.org/).
27338       parameters:
27339         - name: vnf-id
27340           in: path
27341           description: Unique id of VNF.  This is unique across the graph.
27342           required: true
27343           type: string
27344           example: __VNF-ID__
27345         - name: interface-name
27346           in: path
27347           description: Name given to the interface
27348           required: true
27349           type: string
27350           example: __INTERFACE-NAME__
27351         - name: vlan-interface
27352           in: path
27353           description: String that identifies the interface
27354           required: true
27355           type: string
27356           example: __VLAN-INTERFACE__
27357         - name: l3-interface-ipv4-address
27358           in: path
27359           description: IP address
27360           required: true
27361           type: string
27362           example: __L3-INTERFACE-IPV4-ADDRESS__
27363         - name: body
27364           in: body
27365           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27366           required: true
27367           schema:
27368             $ref: "#/definitions/l3-interface-ipv4-address-list"
27369     patch:
27370       tags:
27371         - Network
27372       summary: update an existing l3-interface-ipv4-address-list
27373       description: |
27374         Update an existing l3-interface-ipv4-address-list
27375         #
27376         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27377         The PUT operation will entirely replace an existing object.
27378         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27379         #
27380         Other differences between PUT and PATCH are:
27381         #
27382         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27383         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27384         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27385       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27386       consumes:
27387         - application/json
27388         - application/xml
27389       produces:
27390         - application/json
27391         - application/xml
27392       responses:
27393         "default":
27394           description: Response codes found in [response codes](https://wiki.onap.org/).
27395       parameters:
27396         - name: vnf-id
27397           in: path
27398           description: Unique id of VNF.  This is unique across the graph.
27399           required: true
27400           type: string
27401           example: __VNF-ID__
27402         - name: interface-name
27403           in: path
27404           description: Name given to the interface
27405           required: true
27406           type: string
27407           example: __INTERFACE-NAME__
27408         - name: vlan-interface
27409           in: path
27410           description: String that identifies the interface
27411           required: true
27412           type: string
27413           example: __VLAN-INTERFACE__
27414         - name: l3-interface-ipv4-address
27415           in: path
27416           description: IP address
27417           required: true
27418           type: string
27419           example: __L3-INTERFACE-IPV4-ADDRESS__
27420         - name: body
27421           in: body
27422           description: l3-interface-ipv4-address-list object that needs to be updated.
27423           required: true
27424           schema:
27425             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27426     delete:
27427       tags:
27428         - Network
27429       summary: delete an existing l3-interface-ipv4-address-list
27430       description: delete an existing l3-interface-ipv4-address-list
27431       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27432       consumes:
27433         - application/json
27434         - application/xml
27435       produces:
27436         - application/json
27437         - application/xml
27438       responses:
27439         "default":
27440           description: Response codes found in [response codes](https://wiki.onap.org/).
27441       parameters:
27442         - name: vnf-id
27443           in: path
27444           description: Unique id of VNF.  This is unique across the graph.
27445           required: true
27446           type: string
27447           example: __VNF-ID__
27448         - name: interface-name
27449           in: path
27450           description: Name given to the interface
27451           required: true
27452           type: string
27453           example: __INTERFACE-NAME__
27454         - name: vlan-interface
27455           in: path
27456           description: String that identifies the interface
27457           required: true
27458           type: string
27459           example: __VLAN-INTERFACE__
27460         - name: l3-interface-ipv4-address
27461           in: path
27462           description: IP address
27463           required: true
27464           type: string
27465           example: __L3-INTERFACE-IPV4-ADDRESS__
27466         - name: resource-version
27467           in: query
27468           description: resource-version for concurrency
27469           required: true
27470           type: string
27471   /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:
27472     put:
27473       tags:
27474         - Network
27475       summary: see node definition for valid relationships
27476       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27477       consumes:
27478         - application/json
27479         - application/xml
27480       produces:
27481         - application/json
27482         - application/xml
27483       responses:
27484         "default":
27485           description: Response codes found in [response codes](https://wiki.onap.org/).
27486       parameters:
27487         - name: vnf-id
27488           in: path
27489           description: Unique id of VNF.  This is unique across the graph.
27490           required: true
27491           type: string
27492           example: __VNF-ID__
27493         - name: interface-name
27494           in: path
27495           description: Name given to the interface
27496           required: true
27497           type: string
27498           example: __INTERFACE-NAME__
27499         - name: vlan-interface
27500           in: path
27501           description: String that identifies the interface
27502           required: true
27503           type: string
27504           example: __VLAN-INTERFACE__
27505         - name: l3-interface-ipv6-address
27506           in: path
27507           description: IP address
27508           required: true
27509           type: string
27510           example: __L3-INTERFACE-IPV6-ADDRESS__
27511         - name: body
27512           in: body
27513           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27514           required: true
27515           schema:
27516             $ref: "#/definitions/relationship"
27517     delete:
27518       tags:
27519         - Network
27520       summary: delete an existing relationship
27521       description: delete an existing relationship
27522       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27523       consumes:
27524         - application/json
27525         - application/xml
27526       produces:
27527         - application/json
27528         - application/xml
27529       responses:
27530         "default":
27531           description: Response codes found in [response codes](https://wiki.onap.org/).
27532       parameters:
27533         - name: vnf-id
27534           in: path
27535           description: Unique id of VNF.  This is unique across the graph.
27536           required: true
27537           type: string
27538           example: __VNF-ID__
27539         - name: interface-name
27540           in: path
27541           description: Name given to the interface
27542           required: true
27543           type: string
27544           example: __INTERFACE-NAME__
27545         - name: vlan-interface
27546           in: path
27547           description: String that identifies the interface
27548           required: true
27549           type: string
27550           example: __VLAN-INTERFACE__
27551         - name: l3-interface-ipv6-address
27552           in: path
27553           description: IP address
27554           required: true
27555           type: string
27556           example: __L3-INTERFACE-IPV6-ADDRESS__
27557   /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}:
27558     get:
27559       tags:
27560         - Network
27561       summary: returns l3-interface-ipv6-address-list
27562       description: returns l3-interface-ipv6-address-list
27563       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27564       produces:
27565         - application/json
27566         - application/xml
27567       responses:
27568         "200":
27569           description: successful operation
27570           schema:
27571               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27572         "default":
27573           description: Response codes found in [response codes](https://wiki.onap.org/).
27574       parameters:
27575         - name: vnf-id
27576           in: path
27577           description: Unique id of VNF.  This is unique across the graph.
27578           required: true
27579           type: string
27580           example: __VNF-ID__
27581         - name: interface-name
27582           in: path
27583           description: Name given to the interface
27584           required: true
27585           type: string
27586           example: __INTERFACE-NAME__
27587         - name: vlan-interface
27588           in: path
27589           description: String that identifies the interface
27590           required: true
27591           type: string
27592           example: __VLAN-INTERFACE__
27593         - name: l3-interface-ipv6-address
27594           in: path
27595           description: IP address
27596           required: true
27597           type: string
27598           example: __L3-INTERFACE-IPV6-ADDRESS__
27599     put:
27600       tags:
27601         - Network
27602       summary: create or update an existing l3-interface-ipv6-address-list
27603       description: |
27604         Create or update an existing l3-interface-ipv6-address-list.
27605         #
27606         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27607       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27608       consumes:
27609         - application/json
27610         - application/xml
27611       produces:
27612         - application/json
27613         - application/xml
27614       responses:
27615         "default":
27616           description: Response codes found in [response codes](https://wiki.onap.org/).
27617       parameters:
27618         - name: vnf-id
27619           in: path
27620           description: Unique id of VNF.  This is unique across the graph.
27621           required: true
27622           type: string
27623           example: __VNF-ID__
27624         - name: interface-name
27625           in: path
27626           description: Name given to the interface
27627           required: true
27628           type: string
27629           example: __INTERFACE-NAME__
27630         - name: vlan-interface
27631           in: path
27632           description: String that identifies the interface
27633           required: true
27634           type: string
27635           example: __VLAN-INTERFACE__
27636         - name: l3-interface-ipv6-address
27637           in: path
27638           description: IP address
27639           required: true
27640           type: string
27641           example: __L3-INTERFACE-IPV6-ADDRESS__
27642         - name: body
27643           in: body
27644           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27645           required: true
27646           schema:
27647             $ref: "#/definitions/l3-interface-ipv6-address-list"
27648     patch:
27649       tags:
27650         - Network
27651       summary: update an existing l3-interface-ipv6-address-list
27652       description: |
27653         Update an existing l3-interface-ipv6-address-list
27654         #
27655         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27656         The PUT operation will entirely replace an existing object.
27657         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27658         #
27659         Other differences between PUT and PATCH are:
27660         #
27661         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27662         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27663         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27664       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27665       consumes:
27666         - application/json
27667         - application/xml
27668       produces:
27669         - application/json
27670         - application/xml
27671       responses:
27672         "default":
27673           description: Response codes found in [response codes](https://wiki.onap.org/).
27674       parameters:
27675         - name: vnf-id
27676           in: path
27677           description: Unique id of VNF.  This is unique across the graph.
27678           required: true
27679           type: string
27680           example: __VNF-ID__
27681         - name: interface-name
27682           in: path
27683           description: Name given to the interface
27684           required: true
27685           type: string
27686           example: __INTERFACE-NAME__
27687         - name: vlan-interface
27688           in: path
27689           description: String that identifies the interface
27690           required: true
27691           type: string
27692           example: __VLAN-INTERFACE__
27693         - name: l3-interface-ipv6-address
27694           in: path
27695           description: IP address
27696           required: true
27697           type: string
27698           example: __L3-INTERFACE-IPV6-ADDRESS__
27699         - name: body
27700           in: body
27701           description: l3-interface-ipv6-address-list object that needs to be updated.
27702           required: true
27703           schema:
27704             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27705     delete:
27706       tags:
27707         - Network
27708       summary: delete an existing l3-interface-ipv6-address-list
27709       description: delete an existing l3-interface-ipv6-address-list
27710       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27711       consumes:
27712         - application/json
27713         - application/xml
27714       produces:
27715         - application/json
27716         - application/xml
27717       responses:
27718         "default":
27719           description: Response codes found in [response codes](https://wiki.onap.org/).
27720       parameters:
27721         - name: vnf-id
27722           in: path
27723           description: Unique id of VNF.  This is unique across the graph.
27724           required: true
27725           type: string
27726           example: __VNF-ID__
27727         - name: interface-name
27728           in: path
27729           description: Name given to the interface
27730           required: true
27731           type: string
27732           example: __INTERFACE-NAME__
27733         - name: vlan-interface
27734           in: path
27735           description: String that identifies the interface
27736           required: true
27737           type: string
27738           example: __VLAN-INTERFACE__
27739         - name: l3-interface-ipv6-address
27740           in: path
27741           description: IP address
27742           required: true
27743           type: string
27744           example: __L3-INTERFACE-IPV6-ADDRESS__
27745         - name: resource-version
27746           in: query
27747           description: resource-version for concurrency
27748           required: true
27749           type: string
27750   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
27751     get:
27752       tags:
27753         - Network
27754       summary: returns vlan
27755       description: returns vlan
27756       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
27757       produces:
27758         - application/json
27759         - application/xml
27760       responses:
27761         "200":
27762           description: successful operation
27763           schema:
27764               $ref: "#/getDefinitions/vlan"
27765         "default":
27766           description: Response codes found in [response codes](https://wiki.onap.org/).
27767       parameters:
27768         - name: vnf-id
27769           in: path
27770           description: Unique id of VNF.  This is unique across the graph.
27771           required: true
27772           type: string
27773           example: __VNF-ID__
27774         - name: interface-name
27775           in: path
27776           description: Name given to the interface
27777           required: true
27778           type: string
27779           example: __INTERFACE-NAME__
27780         - name: vlan-interface
27781           in: path
27782           description: String that identifies the interface
27783           required: true
27784           type: string
27785           example: __VLAN-INTERFACE__
27786     put:
27787       tags:
27788         - Network
27789       summary: create or update an existing vlan
27790       description: |
27791         Create or update an existing vlan.
27792         #
27793         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27794       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
27795       consumes:
27796         - application/json
27797         - application/xml
27798       produces:
27799         - application/json
27800         - application/xml
27801       responses:
27802         "default":
27803           description: Response codes found in [response codes](https://wiki.onap.org/).
27804       parameters:
27805         - name: vnf-id
27806           in: path
27807           description: Unique id of VNF.  This is unique across the graph.
27808           required: true
27809           type: string
27810           example: __VNF-ID__
27811         - name: interface-name
27812           in: path
27813           description: Name given to the interface
27814           required: true
27815           type: string
27816           example: __INTERFACE-NAME__
27817         - name: vlan-interface
27818           in: path
27819           description: String that identifies the interface
27820           required: true
27821           type: string
27822           example: __VLAN-INTERFACE__
27823         - name: body
27824           in: body
27825           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
27826           required: true
27827           schema:
27828             $ref: "#/definitions/vlan"
27829     patch:
27830       tags:
27831         - Network
27832       summary: update an existing vlan
27833       description: |
27834         Update an existing vlan
27835         #
27836         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27837         The PUT operation will entirely replace an existing object.
27838         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27839         #
27840         Other differences between PUT and PATCH are:
27841         #
27842         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27843         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27844         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27845       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
27846       consumes:
27847         - application/json
27848         - application/xml
27849       produces:
27850         - application/json
27851         - application/xml
27852       responses:
27853         "default":
27854           description: Response codes found in [response codes](https://wiki.onap.org/).
27855       parameters:
27856         - name: vnf-id
27857           in: path
27858           description: Unique id of VNF.  This is unique across the graph.
27859           required: true
27860           type: string
27861           example: __VNF-ID__
27862         - name: interface-name
27863           in: path
27864           description: Name given to the interface
27865           required: true
27866           type: string
27867           example: __INTERFACE-NAME__
27868         - name: vlan-interface
27869           in: path
27870           description: String that identifies the interface
27871           required: true
27872           type: string
27873           example: __VLAN-INTERFACE__
27874         - name: body
27875           in: body
27876           description: vlan object that needs to be updated.
27877           required: true
27878           schema:
27879             $ref: "#/patchDefinitions/vlan"
27880     delete:
27881       tags:
27882         - Network
27883       summary: delete an existing vlan
27884       description: delete an existing vlan
27885       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
27886       consumes:
27887         - application/json
27888         - application/xml
27889       produces:
27890         - application/json
27891         - application/xml
27892       responses:
27893         "default":
27894           description: Response codes found in [response codes](https://wiki.onap.org/).
27895       parameters:
27896         - name: vnf-id
27897           in: path
27898           description: Unique id of VNF.  This is unique across the graph.
27899           required: true
27900           type: string
27901           example: __VNF-ID__
27902         - name: interface-name
27903           in: path
27904           description: Name given to the interface
27905           required: true
27906           type: string
27907           example: __INTERFACE-NAME__
27908         - name: vlan-interface
27909           in: path
27910           description: String that identifies the interface
27911           required: true
27912           type: string
27913           example: __VLAN-INTERFACE__
27914         - name: resource-version
27915           in: query
27916           description: resource-version for concurrency
27917           required: true
27918           type: string
27919   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
27920     get:
27921       tags:
27922         - Network
27923       summary: returns vlans
27924       description: returns vlans
27925       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
27926       produces:
27927         - application/json
27928         - application/xml
27929       responses:
27930         "200":
27931           description: successful operation
27932           schema:
27933               $ref: "#/getDefinitions/vlans"
27934         "default":
27935           description: Response codes found in [response codes](https://wiki.onap.org/).
27936       parameters:
27937         - name: vnf-id
27938           in: path
27939           description: Unique id of VNF.  This is unique across the graph.
27940           required: true
27941           type: string
27942           example: __VNF-ID__
27943         - name: interface-name
27944           in: path
27945           description: Name given to the interface
27946           required: true
27947           type: string
27948           example: __INTERFACE-NAME__
27949         - name: vlan-interface
27950           in: query
27951           description:
27952           required: false
27953           type: string
27954         - name: vlan-id-inner
27955           in: query
27956           description:
27957           required: false
27958           type: integer
27959           format: int64
27960         - name: vpn-id
27961           in: query
27962           description:
27963           required: false
27964           type: string
27965   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
27966     put:
27967       tags:
27968         - Network
27969       summary: see node definition for valid relationships
27970       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
27971       consumes:
27972         - application/json
27973         - application/xml
27974       produces:
27975         - application/json
27976         - application/xml
27977       responses:
27978         "default":
27979           description: Response codes found in [response codes](https://wiki.onap.org/).
27980       parameters:
27981         - name: vnf-id
27982           in: path
27983           description: Unique id of VNF.  This is unique across the graph.
27984           required: true
27985           type: string
27986           example: __VNF-ID__
27987         - name: interface-name
27988           in: path
27989           description: Name given to the interface
27990           required: true
27991           type: string
27992           example: __INTERFACE-NAME__
27993         - name: pci-id
27994           in: path
27995           description: PCI ID used to identify the sriov-vf
27996           required: true
27997           type: string
27998           example: __PCI-ID__
27999         - name: body
28000           in: body
28001           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
28002           required: true
28003           schema:
28004             $ref: "#/definitions/relationship"
28005     delete:
28006       tags:
28007         - Network
28008       summary: delete an existing relationship
28009       description: delete an existing relationship
28010       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28011       consumes:
28012         - application/json
28013         - application/xml
28014       produces:
28015         - application/json
28016         - application/xml
28017       responses:
28018         "default":
28019           description: Response codes found in [response codes](https://wiki.onap.org/).
28020       parameters:
28021         - name: vnf-id
28022           in: path
28023           description: Unique id of VNF.  This is unique across the graph.
28024           required: true
28025           type: string
28026           example: __VNF-ID__
28027         - name: interface-name
28028           in: path
28029           description: Name given to the interface
28030           required: true
28031           type: string
28032           example: __INTERFACE-NAME__
28033         - name: pci-id
28034           in: path
28035           description: PCI ID used to identify the sriov-vf
28036           required: true
28037           type: string
28038           example: __PCI-ID__
28039   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
28040     get:
28041       tags:
28042         - Network
28043       summary: returns sriov-vf
28044       description: returns sriov-vf
28045       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28046       produces:
28047         - application/json
28048         - application/xml
28049       responses:
28050         "200":
28051           description: successful operation
28052           schema:
28053               $ref: "#/getDefinitions/sriov-vf"
28054         "default":
28055           description: Response codes found in [response codes](https://wiki.onap.org/).
28056       parameters:
28057         - name: vnf-id
28058           in: path
28059           description: Unique id of VNF.  This is unique across the graph.
28060           required: true
28061           type: string
28062           example: __VNF-ID__
28063         - name: interface-name
28064           in: path
28065           description: Name given to the interface
28066           required: true
28067           type: string
28068           example: __INTERFACE-NAME__
28069         - name: pci-id
28070           in: path
28071           description: PCI ID used to identify the sriov-vf
28072           required: true
28073           type: string
28074           example: __PCI-ID__
28075     put:
28076       tags:
28077         - Network
28078       summary: create or update an existing sriov-vf
28079       description: |
28080         Create or update an existing sriov-vf.
28081         #
28082         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28083       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28084       consumes:
28085         - application/json
28086         - application/xml
28087       produces:
28088         - application/json
28089         - application/xml
28090       responses:
28091         "default":
28092           description: Response codes found in [response codes](https://wiki.onap.org/).
28093       parameters:
28094         - name: vnf-id
28095           in: path
28096           description: Unique id of VNF.  This is unique across the graph.
28097           required: true
28098           type: string
28099           example: __VNF-ID__
28100         - name: interface-name
28101           in: path
28102           description: Name given to the interface
28103           required: true
28104           type: string
28105           example: __INTERFACE-NAME__
28106         - name: pci-id
28107           in: path
28108           description: PCI ID used to identify the sriov-vf
28109           required: true
28110           type: string
28111           example: __PCI-ID__
28112         - name: body
28113           in: body
28114           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
28115           required: true
28116           schema:
28117             $ref: "#/definitions/sriov-vf"
28118     patch:
28119       tags:
28120         - Network
28121       summary: update an existing sriov-vf
28122       description: |
28123         Update an existing sriov-vf
28124         #
28125         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28126         The PUT operation will entirely replace an existing object.
28127         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28128         #
28129         Other differences between PUT and PATCH are:
28130         #
28131         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28132         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28133         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28134       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28135       consumes:
28136         - application/json
28137         - application/xml
28138       produces:
28139         - application/json
28140         - application/xml
28141       responses:
28142         "default":
28143           description: Response codes found in [response codes](https://wiki.onap.org/).
28144       parameters:
28145         - name: vnf-id
28146           in: path
28147           description: Unique id of VNF.  This is unique across the graph.
28148           required: true
28149           type: string
28150           example: __VNF-ID__
28151         - name: interface-name
28152           in: path
28153           description: Name given to the interface
28154           required: true
28155           type: string
28156           example: __INTERFACE-NAME__
28157         - name: pci-id
28158           in: path
28159           description: PCI ID used to identify the sriov-vf
28160           required: true
28161           type: string
28162           example: __PCI-ID__
28163         - name: body
28164           in: body
28165           description: sriov-vf object that needs to be updated.
28166           required: true
28167           schema:
28168             $ref: "#/patchDefinitions/sriov-vf"
28169     delete:
28170       tags:
28171         - Network
28172       summary: delete an existing sriov-vf
28173       description: delete an existing sriov-vf
28174       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28175       consumes:
28176         - application/json
28177         - application/xml
28178       produces:
28179         - application/json
28180         - application/xml
28181       responses:
28182         "default":
28183           description: Response codes found in [response codes](https://wiki.onap.org/).
28184       parameters:
28185         - name: vnf-id
28186           in: path
28187           description: Unique id of VNF.  This is unique across the graph.
28188           required: true
28189           type: string
28190           example: __VNF-ID__
28191         - name: interface-name
28192           in: path
28193           description: Name given to the interface
28194           required: true
28195           type: string
28196           example: __INTERFACE-NAME__
28197         - name: pci-id
28198           in: path
28199           description: PCI ID used to identify the sriov-vf
28200           required: true
28201           type: string
28202           example: __PCI-ID__
28203         - name: resource-version
28204           in: query
28205           description: resource-version for concurrency
28206           required: true
28207           type: string
28208   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28209     get:
28210       tags:
28211         - Network
28212       summary: returns sriov-vfs
28213       description: returns sriov-vfs
28214       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
28215       produces:
28216         - application/json
28217         - application/xml
28218       responses:
28219         "200":
28220           description: successful operation
28221           schema:
28222               $ref: "#/getDefinitions/sriov-vfs"
28223         "default":
28224           description: Response codes found in [response codes](https://wiki.onap.org/).
28225       parameters:
28226         - name: vnf-id
28227           in: path
28228           description: Unique id of VNF.  This is unique across the graph.
28229           required: true
28230           type: string
28231           example: __VNF-ID__
28232         - name: interface-name
28233           in: path
28234           description: Name given to the interface
28235           required: true
28236           type: string
28237           example: __INTERFACE-NAME__
28238         - name: pci-id
28239           in: query
28240           description:
28241           required: false
28242           type: string
28243         - name: vf-vlan-filter
28244           in: query
28245           description:
28246           required: false
28247           type: string
28248         - name: vf-mac-filter
28249           in: query
28250           description:
28251           required: false
28252           type: string
28253         - name: vf-vlan-strip
28254           in: query
28255           description:
28256           required: false
28257           type: boolean
28258         - name: neutron-network-id
28259           in: query
28260           description:
28261           required: false
28262           type: string
28263   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28264     put:
28265       tags:
28266         - Network
28267       summary: see node definition for valid relationships
28268       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
28269       consumes:
28270         - application/json
28271         - application/xml
28272       produces:
28273         - application/json
28274         - application/xml
28275       responses:
28276         "default":
28277           description: Response codes found in [response codes](https://wiki.onap.org/).
28278       parameters:
28279         - name: vnf-id
28280           in: path
28281           description: Unique id of VNF.  This is unique across the graph.
28282           required: true
28283           type: string
28284           example: __VNF-ID__
28285         - name: interface-name
28286           in: path
28287           description: Name given to the interface
28288           required: true
28289           type: string
28290           example: __INTERFACE-NAME__
28291         - name: body
28292           in: body
28293           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
28294           required: true
28295           schema:
28296             $ref: "#/definitions/relationship"
28297     delete:
28298       tags:
28299         - Network
28300       summary: delete an existing relationship
28301       description: delete an existing relationship
28302       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
28303       consumes:
28304         - application/json
28305         - application/xml
28306       produces:
28307         - application/json
28308         - application/xml
28309       responses:
28310         "default":
28311           description: Response codes found in [response codes](https://wiki.onap.org/).
28312       parameters:
28313         - name: vnf-id
28314           in: path
28315           description: Unique id of VNF.  This is unique across the graph.
28316           required: true
28317           type: string
28318           example: __VNF-ID__
28319         - name: interface-name
28320           in: path
28321           description: Name given to the interface
28322           required: true
28323           type: string
28324           example: __INTERFACE-NAME__
28325   /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:
28326     put:
28327       tags:
28328         - Network
28329       summary: see node definition for valid relationships
28330       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28331       consumes:
28332         - application/json
28333         - application/xml
28334       produces:
28335         - application/json
28336         - application/xml
28337       responses:
28338         "default":
28339           description: Response codes found in [response codes](https://wiki.onap.org/).
28340       parameters:
28341         - name: vnf-id
28342           in: path
28343           description: Unique id of VNF.  This is unique across the graph.
28344           required: true
28345           type: string
28346           example: __VNF-ID__
28347         - name: interface-name
28348           in: path
28349           description: Name given to the interface
28350           required: true
28351           type: string
28352           example: __INTERFACE-NAME__
28353         - name: l3-interface-ipv4-address
28354           in: path
28355           description: IP address
28356           required: true
28357           type: string
28358           example: __L3-INTERFACE-IPV4-ADDRESS__
28359         - name: body
28360           in: body
28361           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28362           required: true
28363           schema:
28364             $ref: "#/definitions/relationship"
28365     delete:
28366       tags:
28367         - Network
28368       summary: delete an existing relationship
28369       description: delete an existing relationship
28370       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28371       consumes:
28372         - application/json
28373         - application/xml
28374       produces:
28375         - application/json
28376         - application/xml
28377       responses:
28378         "default":
28379           description: Response codes found in [response codes](https://wiki.onap.org/).
28380       parameters:
28381         - name: vnf-id
28382           in: path
28383           description: Unique id of VNF.  This is unique across the graph.
28384           required: true
28385           type: string
28386           example: __VNF-ID__
28387         - name: interface-name
28388           in: path
28389           description: Name given to the interface
28390           required: true
28391           type: string
28392           example: __INTERFACE-NAME__
28393         - name: l3-interface-ipv4-address
28394           in: path
28395           description: IP address
28396           required: true
28397           type: string
28398           example: __L3-INTERFACE-IPV4-ADDRESS__
28399   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
28400     get:
28401       tags:
28402         - Network
28403       summary: returns l3-interface-ipv4-address-list
28404       description: returns l3-interface-ipv4-address-list
28405       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28406       produces:
28407         - application/json
28408         - application/xml
28409       responses:
28410         "200":
28411           description: successful operation
28412           schema:
28413               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28414         "default":
28415           description: Response codes found in [response codes](https://wiki.onap.org/).
28416       parameters:
28417         - name: vnf-id
28418           in: path
28419           description: Unique id of VNF.  This is unique across the graph.
28420           required: true
28421           type: string
28422           example: __VNF-ID__
28423         - name: interface-name
28424           in: path
28425           description: Name given to the interface
28426           required: true
28427           type: string
28428           example: __INTERFACE-NAME__
28429         - name: l3-interface-ipv4-address
28430           in: path
28431           description: IP address
28432           required: true
28433           type: string
28434           example: __L3-INTERFACE-IPV4-ADDRESS__
28435     put:
28436       tags:
28437         - Network
28438       summary: create or update an existing l3-interface-ipv4-address-list
28439       description: |
28440         Create or update an existing l3-interface-ipv4-address-list.
28441         #
28442         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28443       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28444       consumes:
28445         - application/json
28446         - application/xml
28447       produces:
28448         - application/json
28449         - application/xml
28450       responses:
28451         "default":
28452           description: Response codes found in [response codes](https://wiki.onap.org/).
28453       parameters:
28454         - name: vnf-id
28455           in: path
28456           description: Unique id of VNF.  This is unique across the graph.
28457           required: true
28458           type: string
28459           example: __VNF-ID__
28460         - name: interface-name
28461           in: path
28462           description: Name given to the interface
28463           required: true
28464           type: string
28465           example: __INTERFACE-NAME__
28466         - name: l3-interface-ipv4-address
28467           in: path
28468           description: IP address
28469           required: true
28470           type: string
28471           example: __L3-INTERFACE-IPV4-ADDRESS__
28472         - name: body
28473           in: body
28474           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28475           required: true
28476           schema:
28477             $ref: "#/definitions/l3-interface-ipv4-address-list"
28478     patch:
28479       tags:
28480         - Network
28481       summary: update an existing l3-interface-ipv4-address-list
28482       description: |
28483         Update an existing l3-interface-ipv4-address-list
28484         #
28485         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28486         The PUT operation will entirely replace an existing object.
28487         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28488         #
28489         Other differences between PUT and PATCH are:
28490         #
28491         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28492         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28493         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28494       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28495       consumes:
28496         - application/json
28497         - application/xml
28498       produces:
28499         - application/json
28500         - application/xml
28501       responses:
28502         "default":
28503           description: Response codes found in [response codes](https://wiki.onap.org/).
28504       parameters:
28505         - name: vnf-id
28506           in: path
28507           description: Unique id of VNF.  This is unique across the graph.
28508           required: true
28509           type: string
28510           example: __VNF-ID__
28511         - name: interface-name
28512           in: path
28513           description: Name given to the interface
28514           required: true
28515           type: string
28516           example: __INTERFACE-NAME__
28517         - name: l3-interface-ipv4-address
28518           in: path
28519           description: IP address
28520           required: true
28521           type: string
28522           example: __L3-INTERFACE-IPV4-ADDRESS__
28523         - name: body
28524           in: body
28525           description: l3-interface-ipv4-address-list object that needs to be updated.
28526           required: true
28527           schema:
28528             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28529     delete:
28530       tags:
28531         - Network
28532       summary: delete an existing l3-interface-ipv4-address-list
28533       description: delete an existing l3-interface-ipv4-address-list
28534       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28535       consumes:
28536         - application/json
28537         - application/xml
28538       produces:
28539         - application/json
28540         - application/xml
28541       responses:
28542         "default":
28543           description: Response codes found in [response codes](https://wiki.onap.org/).
28544       parameters:
28545         - name: vnf-id
28546           in: path
28547           description: Unique id of VNF.  This is unique across the graph.
28548           required: true
28549           type: string
28550           example: __VNF-ID__
28551         - name: interface-name
28552           in: path
28553           description: Name given to the interface
28554           required: true
28555           type: string
28556           example: __INTERFACE-NAME__
28557         - name: l3-interface-ipv4-address
28558           in: path
28559           description: IP address
28560           required: true
28561           type: string
28562           example: __L3-INTERFACE-IPV4-ADDRESS__
28563         - name: resource-version
28564           in: query
28565           description: resource-version for concurrency
28566           required: true
28567           type: string
28568   /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:
28569     put:
28570       tags:
28571         - Network
28572       summary: see node definition for valid relationships
28573       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28574       consumes:
28575         - application/json
28576         - application/xml
28577       produces:
28578         - application/json
28579         - application/xml
28580       responses:
28581         "default":
28582           description: Response codes found in [response codes](https://wiki.onap.org/).
28583       parameters:
28584         - name: vnf-id
28585           in: path
28586           description: Unique id of VNF.  This is unique across the graph.
28587           required: true
28588           type: string
28589           example: __VNF-ID__
28590         - name: interface-name
28591           in: path
28592           description: Name given to the interface
28593           required: true
28594           type: string
28595           example: __INTERFACE-NAME__
28596         - name: l3-interface-ipv6-address
28597           in: path
28598           description: IP address
28599           required: true
28600           type: string
28601           example: __L3-INTERFACE-IPV6-ADDRESS__
28602         - name: body
28603           in: body
28604           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28605           required: true
28606           schema:
28607             $ref: "#/definitions/relationship"
28608     delete:
28609       tags:
28610         - Network
28611       summary: delete an existing relationship
28612       description: delete an existing relationship
28613       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28614       consumes:
28615         - application/json
28616         - application/xml
28617       produces:
28618         - application/json
28619         - application/xml
28620       responses:
28621         "default":
28622           description: Response codes found in [response codes](https://wiki.onap.org/).
28623       parameters:
28624         - name: vnf-id
28625           in: path
28626           description: Unique id of VNF.  This is unique across the graph.
28627           required: true
28628           type: string
28629           example: __VNF-ID__
28630         - name: interface-name
28631           in: path
28632           description: Name given to the interface
28633           required: true
28634           type: string
28635           example: __INTERFACE-NAME__
28636         - name: l3-interface-ipv6-address
28637           in: path
28638           description: IP address
28639           required: true
28640           type: string
28641           example: __L3-INTERFACE-IPV6-ADDRESS__
28642   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
28643     get:
28644       tags:
28645         - Network
28646       summary: returns l3-interface-ipv6-address-list
28647       description: returns l3-interface-ipv6-address-list
28648       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28649       produces:
28650         - application/json
28651         - application/xml
28652       responses:
28653         "200":
28654           description: successful operation
28655           schema:
28656               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28657         "default":
28658           description: Response codes found in [response codes](https://wiki.onap.org/).
28659       parameters:
28660         - name: vnf-id
28661           in: path
28662           description: Unique id of VNF.  This is unique across the graph.
28663           required: true
28664           type: string
28665           example: __VNF-ID__
28666         - name: interface-name
28667           in: path
28668           description: Name given to the interface
28669           required: true
28670           type: string
28671           example: __INTERFACE-NAME__
28672         - name: l3-interface-ipv6-address
28673           in: path
28674           description: IP address
28675           required: true
28676           type: string
28677           example: __L3-INTERFACE-IPV6-ADDRESS__
28678     put:
28679       tags:
28680         - Network
28681       summary: create or update an existing l3-interface-ipv6-address-list
28682       description: |
28683         Create or update an existing l3-interface-ipv6-address-list.
28684         #
28685         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28686       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28687       consumes:
28688         - application/json
28689         - application/xml
28690       produces:
28691         - application/json
28692         - application/xml
28693       responses:
28694         "default":
28695           description: Response codes found in [response codes](https://wiki.onap.org/).
28696       parameters:
28697         - name: vnf-id
28698           in: path
28699           description: Unique id of VNF.  This is unique across the graph.
28700           required: true
28701           type: string
28702           example: __VNF-ID__
28703         - name: interface-name
28704           in: path
28705           description: Name given to the interface
28706           required: true
28707           type: string
28708           example: __INTERFACE-NAME__
28709         - name: l3-interface-ipv6-address
28710           in: path
28711           description: IP address
28712           required: true
28713           type: string
28714           example: __L3-INTERFACE-IPV6-ADDRESS__
28715         - name: body
28716           in: body
28717           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28718           required: true
28719           schema:
28720             $ref: "#/definitions/l3-interface-ipv6-address-list"
28721     patch:
28722       tags:
28723         - Network
28724       summary: update an existing l3-interface-ipv6-address-list
28725       description: |
28726         Update an existing l3-interface-ipv6-address-list
28727         #
28728         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28729         The PUT operation will entirely replace an existing object.
28730         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28731         #
28732         Other differences between PUT and PATCH are:
28733         #
28734         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28735         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28736         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28737       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28738       consumes:
28739         - application/json
28740         - application/xml
28741       produces:
28742         - application/json
28743         - application/xml
28744       responses:
28745         "default":
28746           description: Response codes found in [response codes](https://wiki.onap.org/).
28747       parameters:
28748         - name: vnf-id
28749           in: path
28750           description: Unique id of VNF.  This is unique across the graph.
28751           required: true
28752           type: string
28753           example: __VNF-ID__
28754         - name: interface-name
28755           in: path
28756           description: Name given to the interface
28757           required: true
28758           type: string
28759           example: __INTERFACE-NAME__
28760         - name: l3-interface-ipv6-address
28761           in: path
28762           description: IP address
28763           required: true
28764           type: string
28765           example: __L3-INTERFACE-IPV6-ADDRESS__
28766         - name: body
28767           in: body
28768           description: l3-interface-ipv6-address-list object that needs to be updated.
28769           required: true
28770           schema:
28771             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28772     delete:
28773       tags:
28774         - Network
28775       summary: delete an existing l3-interface-ipv6-address-list
28776       description: delete an existing l3-interface-ipv6-address-list
28777       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28778       consumes:
28779         - application/json
28780         - application/xml
28781       produces:
28782         - application/json
28783         - application/xml
28784       responses:
28785         "default":
28786           description: Response codes found in [response codes](https://wiki.onap.org/).
28787       parameters:
28788         - name: vnf-id
28789           in: path
28790           description: Unique id of VNF.  This is unique across the graph.
28791           required: true
28792           type: string
28793           example: __VNF-ID__
28794         - name: interface-name
28795           in: path
28796           description: Name given to the interface
28797           required: true
28798           type: string
28799           example: __INTERFACE-NAME__
28800         - name: l3-interface-ipv6-address
28801           in: path
28802           description: IP address
28803           required: true
28804           type: string
28805           example: __L3-INTERFACE-IPV6-ADDRESS__
28806         - name: resource-version
28807           in: query
28808           description: resource-version for concurrency
28809           required: true
28810           type: string
28811   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
28812     get:
28813       tags:
28814         - Network
28815       summary: returns l-interface
28816       description: returns l-interface
28817       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
28818       produces:
28819         - application/json
28820         - application/xml
28821       responses:
28822         "200":
28823           description: successful operation
28824           schema:
28825               $ref: "#/getDefinitions/l-interface"
28826         "default":
28827           description: Response codes found in [response codes](https://wiki.onap.org/).
28828       parameters:
28829         - name: vnf-id
28830           in: path
28831           description: Unique id of VNF.  This is unique across the graph.
28832           required: true
28833           type: string
28834           example: __VNF-ID__
28835         - name: interface-name
28836           in: path
28837           description: Name given to the interface
28838           required: true
28839           type: string
28840           example: __INTERFACE-NAME__
28841     put:
28842       tags:
28843         - Network
28844       summary: create or update an existing l-interface
28845       description: |
28846         Create or update an existing l-interface.
28847         #
28848         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28849       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
28850       consumes:
28851         - application/json
28852         - application/xml
28853       produces:
28854         - application/json
28855         - application/xml
28856       responses:
28857         "default":
28858           description: Response codes found in [response codes](https://wiki.onap.org/).
28859       parameters:
28860         - name: vnf-id
28861           in: path
28862           description: Unique id of VNF.  This is unique across the graph.
28863           required: true
28864           type: string
28865           example: __VNF-ID__
28866         - name: interface-name
28867           in: path
28868           description: Name given to the interface
28869           required: true
28870           type: string
28871           example: __INTERFACE-NAME__
28872         - name: body
28873           in: body
28874           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
28875           required: true
28876           schema:
28877             $ref: "#/definitions/l-interface"
28878     patch:
28879       tags:
28880         - Network
28881       summary: update an existing l-interface
28882       description: |
28883         Update an existing l-interface
28884         #
28885         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28886         The PUT operation will entirely replace an existing object.
28887         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28888         #
28889         Other differences between PUT and PATCH are:
28890         #
28891         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28892         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28893         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28894       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
28895       consumes:
28896         - application/json
28897         - application/xml
28898       produces:
28899         - application/json
28900         - application/xml
28901       responses:
28902         "default":
28903           description: Response codes found in [response codes](https://wiki.onap.org/).
28904       parameters:
28905         - name: vnf-id
28906           in: path
28907           description: Unique id of VNF.  This is unique across the graph.
28908           required: true
28909           type: string
28910           example: __VNF-ID__
28911         - name: interface-name
28912           in: path
28913           description: Name given to the interface
28914           required: true
28915           type: string
28916           example: __INTERFACE-NAME__
28917         - name: body
28918           in: body
28919           description: l-interface object that needs to be updated.
28920           required: true
28921           schema:
28922             $ref: "#/patchDefinitions/l-interface"
28923     delete:
28924       tags:
28925         - Network
28926       summary: delete an existing l-interface
28927       description: delete an existing l-interface
28928       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
28929       consumes:
28930         - application/json
28931         - application/xml
28932       produces:
28933         - application/json
28934         - application/xml
28935       responses:
28936         "default":
28937           description: Response codes found in [response codes](https://wiki.onap.org/).
28938       parameters:
28939         - name: vnf-id
28940           in: path
28941           description: Unique id of VNF.  This is unique across the graph.
28942           required: true
28943           type: string
28944           example: __VNF-ID__
28945         - name: interface-name
28946           in: path
28947           description: Name given to the interface
28948           required: true
28949           type: string
28950           example: __INTERFACE-NAME__
28951         - name: resource-version
28952           in: query
28953           description: resource-version for concurrency
28954           required: true
28955           type: string
28956   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
28957     get:
28958       tags:
28959         - Network
28960       summary: returns l-interfaces
28961       description: returns l-interfaces
28962       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
28963       produces:
28964         - application/json
28965         - application/xml
28966       responses:
28967         "200":
28968           description: successful operation
28969           schema:
28970               $ref: "#/getDefinitions/l-interfaces"
28971         "default":
28972           description: Response codes found in [response codes](https://wiki.onap.org/).
28973       parameters:
28974         - name: vnf-id
28975           in: path
28976           description: Unique id of VNF.  This is unique across the graph.
28977           required: true
28978           type: string
28979           example: __VNF-ID__
28980         - name: interface-name
28981           in: query
28982           description:
28983           required: false
28984           type: string
28985         - name: interface-id
28986           in: query
28987           description:
28988           required: false
28989           type: string
28990         - name: macaddr
28991           in: query
28992           description:
28993           required: false
28994           type: string
28995         - name: network-name
28996           in: query
28997           description:
28998           required: false
28999           type: string
29000   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
29001     put:
29002       tags:
29003         - Network
29004       summary: see node definition for valid relationships
29005       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
29006       consumes:
29007         - application/json
29008         - application/xml
29009       produces:
29010         - application/json
29011         - application/xml
29012       responses:
29013         "default":
29014           description: Response codes found in [response codes](https://wiki.onap.org/).
29015       parameters:
29016         - name: vnf-id
29017           in: path
29018           description: Unique id of VNF.  This is unique across the graph.
29019           required: true
29020           type: string
29021           example: __VNF-ID__
29022         - name: interface-name
29023           in: path
29024           description: Name that identifies the link aggregate interface
29025           required: true
29026           type: string
29027           example: __INTERFACE-NAME__
29028         - name: body
29029           in: body
29030           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
29031           required: true
29032           schema:
29033             $ref: "#/definitions/relationship"
29034     delete:
29035       tags:
29036         - Network
29037       summary: delete an existing relationship
29038       description: delete an existing relationship
29039       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
29040       consumes:
29041         - application/json
29042         - application/xml
29043       produces:
29044         - application/json
29045         - application/xml
29046       responses:
29047         "default":
29048           description: Response codes found in [response codes](https://wiki.onap.org/).
29049       parameters:
29050         - name: vnf-id
29051           in: path
29052           description: Unique id of VNF.  This is unique across the graph.
29053           required: true
29054           type: string
29055           example: __VNF-ID__
29056         - name: interface-name
29057           in: path
29058           description: Name that identifies the link aggregate interface
29059           required: true
29060           type: string
29061           example: __INTERFACE-NAME__
29062   /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:
29063     put:
29064       tags:
29065         - Network
29066       summary: see node definition for valid relationships
29067       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
29068       consumes:
29069         - application/json
29070         - application/xml
29071       produces:
29072         - application/json
29073         - application/xml
29074       responses:
29075         "default":
29076           description: Response codes found in [response codes](https://wiki.onap.org/).
29077       parameters:
29078         - name: vnf-id
29079           in: path
29080           description: Unique id of VNF.  This is unique across the graph.
29081           required: true
29082           type: string
29083           example: __VNF-ID__
29084         - name: interface-name
29085           in: path
29086           description: Name that identifies the link aggregate interface
29087           required: true
29088           type: string
29089           example: __INTERFACE-NAME__
29090         - name: interface-name
29091           in: path
29092           description: Name given to the interface
29093           required: true
29094           type: string
29095           example: __INTERFACE-NAME__
29096         - name: vlan-interface
29097           in: path
29098           description: String that identifies the interface
29099           required: true
29100           type: string
29101           example: __VLAN-INTERFACE__
29102         - name: body
29103           in: body
29104           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
29105           required: true
29106           schema:
29107             $ref: "#/definitions/relationship"
29108     delete:
29109       tags:
29110         - Network
29111       summary: delete an existing relationship
29112       description: delete an existing relationship
29113       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
29114       consumes:
29115         - application/json
29116         - application/xml
29117       produces:
29118         - application/json
29119         - application/xml
29120       responses:
29121         "default":
29122           description: Response codes found in [response codes](https://wiki.onap.org/).
29123       parameters:
29124         - name: vnf-id
29125           in: path
29126           description: Unique id of VNF.  This is unique across the graph.
29127           required: true
29128           type: string
29129           example: __VNF-ID__
29130         - name: interface-name
29131           in: path
29132           description: Name that identifies the link aggregate interface
29133           required: true
29134           type: string
29135           example: __INTERFACE-NAME__
29136         - name: interface-name
29137           in: path
29138           description: Name given to the interface
29139           required: true
29140           type: string
29141           example: __INTERFACE-NAME__
29142         - name: vlan-interface
29143           in: path
29144           description: String that identifies the interface
29145           required: true
29146           type: string
29147           example: __VLAN-INTERFACE__
29148   /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:
29149     put:
29150       tags:
29151         - Network
29152       summary: see node definition for valid relationships
29153       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
29154       consumes:
29155         - application/json
29156         - application/xml
29157       produces:
29158         - application/json
29159         - application/xml
29160       responses:
29161         "default":
29162           description: Response codes found in [response codes](https://wiki.onap.org/).
29163       parameters:
29164         - name: vnf-id
29165           in: path
29166           description: Unique id of VNF.  This is unique across the graph.
29167           required: true
29168           type: string
29169           example: __VNF-ID__
29170         - name: interface-name
29171           in: path
29172           description: Name that identifies the link aggregate interface
29173           required: true
29174           type: string
29175           example: __INTERFACE-NAME__
29176         - name: interface-name
29177           in: path
29178           description: Name given to the interface
29179           required: true
29180           type: string
29181           example: __INTERFACE-NAME__
29182         - name: vlan-interface
29183           in: path
29184           description: String that identifies the interface
29185           required: true
29186           type: string
29187           example: __VLAN-INTERFACE__
29188         - name: l3-interface-ipv4-address
29189           in: path
29190           description: IP address
29191           required: true
29192           type: string
29193           example: __L3-INTERFACE-IPV4-ADDRESS__
29194         - name: body
29195           in: body
29196           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
29197           required: true
29198           schema:
29199             $ref: "#/definitions/relationship"
29200     delete:
29201       tags:
29202         - Network
29203       summary: delete an existing relationship
29204       description: delete an existing relationship
29205       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
29206       consumes:
29207         - application/json
29208         - application/xml
29209       produces:
29210         - application/json
29211         - application/xml
29212       responses:
29213         "default":
29214           description: Response codes found in [response codes](https://wiki.onap.org/).
29215       parameters:
29216         - name: vnf-id
29217           in: path
29218           description: Unique id of VNF.  This is unique across the graph.
29219           required: true
29220           type: string
29221           example: __VNF-ID__
29222         - name: interface-name
29223           in: path
29224           description: Name that identifies the link aggregate interface
29225           required: true
29226           type: string
29227           example: __INTERFACE-NAME__
29228         - name: interface-name
29229           in: path
29230           description: Name given to the interface
29231           required: true
29232           type: string
29233           example: __INTERFACE-NAME__
29234         - name: vlan-interface
29235           in: path
29236           description: String that identifies the interface
29237           required: true
29238           type: string
29239           example: __VLAN-INTERFACE__
29240         - name: l3-interface-ipv4-address
29241           in: path
29242           description: IP address
29243           required: true
29244           type: string
29245           example: __L3-INTERFACE-IPV4-ADDRESS__
29246   /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}:
29247     get:
29248       tags:
29249         - Network
29250       summary: returns l3-interface-ipv4-address-list
29251       description: returns l3-interface-ipv4-address-list
29252       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29253       produces:
29254         - application/json
29255         - application/xml
29256       responses:
29257         "200":
29258           description: successful operation
29259           schema:
29260               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29261         "default":
29262           description: Response codes found in [response codes](https://wiki.onap.org/).
29263       parameters:
29264         - name: vnf-id
29265           in: path
29266           description: Unique id of VNF.  This is unique across the graph.
29267           required: true
29268           type: string
29269           example: __VNF-ID__
29270         - name: interface-name
29271           in: path
29272           description: Name that identifies the link aggregate interface
29273           required: true
29274           type: string
29275           example: __INTERFACE-NAME__
29276         - name: interface-name
29277           in: path
29278           description: Name given to the interface
29279           required: true
29280           type: string
29281           example: __INTERFACE-NAME__
29282         - name: vlan-interface
29283           in: path
29284           description: String that identifies the interface
29285           required: true
29286           type: string
29287           example: __VLAN-INTERFACE__
29288         - name: l3-interface-ipv4-address
29289           in: path
29290           description: IP address
29291           required: true
29292           type: string
29293           example: __L3-INTERFACE-IPV4-ADDRESS__
29294     put:
29295       tags:
29296         - Network
29297       summary: create or update an existing l3-interface-ipv4-address-list
29298       description: |
29299         Create or update an existing l3-interface-ipv4-address-list.
29300         #
29301         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29302       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29303       consumes:
29304         - application/json
29305         - application/xml
29306       produces:
29307         - application/json
29308         - application/xml
29309       responses:
29310         "default":
29311           description: Response codes found in [response codes](https://wiki.onap.org/).
29312       parameters:
29313         - name: vnf-id
29314           in: path
29315           description: Unique id of VNF.  This is unique across the graph.
29316           required: true
29317           type: string
29318           example: __VNF-ID__
29319         - name: interface-name
29320           in: path
29321           description: Name that identifies the link aggregate interface
29322           required: true
29323           type: string
29324           example: __INTERFACE-NAME__
29325         - name: interface-name
29326           in: path
29327           description: Name given to the interface
29328           required: true
29329           type: string
29330           example: __INTERFACE-NAME__
29331         - name: vlan-interface
29332           in: path
29333           description: String that identifies the interface
29334           required: true
29335           type: string
29336           example: __VLAN-INTERFACE__
29337         - name: l3-interface-ipv4-address
29338           in: path
29339           description: IP address
29340           required: true
29341           type: string
29342           example: __L3-INTERFACE-IPV4-ADDRESS__
29343         - name: body
29344           in: body
29345           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
29346           required: true
29347           schema:
29348             $ref: "#/definitions/l3-interface-ipv4-address-list"
29349     patch:
29350       tags:
29351         - Network
29352       summary: update an existing l3-interface-ipv4-address-list
29353       description: |
29354         Update an existing l3-interface-ipv4-address-list
29355         #
29356         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29357         The PUT operation will entirely replace an existing object.
29358         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29359         #
29360         Other differences between PUT and PATCH are:
29361         #
29362         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29363         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29364         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29365       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29366       consumes:
29367         - application/json
29368         - application/xml
29369       produces:
29370         - application/json
29371         - application/xml
29372       responses:
29373         "default":
29374           description: Response codes found in [response codes](https://wiki.onap.org/).
29375       parameters:
29376         - name: vnf-id
29377           in: path
29378           description: Unique id of VNF.  This is unique across the graph.
29379           required: true
29380           type: string
29381           example: __VNF-ID__
29382         - name: interface-name
29383           in: path
29384           description: Name that identifies the link aggregate interface
29385           required: true
29386           type: string
29387           example: __INTERFACE-NAME__
29388         - name: interface-name
29389           in: path
29390           description: Name given to the interface
29391           required: true
29392           type: string
29393           example: __INTERFACE-NAME__
29394         - name: vlan-interface
29395           in: path
29396           description: String that identifies the interface
29397           required: true
29398           type: string
29399           example: __VLAN-INTERFACE__
29400         - name: l3-interface-ipv4-address
29401           in: path
29402           description: IP address
29403           required: true
29404           type: string
29405           example: __L3-INTERFACE-IPV4-ADDRESS__
29406         - name: body
29407           in: body
29408           description: l3-interface-ipv4-address-list object that needs to be updated.
29409           required: true
29410           schema:
29411             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29412     delete:
29413       tags:
29414         - Network
29415       summary: delete an existing l3-interface-ipv4-address-list
29416       description: delete an existing l3-interface-ipv4-address-list
29417       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29418       consumes:
29419         - application/json
29420         - application/xml
29421       produces:
29422         - application/json
29423         - application/xml
29424       responses:
29425         "default":
29426           description: Response codes found in [response codes](https://wiki.onap.org/).
29427       parameters:
29428         - name: vnf-id
29429           in: path
29430           description: Unique id of VNF.  This is unique across the graph.
29431           required: true
29432           type: string
29433           example: __VNF-ID__
29434         - name: interface-name
29435           in: path
29436           description: Name that identifies the link aggregate interface
29437           required: true
29438           type: string
29439           example: __INTERFACE-NAME__
29440         - name: interface-name
29441           in: path
29442           description: Name given to the interface
29443           required: true
29444           type: string
29445           example: __INTERFACE-NAME__
29446         - name: vlan-interface
29447           in: path
29448           description: String that identifies the interface
29449           required: true
29450           type: string
29451           example: __VLAN-INTERFACE__
29452         - name: l3-interface-ipv4-address
29453           in: path
29454           description: IP address
29455           required: true
29456           type: string
29457           example: __L3-INTERFACE-IPV4-ADDRESS__
29458         - name: resource-version
29459           in: query
29460           description: resource-version for concurrency
29461           required: true
29462           type: string
29463   /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:
29464     put:
29465       tags:
29466         - Network
29467       summary: see node definition for valid relationships
29468       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
29469       consumes:
29470         - application/json
29471         - application/xml
29472       produces:
29473         - application/json
29474         - application/xml
29475       responses:
29476         "default":
29477           description: Response codes found in [response codes](https://wiki.onap.org/).
29478       parameters:
29479         - name: vnf-id
29480           in: path
29481           description: Unique id of VNF.  This is unique across the graph.
29482           required: true
29483           type: string
29484           example: __VNF-ID__
29485         - name: interface-name
29486           in: path
29487           description: Name that identifies the link aggregate interface
29488           required: true
29489           type: string
29490           example: __INTERFACE-NAME__
29491         - name: interface-name
29492           in: path
29493           description: Name given to the interface
29494           required: true
29495           type: string
29496           example: __INTERFACE-NAME__
29497         - name: vlan-interface
29498           in: path
29499           description: String that identifies the interface
29500           required: true
29501           type: string
29502           example: __VLAN-INTERFACE__
29503         - name: l3-interface-ipv6-address
29504           in: path
29505           description: IP address
29506           required: true
29507           type: string
29508           example: __L3-INTERFACE-IPV6-ADDRESS__
29509         - name: body
29510           in: body
29511           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
29512           required: true
29513           schema:
29514             $ref: "#/definitions/relationship"
29515     delete:
29516       tags:
29517         - Network
29518       summary: delete an existing relationship
29519       description: delete an existing relationship
29520       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
29521       consumes:
29522         - application/json
29523         - application/xml
29524       produces:
29525         - application/json
29526         - application/xml
29527       responses:
29528         "default":
29529           description: Response codes found in [response codes](https://wiki.onap.org/).
29530       parameters:
29531         - name: vnf-id
29532           in: path
29533           description: Unique id of VNF.  This is unique across the graph.
29534           required: true
29535           type: string
29536           example: __VNF-ID__
29537         - name: interface-name
29538           in: path
29539           description: Name that identifies the link aggregate interface
29540           required: true
29541           type: string
29542           example: __INTERFACE-NAME__
29543         - name: interface-name
29544           in: path
29545           description: Name given to the interface
29546           required: true
29547           type: string
29548           example: __INTERFACE-NAME__
29549         - name: vlan-interface
29550           in: path
29551           description: String that identifies the interface
29552           required: true
29553           type: string
29554           example: __VLAN-INTERFACE__
29555         - name: l3-interface-ipv6-address
29556           in: path
29557           description: IP address
29558           required: true
29559           type: string
29560           example: __L3-INTERFACE-IPV6-ADDRESS__
29561   /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}:
29562     get:
29563       tags:
29564         - Network
29565       summary: returns l3-interface-ipv6-address-list
29566       description: returns l3-interface-ipv6-address-list
29567       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29568       produces:
29569         - application/json
29570         - application/xml
29571       responses:
29572         "200":
29573           description: successful operation
29574           schema:
29575               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29576         "default":
29577           description: Response codes found in [response codes](https://wiki.onap.org/).
29578       parameters:
29579         - name: vnf-id
29580           in: path
29581           description: Unique id of VNF.  This is unique across the graph.
29582           required: true
29583           type: string
29584           example: __VNF-ID__
29585         - name: interface-name
29586           in: path
29587           description: Name that identifies the link aggregate interface
29588           required: true
29589           type: string
29590           example: __INTERFACE-NAME__
29591         - name: interface-name
29592           in: path
29593           description: Name given to the interface
29594           required: true
29595           type: string
29596           example: __INTERFACE-NAME__
29597         - name: vlan-interface
29598           in: path
29599           description: String that identifies the interface
29600           required: true
29601           type: string
29602           example: __VLAN-INTERFACE__
29603         - name: l3-interface-ipv6-address
29604           in: path
29605           description: IP address
29606           required: true
29607           type: string
29608           example: __L3-INTERFACE-IPV6-ADDRESS__
29609     put:
29610       tags:
29611         - Network
29612       summary: create or update an existing l3-interface-ipv6-address-list
29613       description: |
29614         Create or update an existing l3-interface-ipv6-address-list.
29615         #
29616         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29617       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29618       consumes:
29619         - application/json
29620         - application/xml
29621       produces:
29622         - application/json
29623         - application/xml
29624       responses:
29625         "default":
29626           description: Response codes found in [response codes](https://wiki.onap.org/).
29627       parameters:
29628         - name: vnf-id
29629           in: path
29630           description: Unique id of VNF.  This is unique across the graph.
29631           required: true
29632           type: string
29633           example: __VNF-ID__
29634         - name: interface-name
29635           in: path
29636           description: Name that identifies the link aggregate interface
29637           required: true
29638           type: string
29639           example: __INTERFACE-NAME__
29640         - name: interface-name
29641           in: path
29642           description: Name given to the interface
29643           required: true
29644           type: string
29645           example: __INTERFACE-NAME__
29646         - name: vlan-interface
29647           in: path
29648           description: String that identifies the interface
29649           required: true
29650           type: string
29651           example: __VLAN-INTERFACE__
29652         - name: l3-interface-ipv6-address
29653           in: path
29654           description: IP address
29655           required: true
29656           type: string
29657           example: __L3-INTERFACE-IPV6-ADDRESS__
29658         - name: body
29659           in: body
29660           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
29661           required: true
29662           schema:
29663             $ref: "#/definitions/l3-interface-ipv6-address-list"
29664     patch:
29665       tags:
29666         - Network
29667       summary: update an existing l3-interface-ipv6-address-list
29668       description: |
29669         Update an existing l3-interface-ipv6-address-list
29670         #
29671         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29672         The PUT operation will entirely replace an existing object.
29673         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29674         #
29675         Other differences between PUT and PATCH are:
29676         #
29677         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29678         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29679         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29680       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29681       consumes:
29682         - application/json
29683         - application/xml
29684       produces:
29685         - application/json
29686         - application/xml
29687       responses:
29688         "default":
29689           description: Response codes found in [response codes](https://wiki.onap.org/).
29690       parameters:
29691         - name: vnf-id
29692           in: path
29693           description: Unique id of VNF.  This is unique across the graph.
29694           required: true
29695           type: string
29696           example: __VNF-ID__
29697         - name: interface-name
29698           in: path
29699           description: Name that identifies the link aggregate interface
29700           required: true
29701           type: string
29702           example: __INTERFACE-NAME__
29703         - name: interface-name
29704           in: path
29705           description: Name given to the interface
29706           required: true
29707           type: string
29708           example: __INTERFACE-NAME__
29709         - name: vlan-interface
29710           in: path
29711           description: String that identifies the interface
29712           required: true
29713           type: string
29714           example: __VLAN-INTERFACE__
29715         - name: l3-interface-ipv6-address
29716           in: path
29717           description: IP address
29718           required: true
29719           type: string
29720           example: __L3-INTERFACE-IPV6-ADDRESS__
29721         - name: body
29722           in: body
29723           description: l3-interface-ipv6-address-list object that needs to be updated.
29724           required: true
29725           schema:
29726             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29727     delete:
29728       tags:
29729         - Network
29730       summary: delete an existing l3-interface-ipv6-address-list
29731       description: delete an existing l3-interface-ipv6-address-list
29732       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29733       consumes:
29734         - application/json
29735         - application/xml
29736       produces:
29737         - application/json
29738         - application/xml
29739       responses:
29740         "default":
29741           description: Response codes found in [response codes](https://wiki.onap.org/).
29742       parameters:
29743         - name: vnf-id
29744           in: path
29745           description: Unique id of VNF.  This is unique across the graph.
29746           required: true
29747           type: string
29748           example: __VNF-ID__
29749         - name: interface-name
29750           in: path
29751           description: Name that identifies the link aggregate interface
29752           required: true
29753           type: string
29754           example: __INTERFACE-NAME__
29755         - name: interface-name
29756           in: path
29757           description: Name given to the interface
29758           required: true
29759           type: string
29760           example: __INTERFACE-NAME__
29761         - name: vlan-interface
29762           in: path
29763           description: String that identifies the interface
29764           required: true
29765           type: string
29766           example: __VLAN-INTERFACE__
29767         - name: l3-interface-ipv6-address
29768           in: path
29769           description: IP address
29770           required: true
29771           type: string
29772           example: __L3-INTERFACE-IPV6-ADDRESS__
29773         - name: resource-version
29774           in: query
29775           description: resource-version for concurrency
29776           required: true
29777           type: string
29778   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
29779     get:
29780       tags:
29781         - Network
29782       summary: returns vlan
29783       description: returns vlan
29784       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29785       produces:
29786         - application/json
29787         - application/xml
29788       responses:
29789         "200":
29790           description: successful operation
29791           schema:
29792               $ref: "#/getDefinitions/vlan"
29793         "default":
29794           description: Response codes found in [response codes](https://wiki.onap.org/).
29795       parameters:
29796         - name: vnf-id
29797           in: path
29798           description: Unique id of VNF.  This is unique across the graph.
29799           required: true
29800           type: string
29801           example: __VNF-ID__
29802         - name: interface-name
29803           in: path
29804           description: Name that identifies the link aggregate interface
29805           required: true
29806           type: string
29807           example: __INTERFACE-NAME__
29808         - name: interface-name
29809           in: path
29810           description: Name given to the interface
29811           required: true
29812           type: string
29813           example: __INTERFACE-NAME__
29814         - name: vlan-interface
29815           in: path
29816           description: String that identifies the interface
29817           required: true
29818           type: string
29819           example: __VLAN-INTERFACE__
29820     put:
29821       tags:
29822         - Network
29823       summary: create or update an existing vlan
29824       description: |
29825         Create or update an existing vlan.
29826         #
29827         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29828       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29829       consumes:
29830         - application/json
29831         - application/xml
29832       produces:
29833         - application/json
29834         - application/xml
29835       responses:
29836         "default":
29837           description: Response codes found in [response codes](https://wiki.onap.org/).
29838       parameters:
29839         - name: vnf-id
29840           in: path
29841           description: Unique id of VNF.  This is unique across the graph.
29842           required: true
29843           type: string
29844           example: __VNF-ID__
29845         - name: interface-name
29846           in: path
29847           description: Name that identifies the link aggregate interface
29848           required: true
29849           type: string
29850           example: __INTERFACE-NAME__
29851         - name: interface-name
29852           in: path
29853           description: Name given to the interface
29854           required: true
29855           type: string
29856           example: __INTERFACE-NAME__
29857         - name: vlan-interface
29858           in: path
29859           description: String that identifies the interface
29860           required: true
29861           type: string
29862           example: __VLAN-INTERFACE__
29863         - name: body
29864           in: body
29865           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
29866           required: true
29867           schema:
29868             $ref: "#/definitions/vlan"
29869     patch:
29870       tags:
29871         - Network
29872       summary: update an existing vlan
29873       description: |
29874         Update an existing vlan
29875         #
29876         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29877         The PUT operation will entirely replace an existing object.
29878         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29879         #
29880         Other differences between PUT and PATCH are:
29881         #
29882         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29883         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29884         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29885       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29886       consumes:
29887         - application/json
29888         - application/xml
29889       produces:
29890         - application/json
29891         - application/xml
29892       responses:
29893         "default":
29894           description: Response codes found in [response codes](https://wiki.onap.org/).
29895       parameters:
29896         - name: vnf-id
29897           in: path
29898           description: Unique id of VNF.  This is unique across the graph.
29899           required: true
29900           type: string
29901           example: __VNF-ID__
29902         - name: interface-name
29903           in: path
29904           description: Name that identifies the link aggregate interface
29905           required: true
29906           type: string
29907           example: __INTERFACE-NAME__
29908         - name: interface-name
29909           in: path
29910           description: Name given to the interface
29911           required: true
29912           type: string
29913           example: __INTERFACE-NAME__
29914         - name: vlan-interface
29915           in: path
29916           description: String that identifies the interface
29917           required: true
29918           type: string
29919           example: __VLAN-INTERFACE__
29920         - name: body
29921           in: body
29922           description: vlan object that needs to be updated.
29923           required: true
29924           schema:
29925             $ref: "#/patchDefinitions/vlan"
29926     delete:
29927       tags:
29928         - Network
29929       summary: delete an existing vlan
29930       description: delete an existing vlan
29931       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29932       consumes:
29933         - application/json
29934         - application/xml
29935       produces:
29936         - application/json
29937         - application/xml
29938       responses:
29939         "default":
29940           description: Response codes found in [response codes](https://wiki.onap.org/).
29941       parameters:
29942         - name: vnf-id
29943           in: path
29944           description: Unique id of VNF.  This is unique across the graph.
29945           required: true
29946           type: string
29947           example: __VNF-ID__
29948         - name: interface-name
29949           in: path
29950           description: Name that identifies the link aggregate interface
29951           required: true
29952           type: string
29953           example: __INTERFACE-NAME__
29954         - name: interface-name
29955           in: path
29956           description: Name given to the interface
29957           required: true
29958           type: string
29959           example: __INTERFACE-NAME__
29960         - name: vlan-interface
29961           in: path
29962           description: String that identifies the interface
29963           required: true
29964           type: string
29965           example: __VLAN-INTERFACE__
29966         - name: resource-version
29967           in: query
29968           description: resource-version for concurrency
29969           required: true
29970           type: string
29971   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
29972     get:
29973       tags:
29974         - Network
29975       summary: returns vlans
29976       description: returns vlans
29977       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
29978       produces:
29979         - application/json
29980         - application/xml
29981       responses:
29982         "200":
29983           description: successful operation
29984           schema:
29985               $ref: "#/getDefinitions/vlans"
29986         "default":
29987           description: Response codes found in [response codes](https://wiki.onap.org/).
29988       parameters:
29989         - name: vnf-id
29990           in: path
29991           description: Unique id of VNF.  This is unique across the graph.
29992           required: true
29993           type: string
29994           example: __VNF-ID__
29995         - name: interface-name
29996           in: path
29997           description: Name that identifies the link aggregate interface
29998           required: true
29999           type: string
30000           example: __INTERFACE-NAME__
30001         - name: interface-name
30002           in: path
30003           description: Name given to the interface
30004           required: true
30005           type: string
30006           example: __INTERFACE-NAME__
30007         - name: vlan-interface
30008           in: query
30009           description:
30010           required: false
30011           type: string
30012         - name: vlan-id-inner
30013           in: query
30014           description:
30015           required: false
30016           type: integer
30017           format: int64
30018         - name: vpn-id
30019           in: query
30020           description:
30021           required: false
30022           type: string
30023   /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:
30024     put:
30025       tags:
30026         - Network
30027       summary: see node definition for valid relationships
30028       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
30029       consumes:
30030         - application/json
30031         - application/xml
30032       produces:
30033         - application/json
30034         - application/xml
30035       responses:
30036         "default":
30037           description: Response codes found in [response codes](https://wiki.onap.org/).
30038       parameters:
30039         - name: vnf-id
30040           in: path
30041           description: Unique id of VNF.  This is unique across the graph.
30042           required: true
30043           type: string
30044           example: __VNF-ID__
30045         - name: interface-name
30046           in: path
30047           description: Name that identifies the link aggregate interface
30048           required: true
30049           type: string
30050           example: __INTERFACE-NAME__
30051         - name: interface-name
30052           in: path
30053           description: Name given to the interface
30054           required: true
30055           type: string
30056           example: __INTERFACE-NAME__
30057         - name: pci-id
30058           in: path
30059           description: PCI ID used to identify the sriov-vf
30060           required: true
30061           type: string
30062           example: __PCI-ID__
30063         - name: body
30064           in: body
30065           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
30066           required: true
30067           schema:
30068             $ref: "#/definitions/relationship"
30069     delete:
30070       tags:
30071         - Network
30072       summary: delete an existing relationship
30073       description: delete an existing relationship
30074       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
30075       consumes:
30076         - application/json
30077         - application/xml
30078       produces:
30079         - application/json
30080         - application/xml
30081       responses:
30082         "default":
30083           description: Response codes found in [response codes](https://wiki.onap.org/).
30084       parameters:
30085         - name: vnf-id
30086           in: path
30087           description: Unique id of VNF.  This is unique across the graph.
30088           required: true
30089           type: string
30090           example: __VNF-ID__
30091         - name: interface-name
30092           in: path
30093           description: Name that identifies the link aggregate interface
30094           required: true
30095           type: string
30096           example: __INTERFACE-NAME__
30097         - name: interface-name
30098           in: path
30099           description: Name given to the interface
30100           required: true
30101           type: string
30102           example: __INTERFACE-NAME__
30103         - name: pci-id
30104           in: path
30105           description: PCI ID used to identify the sriov-vf
30106           required: true
30107           type: string
30108           example: __PCI-ID__
30109   /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}:
30110     get:
30111       tags:
30112         - Network
30113       summary: returns sriov-vf
30114       description: returns sriov-vf
30115       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30116       produces:
30117         - application/json
30118         - application/xml
30119       responses:
30120         "200":
30121           description: successful operation
30122           schema:
30123               $ref: "#/getDefinitions/sriov-vf"
30124         "default":
30125           description: Response codes found in [response codes](https://wiki.onap.org/).
30126       parameters:
30127         - name: vnf-id
30128           in: path
30129           description: Unique id of VNF.  This is unique across the graph.
30130           required: true
30131           type: string
30132           example: __VNF-ID__
30133         - name: interface-name
30134           in: path
30135           description: Name that identifies the link aggregate interface
30136           required: true
30137           type: string
30138           example: __INTERFACE-NAME__
30139         - name: interface-name
30140           in: path
30141           description: Name given to the interface
30142           required: true
30143           type: string
30144           example: __INTERFACE-NAME__
30145         - name: pci-id
30146           in: path
30147           description: PCI ID used to identify the sriov-vf
30148           required: true
30149           type: string
30150           example: __PCI-ID__
30151     put:
30152       tags:
30153         - Network
30154       summary: create or update an existing sriov-vf
30155       description: |
30156         Create or update an existing sriov-vf.
30157         #
30158         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30159       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30160       consumes:
30161         - application/json
30162         - application/xml
30163       produces:
30164         - application/json
30165         - application/xml
30166       responses:
30167         "default":
30168           description: Response codes found in [response codes](https://wiki.onap.org/).
30169       parameters:
30170         - name: vnf-id
30171           in: path
30172           description: Unique id of VNF.  This is unique across the graph.
30173           required: true
30174           type: string
30175           example: __VNF-ID__
30176         - name: interface-name
30177           in: path
30178           description: Name that identifies the link aggregate interface
30179           required: true
30180           type: string
30181           example: __INTERFACE-NAME__
30182         - name: interface-name
30183           in: path
30184           description: Name given to the interface
30185           required: true
30186           type: string
30187           example: __INTERFACE-NAME__
30188         - name: pci-id
30189           in: path
30190           description: PCI ID used to identify the sriov-vf
30191           required: true
30192           type: string
30193           example: __PCI-ID__
30194         - name: body
30195           in: body
30196           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
30197           required: true
30198           schema:
30199             $ref: "#/definitions/sriov-vf"
30200     patch:
30201       tags:
30202         - Network
30203       summary: update an existing sriov-vf
30204       description: |
30205         Update an existing sriov-vf
30206         #
30207         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30208         The PUT operation will entirely replace an existing object.
30209         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30210         #
30211         Other differences between PUT and PATCH are:
30212         #
30213         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30214         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30215         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30216       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30217       consumes:
30218         - application/json
30219         - application/xml
30220       produces:
30221         - application/json
30222         - application/xml
30223       responses:
30224         "default":
30225           description: Response codes found in [response codes](https://wiki.onap.org/).
30226       parameters:
30227         - name: vnf-id
30228           in: path
30229           description: Unique id of VNF.  This is unique across the graph.
30230           required: true
30231           type: string
30232           example: __VNF-ID__
30233         - name: interface-name
30234           in: path
30235           description: Name that identifies the link aggregate interface
30236           required: true
30237           type: string
30238           example: __INTERFACE-NAME__
30239         - name: interface-name
30240           in: path
30241           description: Name given to the interface
30242           required: true
30243           type: string
30244           example: __INTERFACE-NAME__
30245         - name: pci-id
30246           in: path
30247           description: PCI ID used to identify the sriov-vf
30248           required: true
30249           type: string
30250           example: __PCI-ID__
30251         - name: body
30252           in: body
30253           description: sriov-vf object that needs to be updated.
30254           required: true
30255           schema:
30256             $ref: "#/patchDefinitions/sriov-vf"
30257     delete:
30258       tags:
30259         - Network
30260       summary: delete an existing sriov-vf
30261       description: delete an existing sriov-vf
30262       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30263       consumes:
30264         - application/json
30265         - application/xml
30266       produces:
30267         - application/json
30268         - application/xml
30269       responses:
30270         "default":
30271           description: Response codes found in [response codes](https://wiki.onap.org/).
30272       parameters:
30273         - name: vnf-id
30274           in: path
30275           description: Unique id of VNF.  This is unique across the graph.
30276           required: true
30277           type: string
30278           example: __VNF-ID__
30279         - name: interface-name
30280           in: path
30281           description: Name that identifies the link aggregate interface
30282           required: true
30283           type: string
30284           example: __INTERFACE-NAME__
30285         - name: interface-name
30286           in: path
30287           description: Name given to the interface
30288           required: true
30289           type: string
30290           example: __INTERFACE-NAME__
30291         - name: pci-id
30292           in: path
30293           description: PCI ID used to identify the sriov-vf
30294           required: true
30295           type: string
30296           example: __PCI-ID__
30297         - name: resource-version
30298           in: query
30299           description: resource-version for concurrency
30300           required: true
30301           type: string
30302   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
30303     get:
30304       tags:
30305         - Network
30306       summary: returns sriov-vfs
30307       description: returns sriov-vfs
30308       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
30309       produces:
30310         - application/json
30311         - application/xml
30312       responses:
30313         "200":
30314           description: successful operation
30315           schema:
30316               $ref: "#/getDefinitions/sriov-vfs"
30317         "default":
30318           description: Response codes found in [response codes](https://wiki.onap.org/).
30319       parameters:
30320         - name: vnf-id
30321           in: path
30322           description: Unique id of VNF.  This is unique across the graph.
30323           required: true
30324           type: string
30325           example: __VNF-ID__
30326         - name: interface-name
30327           in: path
30328           description: Name that identifies the link aggregate interface
30329           required: true
30330           type: string
30331           example: __INTERFACE-NAME__
30332         - name: interface-name
30333           in: path
30334           description: Name given to the interface
30335           required: true
30336           type: string
30337           example: __INTERFACE-NAME__
30338         - name: pci-id
30339           in: query
30340           description:
30341           required: false
30342           type: string
30343         - name: vf-vlan-filter
30344           in: query
30345           description:
30346           required: false
30347           type: string
30348         - name: vf-mac-filter
30349           in: query
30350           description:
30351           required: false
30352           type: string
30353         - name: vf-vlan-strip
30354           in: query
30355           description:
30356           required: false
30357           type: boolean
30358         - name: neutron-network-id
30359           in: query
30360           description:
30361           required: false
30362           type: string
30363   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
30364     put:
30365       tags:
30366         - Network
30367       summary: see node definition for valid relationships
30368       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
30369       consumes:
30370         - application/json
30371         - application/xml
30372       produces:
30373         - application/json
30374         - application/xml
30375       responses:
30376         "default":
30377           description: Response codes found in [response codes](https://wiki.onap.org/).
30378       parameters:
30379         - name: vnf-id
30380           in: path
30381           description: Unique id of VNF.  This is unique across the graph.
30382           required: true
30383           type: string
30384           example: __VNF-ID__
30385         - name: interface-name
30386           in: path
30387           description: Name that identifies the link aggregate interface
30388           required: true
30389           type: string
30390           example: __INTERFACE-NAME__
30391         - name: interface-name
30392           in: path
30393           description: Name given to the interface
30394           required: true
30395           type: string
30396           example: __INTERFACE-NAME__
30397         - name: body
30398           in: body
30399           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
30400           required: true
30401           schema:
30402             $ref: "#/definitions/relationship"
30403     delete:
30404       tags:
30405         - Network
30406       summary: delete an existing relationship
30407       description: delete an existing relationship
30408       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
30409       consumes:
30410         - application/json
30411         - application/xml
30412       produces:
30413         - application/json
30414         - application/xml
30415       responses:
30416         "default":
30417           description: Response codes found in [response codes](https://wiki.onap.org/).
30418       parameters:
30419         - name: vnf-id
30420           in: path
30421           description: Unique id of VNF.  This is unique across the graph.
30422           required: true
30423           type: string
30424           example: __VNF-ID__
30425         - name: interface-name
30426           in: path
30427           description: Name that identifies the link aggregate interface
30428           required: true
30429           type: string
30430           example: __INTERFACE-NAME__
30431         - name: interface-name
30432           in: path
30433           description: Name given to the interface
30434           required: true
30435           type: string
30436           example: __INTERFACE-NAME__
30437   /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:
30438     put:
30439       tags:
30440         - Network
30441       summary: see node definition for valid relationships
30442       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
30443       consumes:
30444         - application/json
30445         - application/xml
30446       produces:
30447         - application/json
30448         - application/xml
30449       responses:
30450         "default":
30451           description: Response codes found in [response codes](https://wiki.onap.org/).
30452       parameters:
30453         - name: vnf-id
30454           in: path
30455           description: Unique id of VNF.  This is unique across the graph.
30456           required: true
30457           type: string
30458           example: __VNF-ID__
30459         - name: interface-name
30460           in: path
30461           description: Name that identifies the link aggregate interface
30462           required: true
30463           type: string
30464           example: __INTERFACE-NAME__
30465         - name: interface-name
30466           in: path
30467           description: Name given to the interface
30468           required: true
30469           type: string
30470           example: __INTERFACE-NAME__
30471         - name: l3-interface-ipv4-address
30472           in: path
30473           description: IP address
30474           required: true
30475           type: string
30476           example: __L3-INTERFACE-IPV4-ADDRESS__
30477         - name: body
30478           in: body
30479           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30480           required: true
30481           schema:
30482             $ref: "#/definitions/relationship"
30483     delete:
30484       tags:
30485         - Network
30486       summary: delete an existing relationship
30487       description: delete an existing relationship
30488       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
30489       consumes:
30490         - application/json
30491         - application/xml
30492       produces:
30493         - application/json
30494         - application/xml
30495       responses:
30496         "default":
30497           description: Response codes found in [response codes](https://wiki.onap.org/).
30498       parameters:
30499         - name: vnf-id
30500           in: path
30501           description: Unique id of VNF.  This is unique across the graph.
30502           required: true
30503           type: string
30504           example: __VNF-ID__
30505         - name: interface-name
30506           in: path
30507           description: Name that identifies the link aggregate interface
30508           required: true
30509           type: string
30510           example: __INTERFACE-NAME__
30511         - name: interface-name
30512           in: path
30513           description: Name given to the interface
30514           required: true
30515           type: string
30516           example: __INTERFACE-NAME__
30517         - name: l3-interface-ipv4-address
30518           in: path
30519           description: IP address
30520           required: true
30521           type: string
30522           example: __L3-INTERFACE-IPV4-ADDRESS__
30523   /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}:
30524     get:
30525       tags:
30526         - Network
30527       summary: returns l3-interface-ipv4-address-list
30528       description: returns l3-interface-ipv4-address-list
30529       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30530       produces:
30531         - application/json
30532         - application/xml
30533       responses:
30534         "200":
30535           description: successful operation
30536           schema:
30537               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30538         "default":
30539           description: Response codes found in [response codes](https://wiki.onap.org/).
30540       parameters:
30541         - name: vnf-id
30542           in: path
30543           description: Unique id of VNF.  This is unique across the graph.
30544           required: true
30545           type: string
30546           example: __VNF-ID__
30547         - name: interface-name
30548           in: path
30549           description: Name that identifies the link aggregate interface
30550           required: true
30551           type: string
30552           example: __INTERFACE-NAME__
30553         - name: interface-name
30554           in: path
30555           description: Name given to the interface
30556           required: true
30557           type: string
30558           example: __INTERFACE-NAME__
30559         - name: l3-interface-ipv4-address
30560           in: path
30561           description: IP address
30562           required: true
30563           type: string
30564           example: __L3-INTERFACE-IPV4-ADDRESS__
30565     put:
30566       tags:
30567         - Network
30568       summary: create or update an existing l3-interface-ipv4-address-list
30569       description: |
30570         Create or update an existing l3-interface-ipv4-address-list.
30571         #
30572         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30573       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30574       consumes:
30575         - application/json
30576         - application/xml
30577       produces:
30578         - application/json
30579         - application/xml
30580       responses:
30581         "default":
30582           description: Response codes found in [response codes](https://wiki.onap.org/).
30583       parameters:
30584         - name: vnf-id
30585           in: path
30586           description: Unique id of VNF.  This is unique across the graph.
30587           required: true
30588           type: string
30589           example: __VNF-ID__
30590         - name: interface-name
30591           in: path
30592           description: Name that identifies the link aggregate interface
30593           required: true
30594           type: string
30595           example: __INTERFACE-NAME__
30596         - name: interface-name
30597           in: path
30598           description: Name given to the interface
30599           required: true
30600           type: string
30601           example: __INTERFACE-NAME__
30602         - name: l3-interface-ipv4-address
30603           in: path
30604           description: IP address
30605           required: true
30606           type: string
30607           example: __L3-INTERFACE-IPV4-ADDRESS__
30608         - name: body
30609           in: body
30610           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30611           required: true
30612           schema:
30613             $ref: "#/definitions/l3-interface-ipv4-address-list"
30614     patch:
30615       tags:
30616         - Network
30617       summary: update an existing l3-interface-ipv4-address-list
30618       description: |
30619         Update an existing l3-interface-ipv4-address-list
30620         #
30621         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30622         The PUT operation will entirely replace an existing object.
30623         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30624         #
30625         Other differences between PUT and PATCH are:
30626         #
30627         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30628         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30629         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30630       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30631       consumes:
30632         - application/json
30633         - application/xml
30634       produces:
30635         - application/json
30636         - application/xml
30637       responses:
30638         "default":
30639           description: Response codes found in [response codes](https://wiki.onap.org/).
30640       parameters:
30641         - name: vnf-id
30642           in: path
30643           description: Unique id of VNF.  This is unique across the graph.
30644           required: true
30645           type: string
30646           example: __VNF-ID__
30647         - name: interface-name
30648           in: path
30649           description: Name that identifies the link aggregate interface
30650           required: true
30651           type: string
30652           example: __INTERFACE-NAME__
30653         - name: interface-name
30654           in: path
30655           description: Name given to the interface
30656           required: true
30657           type: string
30658           example: __INTERFACE-NAME__
30659         - name: l3-interface-ipv4-address
30660           in: path
30661           description: IP address
30662           required: true
30663           type: string
30664           example: __L3-INTERFACE-IPV4-ADDRESS__
30665         - name: body
30666           in: body
30667           description: l3-interface-ipv4-address-list object that needs to be updated.
30668           required: true
30669           schema:
30670             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30671     delete:
30672       tags:
30673         - Network
30674       summary: delete an existing l3-interface-ipv4-address-list
30675       description: delete an existing l3-interface-ipv4-address-list
30676       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30677       consumes:
30678         - application/json
30679         - application/xml
30680       produces:
30681         - application/json
30682         - application/xml
30683       responses:
30684         "default":
30685           description: Response codes found in [response codes](https://wiki.onap.org/).
30686       parameters:
30687         - name: vnf-id
30688           in: path
30689           description: Unique id of VNF.  This is unique across the graph.
30690           required: true
30691           type: string
30692           example: __VNF-ID__
30693         - name: interface-name
30694           in: path
30695           description: Name that identifies the link aggregate interface
30696           required: true
30697           type: string
30698           example: __INTERFACE-NAME__
30699         - name: interface-name
30700           in: path
30701           description: Name given to the interface
30702           required: true
30703           type: string
30704           example: __INTERFACE-NAME__
30705         - name: l3-interface-ipv4-address
30706           in: path
30707           description: IP address
30708           required: true
30709           type: string
30710           example: __L3-INTERFACE-IPV4-ADDRESS__
30711         - name: resource-version
30712           in: query
30713           description: resource-version for concurrency
30714           required: true
30715           type: string
30716   /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:
30717     put:
30718       tags:
30719         - Network
30720       summary: see node definition for valid relationships
30721       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30722       consumes:
30723         - application/json
30724         - application/xml
30725       produces:
30726         - application/json
30727         - application/xml
30728       responses:
30729         "default":
30730           description: Response codes found in [response codes](https://wiki.onap.org/).
30731       parameters:
30732         - name: vnf-id
30733           in: path
30734           description: Unique id of VNF.  This is unique across the graph.
30735           required: true
30736           type: string
30737           example: __VNF-ID__
30738         - name: interface-name
30739           in: path
30740           description: Name that identifies the link aggregate interface
30741           required: true
30742           type: string
30743           example: __INTERFACE-NAME__
30744         - name: interface-name
30745           in: path
30746           description: Name given to the interface
30747           required: true
30748           type: string
30749           example: __INTERFACE-NAME__
30750         - name: l3-interface-ipv6-address
30751           in: path
30752           description: IP address
30753           required: true
30754           type: string
30755           example: __L3-INTERFACE-IPV6-ADDRESS__
30756         - name: body
30757           in: body
30758           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30759           required: true
30760           schema:
30761             $ref: "#/definitions/relationship"
30762     delete:
30763       tags:
30764         - Network
30765       summary: delete an existing relationship
30766       description: delete an existing relationship
30767       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30768       consumes:
30769         - application/json
30770         - application/xml
30771       produces:
30772         - application/json
30773         - application/xml
30774       responses:
30775         "default":
30776           description: Response codes found in [response codes](https://wiki.onap.org/).
30777       parameters:
30778         - name: vnf-id
30779           in: path
30780           description: Unique id of VNF.  This is unique across the graph.
30781           required: true
30782           type: string
30783           example: __VNF-ID__
30784         - name: interface-name
30785           in: path
30786           description: Name that identifies the link aggregate interface
30787           required: true
30788           type: string
30789           example: __INTERFACE-NAME__
30790         - name: interface-name
30791           in: path
30792           description: Name given to the interface
30793           required: true
30794           type: string
30795           example: __INTERFACE-NAME__
30796         - name: l3-interface-ipv6-address
30797           in: path
30798           description: IP address
30799           required: true
30800           type: string
30801           example: __L3-INTERFACE-IPV6-ADDRESS__
30802   /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}:
30803     get:
30804       tags:
30805         - Network
30806       summary: returns l3-interface-ipv6-address-list
30807       description: returns l3-interface-ipv6-address-list
30808       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30809       produces:
30810         - application/json
30811         - application/xml
30812       responses:
30813         "200":
30814           description: successful operation
30815           schema:
30816               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30817         "default":
30818           description: Response codes found in [response codes](https://wiki.onap.org/).
30819       parameters:
30820         - name: vnf-id
30821           in: path
30822           description: Unique id of VNF.  This is unique across the graph.
30823           required: true
30824           type: string
30825           example: __VNF-ID__
30826         - name: interface-name
30827           in: path
30828           description: Name that identifies the link aggregate interface
30829           required: true
30830           type: string
30831           example: __INTERFACE-NAME__
30832         - name: interface-name
30833           in: path
30834           description: Name given to the interface
30835           required: true
30836           type: string
30837           example: __INTERFACE-NAME__
30838         - name: l3-interface-ipv6-address
30839           in: path
30840           description: IP address
30841           required: true
30842           type: string
30843           example: __L3-INTERFACE-IPV6-ADDRESS__
30844     put:
30845       tags:
30846         - Network
30847       summary: create or update an existing l3-interface-ipv6-address-list
30848       description: |
30849         Create or update an existing l3-interface-ipv6-address-list.
30850         #
30851         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30852       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30853       consumes:
30854         - application/json
30855         - application/xml
30856       produces:
30857         - application/json
30858         - application/xml
30859       responses:
30860         "default":
30861           description: Response codes found in [response codes](https://wiki.onap.org/).
30862       parameters:
30863         - name: vnf-id
30864           in: path
30865           description: Unique id of VNF.  This is unique across the graph.
30866           required: true
30867           type: string
30868           example: __VNF-ID__
30869         - name: interface-name
30870           in: path
30871           description: Name that identifies the link aggregate interface
30872           required: true
30873           type: string
30874           example: __INTERFACE-NAME__
30875         - name: interface-name
30876           in: path
30877           description: Name given to the interface
30878           required: true
30879           type: string
30880           example: __INTERFACE-NAME__
30881         - name: l3-interface-ipv6-address
30882           in: path
30883           description: IP address
30884           required: true
30885           type: string
30886           example: __L3-INTERFACE-IPV6-ADDRESS__
30887         - name: body
30888           in: body
30889           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30890           required: true
30891           schema:
30892             $ref: "#/definitions/l3-interface-ipv6-address-list"
30893     patch:
30894       tags:
30895         - Network
30896       summary: update an existing l3-interface-ipv6-address-list
30897       description: |
30898         Update an existing l3-interface-ipv6-address-list
30899         #
30900         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30901         The PUT operation will entirely replace an existing object.
30902         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30903         #
30904         Other differences between PUT and PATCH are:
30905         #
30906         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30907         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30908         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30909       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30910       consumes:
30911         - application/json
30912         - application/xml
30913       produces:
30914         - application/json
30915         - application/xml
30916       responses:
30917         "default":
30918           description: Response codes found in [response codes](https://wiki.onap.org/).
30919       parameters:
30920         - name: vnf-id
30921           in: path
30922           description: Unique id of VNF.  This is unique across the graph.
30923           required: true
30924           type: string
30925           example: __VNF-ID__
30926         - name: interface-name
30927           in: path
30928           description: Name that identifies the link aggregate interface
30929           required: true
30930           type: string
30931           example: __INTERFACE-NAME__
30932         - name: interface-name
30933           in: path
30934           description: Name given to the interface
30935           required: true
30936           type: string
30937           example: __INTERFACE-NAME__
30938         - name: l3-interface-ipv6-address
30939           in: path
30940           description: IP address
30941           required: true
30942           type: string
30943           example: __L3-INTERFACE-IPV6-ADDRESS__
30944         - name: body
30945           in: body
30946           description: l3-interface-ipv6-address-list object that needs to be updated.
30947           required: true
30948           schema:
30949             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30950     delete:
30951       tags:
30952         - Network
30953       summary: delete an existing l3-interface-ipv6-address-list
30954       description: delete an existing l3-interface-ipv6-address-list
30955       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30956       consumes:
30957         - application/json
30958         - application/xml
30959       produces:
30960         - application/json
30961         - application/xml
30962       responses:
30963         "default":
30964           description: Response codes found in [response codes](https://wiki.onap.org/).
30965       parameters:
30966         - name: vnf-id
30967           in: path
30968           description: Unique id of VNF.  This is unique across the graph.
30969           required: true
30970           type: string
30971           example: __VNF-ID__
30972         - name: interface-name
30973           in: path
30974           description: Name that identifies the link aggregate interface
30975           required: true
30976           type: string
30977           example: __INTERFACE-NAME__
30978         - name: interface-name
30979           in: path
30980           description: Name given to the interface
30981           required: true
30982           type: string
30983           example: __INTERFACE-NAME__
30984         - name: l3-interface-ipv6-address
30985           in: path
30986           description: IP address
30987           required: true
30988           type: string
30989           example: __L3-INTERFACE-IPV6-ADDRESS__
30990         - name: resource-version
30991           in: query
30992           description: resource-version for concurrency
30993           required: true
30994           type: string
30995   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
30996     get:
30997       tags:
30998         - Network
30999       summary: returns l-interface
31000       description: returns l-interface
31001       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31002       produces:
31003         - application/json
31004         - application/xml
31005       responses:
31006         "200":
31007           description: successful operation
31008           schema:
31009               $ref: "#/getDefinitions/l-interface"
31010         "default":
31011           description: Response codes found in [response codes](https://wiki.onap.org/).
31012       parameters:
31013         - name: vnf-id
31014           in: path
31015           description: Unique id of VNF.  This is unique across the graph.
31016           required: true
31017           type: string
31018           example: __VNF-ID__
31019         - name: interface-name
31020           in: path
31021           description: Name that identifies the link aggregate interface
31022           required: true
31023           type: string
31024           example: __INTERFACE-NAME__
31025         - name: interface-name
31026           in: path
31027           description: Name given to the interface
31028           required: true
31029           type: string
31030           example: __INTERFACE-NAME__
31031     put:
31032       tags:
31033         - Network
31034       summary: create or update an existing l-interface
31035       description: |
31036         Create or update an existing l-interface.
31037         #
31038         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31039       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31040       consumes:
31041         - application/json
31042         - application/xml
31043       produces:
31044         - application/json
31045         - application/xml
31046       responses:
31047         "default":
31048           description: Response codes found in [response codes](https://wiki.onap.org/).
31049       parameters:
31050         - name: vnf-id
31051           in: path
31052           description: Unique id of VNF.  This is unique across the graph.
31053           required: true
31054           type: string
31055           example: __VNF-ID__
31056         - name: interface-name
31057           in: path
31058           description: Name that identifies the link aggregate interface
31059           required: true
31060           type: string
31061           example: __INTERFACE-NAME__
31062         - name: interface-name
31063           in: path
31064           description: Name given to the interface
31065           required: true
31066           type: string
31067           example: __INTERFACE-NAME__
31068         - name: body
31069           in: body
31070           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
31071           required: true
31072           schema:
31073             $ref: "#/definitions/l-interface"
31074     patch:
31075       tags:
31076         - Network
31077       summary: update an existing l-interface
31078       description: |
31079         Update an existing l-interface
31080         #
31081         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31082         The PUT operation will entirely replace an existing object.
31083         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31084         #
31085         Other differences between PUT and PATCH are:
31086         #
31087         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31088         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31089         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31090       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31091       consumes:
31092         - application/json
31093         - application/xml
31094       produces:
31095         - application/json
31096         - application/xml
31097       responses:
31098         "default":
31099           description: Response codes found in [response codes](https://wiki.onap.org/).
31100       parameters:
31101         - name: vnf-id
31102           in: path
31103           description: Unique id of VNF.  This is unique across the graph.
31104           required: true
31105           type: string
31106           example: __VNF-ID__
31107         - name: interface-name
31108           in: path
31109           description: Name that identifies the link aggregate interface
31110           required: true
31111           type: string
31112           example: __INTERFACE-NAME__
31113         - name: interface-name
31114           in: path
31115           description: Name given to the interface
31116           required: true
31117           type: string
31118           example: __INTERFACE-NAME__
31119         - name: body
31120           in: body
31121           description: l-interface object that needs to be updated.
31122           required: true
31123           schema:
31124             $ref: "#/patchDefinitions/l-interface"
31125     delete:
31126       tags:
31127         - Network
31128       summary: delete an existing l-interface
31129       description: delete an existing l-interface
31130       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31131       consumes:
31132         - application/json
31133         - application/xml
31134       produces:
31135         - application/json
31136         - application/xml
31137       responses:
31138         "default":
31139           description: Response codes found in [response codes](https://wiki.onap.org/).
31140       parameters:
31141         - name: vnf-id
31142           in: path
31143           description: Unique id of VNF.  This is unique across the graph.
31144           required: true
31145           type: string
31146           example: __VNF-ID__
31147         - name: interface-name
31148           in: path
31149           description: Name that identifies the link aggregate interface
31150           required: true
31151           type: string
31152           example: __INTERFACE-NAME__
31153         - name: interface-name
31154           in: path
31155           description: Name given to the interface
31156           required: true
31157           type: string
31158           example: __INTERFACE-NAME__
31159         - name: resource-version
31160           in: query
31161           description: resource-version for concurrency
31162           required: true
31163           type: string
31164   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
31165     get:
31166       tags:
31167         - Network
31168       summary: returns l-interfaces
31169       description: returns l-interfaces
31170       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
31171       produces:
31172         - application/json
31173         - application/xml
31174       responses:
31175         "200":
31176           description: successful operation
31177           schema:
31178               $ref: "#/getDefinitions/l-interfaces"
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 that identifies the link aggregate interface
31191           required: true
31192           type: string
31193           example: __INTERFACE-NAME__
31194         - name: interface-name
31195           in: query
31196           description:
31197           required: false
31198           type: string
31199         - name: interface-id
31200           in: query
31201           description:
31202           required: false
31203           type: string
31204         - name: macaddr
31205           in: query
31206           description:
31207           required: false
31208           type: string
31209         - name: network-name
31210           in: query
31211           description:
31212           required: false
31213           type: string
31214   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
31215     get:
31216       tags:
31217         - Network
31218       summary: returns lag-interface
31219       description: returns lag-interface
31220       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31221       produces:
31222         - application/json
31223         - application/xml
31224       responses:
31225         "200":
31226           description: successful operation
31227           schema:
31228               $ref: "#/getDefinitions/lag-interface"
31229         "default":
31230           description: Response codes found in [response codes](https://wiki.onap.org/).
31231       parameters:
31232         - name: vnf-id
31233           in: path
31234           description: Unique id of VNF.  This is unique across the graph.
31235           required: true
31236           type: string
31237           example: __VNF-ID__
31238         - name: interface-name
31239           in: path
31240           description: Name that identifies the link aggregate interface
31241           required: true
31242           type: string
31243           example: __INTERFACE-NAME__
31244     put:
31245       tags:
31246         - Network
31247       summary: create or update an existing lag-interface
31248       description: |
31249         Create or update an existing lag-interface.
31250         #
31251         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31252       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31253       consumes:
31254         - application/json
31255         - application/xml
31256       produces:
31257         - application/json
31258         - application/xml
31259       responses:
31260         "default":
31261           description: Response codes found in [response codes](https://wiki.onap.org/).
31262       parameters:
31263         - name: vnf-id
31264           in: path
31265           description: Unique id of VNF.  This is unique across the graph.
31266           required: true
31267           type: string
31268           example: __VNF-ID__
31269         - name: interface-name
31270           in: path
31271           description: Name that identifies the link aggregate interface
31272           required: true
31273           type: string
31274           example: __INTERFACE-NAME__
31275         - name: body
31276           in: body
31277           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
31278           required: true
31279           schema:
31280             $ref: "#/definitions/lag-interface"
31281     patch:
31282       tags:
31283         - Network
31284       summary: update an existing lag-interface
31285       description: |
31286         Update an existing lag-interface
31287         #
31288         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31289         The PUT operation will entirely replace an existing object.
31290         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31291         #
31292         Other differences between PUT and PATCH are:
31293         #
31294         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31295         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31296         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31297       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31298       consumes:
31299         - application/json
31300         - application/xml
31301       produces:
31302         - application/json
31303         - application/xml
31304       responses:
31305         "default":
31306           description: Response codes found in [response codes](https://wiki.onap.org/).
31307       parameters:
31308         - name: vnf-id
31309           in: path
31310           description: Unique id of VNF.  This is unique across the graph.
31311           required: true
31312           type: string
31313           example: __VNF-ID__
31314         - name: interface-name
31315           in: path
31316           description: Name that identifies the link aggregate interface
31317           required: true
31318           type: string
31319           example: __INTERFACE-NAME__
31320         - name: body
31321           in: body
31322           description: lag-interface object that needs to be updated.
31323           required: true
31324           schema:
31325             $ref: "#/patchDefinitions/lag-interface"
31326     delete:
31327       tags:
31328         - Network
31329       summary: delete an existing lag-interface
31330       description: delete an existing lag-interface
31331       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31332       consumes:
31333         - application/json
31334         - application/xml
31335       produces:
31336         - application/json
31337         - application/xml
31338       responses:
31339         "default":
31340           description: Response codes found in [response codes](https://wiki.onap.org/).
31341       parameters:
31342         - name: vnf-id
31343           in: path
31344           description: Unique id of VNF.  This is unique across the graph.
31345           required: true
31346           type: string
31347           example: __VNF-ID__
31348         - name: interface-name
31349           in: path
31350           description: Name that identifies the link aggregate interface
31351           required: true
31352           type: string
31353           example: __INTERFACE-NAME__
31354         - name: resource-version
31355           in: query
31356           description: resource-version for concurrency
31357           required: true
31358           type: string
31359   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
31360     get:
31361       tags:
31362         - Network
31363       summary: returns lag-interfaces
31364       description: returns lag-interfaces
31365       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
31366       produces:
31367         - application/json
31368         - application/xml
31369       responses:
31370         "200":
31371           description: successful operation
31372           schema:
31373               $ref: "#/getDefinitions/lag-interfaces"
31374         "default":
31375           description: Response codes found in [response codes](https://wiki.onap.org/).
31376       parameters:
31377         - name: vnf-id
31378           in: path
31379           description: Unique id of VNF.  This is unique across the graph.
31380           required: true
31381           type: string
31382           example: __VNF-ID__
31383         - name: interface-name
31384           in: query
31385           description:
31386           required: false
31387           type: string
31388         - name: interface-id
31389           in: query
31390           description:
31391           required: false
31392           type: string
31393         - name: interface-role
31394           in: query
31395           description:
31396           required: false
31397           type: string
31398   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
31399     put:
31400       tags:
31401         - Network
31402       summary: see node definition for valid relationships
31403       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
31404       consumes:
31405         - application/json
31406         - application/xml
31407       produces:
31408         - application/json
31409         - application/xml
31410       responses:
31411         "default":
31412           description: Response codes found in [response codes](https://wiki.onap.org/).
31413       parameters:
31414         - name: vnf-id
31415           in: path
31416           description: Unique id of VNF.  This is unique across the graph.
31417           required: true
31418           type: string
31419           example: __VNF-ID__
31420         - name: vf-module-id
31421           in: path
31422           description: Unique ID of vf-module.
31423           required: true
31424           type: string
31425           example: __VF-MODULE-ID__
31426         - name: body
31427           in: body
31428           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
31429           required: true
31430           schema:
31431             $ref: "#/definitions/relationship"
31432     delete:
31433       tags:
31434         - Network
31435       summary: delete an existing relationship
31436       description: delete an existing relationship
31437       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
31438       consumes:
31439         - application/json
31440         - application/xml
31441       produces:
31442         - application/json
31443         - application/xml
31444       responses:
31445         "default":
31446           description: Response codes found in [response codes](https://wiki.onap.org/).
31447       parameters:
31448         - name: vnf-id
31449           in: path
31450           description: Unique id of VNF.  This is unique across the graph.
31451           required: true
31452           type: string
31453           example: __VNF-ID__
31454         - name: vf-module-id
31455           in: path
31456           description: Unique ID of vf-module.
31457           required: true
31458           type: string
31459           example: __VF-MODULE-ID__
31460   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
31461     get:
31462       tags:
31463         - Network
31464       summary: returns vf-module
31465       description: returns vf-module
31466       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
31467       produces:
31468         - application/json
31469         - application/xml
31470       responses:
31471         "200":
31472           description: successful operation
31473           schema:
31474               $ref: "#/getDefinitions/vf-module"
31475         "default":
31476           description: Response codes found in [response codes](https://wiki.onap.org/).
31477       parameters:
31478         - name: vnf-id
31479           in: path
31480           description: Unique id of VNF.  This is unique across the graph.
31481           required: true
31482           type: string
31483           example: __VNF-ID__
31484         - name: vf-module-id
31485           in: path
31486           description: Unique ID of vf-module.
31487           required: true
31488           type: string
31489           example: __VF-MODULE-ID__
31490     put:
31491       tags:
31492         - Network
31493       summary: create or update an existing vf-module
31494       description: |
31495         Create or update an existing vf-module.
31496         #
31497         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31498       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
31499       consumes:
31500         - application/json
31501         - application/xml
31502       produces:
31503         - application/json
31504         - application/xml
31505       responses:
31506         "default":
31507           description: Response codes found in [response codes](https://wiki.onap.org/).
31508       parameters:
31509         - name: vnf-id
31510           in: path
31511           description: Unique id of VNF.  This is unique across the graph.
31512           required: true
31513           type: string
31514           example: __VNF-ID__
31515         - name: vf-module-id
31516           in: path
31517           description: Unique ID of vf-module.
31518           required: true
31519           type: string
31520           example: __VF-MODULE-ID__
31521         - name: body
31522           in: body
31523           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
31524           required: true
31525           schema:
31526             $ref: "#/definitions/vf-module"
31527     patch:
31528       tags:
31529         - Network
31530       summary: update an existing vf-module
31531       description: |
31532         Update an existing vf-module
31533         #
31534         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31535         The PUT operation will entirely replace an existing object.
31536         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31537         #
31538         Other differences between PUT and PATCH are:
31539         #
31540         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31541         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31542         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31543       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
31544       consumes:
31545         - application/json
31546         - application/xml
31547       produces:
31548         - application/json
31549         - application/xml
31550       responses:
31551         "default":
31552           description: Response codes found in [response codes](https://wiki.onap.org/).
31553       parameters:
31554         - name: vnf-id
31555           in: path
31556           description: Unique id of VNF.  This is unique across the graph.
31557           required: true
31558           type: string
31559           example: __VNF-ID__
31560         - name: vf-module-id
31561           in: path
31562           description: Unique ID of vf-module.
31563           required: true
31564           type: string
31565           example: __VF-MODULE-ID__
31566         - name: body
31567           in: body
31568           description: vf-module object that needs to be updated.
31569           required: true
31570           schema:
31571             $ref: "#/patchDefinitions/vf-module"
31572     delete:
31573       tags:
31574         - Network
31575       summary: delete an existing vf-module
31576       description: delete an existing vf-module
31577       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
31578       consumes:
31579         - application/json
31580         - application/xml
31581       produces:
31582         - application/json
31583         - application/xml
31584       responses:
31585         "default":
31586           description: Response codes found in [response codes](https://wiki.onap.org/).
31587       parameters:
31588         - name: vnf-id
31589           in: path
31590           description: Unique id of VNF.  This is unique across the graph.
31591           required: true
31592           type: string
31593           example: __VNF-ID__
31594         - name: vf-module-id
31595           in: path
31596           description: Unique ID of vf-module.
31597           required: true
31598           type: string
31599           example: __VF-MODULE-ID__
31600         - name: resource-version
31601           in: query
31602           description: resource-version for concurrency
31603           required: true
31604           type: string
31605   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
31606     get:
31607       tags:
31608         - Network
31609       summary: returns vf-modules
31610       description: returns vf-modules
31611       operationId: getNetworkGenericVnfsGenericVnfVfModules
31612       produces:
31613         - application/json
31614         - application/xml
31615       responses:
31616         "200":
31617           description: successful operation
31618           schema:
31619               $ref: "#/getDefinitions/vf-modules"
31620         "default":
31621           description: Response codes found in [response codes](https://wiki.onap.org/).
31622       parameters:
31623         - name: vnf-id
31624           in: path
31625           description: Unique id of VNF.  This is unique across the graph.
31626           required: true
31627           type: string
31628           example: __VNF-ID__
31629         - name: vf-module-id
31630           in: query
31631           description:
31632           required: false
31633           type: string
31634         - name: vf-module-name
31635           in: query
31636           description:
31637           required: false
31638           type: string
31639         - name: heat-stack-id
31640           in: query
31641           description:
31642           required: false
31643           type: string
31644         - name: persona-model-id
31645           in: query
31646           description:
31647           required: false
31648           type: string
31649         - name: persona-model-version
31650           in: query
31651           description:
31652           required: false
31653           type: string
31654         - name: widget-model-id
31655           in: query
31656           description:
31657           required: false
31658           type: string
31659         - name: widget-model-version
31660           in: query
31661           description:
31662           required: false
31663           type: string
31664         - name: contrail-service-instance-fqdn
31665           in: query
31666           description:
31667           required: false
31668           type: string
31669   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31670     put:
31671       tags:
31672         - Network
31673       summary: see node definition for valid relationships
31674       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
31675       consumes:
31676         - application/json
31677         - application/xml
31678       produces:
31679         - application/json
31680         - application/xml
31681       responses:
31682         "default":
31683           description: Response codes found in [response codes](https://wiki.onap.org/).
31684       parameters:
31685         - name: vnf-id
31686           in: path
31687           description: Unique id of VNF.  This is unique across the graph.
31688           required: true
31689           type: string
31690           example: __VNF-ID__
31691         - name: group-uuid
31692           in: path
31693           description: Unique ID for the license group the resource belongs to, should be uuid.
31694           required: true
31695           type: string
31696           example: __GROUP-UUID__
31697         - name: resource-uuid
31698           in: path
31699           description: Unique ID of a license resource.
31700           required: true
31701           type: string
31702           example: __RESOURCE-UUID__
31703         - name: body
31704           in: body
31705           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)
31706           required: true
31707           schema:
31708             $ref: "#/definitions/relationship"
31709     delete:
31710       tags:
31711         - Network
31712       summary: delete an existing relationship
31713       description: delete an existing relationship
31714       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
31715       consumes:
31716         - application/json
31717         - application/xml
31718       produces:
31719         - application/json
31720         - application/xml
31721       responses:
31722         "default":
31723           description: Response codes found in [response codes](https://wiki.onap.org/).
31724       parameters:
31725         - name: vnf-id
31726           in: path
31727           description: Unique id of VNF.  This is unique across the graph.
31728           required: true
31729           type: string
31730           example: __VNF-ID__
31731         - name: group-uuid
31732           in: path
31733           description: Unique ID for the license group the resource belongs to, should be uuid.
31734           required: true
31735           type: string
31736           example: __GROUP-UUID__
31737         - name: resource-uuid
31738           in: path
31739           description: Unique ID of a license resource.
31740           required: true
31741           type: string
31742           example: __RESOURCE-UUID__
31743   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
31744     get:
31745       tags:
31746         - Network
31747       summary: returns license
31748       description: returns license
31749       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
31750       produces:
31751         - application/json
31752         - application/xml
31753       responses:
31754         "200":
31755           description: successful operation
31756           schema:
31757               $ref: "#/getDefinitions/license"
31758         "default":
31759           description: Response codes found in [response codes](https://wiki.onap.org/).
31760       parameters:
31761         - name: vnf-id
31762           in: path
31763           description: Unique id of VNF.  This is unique across the graph.
31764           required: true
31765           type: string
31766           example: __VNF-ID__
31767         - name: group-uuid
31768           in: path
31769           description: Unique ID for the license group the resource belongs to, should be uuid.
31770           required: true
31771           type: string
31772           example: __GROUP-UUID__
31773         - name: resource-uuid
31774           in: path
31775           description: Unique ID of a license resource.
31776           required: true
31777           type: string
31778           example: __RESOURCE-UUID__
31779     put:
31780       tags:
31781         - Network
31782       summary: create or update an existing license
31783       description: |
31784         Create or update an existing license.
31785         #
31786         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31787       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
31788       consumes:
31789         - application/json
31790         - application/xml
31791       produces:
31792         - application/json
31793         - application/xml
31794       responses:
31795         "default":
31796           description: Response codes found in [response codes](https://wiki.onap.org/).
31797       parameters:
31798         - name: vnf-id
31799           in: path
31800           description: Unique id of VNF.  This is unique across the graph.
31801           required: true
31802           type: string
31803           example: __VNF-ID__
31804         - name: group-uuid
31805           in: path
31806           description: Unique ID for the license group the resource belongs to, should be uuid.
31807           required: true
31808           type: string
31809           example: __GROUP-UUID__
31810         - name: resource-uuid
31811           in: path
31812           description: Unique ID of a license resource.
31813           required: true
31814           type: string
31815           example: __RESOURCE-UUID__
31816         - name: body
31817           in: body
31818           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)
31819           required: true
31820           schema:
31821             $ref: "#/definitions/license"
31822     patch:
31823       tags:
31824         - Network
31825       summary: update an existing license
31826       description: |
31827         Update an existing license
31828         #
31829         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31830         The PUT operation will entirely replace an existing object.
31831         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31832         #
31833         Other differences between PUT and PATCH are:
31834         #
31835         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31836         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31837         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31838       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
31839       consumes:
31840         - application/json
31841         - application/xml
31842       produces:
31843         - application/json
31844         - application/xml
31845       responses:
31846         "default":
31847           description: Response codes found in [response codes](https://wiki.onap.org/).
31848       parameters:
31849         - name: vnf-id
31850           in: path
31851           description: Unique id of VNF.  This is unique across the graph.
31852           required: true
31853           type: string
31854           example: __VNF-ID__
31855         - name: group-uuid
31856           in: path
31857           description: Unique ID for the license group the resource belongs to, should be uuid.
31858           required: true
31859           type: string
31860           example: __GROUP-UUID__
31861         - name: resource-uuid
31862           in: path
31863           description: Unique ID of a license resource.
31864           required: true
31865           type: string
31866           example: __RESOURCE-UUID__
31867         - name: body
31868           in: body
31869           description: license object that needs to be updated.
31870           required: true
31871           schema:
31872             $ref: "#/patchDefinitions/license"
31873     delete:
31874       tags:
31875         - Network
31876       summary: delete an existing license
31877       description: delete an existing license
31878       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
31879       consumes:
31880         - application/json
31881         - application/xml
31882       produces:
31883         - application/json
31884         - application/xml
31885       responses:
31886         "default":
31887           description: Response codes found in [response codes](https://wiki.onap.org/).
31888       parameters:
31889         - name: vnf-id
31890           in: path
31891           description: Unique id of VNF.  This is unique across the graph.
31892           required: true
31893           type: string
31894           example: __VNF-ID__
31895         - name: group-uuid
31896           in: path
31897           description: Unique ID for the license group the resource belongs to, should be uuid.
31898           required: true
31899           type: string
31900           example: __GROUP-UUID__
31901         - name: resource-uuid
31902           in: path
31903           description: Unique ID of a license resource.
31904           required: true
31905           type: string
31906           example: __RESOURCE-UUID__
31907         - name: resource-version
31908           in: query
31909           description: resource-version for concurrency
31910           required: true
31911           type: string
31912   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
31913     get:
31914       tags:
31915         - Network
31916       summary: returns licenses
31917       description: returns licenses
31918       operationId: getNetworkGenericVnfsGenericVnfLicenses
31919       produces:
31920         - application/json
31921         - application/xml
31922       responses:
31923         "200":
31924           description: successful operation
31925           schema:
31926               $ref: "#/getDefinitions/licenses"
31927         "default":
31928           description: Response codes found in [response codes](https://wiki.onap.org/).
31929       parameters:
31930         - name: vnf-id
31931           in: path
31932           description: Unique id of VNF.  This is unique across the graph.
31933           required: true
31934           type: string
31935           example: __VNF-ID__
31936         - name: group-uuid
31937           in: query
31938           description:
31939           required: false
31940           type: string
31941         - name: resource-uuid
31942           in: query
31943           description:
31944           required: false
31945           type: string
31946   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31947     put:
31948       tags:
31949         - Network
31950       summary: see node definition for valid relationships
31951       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
31952       consumes:
31953         - application/json
31954         - application/xml
31955       produces:
31956         - application/json
31957         - application/xml
31958       responses:
31959         "default":
31960           description: Response codes found in [response codes](https://wiki.onap.org/).
31961       parameters:
31962         - name: vnf-id
31963           in: path
31964           description: Unique id of VNF.  This is unique across the graph.
31965           required: true
31966           type: string
31967           example: __VNF-ID__
31968         - name: group-uuid
31969           in: path
31970           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31971           required: true
31972           type: string
31973           example: __GROUP-UUID__
31974         - name: resource-uuid
31975           in: path
31976           description: Unique ID of an entitlement resource.
31977           required: true
31978           type: string
31979           example: __RESOURCE-UUID__
31980         - name: body
31981           in: body
31982           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
31983           required: true
31984           schema:
31985             $ref: "#/definitions/relationship"
31986     delete:
31987       tags:
31988         - Network
31989       summary: delete an existing relationship
31990       description: delete an existing relationship
31991       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
31992       consumes:
31993         - application/json
31994         - application/xml
31995       produces:
31996         - application/json
31997         - application/xml
31998       responses:
31999         "default":
32000           description: Response codes found in [response codes](https://wiki.onap.org/).
32001       parameters:
32002         - name: vnf-id
32003           in: path
32004           description: Unique id of VNF.  This is unique across the graph.
32005           required: true
32006           type: string
32007           example: __VNF-ID__
32008         - name: group-uuid
32009           in: path
32010           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32011           required: true
32012           type: string
32013           example: __GROUP-UUID__
32014         - name: resource-uuid
32015           in: path
32016           description: Unique ID of an entitlement resource.
32017           required: true
32018           type: string
32019           example: __RESOURCE-UUID__
32020   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
32021     get:
32022       tags:
32023         - Network
32024       summary: returns entitlement
32025       description: returns entitlement
32026       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32027       produces:
32028         - application/json
32029         - application/xml
32030       responses:
32031         "200":
32032           description: successful operation
32033           schema:
32034               $ref: "#/getDefinitions/entitlement"
32035         "default":
32036           description: Response codes found in [response codes](https://wiki.onap.org/).
32037       parameters:
32038         - name: vnf-id
32039           in: path
32040           description: Unique id of VNF.  This is unique across the graph.
32041           required: true
32042           type: string
32043           example: __VNF-ID__
32044         - name: group-uuid
32045           in: path
32046           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32047           required: true
32048           type: string
32049           example: __GROUP-UUID__
32050         - name: resource-uuid
32051           in: path
32052           description: Unique ID of an entitlement resource.
32053           required: true
32054           type: string
32055           example: __RESOURCE-UUID__
32056     put:
32057       tags:
32058         - Network
32059       summary: create or update an existing entitlement
32060       description: |
32061         Create or update an existing entitlement.
32062         #
32063         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32064       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32065       consumes:
32066         - application/json
32067         - application/xml
32068       produces:
32069         - application/json
32070         - application/xml
32071       responses:
32072         "default":
32073           description: Response codes found in [response codes](https://wiki.onap.org/).
32074       parameters:
32075         - name: vnf-id
32076           in: path
32077           description: Unique id of VNF.  This is unique across the graph.
32078           required: true
32079           type: string
32080           example: __VNF-ID__
32081         - name: group-uuid
32082           in: path
32083           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32084           required: true
32085           type: string
32086           example: __GROUP-UUID__
32087         - name: resource-uuid
32088           in: path
32089           description: Unique ID of an entitlement resource.
32090           required: true
32091           type: string
32092           example: __RESOURCE-UUID__
32093         - name: body
32094           in: body
32095           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
32096           required: true
32097           schema:
32098             $ref: "#/definitions/entitlement"
32099     patch:
32100       tags:
32101         - Network
32102       summary: update an existing entitlement
32103       description: |
32104         Update an existing entitlement
32105         #
32106         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32107         The PUT operation will entirely replace an existing object.
32108         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32109         #
32110         Other differences between PUT and PATCH are:
32111         #
32112         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32113         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32114         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32115       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32116       consumes:
32117         - application/json
32118         - application/xml
32119       produces:
32120         - application/json
32121         - application/xml
32122       responses:
32123         "default":
32124           description: Response codes found in [response codes](https://wiki.onap.org/).
32125       parameters:
32126         - name: vnf-id
32127           in: path
32128           description: Unique id of VNF.  This is unique across the graph.
32129           required: true
32130           type: string
32131           example: __VNF-ID__
32132         - name: group-uuid
32133           in: path
32134           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32135           required: true
32136           type: string
32137           example: __GROUP-UUID__
32138         - name: resource-uuid
32139           in: path
32140           description: Unique ID of an entitlement resource.
32141           required: true
32142           type: string
32143           example: __RESOURCE-UUID__
32144         - name: body
32145           in: body
32146           description: entitlement object that needs to be updated.
32147           required: true
32148           schema:
32149             $ref: "#/patchDefinitions/entitlement"
32150     delete:
32151       tags:
32152         - Network
32153       summary: delete an existing entitlement
32154       description: delete an existing entitlement
32155       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
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: group-uuid
32173           in: path
32174           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32175           required: true
32176           type: string
32177           example: __GROUP-UUID__
32178         - name: resource-uuid
32179           in: path
32180           description: Unique ID of an entitlement resource.
32181           required: true
32182           type: string
32183           example: __RESOURCE-UUID__
32184         - name: resource-version
32185           in: query
32186           description: resource-version for concurrency
32187           required: true
32188           type: string
32189   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
32190     get:
32191       tags:
32192         - Network
32193       summary: returns entitlements
32194       description: returns entitlements
32195       operationId: getNetworkGenericVnfsGenericVnfEntitlements
32196       produces:
32197         - application/json
32198         - application/xml
32199       responses:
32200         "200":
32201           description: successful operation
32202           schema:
32203               $ref: "#/getDefinitions/entitlements"
32204         "default":
32205           description: Response codes found in [response codes](https://wiki.onap.org/).
32206       parameters:
32207         - name: vnf-id
32208           in: path
32209           description: Unique id of VNF.  This is unique across the graph.
32210           required: true
32211           type: string
32212           example: __VNF-ID__
32213         - name: group-uuid
32214           in: query
32215           description:
32216           required: false
32217           type: string
32218         - name: resource-uuid
32219           in: query
32220           description:
32221           required: false
32222           type: string
32223   /network/generic-vnfs/generic-vnf/{vnf-id}:
32224     get:
32225       tags:
32226         - Network
32227       summary: returns generic-vnf
32228       description: returns generic-vnf
32229       operationId: getNetworkGenericVnfsGenericVnf
32230       produces:
32231         - application/json
32232         - application/xml
32233       responses:
32234         "200":
32235           description: successful operation
32236           schema:
32237               $ref: "#/getDefinitions/generic-vnf"
32238         "default":
32239           description: Response codes found in [response codes](https://wiki.onap.org/).
32240       parameters:
32241         - name: vnf-id
32242           in: path
32243           description: Unique id of VNF.  This is unique across the graph.
32244           required: true
32245           type: string
32246           example: __VNF-ID__
32247     put:
32248       tags:
32249         - Network
32250       summary: create or update an existing generic-vnf
32251       description: |
32252         Create or update an existing generic-vnf.
32253         #
32254         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32255       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
32256       consumes:
32257         - application/json
32258         - application/xml
32259       produces:
32260         - application/json
32261         - application/xml
32262       responses:
32263         "default":
32264           description: Response codes found in [response codes](https://wiki.onap.org/).
32265       parameters:
32266         - name: vnf-id
32267           in: path
32268           description: Unique id of VNF.  This is unique across the graph.
32269           required: true
32270           type: string
32271           example: __VNF-ID__
32272         - name: body
32273           in: body
32274           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)
32275           required: true
32276           schema:
32277             $ref: "#/definitions/generic-vnf"
32278     patch:
32279       tags:
32280         - Network
32281       summary: update an existing generic-vnf
32282       description: |
32283         Update an existing generic-vnf
32284         #
32285         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32286         The PUT operation will entirely replace an existing object.
32287         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32288         #
32289         Other differences between PUT and PATCH are:
32290         #
32291         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32292         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32293         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32294       operationId: UpdateNetworkGenericVnfsGenericVnf
32295       consumes:
32296         - application/json
32297         - application/xml
32298       produces:
32299         - application/json
32300         - application/xml
32301       responses:
32302         "default":
32303           description: Response codes found in [response codes](https://wiki.onap.org/).
32304       parameters:
32305         - name: vnf-id
32306           in: path
32307           description: Unique id of VNF.  This is unique across the graph.
32308           required: true
32309           type: string
32310           example: __VNF-ID__
32311         - name: body
32312           in: body
32313           description: generic-vnf object that needs to be updated.
32314           required: true
32315           schema:
32316             $ref: "#/patchDefinitions/generic-vnf"
32317     delete:
32318       tags:
32319         - Network
32320       summary: delete an existing generic-vnf
32321       description: delete an existing generic-vnf
32322       operationId: deleteNetworkGenericVnfsGenericVnf
32323       consumes:
32324         - application/json
32325         - application/xml
32326       produces:
32327         - application/json
32328         - application/xml
32329       responses:
32330         "default":
32331           description: Response codes found in [response codes](https://wiki.onap.org/).
32332       parameters:
32333         - name: vnf-id
32334           in: path
32335           description: Unique id of VNF.  This is unique across the graph.
32336           required: true
32337           type: string
32338           example: __VNF-ID__
32339         - name: resource-version
32340           in: query
32341           description: resource-version for concurrency
32342           required: true
32343           type: string
32344   /network/generic-vnfs:
32345     get:
32346       tags:
32347         - Network
32348       summary: returns generic-vnfs
32349       description: returns generic-vnfs
32350       operationId: getNetworkGenericVnfs
32351       produces:
32352         - application/json
32353         - application/xml
32354       responses:
32355         "200":
32356           description: successful operation
32357           schema:
32358               $ref: "#/getDefinitions/generic-vnfs"
32359         "default":
32360           description: Response codes found in [response codes](https://wiki.onap.org/).
32361       parameters:
32362         - name: vnf-id
32363           in: query
32364           description:
32365           required: false
32366           type: string
32367         - name: vnf-name
32368           in: query
32369           description:
32370           required: false
32371           type: string
32372         - name: vnf-name2
32373           in: query
32374           description:
32375           required: false
32376           type: string
32377         - name: vnf-type
32378           in: query
32379           description:
32380           required: false
32381           type: string
32382         - name: service-id
32383           in: query
32384           description:
32385           required: false
32386           type: string
32387         - name: regional-resource-zone
32388           in: query
32389           description:
32390           required: false
32391           type: string
32392         - name: prov-status
32393           in: query
32394           description:
32395           required: false
32396           type: string
32397         - name: heat-stack-id
32398           in: query
32399           description:
32400           required: false
32401           type: string
32402         - name: in-maint
32403           in: query
32404           description:
32405           required: false
32406           type: boolean
32407         - name: is-closed-loop-disabled
32408           in: query
32409           description:
32410           required: false
32411           type: boolean
32412         - name: persona-model-id
32413           in: query
32414           description:
32415           required: false
32416           type: string
32417         - name: persona-model-version
32418           in: query
32419           description:
32420           required: false
32421           type: string
32422         - name: widget-model-id
32423           in: query
32424           description:
32425           required: false
32426           type: string
32427         - name: widget-model-version
32428           in: query
32429           description:
32430           required: false
32431           type: string
32432   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
32433     put:
32434       tags:
32435         - Network
32436       summary: see node definition for valid relationships
32437       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
32438       consumes:
32439         - application/json
32440         - application/xml
32441       produces:
32442         - application/json
32443         - application/xml
32444       responses:
32445         "default":
32446           description: Response codes found in [response codes](https://wiki.onap.org/).
32447       parameters:
32448         - name: link-name
32449           in: path
32450           description: Alphabetical concatenation of lag-interface names
32451           required: true
32452           type: string
32453           example: __LINK-NAME__
32454         - name: body
32455           in: body
32456           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)
32457           required: true
32458           schema:
32459             $ref: "#/definitions/relationship"
32460     delete:
32461       tags:
32462         - Network
32463       summary: delete an existing relationship
32464       description: delete an existing relationship
32465       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
32466       consumes:
32467         - application/json
32468         - application/xml
32469       produces:
32470         - application/json
32471         - application/xml
32472       responses:
32473         "default":
32474           description: Response codes found in [response codes](https://wiki.onap.org/).
32475       parameters:
32476         - name: link-name
32477           in: path
32478           description: Alphabetical concatenation of lag-interface names
32479           required: true
32480           type: string
32481           example: __LINK-NAME__
32482   /network/lag-links/lag-link/{link-name}:
32483     get:
32484       tags:
32485         - Network
32486       summary: returns lag-link
32487       description: returns lag-link
32488       operationId: getNetworkLagLinksLagLink
32489       produces:
32490         - application/json
32491         - application/xml
32492       responses:
32493         "200":
32494           description: successful operation
32495           schema:
32496               $ref: "#/getDefinitions/lag-link"
32497         "default":
32498           description: Response codes found in [response codes](https://wiki.onap.org/).
32499       parameters:
32500         - name: link-name
32501           in: path
32502           description: Alphabetical concatenation of lag-interface names
32503           required: true
32504           type: string
32505           example: __LINK-NAME__
32506     put:
32507       tags:
32508         - Network
32509       summary: create or update an existing lag-link
32510       description: |
32511         Create or update an existing lag-link.
32512         #
32513         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32514       operationId: createOrUpdateNetworkLagLinksLagLink
32515       consumes:
32516         - application/json
32517         - application/xml
32518       produces:
32519         - application/json
32520         - application/xml
32521       responses:
32522         "default":
32523           description: Response codes found in [response codes](https://wiki.onap.org/).
32524       parameters:
32525         - name: link-name
32526           in: path
32527           description: Alphabetical concatenation of lag-interface names
32528           required: true
32529           type: string
32530           example: __LINK-NAME__
32531         - name: body
32532           in: body
32533           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)
32534           required: true
32535           schema:
32536             $ref: "#/definitions/lag-link"
32537     patch:
32538       tags:
32539         - Network
32540       summary: update an existing lag-link
32541       description: |
32542         Update an existing lag-link
32543         #
32544         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32545         The PUT operation will entirely replace an existing object.
32546         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32547         #
32548         Other differences between PUT and PATCH are:
32549         #
32550         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32551         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32552         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32553       operationId: UpdateNetworkLagLinksLagLink
32554       consumes:
32555         - application/json
32556         - application/xml
32557       produces:
32558         - application/json
32559         - application/xml
32560       responses:
32561         "default":
32562           description: Response codes found in [response codes](https://wiki.onap.org/).
32563       parameters:
32564         - name: link-name
32565           in: path
32566           description: Alphabetical concatenation of lag-interface names
32567           required: true
32568           type: string
32569           example: __LINK-NAME__
32570         - name: body
32571           in: body
32572           description: lag-link object that needs to be updated.
32573           required: true
32574           schema:
32575             $ref: "#/patchDefinitions/lag-link"
32576     delete:
32577       tags:
32578         - Network
32579       summary: delete an existing lag-link
32580       description: delete an existing lag-link
32581       operationId: deleteNetworkLagLinksLagLink
32582       consumes:
32583         - application/json
32584         - application/xml
32585       produces:
32586         - application/json
32587         - application/xml
32588       responses:
32589         "default":
32590           description: Response codes found in [response codes](https://wiki.onap.org/).
32591       parameters:
32592         - name: link-name
32593           in: path
32594           description: Alphabetical concatenation of lag-interface names
32595           required: true
32596           type: string
32597           example: __LINK-NAME__
32598         - name: resource-version
32599           in: query
32600           description: resource-version for concurrency
32601           required: true
32602           type: string
32603   /network/lag-links:
32604     get:
32605       tags:
32606         - Network
32607       summary: returns lag-links
32608       description: returns lag-links
32609       operationId: getNetworkLagLinks
32610       produces:
32611         - application/json
32612         - application/xml
32613       responses:
32614         "200":
32615           description: successful operation
32616           schema:
32617               $ref: "#/getDefinitions/lag-links"
32618         "default":
32619           description: Response codes found in [response codes](https://wiki.onap.org/).
32620       parameters:
32621         - name: link-name
32622           in: query
32623           description:
32624           required: false
32625           type: string
32626   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
32627     put:
32628       tags:
32629         - Network
32630       summary: see node definition for valid relationships
32631       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
32632       consumes:
32633         - application/json
32634         - application/xml
32635       produces:
32636         - application/json
32637         - application/xml
32638       responses:
32639         "default":
32640           description: Response codes found in [response codes](https://wiki.onap.org/).
32641       parameters:
32642         - name: vnf-id2
32643           in: path
32644           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32645           required: true
32646           type: string
32647           example: __VNF-ID2__
32648         - name: body
32649           in: body
32650           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)
32651           required: true
32652           schema:
32653             $ref: "#/definitions/relationship"
32654     delete:
32655       tags:
32656         - Network
32657       summary: delete an existing relationship
32658       description: delete an existing relationship
32659       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
32660       consumes:
32661         - application/json
32662         - application/xml
32663       produces:
32664         - application/json
32665         - application/xml
32666       responses:
32667         "default":
32668           description: Response codes found in [response codes](https://wiki.onap.org/).
32669       parameters:
32670         - name: vnf-id2
32671           in: path
32672           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32673           required: true
32674           type: string
32675           example: __VNF-ID2__
32676   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
32677     put:
32678       tags:
32679         - Network
32680       summary: see node definition for valid relationships
32681       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32682       consumes:
32683         - application/json
32684         - application/xml
32685       produces:
32686         - application/json
32687         - application/xml
32688       responses:
32689         "default":
32690           description: Response codes found in [response codes](https://wiki.onap.org/).
32691       parameters:
32692         - name: vnf-id2
32693           in: path
32694           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32695           required: true
32696           type: string
32697           example: __VNF-ID2__
32698         - name: interface-name
32699           in: path
32700           description: Name given to the interface
32701           required: true
32702           type: string
32703           example: __INTERFACE-NAME__
32704         - name: vlan-interface
32705           in: path
32706           description: String that identifies the interface
32707           required: true
32708           type: string
32709           example: __VLAN-INTERFACE__
32710         - name: body
32711           in: body
32712           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
32713           required: true
32714           schema:
32715             $ref: "#/definitions/relationship"
32716     delete:
32717       tags:
32718         - Network
32719       summary: delete an existing relationship
32720       description: delete an existing relationship
32721       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32722       consumes:
32723         - application/json
32724         - application/xml
32725       produces:
32726         - application/json
32727         - application/xml
32728       responses:
32729         "default":
32730           description: Response codes found in [response codes](https://wiki.onap.org/).
32731       parameters:
32732         - name: vnf-id2
32733           in: path
32734           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32735           required: true
32736           type: string
32737           example: __VNF-ID2__
32738         - name: interface-name
32739           in: path
32740           description: Name given to the interface
32741           required: true
32742           type: string
32743           example: __INTERFACE-NAME__
32744         - name: vlan-interface
32745           in: path
32746           description: String that identifies the interface
32747           required: true
32748           type: string
32749           example: __VLAN-INTERFACE__
32750   /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:
32751     put:
32752       tags:
32753         - Network
32754       summary: see node definition for valid relationships
32755       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32756       consumes:
32757         - application/json
32758         - application/xml
32759       produces:
32760         - application/json
32761         - application/xml
32762       responses:
32763         "default":
32764           description: Response codes found in [response codes](https://wiki.onap.org/).
32765       parameters:
32766         - name: vnf-id2
32767           in: path
32768           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32769           required: true
32770           type: string
32771           example: __VNF-ID2__
32772         - name: interface-name
32773           in: path
32774           description: Name given to the interface
32775           required: true
32776           type: string
32777           example: __INTERFACE-NAME__
32778         - name: vlan-interface
32779           in: path
32780           description: String that identifies the interface
32781           required: true
32782           type: string
32783           example: __VLAN-INTERFACE__
32784         - name: l3-interface-ipv4-address
32785           in: path
32786           description: IP address
32787           required: true
32788           type: string
32789           example: __L3-INTERFACE-IPV4-ADDRESS__
32790         - name: body
32791           in: body
32792           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32793           required: true
32794           schema:
32795             $ref: "#/definitions/relationship"
32796     delete:
32797       tags:
32798         - Network
32799       summary: delete an existing relationship
32800       description: delete an existing relationship
32801       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32802       consumes:
32803         - application/json
32804         - application/xml
32805       produces:
32806         - application/json
32807         - application/xml
32808       responses:
32809         "default":
32810           description: Response codes found in [response codes](https://wiki.onap.org/).
32811       parameters:
32812         - name: vnf-id2
32813           in: path
32814           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32815           required: true
32816           type: string
32817           example: __VNF-ID2__
32818         - name: interface-name
32819           in: path
32820           description: Name given to the interface
32821           required: true
32822           type: string
32823           example: __INTERFACE-NAME__
32824         - name: vlan-interface
32825           in: path
32826           description: String that identifies the interface
32827           required: true
32828           type: string
32829           example: __VLAN-INTERFACE__
32830         - name: l3-interface-ipv4-address
32831           in: path
32832           description: IP address
32833           required: true
32834           type: string
32835           example: __L3-INTERFACE-IPV4-ADDRESS__
32836   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32837     get:
32838       tags:
32839         - Network
32840       summary: returns l3-interface-ipv4-address-list
32841       description: returns l3-interface-ipv4-address-list
32842       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32843       produces:
32844         - application/json
32845         - application/xml
32846       responses:
32847         "200":
32848           description: successful operation
32849           schema:
32850               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32851         "default":
32852           description: Response codes found in [response codes](https://wiki.onap.org/).
32853       parameters:
32854         - name: vnf-id2
32855           in: path
32856           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32857           required: true
32858           type: string
32859           example: __VNF-ID2__
32860         - name: interface-name
32861           in: path
32862           description: Name given to the interface
32863           required: true
32864           type: string
32865           example: __INTERFACE-NAME__
32866         - name: vlan-interface
32867           in: path
32868           description: String that identifies the interface
32869           required: true
32870           type: string
32871           example: __VLAN-INTERFACE__
32872         - name: l3-interface-ipv4-address
32873           in: path
32874           description: IP address
32875           required: true
32876           type: string
32877           example: __L3-INTERFACE-IPV4-ADDRESS__
32878     put:
32879       tags:
32880         - Network
32881       summary: create or update an existing l3-interface-ipv4-address-list
32882       description: |
32883         Create or update an existing l3-interface-ipv4-address-list.
32884         #
32885         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32886       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32887       consumes:
32888         - application/json
32889         - application/xml
32890       produces:
32891         - application/json
32892         - application/xml
32893       responses:
32894         "default":
32895           description: Response codes found in [response codes](https://wiki.onap.org/).
32896       parameters:
32897         - name: vnf-id2
32898           in: path
32899           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32900           required: true
32901           type: string
32902           example: __VNF-ID2__
32903         - name: interface-name
32904           in: path
32905           description: Name given to the interface
32906           required: true
32907           type: string
32908           example: __INTERFACE-NAME__
32909         - name: vlan-interface
32910           in: path
32911           description: String that identifies the interface
32912           required: true
32913           type: string
32914           example: __VLAN-INTERFACE__
32915         - name: l3-interface-ipv4-address
32916           in: path
32917           description: IP address
32918           required: true
32919           type: string
32920           example: __L3-INTERFACE-IPV4-ADDRESS__
32921         - name: body
32922           in: body
32923           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32924           required: true
32925           schema:
32926             $ref: "#/definitions/l3-interface-ipv4-address-list"
32927     patch:
32928       tags:
32929         - Network
32930       summary: update an existing l3-interface-ipv4-address-list
32931       description: |
32932         Update an existing l3-interface-ipv4-address-list
32933         #
32934         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32935         The PUT operation will entirely replace an existing object.
32936         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32937         #
32938         Other differences between PUT and PATCH are:
32939         #
32940         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32941         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32942         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32943       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32944       consumes:
32945         - application/json
32946         - application/xml
32947       produces:
32948         - application/json
32949         - application/xml
32950       responses:
32951         "default":
32952           description: Response codes found in [response codes](https://wiki.onap.org/).
32953       parameters:
32954         - name: vnf-id2
32955           in: path
32956           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32957           required: true
32958           type: string
32959           example: __VNF-ID2__
32960         - name: interface-name
32961           in: path
32962           description: Name given to the interface
32963           required: true
32964           type: string
32965           example: __INTERFACE-NAME__
32966         - name: vlan-interface
32967           in: path
32968           description: String that identifies the interface
32969           required: true
32970           type: string
32971           example: __VLAN-INTERFACE__
32972         - name: l3-interface-ipv4-address
32973           in: path
32974           description: IP address
32975           required: true
32976           type: string
32977           example: __L3-INTERFACE-IPV4-ADDRESS__
32978         - name: body
32979           in: body
32980           description: l3-interface-ipv4-address-list object that needs to be updated.
32981           required: true
32982           schema:
32983             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32984     delete:
32985       tags:
32986         - Network
32987       summary: delete an existing l3-interface-ipv4-address-list
32988       description: delete an existing l3-interface-ipv4-address-list
32989       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32990       consumes:
32991         - application/json
32992         - application/xml
32993       produces:
32994         - application/json
32995         - application/xml
32996       responses:
32997         "default":
32998           description: Response codes found in [response codes](https://wiki.onap.org/).
32999       parameters:
33000         - name: vnf-id2
33001           in: path
33002           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33003           required: true
33004           type: string
33005           example: __VNF-ID2__
33006         - name: interface-name
33007           in: path
33008           description: Name given to the interface
33009           required: true
33010           type: string
33011           example: __INTERFACE-NAME__
33012         - name: vlan-interface
33013           in: path
33014           description: String that identifies the interface
33015           required: true
33016           type: string
33017           example: __VLAN-INTERFACE__
33018         - name: l3-interface-ipv4-address
33019           in: path
33020           description: IP address
33021           required: true
33022           type: string
33023           example: __L3-INTERFACE-IPV4-ADDRESS__
33024         - name: resource-version
33025           in: query
33026           description: resource-version for concurrency
33027           required: true
33028           type: string
33029   /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:
33030     put:
33031       tags:
33032         - Network
33033       summary: see node definition for valid relationships
33034       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33035       consumes:
33036         - application/json
33037         - application/xml
33038       produces:
33039         - application/json
33040         - application/xml
33041       responses:
33042         "default":
33043           description: Response codes found in [response codes](https://wiki.onap.org/).
33044       parameters:
33045         - name: vnf-id2
33046           in: path
33047           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33048           required: true
33049           type: string
33050           example: __VNF-ID2__
33051         - name: interface-name
33052           in: path
33053           description: Name given to the interface
33054           required: true
33055           type: string
33056           example: __INTERFACE-NAME__
33057         - name: vlan-interface
33058           in: path
33059           description: String that identifies the interface
33060           required: true
33061           type: string
33062           example: __VLAN-INTERFACE__
33063         - name: l3-interface-ipv6-address
33064           in: path
33065           description: IP address
33066           required: true
33067           type: string
33068           example: __L3-INTERFACE-IPV6-ADDRESS__
33069         - name: body
33070           in: body
33071           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33072           required: true
33073           schema:
33074             $ref: "#/definitions/relationship"
33075     delete:
33076       tags:
33077         - Network
33078       summary: delete an existing relationship
33079       description: delete an existing relationship
33080       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33081       consumes:
33082         - application/json
33083         - application/xml
33084       produces:
33085         - application/json
33086         - application/xml
33087       responses:
33088         "default":
33089           description: Response codes found in [response codes](https://wiki.onap.org/).
33090       parameters:
33091         - name: vnf-id2
33092           in: path
33093           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33094           required: true
33095           type: string
33096           example: __VNF-ID2__
33097         - name: interface-name
33098           in: path
33099           description: Name given to the interface
33100           required: true
33101           type: string
33102           example: __INTERFACE-NAME__
33103         - name: vlan-interface
33104           in: path
33105           description: String that identifies the interface
33106           required: true
33107           type: string
33108           example: __VLAN-INTERFACE__
33109         - name: l3-interface-ipv6-address
33110           in: path
33111           description: IP address
33112           required: true
33113           type: string
33114           example: __L3-INTERFACE-IPV6-ADDRESS__
33115   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33116     get:
33117       tags:
33118         - Network
33119       summary: returns l3-interface-ipv6-address-list
33120       description: returns l3-interface-ipv6-address-list
33121       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33122       produces:
33123         - application/json
33124         - application/xml
33125       responses:
33126         "200":
33127           description: successful operation
33128           schema:
33129               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33130         "default":
33131           description: Response codes found in [response codes](https://wiki.onap.org/).
33132       parameters:
33133         - name: vnf-id2
33134           in: path
33135           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33136           required: true
33137           type: string
33138           example: __VNF-ID2__
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: vlan-interface
33146           in: path
33147           description: String that identifies the interface
33148           required: true
33149           type: string
33150           example: __VLAN-INTERFACE__
33151         - name: l3-interface-ipv6-address
33152           in: path
33153           description: IP address
33154           required: true
33155           type: string
33156           example: __L3-INTERFACE-IPV6-ADDRESS__
33157     put:
33158       tags:
33159         - Network
33160       summary: create or update an existing l3-interface-ipv6-address-list
33161       description: |
33162         Create or update an existing l3-interface-ipv6-address-list.
33163         #
33164         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33165       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33166       consumes:
33167         - application/json
33168         - application/xml
33169       produces:
33170         - application/json
33171         - application/xml
33172       responses:
33173         "default":
33174           description: Response codes found in [response codes](https://wiki.onap.org/).
33175       parameters:
33176         - name: vnf-id2
33177           in: path
33178           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33179           required: true
33180           type: string
33181           example: __VNF-ID2__
33182         - name: interface-name
33183           in: path
33184           description: Name given to the interface
33185           required: true
33186           type: string
33187           example: __INTERFACE-NAME__
33188         - name: vlan-interface
33189           in: path
33190           description: String that identifies the interface
33191           required: true
33192           type: string
33193           example: __VLAN-INTERFACE__
33194         - name: l3-interface-ipv6-address
33195           in: path
33196           description: IP address
33197           required: true
33198           type: string
33199           example: __L3-INTERFACE-IPV6-ADDRESS__
33200         - name: body
33201           in: body
33202           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33203           required: true
33204           schema:
33205             $ref: "#/definitions/l3-interface-ipv6-address-list"
33206     patch:
33207       tags:
33208         - Network
33209       summary: update an existing l3-interface-ipv6-address-list
33210       description: |
33211         Update an existing l3-interface-ipv6-address-list
33212         #
33213         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33214         The PUT operation will entirely replace an existing object.
33215         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33216         #
33217         Other differences between PUT and PATCH are:
33218         #
33219         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33220         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33221         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33222       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33223       consumes:
33224         - application/json
33225         - application/xml
33226       produces:
33227         - application/json
33228         - application/xml
33229       responses:
33230         "default":
33231           description: Response codes found in [response codes](https://wiki.onap.org/).
33232       parameters:
33233         - name: vnf-id2
33234           in: path
33235           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33236           required: true
33237           type: string
33238           example: __VNF-ID2__
33239         - name: interface-name
33240           in: path
33241           description: Name given to the interface
33242           required: true
33243           type: string
33244           example: __INTERFACE-NAME__
33245         - name: vlan-interface
33246           in: path
33247           description: String that identifies the interface
33248           required: true
33249           type: string
33250           example: __VLAN-INTERFACE__
33251         - name: l3-interface-ipv6-address
33252           in: path
33253           description: IP address
33254           required: true
33255           type: string
33256           example: __L3-INTERFACE-IPV6-ADDRESS__
33257         - name: body
33258           in: body
33259           description: l3-interface-ipv6-address-list object that needs to be updated.
33260           required: true
33261           schema:
33262             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33263     delete:
33264       tags:
33265         - Network
33266       summary: delete an existing l3-interface-ipv6-address-list
33267       description: delete an existing l3-interface-ipv6-address-list
33268       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33269       consumes:
33270         - application/json
33271         - application/xml
33272       produces:
33273         - application/json
33274         - application/xml
33275       responses:
33276         "default":
33277           description: Response codes found in [response codes](https://wiki.onap.org/).
33278       parameters:
33279         - name: vnf-id2
33280           in: path
33281           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33282           required: true
33283           type: string
33284           example: __VNF-ID2__
33285         - name: interface-name
33286           in: path
33287           description: Name given to the interface
33288           required: true
33289           type: string
33290           example: __INTERFACE-NAME__
33291         - name: vlan-interface
33292           in: path
33293           description: String that identifies the interface
33294           required: true
33295           type: string
33296           example: __VLAN-INTERFACE__
33297         - name: l3-interface-ipv6-address
33298           in: path
33299           description: IP address
33300           required: true
33301           type: string
33302           example: __L3-INTERFACE-IPV6-ADDRESS__
33303         - name: resource-version
33304           in: query
33305           description: resource-version for concurrency
33306           required: true
33307           type: string
33308   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
33309     get:
33310       tags:
33311         - Network
33312       summary: returns vlan
33313       description: returns vlan
33314       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33315       produces:
33316         - application/json
33317         - application/xml
33318       responses:
33319         "200":
33320           description: successful operation
33321           schema:
33322               $ref: "#/getDefinitions/vlan"
33323         "default":
33324           description: Response codes found in [response codes](https://wiki.onap.org/).
33325       parameters:
33326         - name: vnf-id2
33327           in: path
33328           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33329           required: true
33330           type: string
33331           example: __VNF-ID2__
33332         - name: interface-name
33333           in: path
33334           description: Name given to the interface
33335           required: true
33336           type: string
33337           example: __INTERFACE-NAME__
33338         - name: vlan-interface
33339           in: path
33340           description: String that identifies the interface
33341           required: true
33342           type: string
33343           example: __VLAN-INTERFACE__
33344     put:
33345       tags:
33346         - Network
33347       summary: create or update an existing vlan
33348       description: |
33349         Create or update an existing vlan.
33350         #
33351         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33352       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33353       consumes:
33354         - application/json
33355         - application/xml
33356       produces:
33357         - application/json
33358         - application/xml
33359       responses:
33360         "default":
33361           description: Response codes found in [response codes](https://wiki.onap.org/).
33362       parameters:
33363         - name: vnf-id2
33364           in: path
33365           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33366           required: true
33367           type: string
33368           example: __VNF-ID2__
33369         - name: interface-name
33370           in: path
33371           description: Name given to the interface
33372           required: true
33373           type: string
33374           example: __INTERFACE-NAME__
33375         - name: vlan-interface
33376           in: path
33377           description: String that identifies the interface
33378           required: true
33379           type: string
33380           example: __VLAN-INTERFACE__
33381         - name: body
33382           in: body
33383           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
33384           required: true
33385           schema:
33386             $ref: "#/definitions/vlan"
33387     patch:
33388       tags:
33389         - Network
33390       summary: update an existing vlan
33391       description: |
33392         Update an existing vlan
33393         #
33394         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33395         The PUT operation will entirely replace an existing object.
33396         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33397         #
33398         Other differences between PUT and PATCH are:
33399         #
33400         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33401         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33402         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33403       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33404       consumes:
33405         - application/json
33406         - application/xml
33407       produces:
33408         - application/json
33409         - application/xml
33410       responses:
33411         "default":
33412           description: Response codes found in [response codes](https://wiki.onap.org/).
33413       parameters:
33414         - name: vnf-id2
33415           in: path
33416           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33417           required: true
33418           type: string
33419           example: __VNF-ID2__
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: vlan-interface
33427           in: path
33428           description: String that identifies the interface
33429           required: true
33430           type: string
33431           example: __VLAN-INTERFACE__
33432         - name: body
33433           in: body
33434           description: vlan object that needs to be updated.
33435           required: true
33436           schema:
33437             $ref: "#/patchDefinitions/vlan"
33438     delete:
33439       tags:
33440         - Network
33441       summary: delete an existing vlan
33442       description: delete an existing vlan
33443       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33444       consumes:
33445         - application/json
33446         - application/xml
33447       produces:
33448         - application/json
33449         - application/xml
33450       responses:
33451         "default":
33452           description: Response codes found in [response codes](https://wiki.onap.org/).
33453       parameters:
33454         - name: vnf-id2
33455           in: path
33456           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33457           required: true
33458           type: string
33459           example: __VNF-ID2__
33460         - name: interface-name
33461           in: path
33462           description: Name given to the interface
33463           required: true
33464           type: string
33465           example: __INTERFACE-NAME__
33466         - name: vlan-interface
33467           in: path
33468           description: String that identifies the interface
33469           required: true
33470           type: string
33471           example: __VLAN-INTERFACE__
33472         - name: resource-version
33473           in: query
33474           description: resource-version for concurrency
33475           required: true
33476           type: string
33477   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
33478     get:
33479       tags:
33480         - Network
33481       summary: returns vlans
33482       description: returns vlans
33483       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
33484       produces:
33485         - application/json
33486         - application/xml
33487       responses:
33488         "200":
33489           description: successful operation
33490           schema:
33491               $ref: "#/getDefinitions/vlans"
33492         "default":
33493           description: Response codes found in [response codes](https://wiki.onap.org/).
33494       parameters:
33495         - name: vnf-id2
33496           in: path
33497           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33498           required: true
33499           type: string
33500           example: __VNF-ID2__
33501         - name: interface-name
33502           in: path
33503           description: Name given to the interface
33504           required: true
33505           type: string
33506           example: __INTERFACE-NAME__
33507         - name: vlan-interface
33508           in: query
33509           description:
33510           required: false
33511           type: string
33512         - name: vlan-id-inner
33513           in: query
33514           description:
33515           required: false
33516           type: integer
33517           format: int64
33518         - name: vpn-id
33519           in: query
33520           description:
33521           required: false
33522           type: string
33523   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
33524     put:
33525       tags:
33526         - Network
33527       summary: see node definition for valid relationships
33528       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33529       consumes:
33530         - application/json
33531         - application/xml
33532       produces:
33533         - application/json
33534         - application/xml
33535       responses:
33536         "default":
33537           description: Response codes found in [response codes](https://wiki.onap.org/).
33538       parameters:
33539         - name: vnf-id2
33540           in: path
33541           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33542           required: true
33543           type: string
33544           example: __VNF-ID2__
33545         - name: interface-name
33546           in: path
33547           description: Name given to the interface
33548           required: true
33549           type: string
33550           example: __INTERFACE-NAME__
33551         - name: pci-id
33552           in: path
33553           description: PCI ID used to identify the sriov-vf
33554           required: true
33555           type: string
33556           example: __PCI-ID__
33557         - name: body
33558           in: body
33559           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
33560           required: true
33561           schema:
33562             $ref: "#/definitions/relationship"
33563     delete:
33564       tags:
33565         - Network
33566       summary: delete an existing relationship
33567       description: delete an existing relationship
33568       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33569       consumes:
33570         - application/json
33571         - application/xml
33572       produces:
33573         - application/json
33574         - application/xml
33575       responses:
33576         "default":
33577           description: Response codes found in [response codes](https://wiki.onap.org/).
33578       parameters:
33579         - name: vnf-id2
33580           in: path
33581           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33582           required: true
33583           type: string
33584           example: __VNF-ID2__
33585         - name: interface-name
33586           in: path
33587           description: Name given to the interface
33588           required: true
33589           type: string
33590           example: __INTERFACE-NAME__
33591         - name: pci-id
33592           in: path
33593           description: PCI ID used to identify the sriov-vf
33594           required: true
33595           type: string
33596           example: __PCI-ID__
33597   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
33598     get:
33599       tags:
33600         - Network
33601       summary: returns sriov-vf
33602       description: returns sriov-vf
33603       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33604       produces:
33605         - application/json
33606         - application/xml
33607       responses:
33608         "200":
33609           description: successful operation
33610           schema:
33611               $ref: "#/getDefinitions/sriov-vf"
33612         "default":
33613           description: Response codes found in [response codes](https://wiki.onap.org/).
33614       parameters:
33615         - name: vnf-id2
33616           in: path
33617           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33618           required: true
33619           type: string
33620           example: __VNF-ID2__
33621         - name: interface-name
33622           in: path
33623           description: Name given to the interface
33624           required: true
33625           type: string
33626           example: __INTERFACE-NAME__
33627         - name: pci-id
33628           in: path
33629           description: PCI ID used to identify the sriov-vf
33630           required: true
33631           type: string
33632           example: __PCI-ID__
33633     put:
33634       tags:
33635         - Network
33636       summary: create or update an existing sriov-vf
33637       description: |
33638         Create or update an existing sriov-vf.
33639         #
33640         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33641       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33642       consumes:
33643         - application/json
33644         - application/xml
33645       produces:
33646         - application/json
33647         - application/xml
33648       responses:
33649         "default":
33650           description: Response codes found in [response codes](https://wiki.onap.org/).
33651       parameters:
33652         - name: vnf-id2
33653           in: path
33654           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33655           required: true
33656           type: string
33657           example: __VNF-ID2__
33658         - name: interface-name
33659           in: path
33660           description: Name given to the interface
33661           required: true
33662           type: string
33663           example: __INTERFACE-NAME__
33664         - name: pci-id
33665           in: path
33666           description: PCI ID used to identify the sriov-vf
33667           required: true
33668           type: string
33669           example: __PCI-ID__
33670         - name: body
33671           in: body
33672           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
33673           required: true
33674           schema:
33675             $ref: "#/definitions/sriov-vf"
33676     patch:
33677       tags:
33678         - Network
33679       summary: update an existing sriov-vf
33680       description: |
33681         Update an existing sriov-vf
33682         #
33683         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33684         The PUT operation will entirely replace an existing object.
33685         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33686         #
33687         Other differences between PUT and PATCH are:
33688         #
33689         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33690         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33691         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33692       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33693       consumes:
33694         - application/json
33695         - application/xml
33696       produces:
33697         - application/json
33698         - application/xml
33699       responses:
33700         "default":
33701           description: Response codes found in [response codes](https://wiki.onap.org/).
33702       parameters:
33703         - name: vnf-id2
33704           in: path
33705           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33706           required: true
33707           type: string
33708           example: __VNF-ID2__
33709         - name: interface-name
33710           in: path
33711           description: Name given to the interface
33712           required: true
33713           type: string
33714           example: __INTERFACE-NAME__
33715         - name: pci-id
33716           in: path
33717           description: PCI ID used to identify the sriov-vf
33718           required: true
33719           type: string
33720           example: __PCI-ID__
33721         - name: body
33722           in: body
33723           description: sriov-vf object that needs to be updated.
33724           required: true
33725           schema:
33726             $ref: "#/patchDefinitions/sriov-vf"
33727     delete:
33728       tags:
33729         - Network
33730       summary: delete an existing sriov-vf
33731       description: delete an existing sriov-vf
33732       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33733       consumes:
33734         - application/json
33735         - application/xml
33736       produces:
33737         - application/json
33738         - application/xml
33739       responses:
33740         "default":
33741           description: Response codes found in [response codes](https://wiki.onap.org/).
33742       parameters:
33743         - name: vnf-id2
33744           in: path
33745           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33746           required: true
33747           type: string
33748           example: __VNF-ID2__
33749         - name: interface-name
33750           in: path
33751           description: Name given to the interface
33752           required: true
33753           type: string
33754           example: __INTERFACE-NAME__
33755         - name: pci-id
33756           in: path
33757           description: PCI ID used to identify the sriov-vf
33758           required: true
33759           type: string
33760           example: __PCI-ID__
33761         - name: resource-version
33762           in: query
33763           description: resource-version for concurrency
33764           required: true
33765           type: string
33766   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
33767     get:
33768       tags:
33769         - Network
33770       summary: returns sriov-vfs
33771       description: returns sriov-vfs
33772       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
33773       produces:
33774         - application/json
33775         - application/xml
33776       responses:
33777         "200":
33778           description: successful operation
33779           schema:
33780               $ref: "#/getDefinitions/sriov-vfs"
33781         "default":
33782           description: Response codes found in [response codes](https://wiki.onap.org/).
33783       parameters:
33784         - name: vnf-id2
33785           in: path
33786           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33787           required: true
33788           type: string
33789           example: __VNF-ID2__
33790         - name: interface-name
33791           in: path
33792           description: Name given to the interface
33793           required: true
33794           type: string
33795           example: __INTERFACE-NAME__
33796         - name: pci-id
33797           in: query
33798           description:
33799           required: false
33800           type: string
33801         - name: vf-vlan-filter
33802           in: query
33803           description:
33804           required: false
33805           type: string
33806         - name: vf-mac-filter
33807           in: query
33808           description:
33809           required: false
33810           type: string
33811         - name: vf-vlan-strip
33812           in: query
33813           description:
33814           required: false
33815           type: boolean
33816         - name: neutron-network-id
33817           in: query
33818           description:
33819           required: false
33820           type: string
33821   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
33822     put:
33823       tags:
33824         - Network
33825       summary: see node definition for valid relationships
33826       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
33827       consumes:
33828         - application/json
33829         - application/xml
33830       produces:
33831         - application/json
33832         - application/xml
33833       responses:
33834         "default":
33835           description: Response codes found in [response codes](https://wiki.onap.org/).
33836       parameters:
33837         - name: vnf-id2
33838           in: path
33839           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33840           required: true
33841           type: string
33842           example: __VNF-ID2__
33843         - name: interface-name
33844           in: path
33845           description: Name given to the interface
33846           required: true
33847           type: string
33848           example: __INTERFACE-NAME__
33849         - name: body
33850           in: body
33851           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)
33852           required: true
33853           schema:
33854             $ref: "#/definitions/relationship"
33855     delete:
33856       tags:
33857         - Network
33858       summary: delete an existing relationship
33859       description: delete an existing relationship
33860       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
33861       consumes:
33862         - application/json
33863         - application/xml
33864       produces:
33865         - application/json
33866         - application/xml
33867       responses:
33868         "default":
33869           description: Response codes found in [response codes](https://wiki.onap.org/).
33870       parameters:
33871         - name: vnf-id2
33872           in: path
33873           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33874           required: true
33875           type: string
33876           example: __VNF-ID2__
33877         - name: interface-name
33878           in: path
33879           description: Name given to the interface
33880           required: true
33881           type: string
33882           example: __INTERFACE-NAME__
33883   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
33884     put:
33885       tags:
33886         - Network
33887       summary: see node definition for valid relationships
33888       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33889       consumes:
33890         - application/json
33891         - application/xml
33892       produces:
33893         - application/json
33894         - application/xml
33895       responses:
33896         "default":
33897           description: Response codes found in [response codes](https://wiki.onap.org/).
33898       parameters:
33899         - name: vnf-id2
33900           in: path
33901           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33902           required: true
33903           type: string
33904           example: __VNF-ID2__
33905         - name: interface-name
33906           in: path
33907           description: Name given to the interface
33908           required: true
33909           type: string
33910           example: __INTERFACE-NAME__
33911         - name: l3-interface-ipv4-address
33912           in: path
33913           description: IP address
33914           required: true
33915           type: string
33916           example: __L3-INTERFACE-IPV4-ADDRESS__
33917         - name: body
33918           in: body
33919           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
33920           required: true
33921           schema:
33922             $ref: "#/definitions/relationship"
33923     delete:
33924       tags:
33925         - Network
33926       summary: delete an existing relationship
33927       description: delete an existing relationship
33928       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33929       consumes:
33930         - application/json
33931         - application/xml
33932       produces:
33933         - application/json
33934         - application/xml
33935       responses:
33936         "default":
33937           description: Response codes found in [response codes](https://wiki.onap.org/).
33938       parameters:
33939         - name: vnf-id2
33940           in: path
33941           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33942           required: true
33943           type: string
33944           example: __VNF-ID2__
33945         - name: interface-name
33946           in: path
33947           description: Name given to the interface
33948           required: true
33949           type: string
33950           example: __INTERFACE-NAME__
33951         - name: l3-interface-ipv4-address
33952           in: path
33953           description: IP address
33954           required: true
33955           type: string
33956           example: __L3-INTERFACE-IPV4-ADDRESS__
33957   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
33958     get:
33959       tags:
33960         - Network
33961       summary: returns l3-interface-ipv4-address-list
33962       description: returns l3-interface-ipv4-address-list
33963       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33964       produces:
33965         - application/json
33966         - application/xml
33967       responses:
33968         "200":
33969           description: successful operation
33970           schema:
33971               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33972         "default":
33973           description: Response codes found in [response codes](https://wiki.onap.org/).
33974       parameters:
33975         - name: vnf-id2
33976           in: path
33977           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33978           required: true
33979           type: string
33980           example: __VNF-ID2__
33981         - name: interface-name
33982           in: path
33983           description: Name given to the interface
33984           required: true
33985           type: string
33986           example: __INTERFACE-NAME__
33987         - name: l3-interface-ipv4-address
33988           in: path
33989           description: IP address
33990           required: true
33991           type: string
33992           example: __L3-INTERFACE-IPV4-ADDRESS__
33993     put:
33994       tags:
33995         - Network
33996       summary: create or update an existing l3-interface-ipv4-address-list
33997       description: |
33998         Create or update an existing l3-interface-ipv4-address-list.
33999         #
34000         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34001       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34002       consumes:
34003         - application/json
34004         - application/xml
34005       produces:
34006         - application/json
34007         - application/xml
34008       responses:
34009         "default":
34010           description: Response codes found in [response codes](https://wiki.onap.org/).
34011       parameters:
34012         - name: vnf-id2
34013           in: path
34014           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34015           required: true
34016           type: string
34017           example: __VNF-ID2__
34018         - name: interface-name
34019           in: path
34020           description: Name given to the interface
34021           required: true
34022           type: string
34023           example: __INTERFACE-NAME__
34024         - name: l3-interface-ipv4-address
34025           in: path
34026           description: IP address
34027           required: true
34028           type: string
34029           example: __L3-INTERFACE-IPV4-ADDRESS__
34030         - name: body
34031           in: body
34032           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34033           required: true
34034           schema:
34035             $ref: "#/definitions/l3-interface-ipv4-address-list"
34036     patch:
34037       tags:
34038         - Network
34039       summary: update an existing l3-interface-ipv4-address-list
34040       description: |
34041         Update an existing l3-interface-ipv4-address-list
34042         #
34043         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34044         The PUT operation will entirely replace an existing object.
34045         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34046         #
34047         Other differences between PUT and PATCH are:
34048         #
34049         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34050         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34051         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34052       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34053       consumes:
34054         - application/json
34055         - application/xml
34056       produces:
34057         - application/json
34058         - application/xml
34059       responses:
34060         "default":
34061           description: Response codes found in [response codes](https://wiki.onap.org/).
34062       parameters:
34063         - name: vnf-id2
34064           in: path
34065           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34066           required: true
34067           type: string
34068           example: __VNF-ID2__
34069         - name: interface-name
34070           in: path
34071           description: Name given to the interface
34072           required: true
34073           type: string
34074           example: __INTERFACE-NAME__
34075         - name: l3-interface-ipv4-address
34076           in: path
34077           description: IP address
34078           required: true
34079           type: string
34080           example: __L3-INTERFACE-IPV4-ADDRESS__
34081         - name: body
34082           in: body
34083           description: l3-interface-ipv4-address-list object that needs to be updated.
34084           required: true
34085           schema:
34086             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34087     delete:
34088       tags:
34089         - Network
34090       summary: delete an existing l3-interface-ipv4-address-list
34091       description: delete an existing l3-interface-ipv4-address-list
34092       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34093       consumes:
34094         - application/json
34095         - application/xml
34096       produces:
34097         - application/json
34098         - application/xml
34099       responses:
34100         "default":
34101           description: Response codes found in [response codes](https://wiki.onap.org/).
34102       parameters:
34103         - name: vnf-id2
34104           in: path
34105           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34106           required: true
34107           type: string
34108           example: __VNF-ID2__
34109         - name: interface-name
34110           in: path
34111           description: Name given to the interface
34112           required: true
34113           type: string
34114           example: __INTERFACE-NAME__
34115         - name: l3-interface-ipv4-address
34116           in: path
34117           description: IP address
34118           required: true
34119           type: string
34120           example: __L3-INTERFACE-IPV4-ADDRESS__
34121         - name: resource-version
34122           in: query
34123           description: resource-version for concurrency
34124           required: true
34125           type: string
34126   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
34127     put:
34128       tags:
34129         - Network
34130       summary: see node definition for valid relationships
34131       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34132       consumes:
34133         - application/json
34134         - application/xml
34135       produces:
34136         - application/json
34137         - application/xml
34138       responses:
34139         "default":
34140           description: Response codes found in [response codes](https://wiki.onap.org/).
34141       parameters:
34142         - name: vnf-id2
34143           in: path
34144           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34145           required: true
34146           type: string
34147           example: __VNF-ID2__
34148         - name: interface-name
34149           in: path
34150           description: Name given to the interface
34151           required: true
34152           type: string
34153           example: __INTERFACE-NAME__
34154         - name: l3-interface-ipv6-address
34155           in: path
34156           description: IP address
34157           required: true
34158           type: string
34159           example: __L3-INTERFACE-IPV6-ADDRESS__
34160         - name: body
34161           in: body
34162           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34163           required: true
34164           schema:
34165             $ref: "#/definitions/relationship"
34166     delete:
34167       tags:
34168         - Network
34169       summary: delete an existing relationship
34170       description: delete an existing relationship
34171       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34172       consumes:
34173         - application/json
34174         - application/xml
34175       produces:
34176         - application/json
34177         - application/xml
34178       responses:
34179         "default":
34180           description: Response codes found in [response codes](https://wiki.onap.org/).
34181       parameters:
34182         - name: vnf-id2
34183           in: path
34184           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34185           required: true
34186           type: string
34187           example: __VNF-ID2__
34188         - name: interface-name
34189           in: path
34190           description: Name given to the interface
34191           required: true
34192           type: string
34193           example: __INTERFACE-NAME__
34194         - name: l3-interface-ipv6-address
34195           in: path
34196           description: IP address
34197           required: true
34198           type: string
34199           example: __L3-INTERFACE-IPV6-ADDRESS__
34200   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
34201     get:
34202       tags:
34203         - Network
34204       summary: returns l3-interface-ipv6-address-list
34205       description: returns l3-interface-ipv6-address-list
34206       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34207       produces:
34208         - application/json
34209         - application/xml
34210       responses:
34211         "200":
34212           description: successful operation
34213           schema:
34214               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34215         "default":
34216           description: Response codes found in [response codes](https://wiki.onap.org/).
34217       parameters:
34218         - name: vnf-id2
34219           in: path
34220           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34221           required: true
34222           type: string
34223           example: __VNF-ID2__
34224         - name: interface-name
34225           in: path
34226           description: Name given to the interface
34227           required: true
34228           type: string
34229           example: __INTERFACE-NAME__
34230         - name: l3-interface-ipv6-address
34231           in: path
34232           description: IP address
34233           required: true
34234           type: string
34235           example: __L3-INTERFACE-IPV6-ADDRESS__
34236     put:
34237       tags:
34238         - Network
34239       summary: create or update an existing l3-interface-ipv6-address-list
34240       description: |
34241         Create or update an existing l3-interface-ipv6-address-list.
34242         #
34243         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34244       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34245       consumes:
34246         - application/json
34247         - application/xml
34248       produces:
34249         - application/json
34250         - application/xml
34251       responses:
34252         "default":
34253           description: Response codes found in [response codes](https://wiki.onap.org/).
34254       parameters:
34255         - name: vnf-id2
34256           in: path
34257           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34258           required: true
34259           type: string
34260           example: __VNF-ID2__
34261         - name: interface-name
34262           in: path
34263           description: Name given to the interface
34264           required: true
34265           type: string
34266           example: __INTERFACE-NAME__
34267         - name: l3-interface-ipv6-address
34268           in: path
34269           description: IP address
34270           required: true
34271           type: string
34272           example: __L3-INTERFACE-IPV6-ADDRESS__
34273         - name: body
34274           in: body
34275           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34276           required: true
34277           schema:
34278             $ref: "#/definitions/l3-interface-ipv6-address-list"
34279     patch:
34280       tags:
34281         - Network
34282       summary: update an existing l3-interface-ipv6-address-list
34283       description: |
34284         Update an existing l3-interface-ipv6-address-list
34285         #
34286         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34287         The PUT operation will entirely replace an existing object.
34288         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34289         #
34290         Other differences between PUT and PATCH are:
34291         #
34292         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34293         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34294         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34295       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34296       consumes:
34297         - application/json
34298         - application/xml
34299       produces:
34300         - application/json
34301         - application/xml
34302       responses:
34303         "default":
34304           description: Response codes found in [response codes](https://wiki.onap.org/).
34305       parameters:
34306         - name: vnf-id2
34307           in: path
34308           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34309           required: true
34310           type: string
34311           example: __VNF-ID2__
34312         - name: interface-name
34313           in: path
34314           description: Name given to the interface
34315           required: true
34316           type: string
34317           example: __INTERFACE-NAME__
34318         - name: l3-interface-ipv6-address
34319           in: path
34320           description: IP address
34321           required: true
34322           type: string
34323           example: __L3-INTERFACE-IPV6-ADDRESS__
34324         - name: body
34325           in: body
34326           description: l3-interface-ipv6-address-list object that needs to be updated.
34327           required: true
34328           schema:
34329             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34330     delete:
34331       tags:
34332         - Network
34333       summary: delete an existing l3-interface-ipv6-address-list
34334       description: delete an existing l3-interface-ipv6-address-list
34335       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34336       consumes:
34337         - application/json
34338         - application/xml
34339       produces:
34340         - application/json
34341         - application/xml
34342       responses:
34343         "default":
34344           description: Response codes found in [response codes](https://wiki.onap.org/).
34345       parameters:
34346         - name: vnf-id2
34347           in: path
34348           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34349           required: true
34350           type: string
34351           example: __VNF-ID2__
34352         - name: interface-name
34353           in: path
34354           description: Name given to the interface
34355           required: true
34356           type: string
34357           example: __INTERFACE-NAME__
34358         - name: l3-interface-ipv6-address
34359           in: path
34360           description: IP address
34361           required: true
34362           type: string
34363           example: __L3-INTERFACE-IPV6-ADDRESS__
34364         - name: resource-version
34365           in: query
34366           description: resource-version for concurrency
34367           required: true
34368           type: string
34369   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
34370     get:
34371       tags:
34372         - Network
34373       summary: returns l-interface
34374       description: returns l-interface
34375       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
34376       produces:
34377         - application/json
34378         - application/xml
34379       responses:
34380         "200":
34381           description: successful operation
34382           schema:
34383               $ref: "#/getDefinitions/l-interface"
34384         "default":
34385           description: Response codes found in [response codes](https://wiki.onap.org/).
34386       parameters:
34387         - name: vnf-id2
34388           in: path
34389           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34390           required: true
34391           type: string
34392           example: __VNF-ID2__
34393         - name: interface-name
34394           in: path
34395           description: Name given to the interface
34396           required: true
34397           type: string
34398           example: __INTERFACE-NAME__
34399     put:
34400       tags:
34401         - Network
34402       summary: create or update an existing l-interface
34403       description: |
34404         Create or update an existing l-interface.
34405         #
34406         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34407       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
34408       consumes:
34409         - application/json
34410         - application/xml
34411       produces:
34412         - application/json
34413         - application/xml
34414       responses:
34415         "default":
34416           description: Response codes found in [response codes](https://wiki.onap.org/).
34417       parameters:
34418         - name: vnf-id2
34419           in: path
34420           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34421           required: true
34422           type: string
34423           example: __VNF-ID2__
34424         - name: interface-name
34425           in: path
34426           description: Name given to the interface
34427           required: true
34428           type: string
34429           example: __INTERFACE-NAME__
34430         - name: body
34431           in: body
34432           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)
34433           required: true
34434           schema:
34435             $ref: "#/definitions/l-interface"
34436     patch:
34437       tags:
34438         - Network
34439       summary: update an existing l-interface
34440       description: |
34441         Update an existing l-interface
34442         #
34443         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34444         The PUT operation will entirely replace an existing object.
34445         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34446         #
34447         Other differences between PUT and PATCH are:
34448         #
34449         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34450         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34451         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34452       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
34453       consumes:
34454         - application/json
34455         - application/xml
34456       produces:
34457         - application/json
34458         - application/xml
34459       responses:
34460         "default":
34461           description: Response codes found in [response codes](https://wiki.onap.org/).
34462       parameters:
34463         - name: vnf-id2
34464           in: path
34465           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34466           required: true
34467           type: string
34468           example: __VNF-ID2__
34469         - name: interface-name
34470           in: path
34471           description: Name given to the interface
34472           required: true
34473           type: string
34474           example: __INTERFACE-NAME__
34475         - name: body
34476           in: body
34477           description: l-interface object that needs to be updated.
34478           required: true
34479           schema:
34480             $ref: "#/patchDefinitions/l-interface"
34481     delete:
34482       tags:
34483         - Network
34484       summary: delete an existing l-interface
34485       description: delete an existing l-interface
34486       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
34487       consumes:
34488         - application/json
34489         - application/xml
34490       produces:
34491         - application/json
34492         - application/xml
34493       responses:
34494         "default":
34495           description: Response codes found in [response codes](https://wiki.onap.org/).
34496       parameters:
34497         - name: vnf-id2
34498           in: path
34499           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34500           required: true
34501           type: string
34502           example: __VNF-ID2__
34503         - name: interface-name
34504           in: path
34505           description: Name given to the interface
34506           required: true
34507           type: string
34508           example: __INTERFACE-NAME__
34509         - name: resource-version
34510           in: query
34511           description: resource-version for concurrency
34512           required: true
34513           type: string
34514   /network/newvces/newvce/{vnf-id2}/l-interfaces:
34515     get:
34516       tags:
34517         - Network
34518       summary: returns l-interfaces
34519       description: returns l-interfaces
34520       operationId: getNetworkNewvcesNewvceLInterfaces
34521       produces:
34522         - application/json
34523         - application/xml
34524       responses:
34525         "200":
34526           description: successful operation
34527           schema:
34528               $ref: "#/getDefinitions/l-interfaces"
34529         "default":
34530           description: Response codes found in [response codes](https://wiki.onap.org/).
34531       parameters:
34532         - name: vnf-id2
34533           in: path
34534           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34535           required: true
34536           type: string
34537           example: __VNF-ID2__
34538         - name: interface-name
34539           in: query
34540           description:
34541           required: false
34542           type: string
34543         - name: interface-id
34544           in: query
34545           description:
34546           required: false
34547           type: string
34548         - name: macaddr
34549           in: query
34550           description:
34551           required: false
34552           type: string
34553         - name: network-name
34554           in: query
34555           description:
34556           required: false
34557           type: string
34558   /network/newvces/newvce/{vnf-id2}:
34559     get:
34560       tags:
34561         - Network
34562       summary: returns newvce
34563       description: returns newvce
34564       operationId: getNetworkNewvcesNewvce
34565       produces:
34566         - application/json
34567         - application/xml
34568       responses:
34569         "200":
34570           description: successful operation
34571           schema:
34572               $ref: "#/getDefinitions/newvce"
34573         "default":
34574           description: Response codes found in [response codes](https://wiki.onap.org/).
34575       parameters:
34576         - name: vnf-id2
34577           in: path
34578           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34579           required: true
34580           type: string
34581           example: __VNF-ID2__
34582     put:
34583       tags:
34584         - Network
34585       summary: create or update an existing newvce
34586       description: |
34587         Create or update an existing newvce.
34588         #
34589         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34590       operationId: createOrUpdateNetworkNewvcesNewvce
34591       consumes:
34592         - application/json
34593         - application/xml
34594       produces:
34595         - application/json
34596         - application/xml
34597       responses:
34598         "default":
34599           description: Response codes found in [response codes](https://wiki.onap.org/).
34600       parameters:
34601         - name: vnf-id2
34602           in: path
34603           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34604           required: true
34605           type: string
34606           example: __VNF-ID2__
34607         - name: body
34608           in: body
34609           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)
34610           required: true
34611           schema:
34612             $ref: "#/definitions/newvce"
34613     patch:
34614       tags:
34615         - Network
34616       summary: update an existing newvce
34617       description: |
34618         Update an existing newvce
34619         #
34620         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34621         The PUT operation will entirely replace an existing object.
34622         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34623         #
34624         Other differences between PUT and PATCH are:
34625         #
34626         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34627         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34628         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34629       operationId: UpdateNetworkNewvcesNewvce
34630       consumes:
34631         - application/json
34632         - application/xml
34633       produces:
34634         - application/json
34635         - application/xml
34636       responses:
34637         "default":
34638           description: Response codes found in [response codes](https://wiki.onap.org/).
34639       parameters:
34640         - name: vnf-id2
34641           in: path
34642           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34643           required: true
34644           type: string
34645           example: __VNF-ID2__
34646         - name: body
34647           in: body
34648           description: newvce object that needs to be updated.
34649           required: true
34650           schema:
34651             $ref: "#/patchDefinitions/newvce"
34652     delete:
34653       tags:
34654         - Network
34655       summary: delete an existing newvce
34656       description: delete an existing newvce
34657       operationId: deleteNetworkNewvcesNewvce
34658       consumes:
34659         - application/json
34660         - application/xml
34661       produces:
34662         - application/json
34663         - application/xml
34664       responses:
34665         "default":
34666           description: Response codes found in [response codes](https://wiki.onap.org/).
34667       parameters:
34668         - name: vnf-id2
34669           in: path
34670           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34671           required: true
34672           type: string
34673           example: __VNF-ID2__
34674         - name: resource-version
34675           in: query
34676           description: resource-version for concurrency
34677           required: true
34678           type: string
34679   /network/newvces:
34680     get:
34681       tags:
34682         - Network
34683       summary: returns newvces
34684       description: returns newvces
34685       operationId: getNetworkNewvces
34686       produces:
34687         - application/json
34688         - application/xml
34689       responses:
34690         "200":
34691           description: successful operation
34692           schema:
34693               $ref: "#/getDefinitions/newvces"
34694         "default":
34695           description: Response codes found in [response codes](https://wiki.onap.org/).
34696       parameters:
34697         - name: vnf-id2
34698           in: query
34699           description:
34700           required: false
34701           type: string
34702         - name: vnf-name
34703           in: query
34704           description:
34705           required: false
34706           type: string
34707         - name: vnf-name2
34708           in: query
34709           description:
34710           required: false
34711           type: string
34712         - name: vnf-type
34713           in: query
34714           description:
34715           required: false
34716           type: string
34717         - name: prov-status
34718           in: query
34719           description:
34720           required: false
34721           type: string
34722         - name: heat-stack-id
34723           in: query
34724           description:
34725           required: false
34726           type: string
34727   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
34728     put:
34729       tags:
34730         - Network
34731       summary: see node definition for valid relationships
34732       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
34733       consumes:
34734         - application/json
34735         - application/xml
34736       produces:
34737         - application/json
34738         - application/xml
34739       responses:
34740         "default":
34741           description: Response codes found in [response codes](https://wiki.onap.org/).
34742       parameters:
34743         - name: pnf-name
34744           in: path
34745           description: unique name of Physical Network Function.
34746           required: true
34747           type: string
34748           example: __PNF-NAME__
34749         - name: body
34750           in: body
34751           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)
34752           required: true
34753           schema:
34754             $ref: "#/definitions/relationship"
34755     delete:
34756       tags:
34757         - Network
34758       summary: delete an existing relationship
34759       description: delete an existing relationship
34760       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
34761       consumes:
34762         - application/json
34763         - application/xml
34764       produces:
34765         - application/json
34766         - application/xml
34767       responses:
34768         "default":
34769           description: Response codes found in [response codes](https://wiki.onap.org/).
34770       parameters:
34771         - name: pnf-name
34772           in: path
34773           description: unique name of Physical Network Function.
34774           required: true
34775           type: string
34776           example: __PNF-NAME__
34777   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
34778     put:
34779       tags:
34780         - Network
34781       summary: see node definition for valid relationships
34782       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
34783       consumes:
34784         - application/json
34785         - application/xml
34786       produces:
34787         - application/json
34788         - application/xml
34789       responses:
34790         "default":
34791           description: Response codes found in [response codes](https://wiki.onap.org/).
34792       parameters:
34793         - name: pnf-name
34794           in: path
34795           description: unique name of Physical Network Function.
34796           required: true
34797           type: string
34798           example: __PNF-NAME__
34799         - name: interface-name
34800           in: path
34801           description: Name that identifies the physical interface
34802           required: true
34803           type: string
34804           example: __INTERFACE-NAME__
34805         - name: body
34806           in: body
34807           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)
34808           required: true
34809           schema:
34810             $ref: "#/definitions/relationship"
34811     delete:
34812       tags:
34813         - Network
34814       summary: delete an existing relationship
34815       description: delete an existing relationship
34816       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
34817       consumes:
34818         - application/json
34819         - application/xml
34820       produces:
34821         - application/json
34822         - application/xml
34823       responses:
34824         "default":
34825           description: Response codes found in [response codes](https://wiki.onap.org/).
34826       parameters:
34827         - name: pnf-name
34828           in: path
34829           description: unique name of Physical Network Function.
34830           required: true
34831           type: string
34832           example: __PNF-NAME__
34833         - name: interface-name
34834           in: path
34835           description: Name that identifies the physical interface
34836           required: true
34837           type: string
34838           example: __INTERFACE-NAME__
34839   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34840     put:
34841       tags:
34842         - Network
34843       summary: see node definition for valid relationships
34844       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34845       consumes:
34846         - application/json
34847         - application/xml
34848       produces:
34849         - application/json
34850         - application/xml
34851       responses:
34852         "default":
34853           description: Response codes found in [response codes](https://wiki.onap.org/).
34854       parameters:
34855         - name: pnf-name
34856           in: path
34857           description: unique name of Physical Network Function.
34858           required: true
34859           type: string
34860           example: __PNF-NAME__
34861         - name: interface-name
34862           in: path
34863           description: Name that identifies the physical interface
34864           required: true
34865           type: string
34866           example: __INTERFACE-NAME__
34867         - name: interface-name
34868           in: path
34869           description: Name given to the interface
34870           required: true
34871           type: string
34872           example: __INTERFACE-NAME__
34873         - name: vlan-interface
34874           in: path
34875           description: String that identifies the interface
34876           required: true
34877           type: string
34878           example: __VLAN-INTERFACE__
34879         - name: body
34880           in: body
34881           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
34882           required: true
34883           schema:
34884             $ref: "#/definitions/relationship"
34885     delete:
34886       tags:
34887         - Network
34888       summary: delete an existing relationship
34889       description: delete an existing relationship
34890       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34891       consumes:
34892         - application/json
34893         - application/xml
34894       produces:
34895         - application/json
34896         - application/xml
34897       responses:
34898         "default":
34899           description: Response codes found in [response codes](https://wiki.onap.org/).
34900       parameters:
34901         - name: pnf-name
34902           in: path
34903           description: unique name of Physical Network Function.
34904           required: true
34905           type: string
34906           example: __PNF-NAME__
34907         - name: interface-name
34908           in: path
34909           description: Name that identifies the physical interface
34910           required: true
34911           type: string
34912           example: __INTERFACE-NAME__
34913         - name: interface-name
34914           in: path
34915           description: Name given to the interface
34916           required: true
34917           type: string
34918           example: __INTERFACE-NAME__
34919         - name: vlan-interface
34920           in: path
34921           description: String that identifies the interface
34922           required: true
34923           type: string
34924           example: __VLAN-INTERFACE__
34925   /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:
34926     put:
34927       tags:
34928         - Network
34929       summary: see node definition for valid relationships
34930       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34931       consumes:
34932         - application/json
34933         - application/xml
34934       produces:
34935         - application/json
34936         - application/xml
34937       responses:
34938         "default":
34939           description: Response codes found in [response codes](https://wiki.onap.org/).
34940       parameters:
34941         - name: pnf-name
34942           in: path
34943           description: unique name of Physical Network Function.
34944           required: true
34945           type: string
34946           example: __PNF-NAME__
34947         - name: interface-name
34948           in: path
34949           description: Name that identifies the physical interface
34950           required: true
34951           type: string
34952           example: __INTERFACE-NAME__
34953         - name: interface-name
34954           in: path
34955           description: Name given to the interface
34956           required: true
34957           type: string
34958           example: __INTERFACE-NAME__
34959         - name: vlan-interface
34960           in: path
34961           description: String that identifies the interface
34962           required: true
34963           type: string
34964           example: __VLAN-INTERFACE__
34965         - name: l3-interface-ipv4-address
34966           in: path
34967           description: IP address
34968           required: true
34969           type: string
34970           example: __L3-INTERFACE-IPV4-ADDRESS__
34971         - name: body
34972           in: body
34973           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34974           required: true
34975           schema:
34976             $ref: "#/definitions/relationship"
34977     delete:
34978       tags:
34979         - Network
34980       summary: delete an existing relationship
34981       description: delete an existing relationship
34982       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34983       consumes:
34984         - application/json
34985         - application/xml
34986       produces:
34987         - application/json
34988         - application/xml
34989       responses:
34990         "default":
34991           description: Response codes found in [response codes](https://wiki.onap.org/).
34992       parameters:
34993         - name: pnf-name
34994           in: path
34995           description: unique name of Physical Network Function.
34996           required: true
34997           type: string
34998           example: __PNF-NAME__
34999         - name: interface-name
35000           in: path
35001           description: Name that identifies the physical interface
35002           required: true
35003           type: string
35004           example: __INTERFACE-NAME__
35005         - name: interface-name
35006           in: path
35007           description: Name given to the interface
35008           required: true
35009           type: string
35010           example: __INTERFACE-NAME__
35011         - name: vlan-interface
35012           in: path
35013           description: String that identifies the interface
35014           required: true
35015           type: string
35016           example: __VLAN-INTERFACE__
35017         - name: l3-interface-ipv4-address
35018           in: path
35019           description: IP address
35020           required: true
35021           type: string
35022           example: __L3-INTERFACE-IPV4-ADDRESS__
35023   /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}:
35024     get:
35025       tags:
35026         - Network
35027       summary: returns l3-interface-ipv4-address-list
35028       description: returns l3-interface-ipv4-address-list
35029       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35030       produces:
35031         - application/json
35032         - application/xml
35033       responses:
35034         "200":
35035           description: successful operation
35036           schema:
35037               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35038         "default":
35039           description: Response codes found in [response codes](https://wiki.onap.org/).
35040       parameters:
35041         - name: pnf-name
35042           in: path
35043           description: unique name of Physical Network Function.
35044           required: true
35045           type: string
35046           example: __PNF-NAME__
35047         - name: interface-name
35048           in: path
35049           description: Name that identifies the physical interface
35050           required: true
35051           type: string
35052           example: __INTERFACE-NAME__
35053         - name: interface-name
35054           in: path
35055           description: Name given to the interface
35056           required: true
35057           type: string
35058           example: __INTERFACE-NAME__
35059         - name: vlan-interface
35060           in: path
35061           description: String that identifies the interface
35062           required: true
35063           type: string
35064           example: __VLAN-INTERFACE__
35065         - name: l3-interface-ipv4-address
35066           in: path
35067           description: IP address
35068           required: true
35069           type: string
35070           example: __L3-INTERFACE-IPV4-ADDRESS__
35071     put:
35072       tags:
35073         - Network
35074       summary: create or update an existing l3-interface-ipv4-address-list
35075       description: |
35076         Create or update an existing l3-interface-ipv4-address-list.
35077         #
35078         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35079       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: pnf-name
35091           in: path
35092           description: unique name of Physical Network Function.
35093           required: true
35094           type: string
35095           example: __PNF-NAME__
35096         - name: interface-name
35097           in: path
35098           description: Name that identifies the physical interface
35099           required: true
35100           type: string
35101           example: __INTERFACE-NAME__
35102         - name: interface-name
35103           in: path
35104           description: Name given to the interface
35105           required: true
35106           type: string
35107           example: __INTERFACE-NAME__
35108         - name: vlan-interface
35109           in: path
35110           description: String that identifies the interface
35111           required: true
35112           type: string
35113           example: __VLAN-INTERFACE__
35114         - name: l3-interface-ipv4-address
35115           in: path
35116           description: IP address
35117           required: true
35118           type: string
35119           example: __L3-INTERFACE-IPV4-ADDRESS__
35120         - name: body
35121           in: body
35122           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35123           required: true
35124           schema:
35125             $ref: "#/definitions/l3-interface-ipv4-address-list"
35126     patch:
35127       tags:
35128         - Network
35129       summary: update an existing l3-interface-ipv4-address-list
35130       description: |
35131         Update an existing l3-interface-ipv4-address-list
35132         #
35133         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35134         The PUT operation will entirely replace an existing object.
35135         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35136         #
35137         Other differences between PUT and PATCH are:
35138         #
35139         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35140         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35141         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35142       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35143       consumes:
35144         - application/json
35145         - application/xml
35146       produces:
35147         - application/json
35148         - application/xml
35149       responses:
35150         "default":
35151           description: Response codes found in [response codes](https://wiki.onap.org/).
35152       parameters:
35153         - name: pnf-name
35154           in: path
35155           description: unique name of Physical Network Function.
35156           required: true
35157           type: string
35158           example: __PNF-NAME__
35159         - name: interface-name
35160           in: path
35161           description: Name that identifies the physical interface
35162           required: true
35163           type: string
35164           example: __INTERFACE-NAME__
35165         - name: interface-name
35166           in: path
35167           description: Name given to the interface
35168           required: true
35169           type: string
35170           example: __INTERFACE-NAME__
35171         - name: vlan-interface
35172           in: path
35173           description: String that identifies the interface
35174           required: true
35175           type: string
35176           example: __VLAN-INTERFACE__
35177         - name: l3-interface-ipv4-address
35178           in: path
35179           description: IP address
35180           required: true
35181           type: string
35182           example: __L3-INTERFACE-IPV4-ADDRESS__
35183         - name: body
35184           in: body
35185           description: l3-interface-ipv4-address-list object that needs to be updated.
35186           required: true
35187           schema:
35188             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35189     delete:
35190       tags:
35191         - Network
35192       summary: delete an existing l3-interface-ipv4-address-list
35193       description: delete an existing l3-interface-ipv4-address-list
35194       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35195       consumes:
35196         - application/json
35197         - application/xml
35198       produces:
35199         - application/json
35200         - application/xml
35201       responses:
35202         "default":
35203           description: Response codes found in [response codes](https://wiki.onap.org/).
35204       parameters:
35205         - name: pnf-name
35206           in: path
35207           description: unique name of Physical Network Function.
35208           required: true
35209           type: string
35210           example: __PNF-NAME__
35211         - name: interface-name
35212           in: path
35213           description: Name that identifies the physical interface
35214           required: true
35215           type: string
35216           example: __INTERFACE-NAME__
35217         - name: interface-name
35218           in: path
35219           description: Name given to the interface
35220           required: true
35221           type: string
35222           example: __INTERFACE-NAME__
35223         - name: vlan-interface
35224           in: path
35225           description: String that identifies the interface
35226           required: true
35227           type: string
35228           example: __VLAN-INTERFACE__
35229         - name: l3-interface-ipv4-address
35230           in: path
35231           description: IP address
35232           required: true
35233           type: string
35234           example: __L3-INTERFACE-IPV4-ADDRESS__
35235         - name: resource-version
35236           in: query
35237           description: resource-version for concurrency
35238           required: true
35239           type: string
35240   /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:
35241     put:
35242       tags:
35243         - Network
35244       summary: see node definition for valid relationships
35245       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35246       consumes:
35247         - application/json
35248         - application/xml
35249       produces:
35250         - application/json
35251         - application/xml
35252       responses:
35253         "default":
35254           description: Response codes found in [response codes](https://wiki.onap.org/).
35255       parameters:
35256         - name: pnf-name
35257           in: path
35258           description: unique name of Physical Network Function.
35259           required: true
35260           type: string
35261           example: __PNF-NAME__
35262         - name: interface-name
35263           in: path
35264           description: Name that identifies the physical interface
35265           required: true
35266           type: string
35267           example: __INTERFACE-NAME__
35268         - name: interface-name
35269           in: path
35270           description: Name given to the interface
35271           required: true
35272           type: string
35273           example: __INTERFACE-NAME__
35274         - name: vlan-interface
35275           in: path
35276           description: String that identifies the interface
35277           required: true
35278           type: string
35279           example: __VLAN-INTERFACE__
35280         - name: l3-interface-ipv6-address
35281           in: path
35282           description: IP address
35283           required: true
35284           type: string
35285           example: __L3-INTERFACE-IPV6-ADDRESS__
35286         - name: body
35287           in: body
35288           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35289           required: true
35290           schema:
35291             $ref: "#/definitions/relationship"
35292     delete:
35293       tags:
35294         - Network
35295       summary: delete an existing relationship
35296       description: delete an existing relationship
35297       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35298       consumes:
35299         - application/json
35300         - application/xml
35301       produces:
35302         - application/json
35303         - application/xml
35304       responses:
35305         "default":
35306           description: Response codes found in [response codes](https://wiki.onap.org/).
35307       parameters:
35308         - name: pnf-name
35309           in: path
35310           description: unique name of Physical Network Function.
35311           required: true
35312           type: string
35313           example: __PNF-NAME__
35314         - name: interface-name
35315           in: path
35316           description: Name that identifies the physical interface
35317           required: true
35318           type: string
35319           example: __INTERFACE-NAME__
35320         - name: interface-name
35321           in: path
35322           description: Name given to the interface
35323           required: true
35324           type: string
35325           example: __INTERFACE-NAME__
35326         - name: vlan-interface
35327           in: path
35328           description: String that identifies the interface
35329           required: true
35330           type: string
35331           example: __VLAN-INTERFACE__
35332         - name: l3-interface-ipv6-address
35333           in: path
35334           description: IP address
35335           required: true
35336           type: string
35337           example: __L3-INTERFACE-IPV6-ADDRESS__
35338   /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}:
35339     get:
35340       tags:
35341         - Network
35342       summary: returns l3-interface-ipv6-address-list
35343       description: returns l3-interface-ipv6-address-list
35344       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35345       produces:
35346         - application/json
35347         - application/xml
35348       responses:
35349         "200":
35350           description: successful operation
35351           schema:
35352               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35353         "default":
35354           description: Response codes found in [response codes](https://wiki.onap.org/).
35355       parameters:
35356         - name: pnf-name
35357           in: path
35358           description: unique name of Physical Network Function.
35359           required: true
35360           type: string
35361           example: __PNF-NAME__
35362         - name: interface-name
35363           in: path
35364           description: Name that identifies the physical interface
35365           required: true
35366           type: string
35367           example: __INTERFACE-NAME__
35368         - name: interface-name
35369           in: path
35370           description: Name given to the interface
35371           required: true
35372           type: string
35373           example: __INTERFACE-NAME__
35374         - name: vlan-interface
35375           in: path
35376           description: String that identifies the interface
35377           required: true
35378           type: string
35379           example: __VLAN-INTERFACE__
35380         - name: l3-interface-ipv6-address
35381           in: path
35382           description: IP address
35383           required: true
35384           type: string
35385           example: __L3-INTERFACE-IPV6-ADDRESS__
35386     put:
35387       tags:
35388         - Network
35389       summary: create or update an existing l3-interface-ipv6-address-list
35390       description: |
35391         Create or update an existing l3-interface-ipv6-address-list.
35392         #
35393         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35394       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35395       consumes:
35396         - application/json
35397         - application/xml
35398       produces:
35399         - application/json
35400         - application/xml
35401       responses:
35402         "default":
35403           description: Response codes found in [response codes](https://wiki.onap.org/).
35404       parameters:
35405         - name: pnf-name
35406           in: path
35407           description: unique name of Physical Network Function.
35408           required: true
35409           type: string
35410           example: __PNF-NAME__
35411         - name: interface-name
35412           in: path
35413           description: Name that identifies the physical interface
35414           required: true
35415           type: string
35416           example: __INTERFACE-NAME__
35417         - name: interface-name
35418           in: path
35419           description: Name given to the interface
35420           required: true
35421           type: string
35422           example: __INTERFACE-NAME__
35423         - name: vlan-interface
35424           in: path
35425           description: String that identifies the interface
35426           required: true
35427           type: string
35428           example: __VLAN-INTERFACE__
35429         - name: l3-interface-ipv6-address
35430           in: path
35431           description: IP address
35432           required: true
35433           type: string
35434           example: __L3-INTERFACE-IPV6-ADDRESS__
35435         - name: body
35436           in: body
35437           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35438           required: true
35439           schema:
35440             $ref: "#/definitions/l3-interface-ipv6-address-list"
35441     patch:
35442       tags:
35443         - Network
35444       summary: update an existing l3-interface-ipv6-address-list
35445       description: |
35446         Update an existing l3-interface-ipv6-address-list
35447         #
35448         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35449         The PUT operation will entirely replace an existing object.
35450         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35451         #
35452         Other differences between PUT and PATCH are:
35453         #
35454         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35455         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35456         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35457       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35458       consumes:
35459         - application/json
35460         - application/xml
35461       produces:
35462         - application/json
35463         - application/xml
35464       responses:
35465         "default":
35466           description: Response codes found in [response codes](https://wiki.onap.org/).
35467       parameters:
35468         - name: pnf-name
35469           in: path
35470           description: unique name of Physical Network Function.
35471           required: true
35472           type: string
35473           example: __PNF-NAME__
35474         - name: interface-name
35475           in: path
35476           description: Name that identifies the physical interface
35477           required: true
35478           type: string
35479           example: __INTERFACE-NAME__
35480         - name: interface-name
35481           in: path
35482           description: Name given to the interface
35483           required: true
35484           type: string
35485           example: __INTERFACE-NAME__
35486         - name: vlan-interface
35487           in: path
35488           description: String that identifies the interface
35489           required: true
35490           type: string
35491           example: __VLAN-INTERFACE__
35492         - name: l3-interface-ipv6-address
35493           in: path
35494           description: IP address
35495           required: true
35496           type: string
35497           example: __L3-INTERFACE-IPV6-ADDRESS__
35498         - name: body
35499           in: body
35500           description: l3-interface-ipv6-address-list object that needs to be updated.
35501           required: true
35502           schema:
35503             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35504     delete:
35505       tags:
35506         - Network
35507       summary: delete an existing l3-interface-ipv6-address-list
35508       description: delete an existing l3-interface-ipv6-address-list
35509       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35510       consumes:
35511         - application/json
35512         - application/xml
35513       produces:
35514         - application/json
35515         - application/xml
35516       responses:
35517         "default":
35518           description: Response codes found in [response codes](https://wiki.onap.org/).
35519       parameters:
35520         - name: pnf-name
35521           in: path
35522           description: unique name of Physical Network Function.
35523           required: true
35524           type: string
35525           example: __PNF-NAME__
35526         - name: interface-name
35527           in: path
35528           description: Name that identifies the physical interface
35529           required: true
35530           type: string
35531           example: __INTERFACE-NAME__
35532         - name: interface-name
35533           in: path
35534           description: Name given to the interface
35535           required: true
35536           type: string
35537           example: __INTERFACE-NAME__
35538         - name: vlan-interface
35539           in: path
35540           description: String that identifies the interface
35541           required: true
35542           type: string
35543           example: __VLAN-INTERFACE__
35544         - name: l3-interface-ipv6-address
35545           in: path
35546           description: IP address
35547           required: true
35548           type: string
35549           example: __L3-INTERFACE-IPV6-ADDRESS__
35550         - name: resource-version
35551           in: query
35552           description: resource-version for concurrency
35553           required: true
35554           type: string
35555   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35556     get:
35557       tags:
35558         - Network
35559       summary: returns vlan
35560       description: returns vlan
35561       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35562       produces:
35563         - application/json
35564         - application/xml
35565       responses:
35566         "200":
35567           description: successful operation
35568           schema:
35569               $ref: "#/getDefinitions/vlan"
35570         "default":
35571           description: Response codes found in [response codes](https://wiki.onap.org/).
35572       parameters:
35573         - name: pnf-name
35574           in: path
35575           description: unique name of Physical Network Function.
35576           required: true
35577           type: string
35578           example: __PNF-NAME__
35579         - name: interface-name
35580           in: path
35581           description: Name that identifies the physical interface
35582           required: true
35583           type: string
35584           example: __INTERFACE-NAME__
35585         - name: interface-name
35586           in: path
35587           description: Name given to the interface
35588           required: true
35589           type: string
35590           example: __INTERFACE-NAME__
35591         - name: vlan-interface
35592           in: path
35593           description: String that identifies the interface
35594           required: true
35595           type: string
35596           example: __VLAN-INTERFACE__
35597     put:
35598       tags:
35599         - Network
35600       summary: create or update an existing vlan
35601       description: |
35602         Create or update an existing vlan.
35603         #
35604         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35605       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35606       consumes:
35607         - application/json
35608         - application/xml
35609       produces:
35610         - application/json
35611         - application/xml
35612       responses:
35613         "default":
35614           description: Response codes found in [response codes](https://wiki.onap.org/).
35615       parameters:
35616         - name: pnf-name
35617           in: path
35618           description: unique name of Physical Network Function.
35619           required: true
35620           type: string
35621           example: __PNF-NAME__
35622         - name: interface-name
35623           in: path
35624           description: Name that identifies the physical interface
35625           required: true
35626           type: string
35627           example: __INTERFACE-NAME__
35628         - name: interface-name
35629           in: path
35630           description: Name given to the interface
35631           required: true
35632           type: string
35633           example: __INTERFACE-NAME__
35634         - name: vlan-interface
35635           in: path
35636           description: String that identifies the interface
35637           required: true
35638           type: string
35639           example: __VLAN-INTERFACE__
35640         - name: body
35641           in: body
35642           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
35643           required: true
35644           schema:
35645             $ref: "#/definitions/vlan"
35646     patch:
35647       tags:
35648         - Network
35649       summary: update an existing vlan
35650       description: |
35651         Update an existing vlan
35652         #
35653         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35654         The PUT operation will entirely replace an existing object.
35655         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35656         #
35657         Other differences between PUT and PATCH are:
35658         #
35659         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35660         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35661         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35662       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35663       consumes:
35664         - application/json
35665         - application/xml
35666       produces:
35667         - application/json
35668         - application/xml
35669       responses:
35670         "default":
35671           description: Response codes found in [response codes](https://wiki.onap.org/).
35672       parameters:
35673         - name: pnf-name
35674           in: path
35675           description: unique name of Physical Network Function.
35676           required: true
35677           type: string
35678           example: __PNF-NAME__
35679         - name: interface-name
35680           in: path
35681           description: Name that identifies the physical interface
35682           required: true
35683           type: string
35684           example: __INTERFACE-NAME__
35685         - name: interface-name
35686           in: path
35687           description: Name given to the interface
35688           required: true
35689           type: string
35690           example: __INTERFACE-NAME__
35691         - name: vlan-interface
35692           in: path
35693           description: String that identifies the interface
35694           required: true
35695           type: string
35696           example: __VLAN-INTERFACE__
35697         - name: body
35698           in: body
35699           description: vlan object that needs to be updated.
35700           required: true
35701           schema:
35702             $ref: "#/patchDefinitions/vlan"
35703     delete:
35704       tags:
35705         - Network
35706       summary: delete an existing vlan
35707       description: delete an existing vlan
35708       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35709       consumes:
35710         - application/json
35711         - application/xml
35712       produces:
35713         - application/json
35714         - application/xml
35715       responses:
35716         "default":
35717           description: Response codes found in [response codes](https://wiki.onap.org/).
35718       parameters:
35719         - name: pnf-name
35720           in: path
35721           description: unique name of Physical Network Function.
35722           required: true
35723           type: string
35724           example: __PNF-NAME__
35725         - name: interface-name
35726           in: path
35727           description: Name that identifies the physical interface
35728           required: true
35729           type: string
35730           example: __INTERFACE-NAME__
35731         - name: interface-name
35732           in: path
35733           description: Name given to the interface
35734           required: true
35735           type: string
35736           example: __INTERFACE-NAME__
35737         - name: vlan-interface
35738           in: path
35739           description: String that identifies the interface
35740           required: true
35741           type: string
35742           example: __VLAN-INTERFACE__
35743         - name: resource-version
35744           in: query
35745           description: resource-version for concurrency
35746           required: true
35747           type: string
35748   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
35749     get:
35750       tags:
35751         - Network
35752       summary: returns vlans
35753       description: returns vlans
35754       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
35755       produces:
35756         - application/json
35757         - application/xml
35758       responses:
35759         "200":
35760           description: successful operation
35761           schema:
35762               $ref: "#/getDefinitions/vlans"
35763         "default":
35764           description: Response codes found in [response codes](https://wiki.onap.org/).
35765       parameters:
35766         - name: pnf-name
35767           in: path
35768           description: unique name of Physical Network Function.
35769           required: true
35770           type: string
35771           example: __PNF-NAME__
35772         - name: interface-name
35773           in: path
35774           description: Name that identifies the physical interface
35775           required: true
35776           type: string
35777           example: __INTERFACE-NAME__
35778         - name: interface-name
35779           in: path
35780           description: Name given to the interface
35781           required: true
35782           type: string
35783           example: __INTERFACE-NAME__
35784         - name: vlan-interface
35785           in: query
35786           description:
35787           required: false
35788           type: string
35789         - name: vlan-id-inner
35790           in: query
35791           description:
35792           required: false
35793           type: integer
35794           format: int64
35795         - name: vpn-id
35796           in: query
35797           description:
35798           required: false
35799           type: string
35800   /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:
35801     put:
35802       tags:
35803         - Network
35804       summary: see node definition for valid relationships
35805       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35806       consumes:
35807         - application/json
35808         - application/xml
35809       produces:
35810         - application/json
35811         - application/xml
35812       responses:
35813         "default":
35814           description: Response codes found in [response codes](https://wiki.onap.org/).
35815       parameters:
35816         - name: pnf-name
35817           in: path
35818           description: unique name of Physical Network Function.
35819           required: true
35820           type: string
35821           example: __PNF-NAME__
35822         - name: interface-name
35823           in: path
35824           description: Name that identifies the physical interface
35825           required: true
35826           type: string
35827           example: __INTERFACE-NAME__
35828         - name: interface-name
35829           in: path
35830           description: Name given to the interface
35831           required: true
35832           type: string
35833           example: __INTERFACE-NAME__
35834         - name: pci-id
35835           in: path
35836           description: PCI ID used to identify the sriov-vf
35837           required: true
35838           type: string
35839           example: __PCI-ID__
35840         - name: body
35841           in: body
35842           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35843           required: true
35844           schema:
35845             $ref: "#/definitions/relationship"
35846     delete:
35847       tags:
35848         - Network
35849       summary: delete an existing relationship
35850       description: delete an existing relationship
35851       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35852       consumes:
35853         - application/json
35854         - application/xml
35855       produces:
35856         - application/json
35857         - application/xml
35858       responses:
35859         "default":
35860           description: Response codes found in [response codes](https://wiki.onap.org/).
35861       parameters:
35862         - name: pnf-name
35863           in: path
35864           description: unique name of Physical Network Function.
35865           required: true
35866           type: string
35867           example: __PNF-NAME__
35868         - name: interface-name
35869           in: path
35870           description: Name that identifies the physical interface
35871           required: true
35872           type: string
35873           example: __INTERFACE-NAME__
35874         - name: interface-name
35875           in: path
35876           description: Name given to the interface
35877           required: true
35878           type: string
35879           example: __INTERFACE-NAME__
35880         - name: pci-id
35881           in: path
35882           description: PCI ID used to identify the sriov-vf
35883           required: true
35884           type: string
35885           example: __PCI-ID__
35886   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
35887     get:
35888       tags:
35889         - Network
35890       summary: returns sriov-vf
35891       description: returns sriov-vf
35892       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35893       produces:
35894         - application/json
35895         - application/xml
35896       responses:
35897         "200":
35898           description: successful operation
35899           schema:
35900               $ref: "#/getDefinitions/sriov-vf"
35901         "default":
35902           description: Response codes found in [response codes](https://wiki.onap.org/).
35903       parameters:
35904         - name: pnf-name
35905           in: path
35906           description: unique name of Physical Network Function.
35907           required: true
35908           type: string
35909           example: __PNF-NAME__
35910         - name: interface-name
35911           in: path
35912           description: Name that identifies the physical interface
35913           required: true
35914           type: string
35915           example: __INTERFACE-NAME__
35916         - name: interface-name
35917           in: path
35918           description: Name given to the interface
35919           required: true
35920           type: string
35921           example: __INTERFACE-NAME__
35922         - name: pci-id
35923           in: path
35924           description: PCI ID used to identify the sriov-vf
35925           required: true
35926           type: string
35927           example: __PCI-ID__
35928     put:
35929       tags:
35930         - Network
35931       summary: create or update an existing sriov-vf
35932       description: |
35933         Create or update an existing sriov-vf.
35934         #
35935         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35936       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35937       consumes:
35938         - application/json
35939         - application/xml
35940       produces:
35941         - application/json
35942         - application/xml
35943       responses:
35944         "default":
35945           description: Response codes found in [response codes](https://wiki.onap.org/).
35946       parameters:
35947         - name: pnf-name
35948           in: path
35949           description: unique name of Physical Network Function.
35950           required: true
35951           type: string
35952           example: __PNF-NAME__
35953         - name: interface-name
35954           in: path
35955           description: Name that identifies the physical interface
35956           required: true
35957           type: string
35958           example: __INTERFACE-NAME__
35959         - name: interface-name
35960           in: path
35961           description: Name given to the interface
35962           required: true
35963           type: string
35964           example: __INTERFACE-NAME__
35965         - name: pci-id
35966           in: path
35967           description: PCI ID used to identify the sriov-vf
35968           required: true
35969           type: string
35970           example: __PCI-ID__
35971         - name: body
35972           in: body
35973           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35974           required: true
35975           schema:
35976             $ref: "#/definitions/sriov-vf"
35977     patch:
35978       tags:
35979         - Network
35980       summary: update an existing sriov-vf
35981       description: |
35982         Update an existing sriov-vf
35983         #
35984         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35985         The PUT operation will entirely replace an existing object.
35986         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35987         #
35988         Other differences between PUT and PATCH are:
35989         #
35990         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35991         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35992         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35993       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35994       consumes:
35995         - application/json
35996         - application/xml
35997       produces:
35998         - application/json
35999         - application/xml
36000       responses:
36001         "default":
36002           description: Response codes found in [response codes](https://wiki.onap.org/).
36003       parameters:
36004         - name: pnf-name
36005           in: path
36006           description: unique name of Physical Network Function.
36007           required: true
36008           type: string
36009           example: __PNF-NAME__
36010         - name: interface-name
36011           in: path
36012           description: Name that identifies the physical interface
36013           required: true
36014           type: string
36015           example: __INTERFACE-NAME__
36016         - name: interface-name
36017           in: path
36018           description: Name given to the interface
36019           required: true
36020           type: string
36021           example: __INTERFACE-NAME__
36022         - name: pci-id
36023           in: path
36024           description: PCI ID used to identify the sriov-vf
36025           required: true
36026           type: string
36027           example: __PCI-ID__
36028         - name: body
36029           in: body
36030           description: sriov-vf object that needs to be updated.
36031           required: true
36032           schema:
36033             $ref: "#/patchDefinitions/sriov-vf"
36034     delete:
36035       tags:
36036         - Network
36037       summary: delete an existing sriov-vf
36038       description: delete an existing sriov-vf
36039       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36040       consumes:
36041         - application/json
36042         - application/xml
36043       produces:
36044         - application/json
36045         - application/xml
36046       responses:
36047         "default":
36048           description: Response codes found in [response codes](https://wiki.onap.org/).
36049       parameters:
36050         - name: pnf-name
36051           in: path
36052           description: unique name of Physical Network Function.
36053           required: true
36054           type: string
36055           example: __PNF-NAME__
36056         - name: interface-name
36057           in: path
36058           description: Name that identifies the physical interface
36059           required: true
36060           type: string
36061           example: __INTERFACE-NAME__
36062         - name: interface-name
36063           in: path
36064           description: Name given to the interface
36065           required: true
36066           type: string
36067           example: __INTERFACE-NAME__
36068         - name: pci-id
36069           in: path
36070           description: PCI ID used to identify the sriov-vf
36071           required: true
36072           type: string
36073           example: __PCI-ID__
36074         - name: resource-version
36075           in: query
36076           description: resource-version for concurrency
36077           required: true
36078           type: string
36079   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36080     get:
36081       tags:
36082         - Network
36083       summary: returns sriov-vfs
36084       description: returns sriov-vfs
36085       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
36086       produces:
36087         - application/json
36088         - application/xml
36089       responses:
36090         "200":
36091           description: successful operation
36092           schema:
36093               $ref: "#/getDefinitions/sriov-vfs"
36094         "default":
36095           description: Response codes found in [response codes](https://wiki.onap.org/).
36096       parameters:
36097         - name: pnf-name
36098           in: path
36099           description: unique name of Physical Network Function.
36100           required: true
36101           type: string
36102           example: __PNF-NAME__
36103         - name: interface-name
36104           in: path
36105           description: Name that identifies the physical interface
36106           required: true
36107           type: string
36108           example: __INTERFACE-NAME__
36109         - name: interface-name
36110           in: path
36111           description: Name given to the interface
36112           required: true
36113           type: string
36114           example: __INTERFACE-NAME__
36115         - name: pci-id
36116           in: query
36117           description:
36118           required: false
36119           type: string
36120         - name: vf-vlan-filter
36121           in: query
36122           description:
36123           required: false
36124           type: string
36125         - name: vf-mac-filter
36126           in: query
36127           description:
36128           required: false
36129           type: string
36130         - name: vf-vlan-strip
36131           in: query
36132           description:
36133           required: false
36134           type: boolean
36135         - name: neutron-network-id
36136           in: query
36137           description:
36138           required: false
36139           type: string
36140   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36141     put:
36142       tags:
36143         - Network
36144       summary: see node definition for valid relationships
36145       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
36146       consumes:
36147         - application/json
36148         - application/xml
36149       produces:
36150         - application/json
36151         - application/xml
36152       responses:
36153         "default":
36154           description: Response codes found in [response codes](https://wiki.onap.org/).
36155       parameters:
36156         - name: pnf-name
36157           in: path
36158           description: unique name of Physical Network Function.
36159           required: true
36160           type: string
36161           example: __PNF-NAME__
36162         - name: interface-name
36163           in: path
36164           description: Name that identifies the physical interface
36165           required: true
36166           type: string
36167           example: __INTERFACE-NAME__
36168         - name: interface-name
36169           in: path
36170           description: Name given to the interface
36171           required: true
36172           type: string
36173           example: __INTERFACE-NAME__
36174         - name: body
36175           in: body
36176           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
36177           required: true
36178           schema:
36179             $ref: "#/definitions/relationship"
36180     delete:
36181       tags:
36182         - Network
36183       summary: delete an existing relationship
36184       description: delete an existing relationship
36185       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
36186       consumes:
36187         - application/json
36188         - application/xml
36189       produces:
36190         - application/json
36191         - application/xml
36192       responses:
36193         "default":
36194           description: Response codes found in [response codes](https://wiki.onap.org/).
36195       parameters:
36196         - name: pnf-name
36197           in: path
36198           description: unique name of Physical Network Function.
36199           required: true
36200           type: string
36201           example: __PNF-NAME__
36202         - name: interface-name
36203           in: path
36204           description: Name that identifies the physical interface
36205           required: true
36206           type: string
36207           example: __INTERFACE-NAME__
36208         - name: interface-name
36209           in: path
36210           description: Name given to the interface
36211           required: true
36212           type: string
36213           example: __INTERFACE-NAME__
36214   /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:
36215     put:
36216       tags:
36217         - Network
36218       summary: see node definition for valid relationships
36219       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36220       consumes:
36221         - application/json
36222         - application/xml
36223       produces:
36224         - application/json
36225         - application/xml
36226       responses:
36227         "default":
36228           description: Response codes found in [response codes](https://wiki.onap.org/).
36229       parameters:
36230         - name: pnf-name
36231           in: path
36232           description: unique name of Physical Network Function.
36233           required: true
36234           type: string
36235           example: __PNF-NAME__
36236         - name: interface-name
36237           in: path
36238           description: Name that identifies the physical interface
36239           required: true
36240           type: string
36241           example: __INTERFACE-NAME__
36242         - name: interface-name
36243           in: path
36244           description: Name given to the interface
36245           required: true
36246           type: string
36247           example: __INTERFACE-NAME__
36248         - name: l3-interface-ipv4-address
36249           in: path
36250           description: IP address
36251           required: true
36252           type: string
36253           example: __L3-INTERFACE-IPV4-ADDRESS__
36254         - name: body
36255           in: body
36256           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36257           required: true
36258           schema:
36259             $ref: "#/definitions/relationship"
36260     delete:
36261       tags:
36262         - Network
36263       summary: delete an existing relationship
36264       description: delete an existing relationship
36265       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36266       consumes:
36267         - application/json
36268         - application/xml
36269       produces:
36270         - application/json
36271         - application/xml
36272       responses:
36273         "default":
36274           description: Response codes found in [response codes](https://wiki.onap.org/).
36275       parameters:
36276         - name: pnf-name
36277           in: path
36278           description: unique name of Physical Network Function.
36279           required: true
36280           type: string
36281           example: __PNF-NAME__
36282         - name: interface-name
36283           in: path
36284           description: Name that identifies the physical interface
36285           required: true
36286           type: string
36287           example: __INTERFACE-NAME__
36288         - name: interface-name
36289           in: path
36290           description: Name given to the interface
36291           required: true
36292           type: string
36293           example: __INTERFACE-NAME__
36294         - name: l3-interface-ipv4-address
36295           in: path
36296           description: IP address
36297           required: true
36298           type: string
36299           example: __L3-INTERFACE-IPV4-ADDRESS__
36300   /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}:
36301     get:
36302       tags:
36303         - Network
36304       summary: returns l3-interface-ipv4-address-list
36305       description: returns l3-interface-ipv4-address-list
36306       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36307       produces:
36308         - application/json
36309         - application/xml
36310       responses:
36311         "200":
36312           description: successful operation
36313           schema:
36314               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36315         "default":
36316           description: Response codes found in [response codes](https://wiki.onap.org/).
36317       parameters:
36318         - name: pnf-name
36319           in: path
36320           description: unique name of Physical Network Function.
36321           required: true
36322           type: string
36323           example: __PNF-NAME__
36324         - name: interface-name
36325           in: path
36326           description: Name that identifies the physical interface
36327           required: true
36328           type: string
36329           example: __INTERFACE-NAME__
36330         - name: interface-name
36331           in: path
36332           description: Name given to the interface
36333           required: true
36334           type: string
36335           example: __INTERFACE-NAME__
36336         - name: l3-interface-ipv4-address
36337           in: path
36338           description: IP address
36339           required: true
36340           type: string
36341           example: __L3-INTERFACE-IPV4-ADDRESS__
36342     put:
36343       tags:
36344         - Network
36345       summary: create or update an existing l3-interface-ipv4-address-list
36346       description: |
36347         Create or update an existing l3-interface-ipv4-address-list.
36348         #
36349         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36350       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36351       consumes:
36352         - application/json
36353         - application/xml
36354       produces:
36355         - application/json
36356         - application/xml
36357       responses:
36358         "default":
36359           description: Response codes found in [response codes](https://wiki.onap.org/).
36360       parameters:
36361         - name: pnf-name
36362           in: path
36363           description: unique name of Physical Network Function.
36364           required: true
36365           type: string
36366           example: __PNF-NAME__
36367         - name: interface-name
36368           in: path
36369           description: Name that identifies the physical interface
36370           required: true
36371           type: string
36372           example: __INTERFACE-NAME__
36373         - name: interface-name
36374           in: path
36375           description: Name given to the interface
36376           required: true
36377           type: string
36378           example: __INTERFACE-NAME__
36379         - name: l3-interface-ipv4-address
36380           in: path
36381           description: IP address
36382           required: true
36383           type: string
36384           example: __L3-INTERFACE-IPV4-ADDRESS__
36385         - name: body
36386           in: body
36387           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36388           required: true
36389           schema:
36390             $ref: "#/definitions/l3-interface-ipv4-address-list"
36391     patch:
36392       tags:
36393         - Network
36394       summary: update an existing l3-interface-ipv4-address-list
36395       description: |
36396         Update an existing l3-interface-ipv4-address-list
36397         #
36398         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36399         The PUT operation will entirely replace an existing object.
36400         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36401         #
36402         Other differences between PUT and PATCH are:
36403         #
36404         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36405         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36406         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36407       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36408       consumes:
36409         - application/json
36410         - application/xml
36411       produces:
36412         - application/json
36413         - application/xml
36414       responses:
36415         "default":
36416           description: Response codes found in [response codes](https://wiki.onap.org/).
36417       parameters:
36418         - name: pnf-name
36419           in: path
36420           description: unique name of Physical Network Function.
36421           required: true
36422           type: string
36423           example: __PNF-NAME__
36424         - name: interface-name
36425           in: path
36426           description: Name that identifies the physical interface
36427           required: true
36428           type: string
36429           example: __INTERFACE-NAME__
36430         - name: interface-name
36431           in: path
36432           description: Name given to the interface
36433           required: true
36434           type: string
36435           example: __INTERFACE-NAME__
36436         - name: l3-interface-ipv4-address
36437           in: path
36438           description: IP address
36439           required: true
36440           type: string
36441           example: __L3-INTERFACE-IPV4-ADDRESS__
36442         - name: body
36443           in: body
36444           description: l3-interface-ipv4-address-list object that needs to be updated.
36445           required: true
36446           schema:
36447             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36448     delete:
36449       tags:
36450         - Network
36451       summary: delete an existing l3-interface-ipv4-address-list
36452       description: delete an existing l3-interface-ipv4-address-list
36453       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36454       consumes:
36455         - application/json
36456         - application/xml
36457       produces:
36458         - application/json
36459         - application/xml
36460       responses:
36461         "default":
36462           description: Response codes found in [response codes](https://wiki.onap.org/).
36463       parameters:
36464         - name: pnf-name
36465           in: path
36466           description: unique name of Physical Network Function.
36467           required: true
36468           type: string
36469           example: __PNF-NAME__
36470         - name: interface-name
36471           in: path
36472           description: Name that identifies the physical interface
36473           required: true
36474           type: string
36475           example: __INTERFACE-NAME__
36476         - name: interface-name
36477           in: path
36478           description: Name given to the interface
36479           required: true
36480           type: string
36481           example: __INTERFACE-NAME__
36482         - name: l3-interface-ipv4-address
36483           in: path
36484           description: IP address
36485           required: true
36486           type: string
36487           example: __L3-INTERFACE-IPV4-ADDRESS__
36488         - name: resource-version
36489           in: query
36490           description: resource-version for concurrency
36491           required: true
36492           type: string
36493   /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:
36494     put:
36495       tags:
36496         - Network
36497       summary: see node definition for valid relationships
36498       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36499       consumes:
36500         - application/json
36501         - application/xml
36502       produces:
36503         - application/json
36504         - application/xml
36505       responses:
36506         "default":
36507           description: Response codes found in [response codes](https://wiki.onap.org/).
36508       parameters:
36509         - name: pnf-name
36510           in: path
36511           description: unique name of Physical Network Function.
36512           required: true
36513           type: string
36514           example: __PNF-NAME__
36515         - name: interface-name
36516           in: path
36517           description: Name that identifies the physical interface
36518           required: true
36519           type: string
36520           example: __INTERFACE-NAME__
36521         - name: interface-name
36522           in: path
36523           description: Name given to the interface
36524           required: true
36525           type: string
36526           example: __INTERFACE-NAME__
36527         - name: l3-interface-ipv6-address
36528           in: path
36529           description: IP address
36530           required: true
36531           type: string
36532           example: __L3-INTERFACE-IPV6-ADDRESS__
36533         - name: body
36534           in: body
36535           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36536           required: true
36537           schema:
36538             $ref: "#/definitions/relationship"
36539     delete:
36540       tags:
36541         - Network
36542       summary: delete an existing relationship
36543       description: delete an existing relationship
36544       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36545       consumes:
36546         - application/json
36547         - application/xml
36548       produces:
36549         - application/json
36550         - application/xml
36551       responses:
36552         "default":
36553           description: Response codes found in [response codes](https://wiki.onap.org/).
36554       parameters:
36555         - name: pnf-name
36556           in: path
36557           description: unique name of Physical Network Function.
36558           required: true
36559           type: string
36560           example: __PNF-NAME__
36561         - name: interface-name
36562           in: path
36563           description: Name that identifies the physical interface
36564           required: true
36565           type: string
36566           example: __INTERFACE-NAME__
36567         - name: interface-name
36568           in: path
36569           description: Name given to the interface
36570           required: true
36571           type: string
36572           example: __INTERFACE-NAME__
36573         - name: l3-interface-ipv6-address
36574           in: path
36575           description: IP address
36576           required: true
36577           type: string
36578           example: __L3-INTERFACE-IPV6-ADDRESS__
36579   /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}:
36580     get:
36581       tags:
36582         - Network
36583       summary: returns l3-interface-ipv6-address-list
36584       description: returns l3-interface-ipv6-address-list
36585       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36586       produces:
36587         - application/json
36588         - application/xml
36589       responses:
36590         "200":
36591           description: successful operation
36592           schema:
36593               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36594         "default":
36595           description: Response codes found in [response codes](https://wiki.onap.org/).
36596       parameters:
36597         - name: pnf-name
36598           in: path
36599           description: unique name of Physical Network Function.
36600           required: true
36601           type: string
36602           example: __PNF-NAME__
36603         - name: interface-name
36604           in: path
36605           description: Name that identifies the physical interface
36606           required: true
36607           type: string
36608           example: __INTERFACE-NAME__
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: l3-interface-ipv6-address
36616           in: path
36617           description: IP address
36618           required: true
36619           type: string
36620           example: __L3-INTERFACE-IPV6-ADDRESS__
36621     put:
36622       tags:
36623         - Network
36624       summary: create or update an existing l3-interface-ipv6-address-list
36625       description: |
36626         Create or update an existing l3-interface-ipv6-address-list.
36627         #
36628         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36629       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36630       consumes:
36631         - application/json
36632         - application/xml
36633       produces:
36634         - application/json
36635         - application/xml
36636       responses:
36637         "default":
36638           description: Response codes found in [response codes](https://wiki.onap.org/).
36639       parameters:
36640         - name: pnf-name
36641           in: path
36642           description: unique name of Physical Network Function.
36643           required: true
36644           type: string
36645           example: __PNF-NAME__
36646         - name: interface-name
36647           in: path
36648           description: Name that identifies the physical interface
36649           required: true
36650           type: string
36651           example: __INTERFACE-NAME__
36652         - name: interface-name
36653           in: path
36654           description: Name given to the interface
36655           required: true
36656           type: string
36657           example: __INTERFACE-NAME__
36658         - name: l3-interface-ipv6-address
36659           in: path
36660           description: IP address
36661           required: true
36662           type: string
36663           example: __L3-INTERFACE-IPV6-ADDRESS__
36664         - name: body
36665           in: body
36666           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36667           required: true
36668           schema:
36669             $ref: "#/definitions/l3-interface-ipv6-address-list"
36670     patch:
36671       tags:
36672         - Network
36673       summary: update an existing l3-interface-ipv6-address-list
36674       description: |
36675         Update an existing l3-interface-ipv6-address-list
36676         #
36677         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36678         The PUT operation will entirely replace an existing object.
36679         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36680         #
36681         Other differences between PUT and PATCH are:
36682         #
36683         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36684         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36685         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36686       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36687       consumes:
36688         - application/json
36689         - application/xml
36690       produces:
36691         - application/json
36692         - application/xml
36693       responses:
36694         "default":
36695           description: Response codes found in [response codes](https://wiki.onap.org/).
36696       parameters:
36697         - name: pnf-name
36698           in: path
36699           description: unique name of Physical Network Function.
36700           required: true
36701           type: string
36702           example: __PNF-NAME__
36703         - name: interface-name
36704           in: path
36705           description: Name that identifies the physical interface
36706           required: true
36707           type: string
36708           example: __INTERFACE-NAME__
36709         - name: interface-name
36710           in: path
36711           description: Name given to the interface
36712           required: true
36713           type: string
36714           example: __INTERFACE-NAME__
36715         - name: l3-interface-ipv6-address
36716           in: path
36717           description: IP address
36718           required: true
36719           type: string
36720           example: __L3-INTERFACE-IPV6-ADDRESS__
36721         - name: body
36722           in: body
36723           description: l3-interface-ipv6-address-list object that needs to be updated.
36724           required: true
36725           schema:
36726             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36727     delete:
36728       tags:
36729         - Network
36730       summary: delete an existing l3-interface-ipv6-address-list
36731       description: delete an existing l3-interface-ipv6-address-list
36732       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36733       consumes:
36734         - application/json
36735         - application/xml
36736       produces:
36737         - application/json
36738         - application/xml
36739       responses:
36740         "default":
36741           description: Response codes found in [response codes](https://wiki.onap.org/).
36742       parameters:
36743         - name: pnf-name
36744           in: path
36745           description: unique name of Physical Network Function.
36746           required: true
36747           type: string
36748           example: __PNF-NAME__
36749         - name: interface-name
36750           in: path
36751           description: Name that identifies the physical interface
36752           required: true
36753           type: string
36754           example: __INTERFACE-NAME__
36755         - name: interface-name
36756           in: path
36757           description: Name given to the interface
36758           required: true
36759           type: string
36760           example: __INTERFACE-NAME__
36761         - name: l3-interface-ipv6-address
36762           in: path
36763           description: IP address
36764           required: true
36765           type: string
36766           example: __L3-INTERFACE-IPV6-ADDRESS__
36767         - name: resource-version
36768           in: query
36769           description: resource-version for concurrency
36770           required: true
36771           type: string
36772   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
36773     get:
36774       tags:
36775         - Network
36776       summary: returns l-interface
36777       description: returns l-interface
36778       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
36779       produces:
36780         - application/json
36781         - application/xml
36782       responses:
36783         "200":
36784           description: successful operation
36785           schema:
36786               $ref: "#/getDefinitions/l-interface"
36787         "default":
36788           description: Response codes found in [response codes](https://wiki.onap.org/).
36789       parameters:
36790         - name: pnf-name
36791           in: path
36792           description: unique name of Physical Network Function.
36793           required: true
36794           type: string
36795           example: __PNF-NAME__
36796         - name: interface-name
36797           in: path
36798           description: Name that identifies the physical interface
36799           required: true
36800           type: string
36801           example: __INTERFACE-NAME__
36802         - name: interface-name
36803           in: path
36804           description: Name given to the interface
36805           required: true
36806           type: string
36807           example: __INTERFACE-NAME__
36808     put:
36809       tags:
36810         - Network
36811       summary: create or update an existing l-interface
36812       description: |
36813         Create or update an existing l-interface.
36814         #
36815         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36816       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
36817       consumes:
36818         - application/json
36819         - application/xml
36820       produces:
36821         - application/json
36822         - application/xml
36823       responses:
36824         "default":
36825           description: Response codes found in [response codes](https://wiki.onap.org/).
36826       parameters:
36827         - name: pnf-name
36828           in: path
36829           description: unique name of Physical Network Function.
36830           required: true
36831           type: string
36832           example: __PNF-NAME__
36833         - name: interface-name
36834           in: path
36835           description: Name that identifies the physical interface
36836           required: true
36837           type: string
36838           example: __INTERFACE-NAME__
36839         - name: interface-name
36840           in: path
36841           description: Name given to the interface
36842           required: true
36843           type: string
36844           example: __INTERFACE-NAME__
36845         - name: body
36846           in: body
36847           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
36848           required: true
36849           schema:
36850             $ref: "#/definitions/l-interface"
36851     patch:
36852       tags:
36853         - Network
36854       summary: update an existing l-interface
36855       description: |
36856         Update an existing l-interface
36857         #
36858         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36859         The PUT operation will entirely replace an existing object.
36860         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36861         #
36862         Other differences between PUT and PATCH are:
36863         #
36864         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36865         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36866         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36867       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
36868       consumes:
36869         - application/json
36870         - application/xml
36871       produces:
36872         - application/json
36873         - application/xml
36874       responses:
36875         "default":
36876           description: Response codes found in [response codes](https://wiki.onap.org/).
36877       parameters:
36878         - name: pnf-name
36879           in: path
36880           description: unique name of Physical Network Function.
36881           required: true
36882           type: string
36883           example: __PNF-NAME__
36884         - name: interface-name
36885           in: path
36886           description: Name that identifies the physical interface
36887           required: true
36888           type: string
36889           example: __INTERFACE-NAME__
36890         - name: interface-name
36891           in: path
36892           description: Name given to the interface
36893           required: true
36894           type: string
36895           example: __INTERFACE-NAME__
36896         - name: body
36897           in: body
36898           description: l-interface object that needs to be updated.
36899           required: true
36900           schema:
36901             $ref: "#/patchDefinitions/l-interface"
36902     delete:
36903       tags:
36904         - Network
36905       summary: delete an existing l-interface
36906       description: delete an existing l-interface
36907       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
36908       consumes:
36909         - application/json
36910         - application/xml
36911       produces:
36912         - application/json
36913         - application/xml
36914       responses:
36915         "default":
36916           description: Response codes found in [response codes](https://wiki.onap.org/).
36917       parameters:
36918         - name: pnf-name
36919           in: path
36920           description: unique name of Physical Network Function.
36921           required: true
36922           type: string
36923           example: __PNF-NAME__
36924         - name: interface-name
36925           in: path
36926           description: Name that identifies the physical interface
36927           required: true
36928           type: string
36929           example: __INTERFACE-NAME__
36930         - name: interface-name
36931           in: path
36932           description: Name given to the interface
36933           required: true
36934           type: string
36935           example: __INTERFACE-NAME__
36936         - name: resource-version
36937           in: query
36938           description: resource-version for concurrency
36939           required: true
36940           type: string
36941   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
36942     get:
36943       tags:
36944         - Network
36945       summary: returns l-interfaces
36946       description: returns l-interfaces
36947       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
36948       produces:
36949         - application/json
36950         - application/xml
36951       responses:
36952         "200":
36953           description: successful operation
36954           schema:
36955               $ref: "#/getDefinitions/l-interfaces"
36956         "default":
36957           description: Response codes found in [response codes](https://wiki.onap.org/).
36958       parameters:
36959         - name: pnf-name
36960           in: path
36961           description: unique name of Physical Network Function.
36962           required: true
36963           type: string
36964           example: __PNF-NAME__
36965         - name: interface-name
36966           in: path
36967           description: Name that identifies the physical interface
36968           required: true
36969           type: string
36970           example: __INTERFACE-NAME__
36971         - name: interface-name
36972           in: query
36973           description:
36974           required: false
36975           type: string
36976         - name: interface-id
36977           in: query
36978           description:
36979           required: false
36980           type: string
36981         - name: macaddr
36982           in: query
36983           description:
36984           required: false
36985           type: string
36986         - name: network-name
36987           in: query
36988           description:
36989           required: false
36990           type: string
36991   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
36992     get:
36993       tags:
36994         - Network
36995       summary: returns p-interface
36996       description: returns p-interface
36997       operationId: getNetworkPnfsPnfPInterfacesPInterface
36998       produces:
36999         - application/json
37000         - application/xml
37001       responses:
37002         "200":
37003           description: successful operation
37004           schema:
37005               $ref: "#/getDefinitions/p-interface"
37006         "default":
37007           description: Response codes found in [response codes](https://wiki.onap.org/).
37008       parameters:
37009         - name: pnf-name
37010           in: path
37011           description: unique name of Physical Network Function.
37012           required: true
37013           type: string
37014           example: __PNF-NAME__
37015         - name: interface-name
37016           in: path
37017           description: Name that identifies the physical interface
37018           required: true
37019           type: string
37020           example: __INTERFACE-NAME__
37021     put:
37022       tags:
37023         - Network
37024       summary: create or update an existing p-interface
37025       description: |
37026         Create or update an existing p-interface.
37027         #
37028         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37029       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
37030       consumes:
37031         - application/json
37032         - application/xml
37033       produces:
37034         - application/json
37035         - application/xml
37036       responses:
37037         "default":
37038           description: Response codes found in [response codes](https://wiki.onap.org/).
37039       parameters:
37040         - name: pnf-name
37041           in: path
37042           description: unique name of Physical Network Function.
37043           required: true
37044           type: string
37045           example: __PNF-NAME__
37046         - name: interface-name
37047           in: path
37048           description: Name that identifies the physical interface
37049           required: true
37050           type: string
37051           example: __INTERFACE-NAME__
37052         - name: body
37053           in: body
37054           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)
37055           required: true
37056           schema:
37057             $ref: "#/definitions/p-interface"
37058     patch:
37059       tags:
37060         - Network
37061       summary: update an existing p-interface
37062       description: |
37063         Update an existing p-interface
37064         #
37065         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37066         The PUT operation will entirely replace an existing object.
37067         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37068         #
37069         Other differences between PUT and PATCH are:
37070         #
37071         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37072         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37073         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37074       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
37075       consumes:
37076         - application/json
37077         - application/xml
37078       produces:
37079         - application/json
37080         - application/xml
37081       responses:
37082         "default":
37083           description: Response codes found in [response codes](https://wiki.onap.org/).
37084       parameters:
37085         - name: pnf-name
37086           in: path
37087           description: unique name of Physical Network Function.
37088           required: true
37089           type: string
37090           example: __PNF-NAME__
37091         - name: interface-name
37092           in: path
37093           description: Name that identifies the physical interface
37094           required: true
37095           type: string
37096           example: __INTERFACE-NAME__
37097         - name: body
37098           in: body
37099           description: p-interface object that needs to be updated.
37100           required: true
37101           schema:
37102             $ref: "#/patchDefinitions/p-interface"
37103     delete:
37104       tags:
37105         - Network
37106       summary: delete an existing p-interface
37107       description: delete an existing p-interface
37108       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
37109       consumes:
37110         - application/json
37111         - application/xml
37112       produces:
37113         - application/json
37114         - application/xml
37115       responses:
37116         "default":
37117           description: Response codes found in [response codes](https://wiki.onap.org/).
37118       parameters:
37119         - name: pnf-name
37120           in: path
37121           description: unique name of Physical Network Function.
37122           required: true
37123           type: string
37124           example: __PNF-NAME__
37125         - name: interface-name
37126           in: path
37127           description: Name that identifies the physical interface
37128           required: true
37129           type: string
37130           example: __INTERFACE-NAME__
37131         - name: resource-version
37132           in: query
37133           description: resource-version for concurrency
37134           required: true
37135           type: string
37136   /network/pnfs/pnf/{pnf-name}/p-interfaces:
37137     get:
37138       tags:
37139         - Network
37140       summary: returns p-interfaces
37141       description: returns p-interfaces
37142       operationId: getNetworkPnfsPnfPInterfaces
37143       produces:
37144         - application/json
37145         - application/xml
37146       responses:
37147         "200":
37148           description: successful operation
37149           schema:
37150               $ref: "#/getDefinitions/p-interfaces"
37151         "default":
37152           description: Response codes found in [response codes](https://wiki.onap.org/).
37153       parameters:
37154         - name: pnf-name
37155           in: path
37156           description: unique name of Physical Network Function.
37157           required: true
37158           type: string
37159           example: __PNF-NAME__
37160         - name: interface-name
37161           in: query
37162           description:
37163           required: false
37164           type: string
37165         - name: prov-status
37166           in: query
37167           description:
37168           required: false
37169           type: string
37170   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
37171     put:
37172       tags:
37173         - Network
37174       summary: see node definition for valid relationships
37175       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
37176       consumes:
37177         - application/json
37178         - application/xml
37179       produces:
37180         - application/json
37181         - application/xml
37182       responses:
37183         "default":
37184           description: Response codes found in [response codes](https://wiki.onap.org/).
37185       parameters:
37186         - name: pnf-name
37187           in: path
37188           description: unique name of Physical Network Function.
37189           required: true
37190           type: string
37191           example: __PNF-NAME__
37192         - name: interface-name
37193           in: path
37194           description: Name that identifies the link aggregate interface
37195           required: true
37196           type: string
37197           example: __INTERFACE-NAME__
37198         - name: body
37199           in: body
37200           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)
37201           required: true
37202           schema:
37203             $ref: "#/definitions/relationship"
37204     delete:
37205       tags:
37206         - Network
37207       summary: delete an existing relationship
37208       description: delete an existing relationship
37209       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
37210       consumes:
37211         - application/json
37212         - application/xml
37213       produces:
37214         - application/json
37215         - application/xml
37216       responses:
37217         "default":
37218           description: Response codes found in [response codes](https://wiki.onap.org/).
37219       parameters:
37220         - name: pnf-name
37221           in: path
37222           description: unique name of Physical Network Function.
37223           required: true
37224           type: string
37225           example: __PNF-NAME__
37226         - name: interface-name
37227           in: path
37228           description: Name that identifies the link aggregate interface
37229           required: true
37230           type: string
37231           example: __INTERFACE-NAME__
37232   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
37233     put:
37234       tags:
37235         - Network
37236       summary: see node definition for valid relationships
37237       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37238       consumes:
37239         - application/json
37240         - application/xml
37241       produces:
37242         - application/json
37243         - application/xml
37244       responses:
37245         "default":
37246           description: Response codes found in [response codes](https://wiki.onap.org/).
37247       parameters:
37248         - name: pnf-name
37249           in: path
37250           description: unique name of Physical Network Function.
37251           required: true
37252           type: string
37253           example: __PNF-NAME__
37254         - name: interface-name
37255           in: path
37256           description: Name that identifies the link aggregate interface
37257           required: true
37258           type: string
37259           example: __INTERFACE-NAME__
37260         - name: interface-name
37261           in: path
37262           description: Name given to the interface
37263           required: true
37264           type: string
37265           example: __INTERFACE-NAME__
37266         - name: vlan-interface
37267           in: path
37268           description: String that identifies the interface
37269           required: true
37270           type: string
37271           example: __VLAN-INTERFACE__
37272         - name: body
37273           in: body
37274           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
37275           required: true
37276           schema:
37277             $ref: "#/definitions/relationship"
37278     delete:
37279       tags:
37280         - Network
37281       summary: delete an existing relationship
37282       description: delete an existing relationship
37283       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37284       consumes:
37285         - application/json
37286         - application/xml
37287       produces:
37288         - application/json
37289         - application/xml
37290       responses:
37291         "default":
37292           description: Response codes found in [response codes](https://wiki.onap.org/).
37293       parameters:
37294         - name: pnf-name
37295           in: path
37296           description: unique name of Physical Network Function.
37297           required: true
37298           type: string
37299           example: __PNF-NAME__
37300         - name: interface-name
37301           in: path
37302           description: Name that identifies the link aggregate interface
37303           required: true
37304           type: string
37305           example: __INTERFACE-NAME__
37306         - name: interface-name
37307           in: path
37308           description: Name given to the interface
37309           required: true
37310           type: string
37311           example: __INTERFACE-NAME__
37312         - name: vlan-interface
37313           in: path
37314           description: String that identifies the interface
37315           required: true
37316           type: string
37317           example: __VLAN-INTERFACE__
37318   /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:
37319     put:
37320       tags:
37321         - Network
37322       summary: see node definition for valid relationships
37323       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37324       consumes:
37325         - application/json
37326         - application/xml
37327       produces:
37328         - application/json
37329         - application/xml
37330       responses:
37331         "default":
37332           description: Response codes found in [response codes](https://wiki.onap.org/).
37333       parameters:
37334         - name: pnf-name
37335           in: path
37336           description: unique name of Physical Network Function.
37337           required: true
37338           type: string
37339           example: __PNF-NAME__
37340         - name: interface-name
37341           in: path
37342           description: Name that identifies the link aggregate interface
37343           required: true
37344           type: string
37345           example: __INTERFACE-NAME__
37346         - name: interface-name
37347           in: path
37348           description: Name given to the interface
37349           required: true
37350           type: string
37351           example: __INTERFACE-NAME__
37352         - name: vlan-interface
37353           in: path
37354           description: String that identifies the interface
37355           required: true
37356           type: string
37357           example: __VLAN-INTERFACE__
37358         - name: l3-interface-ipv4-address
37359           in: path
37360           description: IP address
37361           required: true
37362           type: string
37363           example: __L3-INTERFACE-IPV4-ADDRESS__
37364         - name: body
37365           in: body
37366           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37367           required: true
37368           schema:
37369             $ref: "#/definitions/relationship"
37370     delete:
37371       tags:
37372         - Network
37373       summary: delete an existing relationship
37374       description: delete an existing relationship
37375       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37376       consumes:
37377         - application/json
37378         - application/xml
37379       produces:
37380         - application/json
37381         - application/xml
37382       responses:
37383         "default":
37384           description: Response codes found in [response codes](https://wiki.onap.org/).
37385       parameters:
37386         - name: pnf-name
37387           in: path
37388           description: unique name of Physical Network Function.
37389           required: true
37390           type: string
37391           example: __PNF-NAME__
37392         - name: interface-name
37393           in: path
37394           description: Name that identifies the link aggregate interface
37395           required: true
37396           type: string
37397           example: __INTERFACE-NAME__
37398         - name: interface-name
37399           in: path
37400           description: Name given to the interface
37401           required: true
37402           type: string
37403           example: __INTERFACE-NAME__
37404         - name: vlan-interface
37405           in: path
37406           description: String that identifies the interface
37407           required: true
37408           type: string
37409           example: __VLAN-INTERFACE__
37410         - name: l3-interface-ipv4-address
37411           in: path
37412           description: IP address
37413           required: true
37414           type: string
37415           example: __L3-INTERFACE-IPV4-ADDRESS__
37416   /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}:
37417     get:
37418       tags:
37419         - Network
37420       summary: returns l3-interface-ipv4-address-list
37421       description: returns l3-interface-ipv4-address-list
37422       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37423       produces:
37424         - application/json
37425         - application/xml
37426       responses:
37427         "200":
37428           description: successful operation
37429           schema:
37430               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37431         "default":
37432           description: Response codes found in [response codes](https://wiki.onap.org/).
37433       parameters:
37434         - name: pnf-name
37435           in: path
37436           description: unique name of Physical Network Function.
37437           required: true
37438           type: string
37439           example: __PNF-NAME__
37440         - name: interface-name
37441           in: path
37442           description: Name that identifies the link aggregate interface
37443           required: true
37444           type: string
37445           example: __INTERFACE-NAME__
37446         - name: interface-name
37447           in: path
37448           description: Name given to the interface
37449           required: true
37450           type: string
37451           example: __INTERFACE-NAME__
37452         - name: vlan-interface
37453           in: path
37454           description: String that identifies the interface
37455           required: true
37456           type: string
37457           example: __VLAN-INTERFACE__
37458         - name: l3-interface-ipv4-address
37459           in: path
37460           description: IP address
37461           required: true
37462           type: string
37463           example: __L3-INTERFACE-IPV4-ADDRESS__
37464     put:
37465       tags:
37466         - Network
37467       summary: create or update an existing l3-interface-ipv4-address-list
37468       description: |
37469         Create or update an existing l3-interface-ipv4-address-list.
37470         #
37471         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37472       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37473       consumes:
37474         - application/json
37475         - application/xml
37476       produces:
37477         - application/json
37478         - application/xml
37479       responses:
37480         "default":
37481           description: Response codes found in [response codes](https://wiki.onap.org/).
37482       parameters:
37483         - name: pnf-name
37484           in: path
37485           description: unique name of Physical Network Function.
37486           required: true
37487           type: string
37488           example: __PNF-NAME__
37489         - name: interface-name
37490           in: path
37491           description: Name that identifies the link aggregate interface
37492           required: true
37493           type: string
37494           example: __INTERFACE-NAME__
37495         - name: interface-name
37496           in: path
37497           description: Name given to the interface
37498           required: true
37499           type: string
37500           example: __INTERFACE-NAME__
37501         - name: vlan-interface
37502           in: path
37503           description: String that identifies the interface
37504           required: true
37505           type: string
37506           example: __VLAN-INTERFACE__
37507         - name: l3-interface-ipv4-address
37508           in: path
37509           description: IP address
37510           required: true
37511           type: string
37512           example: __L3-INTERFACE-IPV4-ADDRESS__
37513         - name: body
37514           in: body
37515           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37516           required: true
37517           schema:
37518             $ref: "#/definitions/l3-interface-ipv4-address-list"
37519     patch:
37520       tags:
37521         - Network
37522       summary: update an existing l3-interface-ipv4-address-list
37523       description: |
37524         Update an existing l3-interface-ipv4-address-list
37525         #
37526         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37527         The PUT operation will entirely replace an existing object.
37528         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37529         #
37530         Other differences between PUT and PATCH are:
37531         #
37532         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37533         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37534         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37535       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37536       consumes:
37537         - application/json
37538         - application/xml
37539       produces:
37540         - application/json
37541         - application/xml
37542       responses:
37543         "default":
37544           description: Response codes found in [response codes](https://wiki.onap.org/).
37545       parameters:
37546         - name: pnf-name
37547           in: path
37548           description: unique name of Physical Network Function.
37549           required: true
37550           type: string
37551           example: __PNF-NAME__
37552         - name: interface-name
37553           in: path
37554           description: Name that identifies the link aggregate interface
37555           required: true
37556           type: string
37557           example: __INTERFACE-NAME__
37558         - name: interface-name
37559           in: path
37560           description: Name given to the interface
37561           required: true
37562           type: string
37563           example: __INTERFACE-NAME__
37564         - name: vlan-interface
37565           in: path
37566           description: String that identifies the interface
37567           required: true
37568           type: string
37569           example: __VLAN-INTERFACE__
37570         - name: l3-interface-ipv4-address
37571           in: path
37572           description: IP address
37573           required: true
37574           type: string
37575           example: __L3-INTERFACE-IPV4-ADDRESS__
37576         - name: body
37577           in: body
37578           description: l3-interface-ipv4-address-list object that needs to be updated.
37579           required: true
37580           schema:
37581             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37582     delete:
37583       tags:
37584         - Network
37585       summary: delete an existing l3-interface-ipv4-address-list
37586       description: delete an existing l3-interface-ipv4-address-list
37587       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37588       consumes:
37589         - application/json
37590         - application/xml
37591       produces:
37592         - application/json
37593         - application/xml
37594       responses:
37595         "default":
37596           description: Response codes found in [response codes](https://wiki.onap.org/).
37597       parameters:
37598         - name: pnf-name
37599           in: path
37600           description: unique name of Physical Network Function.
37601           required: true
37602           type: string
37603           example: __PNF-NAME__
37604         - name: interface-name
37605           in: path
37606           description: Name that identifies the link aggregate interface
37607           required: true
37608           type: string
37609           example: __INTERFACE-NAME__
37610         - name: interface-name
37611           in: path
37612           description: Name given to the interface
37613           required: true
37614           type: string
37615           example: __INTERFACE-NAME__
37616         - name: vlan-interface
37617           in: path
37618           description: String that identifies the interface
37619           required: true
37620           type: string
37621           example: __VLAN-INTERFACE__
37622         - name: l3-interface-ipv4-address
37623           in: path
37624           description: IP address
37625           required: true
37626           type: string
37627           example: __L3-INTERFACE-IPV4-ADDRESS__
37628         - name: resource-version
37629           in: query
37630           description: resource-version for concurrency
37631           required: true
37632           type: string
37633   /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:
37634     put:
37635       tags:
37636         - Network
37637       summary: see node definition for valid relationships
37638       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37639       consumes:
37640         - application/json
37641         - application/xml
37642       produces:
37643         - application/json
37644         - application/xml
37645       responses:
37646         "default":
37647           description: Response codes found in [response codes](https://wiki.onap.org/).
37648       parameters:
37649         - name: pnf-name
37650           in: path
37651           description: unique name of Physical Network Function.
37652           required: true
37653           type: string
37654           example: __PNF-NAME__
37655         - name: interface-name
37656           in: path
37657           description: Name that identifies the link aggregate interface
37658           required: true
37659           type: string
37660           example: __INTERFACE-NAME__
37661         - name: interface-name
37662           in: path
37663           description: Name given to the interface
37664           required: true
37665           type: string
37666           example: __INTERFACE-NAME__
37667         - name: vlan-interface
37668           in: path
37669           description: String that identifies the interface
37670           required: true
37671           type: string
37672           example: __VLAN-INTERFACE__
37673         - name: l3-interface-ipv6-address
37674           in: path
37675           description: IP address
37676           required: true
37677           type: string
37678           example: __L3-INTERFACE-IPV6-ADDRESS__
37679         - name: body
37680           in: body
37681           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37682           required: true
37683           schema:
37684             $ref: "#/definitions/relationship"
37685     delete:
37686       tags:
37687         - Network
37688       summary: delete an existing relationship
37689       description: delete an existing relationship
37690       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37691       consumes:
37692         - application/json
37693         - application/xml
37694       produces:
37695         - application/json
37696         - application/xml
37697       responses:
37698         "default":
37699           description: Response codes found in [response codes](https://wiki.onap.org/).
37700       parameters:
37701         - name: pnf-name
37702           in: path
37703           description: unique name of Physical Network Function.
37704           required: true
37705           type: string
37706           example: __PNF-NAME__
37707         - name: interface-name
37708           in: path
37709           description: Name that identifies the link aggregate interface
37710           required: true
37711           type: string
37712           example: __INTERFACE-NAME__
37713         - name: interface-name
37714           in: path
37715           description: Name given to the interface
37716           required: true
37717           type: string
37718           example: __INTERFACE-NAME__
37719         - name: vlan-interface
37720           in: path
37721           description: String that identifies the interface
37722           required: true
37723           type: string
37724           example: __VLAN-INTERFACE__
37725         - name: l3-interface-ipv6-address
37726           in: path
37727           description: IP address
37728           required: true
37729           type: string
37730           example: __L3-INTERFACE-IPV6-ADDRESS__
37731   /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}:
37732     get:
37733       tags:
37734         - Network
37735       summary: returns l3-interface-ipv6-address-list
37736       description: returns l3-interface-ipv6-address-list
37737       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37738       produces:
37739         - application/json
37740         - application/xml
37741       responses:
37742         "200":
37743           description: successful operation
37744           schema:
37745               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37746         "default":
37747           description: Response codes found in [response codes](https://wiki.onap.org/).
37748       parameters:
37749         - name: pnf-name
37750           in: path
37751           description: unique name of Physical Network Function.
37752           required: true
37753           type: string
37754           example: __PNF-NAME__
37755         - name: interface-name
37756           in: path
37757           description: Name that identifies the link aggregate interface
37758           required: true
37759           type: string
37760           example: __INTERFACE-NAME__
37761         - name: interface-name
37762           in: path
37763           description: Name given to the interface
37764           required: true
37765           type: string
37766           example: __INTERFACE-NAME__
37767         - name: vlan-interface
37768           in: path
37769           description: String that identifies the interface
37770           required: true
37771           type: string
37772           example: __VLAN-INTERFACE__
37773         - name: l3-interface-ipv6-address
37774           in: path
37775           description: IP address
37776           required: true
37777           type: string
37778           example: __L3-INTERFACE-IPV6-ADDRESS__
37779     put:
37780       tags:
37781         - Network
37782       summary: create or update an existing l3-interface-ipv6-address-list
37783       description: |
37784         Create or update an existing l3-interface-ipv6-address-list.
37785         #
37786         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37787       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37788       consumes:
37789         - application/json
37790         - application/xml
37791       produces:
37792         - application/json
37793         - application/xml
37794       responses:
37795         "default":
37796           description: Response codes found in [response codes](https://wiki.onap.org/).
37797       parameters:
37798         - name: pnf-name
37799           in: path
37800           description: unique name of Physical Network Function.
37801           required: true
37802           type: string
37803           example: __PNF-NAME__
37804         - name: interface-name
37805           in: path
37806           description: Name that identifies the link aggregate interface
37807           required: true
37808           type: string
37809           example: __INTERFACE-NAME__
37810         - name: interface-name
37811           in: path
37812           description: Name given to the interface
37813           required: true
37814           type: string
37815           example: __INTERFACE-NAME__
37816         - name: vlan-interface
37817           in: path
37818           description: String that identifies the interface
37819           required: true
37820           type: string
37821           example: __VLAN-INTERFACE__
37822         - name: l3-interface-ipv6-address
37823           in: path
37824           description: IP address
37825           required: true
37826           type: string
37827           example: __L3-INTERFACE-IPV6-ADDRESS__
37828         - name: body
37829           in: body
37830           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37831           required: true
37832           schema:
37833             $ref: "#/definitions/l3-interface-ipv6-address-list"
37834     patch:
37835       tags:
37836         - Network
37837       summary: update an existing l3-interface-ipv6-address-list
37838       description: |
37839         Update an existing l3-interface-ipv6-address-list
37840         #
37841         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37842         The PUT operation will entirely replace an existing object.
37843         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37844         #
37845         Other differences between PUT and PATCH are:
37846         #
37847         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37848         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37849         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37850       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37851       consumes:
37852         - application/json
37853         - application/xml
37854       produces:
37855         - application/json
37856         - application/xml
37857       responses:
37858         "default":
37859           description: Response codes found in [response codes](https://wiki.onap.org/).
37860       parameters:
37861         - name: pnf-name
37862           in: path
37863           description: unique name of Physical Network Function.
37864           required: true
37865           type: string
37866           example: __PNF-NAME__
37867         - name: interface-name
37868           in: path
37869           description: Name that identifies the link aggregate interface
37870           required: true
37871           type: string
37872           example: __INTERFACE-NAME__
37873         - name: interface-name
37874           in: path
37875           description: Name given to the interface
37876           required: true
37877           type: string
37878           example: __INTERFACE-NAME__
37879         - name: vlan-interface
37880           in: path
37881           description: String that identifies the interface
37882           required: true
37883           type: string
37884           example: __VLAN-INTERFACE__
37885         - name: l3-interface-ipv6-address
37886           in: path
37887           description: IP address
37888           required: true
37889           type: string
37890           example: __L3-INTERFACE-IPV6-ADDRESS__
37891         - name: body
37892           in: body
37893           description: l3-interface-ipv6-address-list object that needs to be updated.
37894           required: true
37895           schema:
37896             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37897     delete:
37898       tags:
37899         - Network
37900       summary: delete an existing l3-interface-ipv6-address-list
37901       description: delete an existing l3-interface-ipv6-address-list
37902       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37903       consumes:
37904         - application/json
37905         - application/xml
37906       produces:
37907         - application/json
37908         - application/xml
37909       responses:
37910         "default":
37911           description: Response codes found in [response codes](https://wiki.onap.org/).
37912       parameters:
37913         - name: pnf-name
37914           in: path
37915           description: unique name of Physical Network Function.
37916           required: true
37917           type: string
37918           example: __PNF-NAME__
37919         - name: interface-name
37920           in: path
37921           description: Name that identifies the link aggregate interface
37922           required: true
37923           type: string
37924           example: __INTERFACE-NAME__
37925         - name: interface-name
37926           in: path
37927           description: Name given to the interface
37928           required: true
37929           type: string
37930           example: __INTERFACE-NAME__
37931         - name: vlan-interface
37932           in: path
37933           description: String that identifies the interface
37934           required: true
37935           type: string
37936           example: __VLAN-INTERFACE__
37937         - name: l3-interface-ipv6-address
37938           in: path
37939           description: IP address
37940           required: true
37941           type: string
37942           example: __L3-INTERFACE-IPV6-ADDRESS__
37943         - name: resource-version
37944           in: query
37945           description: resource-version for concurrency
37946           required: true
37947           type: string
37948   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
37949     get:
37950       tags:
37951         - Network
37952       summary: returns vlan
37953       description: returns vlan
37954       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
37955       produces:
37956         - application/json
37957         - application/xml
37958       responses:
37959         "200":
37960           description: successful operation
37961           schema:
37962               $ref: "#/getDefinitions/vlan"
37963         "default":
37964           description: Response codes found in [response codes](https://wiki.onap.org/).
37965       parameters:
37966         - name: pnf-name
37967           in: path
37968           description: unique name of Physical Network Function.
37969           required: true
37970           type: string
37971           example: __PNF-NAME__
37972         - name: interface-name
37973           in: path
37974           description: Name that identifies the link aggregate interface
37975           required: true
37976           type: string
37977           example: __INTERFACE-NAME__
37978         - name: interface-name
37979           in: path
37980           description: Name given to the interface
37981           required: true
37982           type: string
37983           example: __INTERFACE-NAME__
37984         - name: vlan-interface
37985           in: path
37986           description: String that identifies the interface
37987           required: true
37988           type: string
37989           example: __VLAN-INTERFACE__
37990     put:
37991       tags:
37992         - Network
37993       summary: create or update an existing vlan
37994       description: |
37995         Create or update an existing vlan.
37996         #
37997         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37998       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
37999       consumes:
38000         - application/json
38001         - application/xml
38002       produces:
38003         - application/json
38004         - application/xml
38005       responses:
38006         "default":
38007           description: Response codes found in [response codes](https://wiki.onap.org/).
38008       parameters:
38009         - name: pnf-name
38010           in: path
38011           description: unique name of Physical Network Function.
38012           required: true
38013           type: string
38014           example: __PNF-NAME__
38015         - name: interface-name
38016           in: path
38017           description: Name that identifies the link aggregate interface
38018           required: true
38019           type: string
38020           example: __INTERFACE-NAME__
38021         - name: interface-name
38022           in: path
38023           description: Name given to the interface
38024           required: true
38025           type: string
38026           example: __INTERFACE-NAME__
38027         - name: vlan-interface
38028           in: path
38029           description: String that identifies the interface
38030           required: true
38031           type: string
38032           example: __VLAN-INTERFACE__
38033         - name: body
38034           in: body
38035           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
38036           required: true
38037           schema:
38038             $ref: "#/definitions/vlan"
38039     patch:
38040       tags:
38041         - Network
38042       summary: update an existing vlan
38043       description: |
38044         Update an existing vlan
38045         #
38046         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38047         The PUT operation will entirely replace an existing object.
38048         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38049         #
38050         Other differences between PUT and PATCH are:
38051         #
38052         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38053         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38054         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38055       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38056       consumes:
38057         - application/json
38058         - application/xml
38059       produces:
38060         - application/json
38061         - application/xml
38062       responses:
38063         "default":
38064           description: Response codes found in [response codes](https://wiki.onap.org/).
38065       parameters:
38066         - name: pnf-name
38067           in: path
38068           description: unique name of Physical Network Function.
38069           required: true
38070           type: string
38071           example: __PNF-NAME__
38072         - name: interface-name
38073           in: path
38074           description: Name that identifies the link aggregate interface
38075           required: true
38076           type: string
38077           example: __INTERFACE-NAME__
38078         - name: interface-name
38079           in: path
38080           description: Name given to the interface
38081           required: true
38082           type: string
38083           example: __INTERFACE-NAME__
38084         - name: vlan-interface
38085           in: path
38086           description: String that identifies the interface
38087           required: true
38088           type: string
38089           example: __VLAN-INTERFACE__
38090         - name: body
38091           in: body
38092           description: vlan object that needs to be updated.
38093           required: true
38094           schema:
38095             $ref: "#/patchDefinitions/vlan"
38096     delete:
38097       tags:
38098         - Network
38099       summary: delete an existing vlan
38100       description: delete an existing vlan
38101       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38102       consumes:
38103         - application/json
38104         - application/xml
38105       produces:
38106         - application/json
38107         - application/xml
38108       responses:
38109         "default":
38110           description: Response codes found in [response codes](https://wiki.onap.org/).
38111       parameters:
38112         - name: pnf-name
38113           in: path
38114           description: unique name of Physical Network Function.
38115           required: true
38116           type: string
38117           example: __PNF-NAME__
38118         - name: interface-name
38119           in: path
38120           description: Name that identifies the link aggregate interface
38121           required: true
38122           type: string
38123           example: __INTERFACE-NAME__
38124         - name: interface-name
38125           in: path
38126           description: Name given to the interface
38127           required: true
38128           type: string
38129           example: __INTERFACE-NAME__
38130         - name: vlan-interface
38131           in: path
38132           description: String that identifies the interface
38133           required: true
38134           type: string
38135           example: __VLAN-INTERFACE__
38136         - name: resource-version
38137           in: query
38138           description: resource-version for concurrency
38139           required: true
38140           type: string
38141   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38142     get:
38143       tags:
38144         - Network
38145       summary: returns vlans
38146       description: returns vlans
38147       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
38148       produces:
38149         - application/json
38150         - application/xml
38151       responses:
38152         "200":
38153           description: successful operation
38154           schema:
38155               $ref: "#/getDefinitions/vlans"
38156         "default":
38157           description: Response codes found in [response codes](https://wiki.onap.org/).
38158       parameters:
38159         - name: pnf-name
38160           in: path
38161           description: unique name of Physical Network Function.
38162           required: true
38163           type: string
38164           example: __PNF-NAME__
38165         - name: interface-name
38166           in: path
38167           description: Name that identifies the link aggregate interface
38168           required: true
38169           type: string
38170           example: __INTERFACE-NAME__
38171         - name: interface-name
38172           in: path
38173           description: Name given to the interface
38174           required: true
38175           type: string
38176           example: __INTERFACE-NAME__
38177         - name: vlan-interface
38178           in: query
38179           description:
38180           required: false
38181           type: string
38182         - name: vlan-id-inner
38183           in: query
38184           description:
38185           required: false
38186           type: integer
38187           format: int64
38188         - name: vpn-id
38189           in: query
38190           description:
38191           required: false
38192           type: string
38193   /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:
38194     put:
38195       tags:
38196         - Network
38197       summary: see node definition for valid relationships
38198       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38199       consumes:
38200         - application/json
38201         - application/xml
38202       produces:
38203         - application/json
38204         - application/xml
38205       responses:
38206         "default":
38207           description: Response codes found in [response codes](https://wiki.onap.org/).
38208       parameters:
38209         - name: pnf-name
38210           in: path
38211           description: unique name of Physical Network Function.
38212           required: true
38213           type: string
38214           example: __PNF-NAME__
38215         - name: interface-name
38216           in: path
38217           description: Name that identifies the link aggregate interface
38218           required: true
38219           type: string
38220           example: __INTERFACE-NAME__
38221         - name: interface-name
38222           in: path
38223           description: Name given to the interface
38224           required: true
38225           type: string
38226           example: __INTERFACE-NAME__
38227         - name: pci-id
38228           in: path
38229           description: PCI ID used to identify the sriov-vf
38230           required: true
38231           type: string
38232           example: __PCI-ID__
38233         - name: body
38234           in: body
38235           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38236           required: true
38237           schema:
38238             $ref: "#/definitions/relationship"
38239     delete:
38240       tags:
38241         - Network
38242       summary: delete an existing relationship
38243       description: delete an existing relationship
38244       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38245       consumes:
38246         - application/json
38247         - application/xml
38248       produces:
38249         - application/json
38250         - application/xml
38251       responses:
38252         "default":
38253           description: Response codes found in [response codes](https://wiki.onap.org/).
38254       parameters:
38255         - name: pnf-name
38256           in: path
38257           description: unique name of Physical Network Function.
38258           required: true
38259           type: string
38260           example: __PNF-NAME__
38261         - name: interface-name
38262           in: path
38263           description: Name that identifies the link aggregate interface
38264           required: true
38265           type: string
38266           example: __INTERFACE-NAME__
38267         - name: interface-name
38268           in: path
38269           description: Name given to the interface
38270           required: true
38271           type: string
38272           example: __INTERFACE-NAME__
38273         - name: pci-id
38274           in: path
38275           description: PCI ID used to identify the sriov-vf
38276           required: true
38277           type: string
38278           example: __PCI-ID__
38279   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
38280     get:
38281       tags:
38282         - Network
38283       summary: returns sriov-vf
38284       description: returns sriov-vf
38285       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38286       produces:
38287         - application/json
38288         - application/xml
38289       responses:
38290         "200":
38291           description: successful operation
38292           schema:
38293               $ref: "#/getDefinitions/sriov-vf"
38294         "default":
38295           description: Response codes found in [response codes](https://wiki.onap.org/).
38296       parameters:
38297         - name: pnf-name
38298           in: path
38299           description: unique name of Physical Network Function.
38300           required: true
38301           type: string
38302           example: __PNF-NAME__
38303         - name: interface-name
38304           in: path
38305           description: Name that identifies the link aggregate interface
38306           required: true
38307           type: string
38308           example: __INTERFACE-NAME__
38309         - name: interface-name
38310           in: path
38311           description: Name given to the interface
38312           required: true
38313           type: string
38314           example: __INTERFACE-NAME__
38315         - name: pci-id
38316           in: path
38317           description: PCI ID used to identify the sriov-vf
38318           required: true
38319           type: string
38320           example: __PCI-ID__
38321     put:
38322       tags:
38323         - Network
38324       summary: create or update an existing sriov-vf
38325       description: |
38326         Create or update an existing sriov-vf.
38327         #
38328         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38329       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38330       consumes:
38331         - application/json
38332         - application/xml
38333       produces:
38334         - application/json
38335         - application/xml
38336       responses:
38337         "default":
38338           description: Response codes found in [response codes](https://wiki.onap.org/).
38339       parameters:
38340         - name: pnf-name
38341           in: path
38342           description: unique name of Physical Network Function.
38343           required: true
38344           type: string
38345           example: __PNF-NAME__
38346         - name: interface-name
38347           in: path
38348           description: Name that identifies the link aggregate interface
38349           required: true
38350           type: string
38351           example: __INTERFACE-NAME__
38352         - name: interface-name
38353           in: path
38354           description: Name given to the interface
38355           required: true
38356           type: string
38357           example: __INTERFACE-NAME__
38358         - name: pci-id
38359           in: path
38360           description: PCI ID used to identify the sriov-vf
38361           required: true
38362           type: string
38363           example: __PCI-ID__
38364         - name: body
38365           in: body
38366           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38367           required: true
38368           schema:
38369             $ref: "#/definitions/sriov-vf"
38370     patch:
38371       tags:
38372         - Network
38373       summary: update an existing sriov-vf
38374       description: |
38375         Update an existing sriov-vf
38376         #
38377         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38378         The PUT operation will entirely replace an existing object.
38379         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38380         #
38381         Other differences between PUT and PATCH are:
38382         #
38383         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38384         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38385         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38386       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38387       consumes:
38388         - application/json
38389         - application/xml
38390       produces:
38391         - application/json
38392         - application/xml
38393       responses:
38394         "default":
38395           description: Response codes found in [response codes](https://wiki.onap.org/).
38396       parameters:
38397         - name: pnf-name
38398           in: path
38399           description: unique name of Physical Network Function.
38400           required: true
38401           type: string
38402           example: __PNF-NAME__
38403         - name: interface-name
38404           in: path
38405           description: Name that identifies the link aggregate interface
38406           required: true
38407           type: string
38408           example: __INTERFACE-NAME__
38409         - name: interface-name
38410           in: path
38411           description: Name given to the interface
38412           required: true
38413           type: string
38414           example: __INTERFACE-NAME__
38415         - name: pci-id
38416           in: path
38417           description: PCI ID used to identify the sriov-vf
38418           required: true
38419           type: string
38420           example: __PCI-ID__
38421         - name: body
38422           in: body
38423           description: sriov-vf object that needs to be updated.
38424           required: true
38425           schema:
38426             $ref: "#/patchDefinitions/sriov-vf"
38427     delete:
38428       tags:
38429         - Network
38430       summary: delete an existing sriov-vf
38431       description: delete an existing sriov-vf
38432       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38433       consumes:
38434         - application/json
38435         - application/xml
38436       produces:
38437         - application/json
38438         - application/xml
38439       responses:
38440         "default":
38441           description: Response codes found in [response codes](https://wiki.onap.org/).
38442       parameters:
38443         - name: pnf-name
38444           in: path
38445           description: unique name of Physical Network Function.
38446           required: true
38447           type: string
38448           example: __PNF-NAME__
38449         - name: interface-name
38450           in: path
38451           description: Name that identifies the link aggregate interface
38452           required: true
38453           type: string
38454           example: __INTERFACE-NAME__
38455         - name: interface-name
38456           in: path
38457           description: Name given to the interface
38458           required: true
38459           type: string
38460           example: __INTERFACE-NAME__
38461         - name: pci-id
38462           in: path
38463           description: PCI ID used to identify the sriov-vf
38464           required: true
38465           type: string
38466           example: __PCI-ID__
38467         - name: resource-version
38468           in: query
38469           description: resource-version for concurrency
38470           required: true
38471           type: string
38472   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38473     get:
38474       tags:
38475         - Network
38476       summary: returns sriov-vfs
38477       description: returns sriov-vfs
38478       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
38479       produces:
38480         - application/json
38481         - application/xml
38482       responses:
38483         "200":
38484           description: successful operation
38485           schema:
38486               $ref: "#/getDefinitions/sriov-vfs"
38487         "default":
38488           description: Response codes found in [response codes](https://wiki.onap.org/).
38489       parameters:
38490         - name: pnf-name
38491           in: path
38492           description: unique name of Physical Network Function.
38493           required: true
38494           type: string
38495           example: __PNF-NAME__
38496         - name: interface-name
38497           in: path
38498           description: Name that identifies the link aggregate interface
38499           required: true
38500           type: string
38501           example: __INTERFACE-NAME__
38502         - name: interface-name
38503           in: path
38504           description: Name given to the interface
38505           required: true
38506           type: string
38507           example: __INTERFACE-NAME__
38508         - name: pci-id
38509           in: query
38510           description:
38511           required: false
38512           type: string
38513         - name: vf-vlan-filter
38514           in: query
38515           description:
38516           required: false
38517           type: string
38518         - name: vf-mac-filter
38519           in: query
38520           description:
38521           required: false
38522           type: string
38523         - name: vf-vlan-strip
38524           in: query
38525           description:
38526           required: false
38527           type: boolean
38528         - name: neutron-network-id
38529           in: query
38530           description:
38531           required: false
38532           type: string
38533   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38534     put:
38535       tags:
38536         - Network
38537       summary: see node definition for valid relationships
38538       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38539       consumes:
38540         - application/json
38541         - application/xml
38542       produces:
38543         - application/json
38544         - application/xml
38545       responses:
38546         "default":
38547           description: Response codes found in [response codes](https://wiki.onap.org/).
38548       parameters:
38549         - name: pnf-name
38550           in: path
38551           description: unique name of Physical Network Function.
38552           required: true
38553           type: string
38554           example: __PNF-NAME__
38555         - name: interface-name
38556           in: path
38557           description: Name that identifies the link aggregate interface
38558           required: true
38559           type: string
38560           example: __INTERFACE-NAME__
38561         - name: interface-name
38562           in: path
38563           description: Name given to the interface
38564           required: true
38565           type: string
38566           example: __INTERFACE-NAME__
38567         - name: body
38568           in: body
38569           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
38570           required: true
38571           schema:
38572             $ref: "#/definitions/relationship"
38573     delete:
38574       tags:
38575         - Network
38576       summary: delete an existing relationship
38577       description: delete an existing relationship
38578       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38579       consumes:
38580         - application/json
38581         - application/xml
38582       produces:
38583         - application/json
38584         - application/xml
38585       responses:
38586         "default":
38587           description: Response codes found in [response codes](https://wiki.onap.org/).
38588       parameters:
38589         - name: pnf-name
38590           in: path
38591           description: unique name of Physical Network Function.
38592           required: true
38593           type: string
38594           example: __PNF-NAME__
38595         - name: interface-name
38596           in: path
38597           description: Name that identifies the link aggregate interface
38598           required: true
38599           type: string
38600           example: __INTERFACE-NAME__
38601         - name: interface-name
38602           in: path
38603           description: Name given to the interface
38604           required: true
38605           type: string
38606           example: __INTERFACE-NAME__
38607   /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:
38608     put:
38609       tags:
38610         - Network
38611       summary: see node definition for valid relationships
38612       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38613       consumes:
38614         - application/json
38615         - application/xml
38616       produces:
38617         - application/json
38618         - application/xml
38619       responses:
38620         "default":
38621           description: Response codes found in [response codes](https://wiki.onap.org/).
38622       parameters:
38623         - name: pnf-name
38624           in: path
38625           description: unique name of Physical Network Function.
38626           required: true
38627           type: string
38628           example: __PNF-NAME__
38629         - name: interface-name
38630           in: path
38631           description: Name that identifies the link aggregate interface
38632           required: true
38633           type: string
38634           example: __INTERFACE-NAME__
38635         - name: interface-name
38636           in: path
38637           description: Name given to the interface
38638           required: true
38639           type: string
38640           example: __INTERFACE-NAME__
38641         - name: l3-interface-ipv4-address
38642           in: path
38643           description: IP address
38644           required: true
38645           type: string
38646           example: __L3-INTERFACE-IPV4-ADDRESS__
38647         - name: body
38648           in: body
38649           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38650           required: true
38651           schema:
38652             $ref: "#/definitions/relationship"
38653     delete:
38654       tags:
38655         - Network
38656       summary: delete an existing relationship
38657       description: delete an existing relationship
38658       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38659       consumes:
38660         - application/json
38661         - application/xml
38662       produces:
38663         - application/json
38664         - application/xml
38665       responses:
38666         "default":
38667           description: Response codes found in [response codes](https://wiki.onap.org/).
38668       parameters:
38669         - name: pnf-name
38670           in: path
38671           description: unique name of Physical Network Function.
38672           required: true
38673           type: string
38674           example: __PNF-NAME__
38675         - name: interface-name
38676           in: path
38677           description: Name that identifies the link aggregate interface
38678           required: true
38679           type: string
38680           example: __INTERFACE-NAME__
38681         - name: interface-name
38682           in: path
38683           description: Name given to the interface
38684           required: true
38685           type: string
38686           example: __INTERFACE-NAME__
38687         - name: l3-interface-ipv4-address
38688           in: path
38689           description: IP address
38690           required: true
38691           type: string
38692           example: __L3-INTERFACE-IPV4-ADDRESS__
38693   /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}:
38694     get:
38695       tags:
38696         - Network
38697       summary: returns l3-interface-ipv4-address-list
38698       description: returns l3-interface-ipv4-address-list
38699       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38700       produces:
38701         - application/json
38702         - application/xml
38703       responses:
38704         "200":
38705           description: successful operation
38706           schema:
38707               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38708         "default":
38709           description: Response codes found in [response codes](https://wiki.onap.org/).
38710       parameters:
38711         - name: pnf-name
38712           in: path
38713           description: unique name of Physical Network Function.
38714           required: true
38715           type: string
38716           example: __PNF-NAME__
38717         - name: interface-name
38718           in: path
38719           description: Name that identifies the link aggregate interface
38720           required: true
38721           type: string
38722           example: __INTERFACE-NAME__
38723         - name: interface-name
38724           in: path
38725           description: Name given to the interface
38726           required: true
38727           type: string
38728           example: __INTERFACE-NAME__
38729         - name: l3-interface-ipv4-address
38730           in: path
38731           description: IP address
38732           required: true
38733           type: string
38734           example: __L3-INTERFACE-IPV4-ADDRESS__
38735     put:
38736       tags:
38737         - Network
38738       summary: create or update an existing l3-interface-ipv4-address-list
38739       description: |
38740         Create or update an existing l3-interface-ipv4-address-list.
38741         #
38742         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38743       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38744       consumes:
38745         - application/json
38746         - application/xml
38747       produces:
38748         - application/json
38749         - application/xml
38750       responses:
38751         "default":
38752           description: Response codes found in [response codes](https://wiki.onap.org/).
38753       parameters:
38754         - name: pnf-name
38755           in: path
38756           description: unique name of Physical Network Function.
38757           required: true
38758           type: string
38759           example: __PNF-NAME__
38760         - name: interface-name
38761           in: path
38762           description: Name that identifies the link aggregate interface
38763           required: true
38764           type: string
38765           example: __INTERFACE-NAME__
38766         - name: interface-name
38767           in: path
38768           description: Name given to the interface
38769           required: true
38770           type: string
38771           example: __INTERFACE-NAME__
38772         - name: l3-interface-ipv4-address
38773           in: path
38774           description: IP address
38775           required: true
38776           type: string
38777           example: __L3-INTERFACE-IPV4-ADDRESS__
38778         - name: body
38779           in: body
38780           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38781           required: true
38782           schema:
38783             $ref: "#/definitions/l3-interface-ipv4-address-list"
38784     patch:
38785       tags:
38786         - Network
38787       summary: update an existing l3-interface-ipv4-address-list
38788       description: |
38789         Update an existing l3-interface-ipv4-address-list
38790         #
38791         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38792         The PUT operation will entirely replace an existing object.
38793         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38794         #
38795         Other differences between PUT and PATCH are:
38796         #
38797         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38798         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38799         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38800       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38801       consumes:
38802         - application/json
38803         - application/xml
38804       produces:
38805         - application/json
38806         - application/xml
38807       responses:
38808         "default":
38809           description: Response codes found in [response codes](https://wiki.onap.org/).
38810       parameters:
38811         - name: pnf-name
38812           in: path
38813           description: unique name of Physical Network Function.
38814           required: true
38815           type: string
38816           example: __PNF-NAME__
38817         - name: interface-name
38818           in: path
38819           description: Name that identifies the link aggregate interface
38820           required: true
38821           type: string
38822           example: __INTERFACE-NAME__
38823         - name: interface-name
38824           in: path
38825           description: Name given to the interface
38826           required: true
38827           type: string
38828           example: __INTERFACE-NAME__
38829         - name: l3-interface-ipv4-address
38830           in: path
38831           description: IP address
38832           required: true
38833           type: string
38834           example: __L3-INTERFACE-IPV4-ADDRESS__
38835         - name: body
38836           in: body
38837           description: l3-interface-ipv4-address-list object that needs to be updated.
38838           required: true
38839           schema:
38840             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38841     delete:
38842       tags:
38843         - Network
38844       summary: delete an existing l3-interface-ipv4-address-list
38845       description: delete an existing l3-interface-ipv4-address-list
38846       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38847       consumes:
38848         - application/json
38849         - application/xml
38850       produces:
38851         - application/json
38852         - application/xml
38853       responses:
38854         "default":
38855           description: Response codes found in [response codes](https://wiki.onap.org/).
38856       parameters:
38857         - name: pnf-name
38858           in: path
38859           description: unique name of Physical Network Function.
38860           required: true
38861           type: string
38862           example: __PNF-NAME__
38863         - name: interface-name
38864           in: path
38865           description: Name that identifies the link aggregate interface
38866           required: true
38867           type: string
38868           example: __INTERFACE-NAME__
38869         - name: interface-name
38870           in: path
38871           description: Name given to the interface
38872           required: true
38873           type: string
38874           example: __INTERFACE-NAME__
38875         - name: l3-interface-ipv4-address
38876           in: path
38877           description: IP address
38878           required: true
38879           type: string
38880           example: __L3-INTERFACE-IPV4-ADDRESS__
38881         - name: resource-version
38882           in: query
38883           description: resource-version for concurrency
38884           required: true
38885           type: string
38886   /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:
38887     put:
38888       tags:
38889         - Network
38890       summary: see node definition for valid relationships
38891       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38892       consumes:
38893         - application/json
38894         - application/xml
38895       produces:
38896         - application/json
38897         - application/xml
38898       responses:
38899         "default":
38900           description: Response codes found in [response codes](https://wiki.onap.org/).
38901       parameters:
38902         - name: pnf-name
38903           in: path
38904           description: unique name of Physical Network Function.
38905           required: true
38906           type: string
38907           example: __PNF-NAME__
38908         - name: interface-name
38909           in: path
38910           description: Name that identifies the link aggregate interface
38911           required: true
38912           type: string
38913           example: __INTERFACE-NAME__
38914         - name: interface-name
38915           in: path
38916           description: Name given to the interface
38917           required: true
38918           type: string
38919           example: __INTERFACE-NAME__
38920         - name: l3-interface-ipv6-address
38921           in: path
38922           description: IP address
38923           required: true
38924           type: string
38925           example: __L3-INTERFACE-IPV6-ADDRESS__
38926         - name: body
38927           in: body
38928           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38929           required: true
38930           schema:
38931             $ref: "#/definitions/relationship"
38932     delete:
38933       tags:
38934         - Network
38935       summary: delete an existing relationship
38936       description: delete an existing relationship
38937       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38938       consumes:
38939         - application/json
38940         - application/xml
38941       produces:
38942         - application/json
38943         - application/xml
38944       responses:
38945         "default":
38946           description: Response codes found in [response codes](https://wiki.onap.org/).
38947       parameters:
38948         - name: pnf-name
38949           in: path
38950           description: unique name of Physical Network Function.
38951           required: true
38952           type: string
38953           example: __PNF-NAME__
38954         - name: interface-name
38955           in: path
38956           description: Name that identifies the link aggregate interface
38957           required: true
38958           type: string
38959           example: __INTERFACE-NAME__
38960         - name: interface-name
38961           in: path
38962           description: Name given to the interface
38963           required: true
38964           type: string
38965           example: __INTERFACE-NAME__
38966         - name: l3-interface-ipv6-address
38967           in: path
38968           description: IP address
38969           required: true
38970           type: string
38971           example: __L3-INTERFACE-IPV6-ADDRESS__
38972   /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}:
38973     get:
38974       tags:
38975         - Network
38976       summary: returns l3-interface-ipv6-address-list
38977       description: returns l3-interface-ipv6-address-list
38978       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38979       produces:
38980         - application/json
38981         - application/xml
38982       responses:
38983         "200":
38984           description: successful operation
38985           schema:
38986               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38987         "default":
38988           description: Response codes found in [response codes](https://wiki.onap.org/).
38989       parameters:
38990         - name: pnf-name
38991           in: path
38992           description: unique name of Physical Network Function.
38993           required: true
38994           type: string
38995           example: __PNF-NAME__
38996         - name: interface-name
38997           in: path
38998           description: Name that identifies the link aggregate interface
38999           required: true
39000           type: string
39001           example: __INTERFACE-NAME__
39002         - name: interface-name
39003           in: path
39004           description: Name given to the interface
39005           required: true
39006           type: string
39007           example: __INTERFACE-NAME__
39008         - name: l3-interface-ipv6-address
39009           in: path
39010           description: IP address
39011           required: true
39012           type: string
39013           example: __L3-INTERFACE-IPV6-ADDRESS__
39014     put:
39015       tags:
39016         - Network
39017       summary: create or update an existing l3-interface-ipv6-address-list
39018       description: |
39019         Create or update an existing l3-interface-ipv6-address-list.
39020         #
39021         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39022       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39023       consumes:
39024         - application/json
39025         - application/xml
39026       produces:
39027         - application/json
39028         - application/xml
39029       responses:
39030         "default":
39031           description: Response codes found in [response codes](https://wiki.onap.org/).
39032       parameters:
39033         - name: pnf-name
39034           in: path
39035           description: unique name of Physical Network Function.
39036           required: true
39037           type: string
39038           example: __PNF-NAME__
39039         - name: interface-name
39040           in: path
39041           description: Name that identifies the link aggregate interface
39042           required: true
39043           type: string
39044           example: __INTERFACE-NAME__
39045         - name: interface-name
39046           in: path
39047           description: Name given to the interface
39048           required: true
39049           type: string
39050           example: __INTERFACE-NAME__
39051         - name: l3-interface-ipv6-address
39052           in: path
39053           description: IP address
39054           required: true
39055           type: string
39056           example: __L3-INTERFACE-IPV6-ADDRESS__
39057         - name: body
39058           in: body
39059           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39060           required: true
39061           schema:
39062             $ref: "#/definitions/l3-interface-ipv6-address-list"
39063     patch:
39064       tags:
39065         - Network
39066       summary: update an existing l3-interface-ipv6-address-list
39067       description: |
39068         Update an existing l3-interface-ipv6-address-list
39069         #
39070         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39071         The PUT operation will entirely replace an existing object.
39072         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39073         #
39074         Other differences between PUT and PATCH are:
39075         #
39076         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39077         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39078         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39079       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39080       consumes:
39081         - application/json
39082         - application/xml
39083       produces:
39084         - application/json
39085         - application/xml
39086       responses:
39087         "default":
39088           description: Response codes found in [response codes](https://wiki.onap.org/).
39089       parameters:
39090         - name: pnf-name
39091           in: path
39092           description: unique name of Physical Network Function.
39093           required: true
39094           type: string
39095           example: __PNF-NAME__
39096         - name: interface-name
39097           in: path
39098           description: Name that identifies the link aggregate interface
39099           required: true
39100           type: string
39101           example: __INTERFACE-NAME__
39102         - name: interface-name
39103           in: path
39104           description: Name given to the interface
39105           required: true
39106           type: string
39107           example: __INTERFACE-NAME__
39108         - name: l3-interface-ipv6-address
39109           in: path
39110           description: IP address
39111           required: true
39112           type: string
39113           example: __L3-INTERFACE-IPV6-ADDRESS__
39114         - name: body
39115           in: body
39116           description: l3-interface-ipv6-address-list object that needs to be updated.
39117           required: true
39118           schema:
39119             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39120     delete:
39121       tags:
39122         - Network
39123       summary: delete an existing l3-interface-ipv6-address-list
39124       description: delete an existing l3-interface-ipv6-address-list
39125       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39126       consumes:
39127         - application/json
39128         - application/xml
39129       produces:
39130         - application/json
39131         - application/xml
39132       responses:
39133         "default":
39134           description: Response codes found in [response codes](https://wiki.onap.org/).
39135       parameters:
39136         - name: pnf-name
39137           in: path
39138           description: unique name of Physical Network Function.
39139           required: true
39140           type: string
39141           example: __PNF-NAME__
39142         - name: interface-name
39143           in: path
39144           description: Name that identifies the link aggregate interface
39145           required: true
39146           type: string
39147           example: __INTERFACE-NAME__
39148         - name: interface-name
39149           in: path
39150           description: Name given to the interface
39151           required: true
39152           type: string
39153           example: __INTERFACE-NAME__
39154         - name: l3-interface-ipv6-address
39155           in: path
39156           description: IP address
39157           required: true
39158           type: string
39159           example: __L3-INTERFACE-IPV6-ADDRESS__
39160         - name: resource-version
39161           in: query
39162           description: resource-version for concurrency
39163           required: true
39164           type: string
39165   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39166     get:
39167       tags:
39168         - Network
39169       summary: returns l-interface
39170       description: returns l-interface
39171       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39172       produces:
39173         - application/json
39174         - application/xml
39175       responses:
39176         "200":
39177           description: successful operation
39178           schema:
39179               $ref: "#/getDefinitions/l-interface"
39180         "default":
39181           description: Response codes found in [response codes](https://wiki.onap.org/).
39182       parameters:
39183         - name: pnf-name
39184           in: path
39185           description: unique name of Physical Network Function.
39186           required: true
39187           type: string
39188           example: __PNF-NAME__
39189         - name: interface-name
39190           in: path
39191           description: Name that identifies the link aggregate interface
39192           required: true
39193           type: string
39194           example: __INTERFACE-NAME__
39195         - name: interface-name
39196           in: path
39197           description: Name given to the interface
39198           required: true
39199           type: string
39200           example: __INTERFACE-NAME__
39201     put:
39202       tags:
39203         - Network
39204       summary: create or update an existing l-interface
39205       description: |
39206         Create or update an existing l-interface.
39207         #
39208         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39209       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39210       consumes:
39211         - application/json
39212         - application/xml
39213       produces:
39214         - application/json
39215         - application/xml
39216       responses:
39217         "default":
39218           description: Response codes found in [response codes](https://wiki.onap.org/).
39219       parameters:
39220         - name: pnf-name
39221           in: path
39222           description: unique name of Physical Network Function.
39223           required: true
39224           type: string
39225           example: __PNF-NAME__
39226         - name: interface-name
39227           in: path
39228           description: Name that identifies the link aggregate interface
39229           required: true
39230           type: string
39231           example: __INTERFACE-NAME__
39232         - name: interface-name
39233           in: path
39234           description: Name given to the interface
39235           required: true
39236           type: string
39237           example: __INTERFACE-NAME__
39238         - name: body
39239           in: body
39240           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
39241           required: true
39242           schema:
39243             $ref: "#/definitions/l-interface"
39244     patch:
39245       tags:
39246         - Network
39247       summary: update an existing l-interface
39248       description: |
39249         Update an existing l-interface
39250         #
39251         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39252         The PUT operation will entirely replace an existing object.
39253         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39254         #
39255         Other differences between PUT and PATCH are:
39256         #
39257         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39258         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39259         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39260       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39261       consumes:
39262         - application/json
39263         - application/xml
39264       produces:
39265         - application/json
39266         - application/xml
39267       responses:
39268         "default":
39269           description: Response codes found in [response codes](https://wiki.onap.org/).
39270       parameters:
39271         - name: pnf-name
39272           in: path
39273           description: unique name of Physical Network Function.
39274           required: true
39275           type: string
39276           example: __PNF-NAME__
39277         - name: interface-name
39278           in: path
39279           description: Name that identifies the link aggregate interface
39280           required: true
39281           type: string
39282           example: __INTERFACE-NAME__
39283         - name: interface-name
39284           in: path
39285           description: Name given to the interface
39286           required: true
39287           type: string
39288           example: __INTERFACE-NAME__
39289         - name: body
39290           in: body
39291           description: l-interface object that needs to be updated.
39292           required: true
39293           schema:
39294             $ref: "#/patchDefinitions/l-interface"
39295     delete:
39296       tags:
39297         - Network
39298       summary: delete an existing l-interface
39299       description: delete an existing l-interface
39300       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39301       consumes:
39302         - application/json
39303         - application/xml
39304       produces:
39305         - application/json
39306         - application/xml
39307       responses:
39308         "default":
39309           description: Response codes found in [response codes](https://wiki.onap.org/).
39310       parameters:
39311         - name: pnf-name
39312           in: path
39313           description: unique name of Physical Network Function.
39314           required: true
39315           type: string
39316           example: __PNF-NAME__
39317         - name: interface-name
39318           in: path
39319           description: Name that identifies the link aggregate interface
39320           required: true
39321           type: string
39322           example: __INTERFACE-NAME__
39323         - name: interface-name
39324           in: path
39325           description: Name given to the interface
39326           required: true
39327           type: string
39328           example: __INTERFACE-NAME__
39329         - name: resource-version
39330           in: query
39331           description: resource-version for concurrency
39332           required: true
39333           type: string
39334   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
39335     get:
39336       tags:
39337         - Network
39338       summary: returns l-interfaces
39339       description: returns l-interfaces
39340       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
39341       produces:
39342         - application/json
39343         - application/xml
39344       responses:
39345         "200":
39346           description: successful operation
39347           schema:
39348               $ref: "#/getDefinitions/l-interfaces"
39349         "default":
39350           description: Response codes found in [response codes](https://wiki.onap.org/).
39351       parameters:
39352         - name: pnf-name
39353           in: path
39354           description: unique name of Physical Network Function.
39355           required: true
39356           type: string
39357           example: __PNF-NAME__
39358         - name: interface-name
39359           in: path
39360           description: Name that identifies the link aggregate interface
39361           required: true
39362           type: string
39363           example: __INTERFACE-NAME__
39364         - name: interface-name
39365           in: query
39366           description:
39367           required: false
39368           type: string
39369         - name: interface-id
39370           in: query
39371           description:
39372           required: false
39373           type: string
39374         - name: macaddr
39375           in: query
39376           description:
39377           required: false
39378           type: string
39379         - name: network-name
39380           in: query
39381           description:
39382           required: false
39383           type: string
39384   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
39385     get:
39386       tags:
39387         - Network
39388       summary: returns lag-interface
39389       description: returns lag-interface
39390       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
39391       produces:
39392         - application/json
39393         - application/xml
39394       responses:
39395         "200":
39396           description: successful operation
39397           schema:
39398               $ref: "#/getDefinitions/lag-interface"
39399         "default":
39400           description: Response codes found in [response codes](https://wiki.onap.org/).
39401       parameters:
39402         - name: pnf-name
39403           in: path
39404           description: unique name of Physical Network Function.
39405           required: true
39406           type: string
39407           example: __PNF-NAME__
39408         - name: interface-name
39409           in: path
39410           description: Name that identifies the link aggregate interface
39411           required: true
39412           type: string
39413           example: __INTERFACE-NAME__
39414     put:
39415       tags:
39416         - Network
39417       summary: create or update an existing lag-interface
39418       description: |
39419         Create or update an existing lag-interface.
39420         #
39421         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39422       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
39423       consumes:
39424         - application/json
39425         - application/xml
39426       produces:
39427         - application/json
39428         - application/xml
39429       responses:
39430         "default":
39431           description: Response codes found in [response codes](https://wiki.onap.org/).
39432       parameters:
39433         - name: pnf-name
39434           in: path
39435           description: unique name of Physical Network Function.
39436           required: true
39437           type: string
39438           example: __PNF-NAME__
39439         - name: interface-name
39440           in: path
39441           description: Name that identifies the link aggregate interface
39442           required: true
39443           type: string
39444           example: __INTERFACE-NAME__
39445         - name: body
39446           in: body
39447           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)
39448           required: true
39449           schema:
39450             $ref: "#/definitions/lag-interface"
39451     patch:
39452       tags:
39453         - Network
39454       summary: update an existing lag-interface
39455       description: |
39456         Update an existing lag-interface
39457         #
39458         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39459         The PUT operation will entirely replace an existing object.
39460         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39461         #
39462         Other differences between PUT and PATCH are:
39463         #
39464         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39465         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39466         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39467       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
39468       consumes:
39469         - application/json
39470         - application/xml
39471       produces:
39472         - application/json
39473         - application/xml
39474       responses:
39475         "default":
39476           description: Response codes found in [response codes](https://wiki.onap.org/).
39477       parameters:
39478         - name: pnf-name
39479           in: path
39480           description: unique name of Physical Network Function.
39481           required: true
39482           type: string
39483           example: __PNF-NAME__
39484         - name: interface-name
39485           in: path
39486           description: Name that identifies the link aggregate interface
39487           required: true
39488           type: string
39489           example: __INTERFACE-NAME__
39490         - name: body
39491           in: body
39492           description: lag-interface object that needs to be updated.
39493           required: true
39494           schema:
39495             $ref: "#/patchDefinitions/lag-interface"
39496     delete:
39497       tags:
39498         - Network
39499       summary: delete an existing lag-interface
39500       description: delete an existing lag-interface
39501       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
39502       consumes:
39503         - application/json
39504         - application/xml
39505       produces:
39506         - application/json
39507         - application/xml
39508       responses:
39509         "default":
39510           description: Response codes found in [response codes](https://wiki.onap.org/).
39511       parameters:
39512         - name: pnf-name
39513           in: path
39514           description: unique name of Physical Network Function.
39515           required: true
39516           type: string
39517           example: __PNF-NAME__
39518         - name: interface-name
39519           in: path
39520           description: Name that identifies the link aggregate interface
39521           required: true
39522           type: string
39523           example: __INTERFACE-NAME__
39524         - name: resource-version
39525           in: query
39526           description: resource-version for concurrency
39527           required: true
39528           type: string
39529   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
39530     get:
39531       tags:
39532         - Network
39533       summary: returns lag-interfaces
39534       description: returns lag-interfaces
39535       operationId: getNetworkPnfsPnfLagInterfaces
39536       produces:
39537         - application/json
39538         - application/xml
39539       responses:
39540         "200":
39541           description: successful operation
39542           schema:
39543               $ref: "#/getDefinitions/lag-interfaces"
39544         "default":
39545           description: Response codes found in [response codes](https://wiki.onap.org/).
39546       parameters:
39547         - name: pnf-name
39548           in: path
39549           description: unique name of Physical Network Function.
39550           required: true
39551           type: string
39552           example: __PNF-NAME__
39553         - name: interface-name
39554           in: query
39555           description:
39556           required: false
39557           type: string
39558         - name: interface-id
39559           in: query
39560           description:
39561           required: false
39562           type: string
39563         - name: interface-role
39564           in: query
39565           description:
39566           required: false
39567           type: string
39568   /network/pnfs/pnf/{pnf-name}:
39569     get:
39570       tags:
39571         - Network
39572       summary: returns pnf
39573       description: returns pnf
39574       operationId: getNetworkPnfsPnf
39575       produces:
39576         - application/json
39577         - application/xml
39578       responses:
39579         "200":
39580           description: successful operation
39581           schema:
39582               $ref: "#/getDefinitions/pnf"
39583         "default":
39584           description: Response codes found in [response codes](https://wiki.onap.org/).
39585       parameters:
39586         - name: pnf-name
39587           in: path
39588           description: unique name of Physical Network Function.
39589           required: true
39590           type: string
39591           example: __PNF-NAME__
39592     put:
39593       tags:
39594         - Network
39595       summary: create or update an existing pnf
39596       description: |
39597         Create or update an existing pnf.
39598         #
39599         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39600       operationId: createOrUpdateNetworkPnfsPnf
39601       consumes:
39602         - application/json
39603         - application/xml
39604       produces:
39605         - application/json
39606         - application/xml
39607       responses:
39608         "default":
39609           description: Response codes found in [response codes](https://wiki.onap.org/).
39610       parameters:
39611         - name: pnf-name
39612           in: path
39613           description: unique name of Physical Network Function.
39614           required: true
39615           type: string
39616           example: __PNF-NAME__
39617         - name: body
39618           in: body
39619           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)
39620           required: true
39621           schema:
39622             $ref: "#/definitions/pnf"
39623     patch:
39624       tags:
39625         - Network
39626       summary: update an existing pnf
39627       description: |
39628         Update an existing pnf
39629         #
39630         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39631         The PUT operation will entirely replace an existing object.
39632         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39633         #
39634         Other differences between PUT and PATCH are:
39635         #
39636         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39637         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39638         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39639       operationId: UpdateNetworkPnfsPnf
39640       consumes:
39641         - application/json
39642         - application/xml
39643       produces:
39644         - application/json
39645         - application/xml
39646       responses:
39647         "default":
39648           description: Response codes found in [response codes](https://wiki.onap.org/).
39649       parameters:
39650         - name: pnf-name
39651           in: path
39652           description: unique name of Physical Network Function.
39653           required: true
39654           type: string
39655           example: __PNF-NAME__
39656         - name: body
39657           in: body
39658           description: pnf object that needs to be updated.
39659           required: true
39660           schema:
39661             $ref: "#/patchDefinitions/pnf"
39662     delete:
39663       tags:
39664         - Network
39665       summary: delete an existing pnf
39666       description: delete an existing pnf
39667       operationId: deleteNetworkPnfsPnf
39668       consumes:
39669         - application/json
39670         - application/xml
39671       produces:
39672         - application/json
39673         - application/xml
39674       responses:
39675         "default":
39676           description: Response codes found in [response codes](https://wiki.onap.org/).
39677       parameters:
39678         - name: pnf-name
39679           in: path
39680           description: unique name of Physical Network Function.
39681           required: true
39682           type: string
39683           example: __PNF-NAME__
39684         - name: resource-version
39685           in: query
39686           description: resource-version for concurrency
39687           required: true
39688           type: string
39689   /network/pnfs:
39690     get:
39691       tags:
39692         - Network
39693       summary: returns pnfs
39694       description: returns pnfs
39695       operationId: getNetworkPnfs
39696       produces:
39697         - application/json
39698         - application/xml
39699       responses:
39700         "200":
39701           description: successful operation
39702           schema:
39703               $ref: "#/getDefinitions/pnfs"
39704         "default":
39705           description: Response codes found in [response codes](https://wiki.onap.org/).
39706       parameters:
39707         - name: pnf-name
39708           in: query
39709           description:
39710           required: false
39711           type: string
39712         - name: inv-status
39713           in: query
39714           description:
39715           required: false
39716           type: string
39717   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
39718     put:
39719       tags:
39720         - Network
39721       summary: see node definition for valid relationships
39722       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
39723       consumes:
39724         - application/json
39725         - application/xml
39726       produces:
39727         - application/json
39728         - application/xml
39729       responses:
39730         "default":
39731           description: Response codes found in [response codes](https://wiki.onap.org/).
39732       parameters:
39733         - name: link-name
39734           in: path
39735           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39736           required: true
39737           type: string
39738           example: __LINK-NAME__
39739         - name: body
39740           in: body
39741           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)
39742           required: true
39743           schema:
39744             $ref: "#/definitions/relationship"
39745     delete:
39746       tags:
39747         - Network
39748       summary: delete an existing relationship
39749       description: delete an existing relationship
39750       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
39751       consumes:
39752         - application/json
39753         - application/xml
39754       produces:
39755         - application/json
39756         - application/xml
39757       responses:
39758         "default":
39759           description: Response codes found in [response codes](https://wiki.onap.org/).
39760       parameters:
39761         - name: link-name
39762           in: path
39763           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39764           required: true
39765           type: string
39766           example: __LINK-NAME__
39767   /network/physical-links/physical-link/{link-name}:
39768     get:
39769       tags:
39770         - Network
39771       summary: returns physical-link
39772       description: returns physical-link
39773       operationId: getNetworkPhysicalLinksPhysicalLink
39774       produces:
39775         - application/json
39776         - application/xml
39777       responses:
39778         "200":
39779           description: successful operation
39780           schema:
39781               $ref: "#/getDefinitions/physical-link"
39782         "default":
39783           description: Response codes found in [response codes](https://wiki.onap.org/).
39784       parameters:
39785         - name: link-name
39786           in: path
39787           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39788           required: true
39789           type: string
39790           example: __LINK-NAME__
39791     put:
39792       tags:
39793         - Network
39794       summary: create or update an existing physical-link
39795       description: |
39796         Create or update an existing physical-link.
39797         #
39798         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39799       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
39800       consumes:
39801         - application/json
39802         - application/xml
39803       produces:
39804         - application/json
39805         - application/xml
39806       responses:
39807         "default":
39808           description: Response codes found in [response codes](https://wiki.onap.org/).
39809       parameters:
39810         - name: link-name
39811           in: path
39812           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39813           required: true
39814           type: string
39815           example: __LINK-NAME__
39816         - name: body
39817           in: body
39818           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)
39819           required: true
39820           schema:
39821             $ref: "#/definitions/physical-link"
39822     patch:
39823       tags:
39824         - Network
39825       summary: update an existing physical-link
39826       description: |
39827         Update an existing physical-link
39828         #
39829         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39830         The PUT operation will entirely replace an existing object.
39831         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39832         #
39833         Other differences between PUT and PATCH are:
39834         #
39835         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39836         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39837         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39838       operationId: UpdateNetworkPhysicalLinksPhysicalLink
39839       consumes:
39840         - application/json
39841         - application/xml
39842       produces:
39843         - application/json
39844         - application/xml
39845       responses:
39846         "default":
39847           description: Response codes found in [response codes](https://wiki.onap.org/).
39848       parameters:
39849         - name: link-name
39850           in: path
39851           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39852           required: true
39853           type: string
39854           example: __LINK-NAME__
39855         - name: body
39856           in: body
39857           description: physical-link object that needs to be updated.
39858           required: true
39859           schema:
39860             $ref: "#/patchDefinitions/physical-link"
39861     delete:
39862       tags:
39863         - Network
39864       summary: delete an existing physical-link
39865       description: delete an existing physical-link
39866       operationId: deleteNetworkPhysicalLinksPhysicalLink
39867       consumes:
39868         - application/json
39869         - application/xml
39870       produces:
39871         - application/json
39872         - application/xml
39873       responses:
39874         "default":
39875           description: Response codes found in [response codes](https://wiki.onap.org/).
39876       parameters:
39877         - name: link-name
39878           in: path
39879           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39880           required: true
39881           type: string
39882           example: __LINK-NAME__
39883         - name: resource-version
39884           in: query
39885           description: resource-version for concurrency
39886           required: true
39887           type: string
39888   /network/physical-links:
39889     get:
39890       tags:
39891         - Network
39892       summary: returns physical-links
39893       description: returns physical-links
39894       operationId: getNetworkPhysicalLinks
39895       produces:
39896         - application/json
39897         - application/xml
39898       responses:
39899         "200":
39900           description: successful operation
39901           schema:
39902               $ref: "#/getDefinitions/physical-links"
39903         "default":
39904           description: Response codes found in [response codes](https://wiki.onap.org/).
39905       parameters:
39906         - name: link-name
39907           in: query
39908           description:
39909           required: false
39910           type: string
39911         - name: circuit-id
39912           in: query
39913           description:
39914           required: false
39915           type: string
39916   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
39917     put:
39918       tags:
39919         - Network
39920       summary: see node definition for valid relationships
39921       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
39922       consumes:
39923         - application/json
39924         - application/xml
39925       produces:
39926         - application/json
39927         - application/xml
39928       responses:
39929         "default":
39930           description: Response codes found in [response codes](https://wiki.onap.org/).
39931       parameters:
39932         - name: ipsec-configuration-id
39933           in: path
39934           description: UUID of this configuration
39935           required: true
39936           type: string
39937           example: __IPSEC-CONFIGURATION-ID__
39938         - name: body
39939           in: body
39940           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)
39941           required: true
39942           schema:
39943             $ref: "#/definitions/relationship"
39944     delete:
39945       tags:
39946         - Network
39947       summary: delete an existing relationship
39948       description: delete an existing relationship
39949       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
39950       consumes:
39951         - application/json
39952         - application/xml
39953       produces:
39954         - application/json
39955         - application/xml
39956       responses:
39957         "default":
39958           description: Response codes found in [response codes](https://wiki.onap.org/).
39959       parameters:
39960         - name: ipsec-configuration-id
39961           in: path
39962           description: UUID of this configuration
39963           required: true
39964           type: string
39965           example: __IPSEC-CONFIGURATION-ID__
39966   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
39967     put:
39968       tags:
39969         - Network
39970       summary: see node definition for valid relationships
39971       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
39972       consumes:
39973         - application/json
39974         - application/xml
39975       produces:
39976         - application/json
39977         - application/xml
39978       responses:
39979         "default":
39980           description: Response codes found in [response codes](https://wiki.onap.org/).
39981       parameters:
39982         - name: ipsec-configuration-id
39983           in: path
39984           description: UUID of this configuration
39985           required: true
39986           type: string
39987           example: __IPSEC-CONFIGURATION-ID__
39988         - name: vig-address-type
39989           in: path
39990           description: indicates whether the VIG is for AVPN or INTERNET
39991           required: true
39992           type: string
39993           example: __VIG-ADDRESS-TYPE__
39994         - name: body
39995           in: body
39996           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
39997           required: true
39998           schema:
39999             $ref: "#/definitions/relationship"
40000     delete:
40001       tags:
40002         - Network
40003       summary: delete an existing relationship
40004       description: delete an existing relationship
40005       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
40006       consumes:
40007         - application/json
40008         - application/xml
40009       produces:
40010         - application/json
40011         - application/xml
40012       responses:
40013         "default":
40014           description: Response codes found in [response codes](https://wiki.onap.org/).
40015       parameters:
40016         - name: ipsec-configuration-id
40017           in: path
40018           description: UUID of this configuration
40019           required: true
40020           type: string
40021           example: __IPSEC-CONFIGURATION-ID__
40022         - name: vig-address-type
40023           in: path
40024           description: indicates whether the VIG is for AVPN or INTERNET
40025           required: true
40026           type: string
40027           example: __VIG-ADDRESS-TYPE__
40028   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
40029     get:
40030       tags:
40031         - Network
40032       summary: returns vig-server
40033       description: returns vig-server
40034       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40035       produces:
40036         - application/json
40037         - application/xml
40038       responses:
40039         "200":
40040           description: successful operation
40041           schema:
40042               $ref: "#/getDefinitions/vig-server"
40043         "default":
40044           description: Response codes found in [response codes](https://wiki.onap.org/).
40045       parameters:
40046         - name: ipsec-configuration-id
40047           in: path
40048           description: UUID of this configuration
40049           required: true
40050           type: string
40051           example: __IPSEC-CONFIGURATION-ID__
40052         - name: vig-address-type
40053           in: path
40054           description: indicates whether the VIG is for AVPN or INTERNET
40055           required: true
40056           type: string
40057           example: __VIG-ADDRESS-TYPE__
40058     put:
40059       tags:
40060         - Network
40061       summary: create or update an existing vig-server
40062       description: |
40063         Create or update an existing vig-server.
40064         #
40065         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40066       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40067       consumes:
40068         - application/json
40069         - application/xml
40070       produces:
40071         - application/json
40072         - application/xml
40073       responses:
40074         "default":
40075           description: Response codes found in [response codes](https://wiki.onap.org/).
40076       parameters:
40077         - name: ipsec-configuration-id
40078           in: path
40079           description: UUID of this configuration
40080           required: true
40081           type: string
40082           example: __IPSEC-CONFIGURATION-ID__
40083         - name: vig-address-type
40084           in: path
40085           description: indicates whether the VIG is for AVPN or INTERNET
40086           required: true
40087           type: string
40088           example: __VIG-ADDRESS-TYPE__
40089         - name: body
40090           in: body
40091           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
40092           required: true
40093           schema:
40094             $ref: "#/definitions/vig-server"
40095     patch:
40096       tags:
40097         - Network
40098       summary: update an existing vig-server
40099       description: |
40100         Update an existing vig-server
40101         #
40102         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40103         The PUT operation will entirely replace an existing object.
40104         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40105         #
40106         Other differences between PUT and PATCH are:
40107         #
40108         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40109         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40110         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40111       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40112       consumes:
40113         - application/json
40114         - application/xml
40115       produces:
40116         - application/json
40117         - application/xml
40118       responses:
40119         "default":
40120           description: Response codes found in [response codes](https://wiki.onap.org/).
40121       parameters:
40122         - name: ipsec-configuration-id
40123           in: path
40124           description: UUID of this configuration
40125           required: true
40126           type: string
40127           example: __IPSEC-CONFIGURATION-ID__
40128         - name: vig-address-type
40129           in: path
40130           description: indicates whether the VIG is for AVPN or INTERNET
40131           required: true
40132           type: string
40133           example: __VIG-ADDRESS-TYPE__
40134         - name: body
40135           in: body
40136           description: vig-server object that needs to be updated.
40137           required: true
40138           schema:
40139             $ref: "#/patchDefinitions/vig-server"
40140     delete:
40141       tags:
40142         - Network
40143       summary: delete an existing vig-server
40144       description: delete an existing vig-server
40145       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40146       consumes:
40147         - application/json
40148         - application/xml
40149       produces:
40150         - application/json
40151         - application/xml
40152       responses:
40153         "default":
40154           description: Response codes found in [response codes](https://wiki.onap.org/).
40155       parameters:
40156         - name: ipsec-configuration-id
40157           in: path
40158           description: UUID of this configuration
40159           required: true
40160           type: string
40161           example: __IPSEC-CONFIGURATION-ID__
40162         - name: vig-address-type
40163           in: path
40164           description: indicates whether the VIG is for AVPN or INTERNET
40165           required: true
40166           type: string
40167           example: __VIG-ADDRESS-TYPE__
40168         - name: resource-version
40169           in: query
40170           description: resource-version for concurrency
40171           required: true
40172           type: string
40173   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
40174     get:
40175       tags:
40176         - Network
40177       summary: returns vig-servers
40178       description: returns vig-servers
40179       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
40180       produces:
40181         - application/json
40182         - application/xml
40183       responses:
40184         "200":
40185           description: successful operation
40186           schema:
40187               $ref: "#/getDefinitions/vig-servers"
40188         "default":
40189           description: Response codes found in [response codes](https://wiki.onap.org/).
40190       parameters:
40191         - name: ipsec-configuration-id
40192           in: path
40193           description: UUID of this configuration
40194           required: true
40195           type: string
40196           example: __IPSEC-CONFIGURATION-ID__
40197         - name: vig-address-type
40198           in: query
40199           description:
40200           required: false
40201           type: string
40202   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
40203     get:
40204       tags:
40205         - Network
40206       summary: returns ipsec-configuration
40207       description: returns ipsec-configuration
40208       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
40209       produces:
40210         - application/json
40211         - application/xml
40212       responses:
40213         "200":
40214           description: successful operation
40215           schema:
40216               $ref: "#/getDefinitions/ipsec-configuration"
40217         "default":
40218           description: Response codes found in [response codes](https://wiki.onap.org/).
40219       parameters:
40220         - name: ipsec-configuration-id
40221           in: path
40222           description: UUID of this configuration
40223           required: true
40224           type: string
40225           example: __IPSEC-CONFIGURATION-ID__
40226     put:
40227       tags:
40228         - Network
40229       summary: create or update an existing ipsec-configuration
40230       description: |
40231         Create or update an existing ipsec-configuration.
40232         #
40233         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40234       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
40235       consumes:
40236         - application/json
40237         - application/xml
40238       produces:
40239         - application/json
40240         - application/xml
40241       responses:
40242         "default":
40243           description: Response codes found in [response codes](https://wiki.onap.org/).
40244       parameters:
40245         - name: ipsec-configuration-id
40246           in: path
40247           description: UUID of this configuration
40248           required: true
40249           type: string
40250           example: __IPSEC-CONFIGURATION-ID__
40251         - name: body
40252           in: body
40253           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)
40254           required: true
40255           schema:
40256             $ref: "#/definitions/ipsec-configuration"
40257     patch:
40258       tags:
40259         - Network
40260       summary: update an existing ipsec-configuration
40261       description: |
40262         Update an existing ipsec-configuration
40263         #
40264         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40265         The PUT operation will entirely replace an existing object.
40266         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40267         #
40268         Other differences between PUT and PATCH are:
40269         #
40270         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40271         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40272         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40273       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
40274       consumes:
40275         - application/json
40276         - application/xml
40277       produces:
40278         - application/json
40279         - application/xml
40280       responses:
40281         "default":
40282           description: Response codes found in [response codes](https://wiki.onap.org/).
40283       parameters:
40284         - name: ipsec-configuration-id
40285           in: path
40286           description: UUID of this configuration
40287           required: true
40288           type: string
40289           example: __IPSEC-CONFIGURATION-ID__
40290         - name: body
40291           in: body
40292           description: ipsec-configuration object that needs to be updated.
40293           required: true
40294           schema:
40295             $ref: "#/patchDefinitions/ipsec-configuration"
40296     delete:
40297       tags:
40298         - Network
40299       summary: delete an existing ipsec-configuration
40300       description: delete an existing ipsec-configuration
40301       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
40302       consumes:
40303         - application/json
40304         - application/xml
40305       produces:
40306         - application/json
40307         - application/xml
40308       responses:
40309         "default":
40310           description: Response codes found in [response codes](https://wiki.onap.org/).
40311       parameters:
40312         - name: ipsec-configuration-id
40313           in: path
40314           description: UUID of this configuration
40315           required: true
40316           type: string
40317           example: __IPSEC-CONFIGURATION-ID__
40318         - name: resource-version
40319           in: query
40320           description: resource-version for concurrency
40321           required: true
40322           type: string
40323   /network/ipsec-configurations:
40324     get:
40325       tags:
40326         - Network
40327       summary: returns ipsec-configurations
40328       description: returns ipsec-configurations
40329       operationId: getNetworkIpsecConfigurations
40330       produces:
40331         - application/json
40332         - application/xml
40333       responses:
40334         "200":
40335           description: successful operation
40336           schema:
40337               $ref: "#/getDefinitions/ipsec-configurations"
40338         "default":
40339           description: Response codes found in [response codes](https://wiki.onap.org/).
40340       parameters:
40341         - name: ipsec-configuration-id
40342           in: query
40343           description:
40344           required: false
40345           type: string
40346   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
40347     put:
40348       tags:
40349         - Network
40350       summary: see node definition for valid relationships
40351       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
40352       consumes:
40353         - application/json
40354         - application/xml
40355       produces:
40356         - application/json
40357         - application/xml
40358       responses:
40359         "default":
40360           description: Response codes found in [response codes](https://wiki.onap.org/).
40361       parameters:
40362         - name: route-table-reference-id
40363           in: path
40364           description: Route Table Reference id, UUID assigned to this instance.
40365           required: true
40366           type: string
40367           example: __ROUTE-TABLE-REFERENCE-ID__
40368         - name: body
40369           in: body
40370           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)
40371           required: true
40372           schema:
40373             $ref: "#/definitions/relationship"
40374     delete:
40375       tags:
40376         - Network
40377       summary: delete an existing relationship
40378       description: delete an existing relationship
40379       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
40380       consumes:
40381         - application/json
40382         - application/xml
40383       produces:
40384         - application/json
40385         - application/xml
40386       responses:
40387         "default":
40388           description: Response codes found in [response codes](https://wiki.onap.org/).
40389       parameters:
40390         - name: route-table-reference-id
40391           in: path
40392           description: Route Table Reference id, UUID assigned to this instance.
40393           required: true
40394           type: string
40395           example: __ROUTE-TABLE-REFERENCE-ID__
40396   /network/route-table-references/route-table-reference/{route-table-reference-id}:
40397     get:
40398       tags:
40399         - Network
40400       summary: returns route-table-reference
40401       description: returns route-table-reference
40402       operationId: getNetworkRouteTableReferencesRouteTableReference
40403       produces:
40404         - application/json
40405         - application/xml
40406       responses:
40407         "200":
40408           description: successful operation
40409           schema:
40410               $ref: "#/getDefinitions/route-table-reference"
40411         "default":
40412           description: Response codes found in [response codes](https://wiki.onap.org/).
40413       parameters:
40414         - name: route-table-reference-id
40415           in: path
40416           description: Route Table Reference id, UUID assigned to this instance.
40417           required: true
40418           type: string
40419           example: __ROUTE-TABLE-REFERENCE-ID__
40420     put:
40421       tags:
40422         - Network
40423       summary: create or update an existing route-table-reference
40424       description: |
40425         Create or update an existing route-table-reference.
40426         #
40427         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40428       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
40429       consumes:
40430         - application/json
40431         - application/xml
40432       produces:
40433         - application/json
40434         - application/xml
40435       responses:
40436         "default":
40437           description: Response codes found in [response codes](https://wiki.onap.org/).
40438       parameters:
40439         - name: route-table-reference-id
40440           in: path
40441           description: Route Table Reference id, UUID assigned to this instance.
40442           required: true
40443           type: string
40444           example: __ROUTE-TABLE-REFERENCE-ID__
40445         - name: body
40446           in: body
40447           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)
40448           required: true
40449           schema:
40450             $ref: "#/definitions/route-table-reference"
40451     patch:
40452       tags:
40453         - Network
40454       summary: update an existing route-table-reference
40455       description: |
40456         Update an existing route-table-reference
40457         #
40458         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40459         The PUT operation will entirely replace an existing object.
40460         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40461         #
40462         Other differences between PUT and PATCH are:
40463         #
40464         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40465         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40466         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40467       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
40468       consumes:
40469         - application/json
40470         - application/xml
40471       produces:
40472         - application/json
40473         - application/xml
40474       responses:
40475         "default":
40476           description: Response codes found in [response codes](https://wiki.onap.org/).
40477       parameters:
40478         - name: route-table-reference-id
40479           in: path
40480           description: Route Table Reference id, UUID assigned to this instance.
40481           required: true
40482           type: string
40483           example: __ROUTE-TABLE-REFERENCE-ID__
40484         - name: body
40485           in: body
40486           description: route-table-reference object that needs to be updated.
40487           required: true
40488           schema:
40489             $ref: "#/patchDefinitions/route-table-reference"
40490     delete:
40491       tags:
40492         - Network
40493       summary: delete an existing route-table-reference
40494       description: delete an existing route-table-reference
40495       operationId: deleteNetworkRouteTableReferencesRouteTableReference
40496       consumes:
40497         - application/json
40498         - application/xml
40499       produces:
40500         - application/json
40501         - application/xml
40502       responses:
40503         "default":
40504           description: Response codes found in [response codes](https://wiki.onap.org/).
40505       parameters:
40506         - name: route-table-reference-id
40507           in: path
40508           description: Route Table Reference id, UUID assigned to this instance.
40509           required: true
40510           type: string
40511           example: __ROUTE-TABLE-REFERENCE-ID__
40512         - name: resource-version
40513           in: query
40514           description: resource-version for concurrency
40515           required: true
40516           type: string
40517   /network/route-table-references:
40518     get:
40519       tags:
40520         - Network
40521       summary: returns route-table-references
40522       description: returns route-table-references
40523       operationId: getNetworkRouteTableReferences
40524       produces:
40525         - application/json
40526         - application/xml
40527       responses:
40528         "200":
40529           description: successful operation
40530           schema:
40531               $ref: "#/getDefinitions/route-table-references"
40532         "default":
40533           description: Response codes found in [response codes](https://wiki.onap.org/).
40534       parameters:
40535         - name: route-table-reference-id
40536           in: query
40537           description:
40538           required: false
40539           type: string
40540         - name: route-table-reference-fqdn
40541           in: query
40542           description:
40543           required: false
40544           type: string
40545   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
40546     put:
40547       tags:
40548         - Network
40549       summary: see node definition for valid relationships
40550       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
40551       consumes:
40552         - application/json
40553         - application/xml
40554       produces:
40555         - application/json
40556         - application/xml
40557       responses:
40558         "default":
40559           description: Response codes found in [response codes](https://wiki.onap.org/).
40560       parameters:
40561         - name: id
40562           in: path
40563           description: Instance Group ID, UUID assigned to this instance.
40564           required: true
40565           type: string
40566           example: __ID__
40567         - name: body
40568           in: body
40569           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)
40570           required: true
40571           schema:
40572             $ref: "#/definitions/relationship"
40573     delete:
40574       tags:
40575         - Network
40576       summary: delete an existing relationship
40577       description: delete an existing relationship
40578       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
40579       consumes:
40580         - application/json
40581         - application/xml
40582       produces:
40583         - application/json
40584         - application/xml
40585       responses:
40586         "default":
40587           description: Response codes found in [response codes](https://wiki.onap.org/).
40588       parameters:
40589         - name: id
40590           in: path
40591           description: Instance Group ID, UUID assigned to this instance.
40592           required: true
40593           type: string
40594           example: __ID__
40595   /network/instance-groups/instance-group/{id}:
40596     get:
40597       tags:
40598         - Network
40599       summary: returns instance-group
40600       description: returns instance-group
40601       operationId: getNetworkInstanceGroupsInstanceGroup
40602       produces:
40603         - application/json
40604         - application/xml
40605       responses:
40606         "200":
40607           description: successful operation
40608           schema:
40609               $ref: "#/getDefinitions/instance-group"
40610         "default":
40611           description: Response codes found in [response codes](https://wiki.onap.org/).
40612       parameters:
40613         - name: id
40614           in: path
40615           description: Instance Group ID, UUID assigned to this instance.
40616           required: true
40617           type: string
40618           example: __ID__
40619     put:
40620       tags:
40621         - Network
40622       summary: create or update an existing instance-group
40623       description: |
40624         Create or update an existing instance-group.
40625         #
40626         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40627       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
40628       consumes:
40629         - application/json
40630         - application/xml
40631       produces:
40632         - application/json
40633         - application/xml
40634       responses:
40635         "default":
40636           description: Response codes found in [response codes](https://wiki.onap.org/).
40637       parameters:
40638         - name: id
40639           in: path
40640           description: Instance Group ID, UUID assigned to this instance.
40641           required: true
40642           type: string
40643           example: __ID__
40644         - name: body
40645           in: body
40646           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)
40647           required: true
40648           schema:
40649             $ref: "#/definitions/instance-group"
40650     patch:
40651       tags:
40652         - Network
40653       summary: update an existing instance-group
40654       description: |
40655         Update an existing instance-group
40656         #
40657         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40658         The PUT operation will entirely replace an existing object.
40659         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40660         #
40661         Other differences between PUT and PATCH are:
40662         #
40663         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40664         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40665         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40666       operationId: UpdateNetworkInstanceGroupsInstanceGroup
40667       consumes:
40668         - application/json
40669         - application/xml
40670       produces:
40671         - application/json
40672         - application/xml
40673       responses:
40674         "default":
40675           description: Response codes found in [response codes](https://wiki.onap.org/).
40676       parameters:
40677         - name: id
40678           in: path
40679           description: Instance Group ID, UUID assigned to this instance.
40680           required: true
40681           type: string
40682           example: __ID__
40683         - name: body
40684           in: body
40685           description: instance-group object that needs to be updated.
40686           required: true
40687           schema:
40688             $ref: "#/patchDefinitions/instance-group"
40689     delete:
40690       tags:
40691         - Network
40692       summary: delete an existing instance-group
40693       description: delete an existing instance-group
40694       operationId: deleteNetworkInstanceGroupsInstanceGroup
40695       consumes:
40696         - application/json
40697         - application/xml
40698       produces:
40699         - application/json
40700         - application/xml
40701       responses:
40702         "default":
40703           description: Response codes found in [response codes](https://wiki.onap.org/).
40704       parameters:
40705         - name: id
40706           in: path
40707           description: Instance Group ID, UUID assigned to this instance.
40708           required: true
40709           type: string
40710           example: __ID__
40711         - name: resource-version
40712           in: query
40713           description: resource-version for concurrency
40714           required: true
40715           type: string
40716   /network/instance-groups:
40717     get:
40718       tags:
40719         - Network
40720       summary: returns instance-groups
40721       description: returns instance-groups
40722       operationId: getNetworkInstanceGroups
40723       produces:
40724         - application/json
40725         - application/xml
40726       responses:
40727         "200":
40728           description: successful operation
40729           schema:
40730               $ref: "#/getDefinitions/instance-groups"
40731         "default":
40732           description: Response codes found in [response codes](https://wiki.onap.org/).
40733       parameters:
40734         - name: id
40735           in: query
40736           description:
40737           required: false
40738           type: string
40739         - name: description
40740           in: query
40741           description:
40742           required: false
40743           type: string
40744         - name: type
40745           in: query
40746           description:
40747           required: false
40748           type: string
40749         - name: sub-type
40750           in: query
40751           description:
40752           required: false
40753           type: string
40754   /network/zones/zone/{zone-id}/relationship-list/relationship:
40755     put:
40756       tags:
40757         - Network
40758       summary: see node definition for valid relationships
40759       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
40760       consumes:
40761         - application/json
40762         - application/xml
40763       produces:
40764         - application/json
40765         - application/xml
40766       responses:
40767         "default":
40768           description: Response codes found in [response codes](https://wiki.onap.org/).
40769       parameters:
40770         - name: zone-id
40771           in: path
40772           description: Code assigned by AIC to the zone
40773           required: true
40774           type: string
40775           example: __ZONE-ID__
40776         - name: body
40777           in: body
40778           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json)
40779           required: true
40780           schema:
40781             $ref: "#/definitions/relationship"
40782     delete:
40783       tags:
40784         - Network
40785       summary: delete an existing relationship
40786       description: delete an existing relationship
40787       operationId: deleteNetworkZonesZoneRelationshipListRelationship
40788       consumes:
40789         - application/json
40790         - application/xml
40791       produces:
40792         - application/json
40793         - application/xml
40794       responses:
40795         "default":
40796           description: Response codes found in [response codes](https://wiki.onap.org/).
40797       parameters:
40798         - name: zone-id
40799           in: path
40800           description: Code assigned by AIC to the zone
40801           required: true
40802           type: string
40803           example: __ZONE-ID__
40804   /network/zones/zone/{zone-id}:
40805     get:
40806       tags:
40807         - Network
40808       summary: returns zone
40809       description: returns zone
40810       operationId: getNetworkZonesZone
40811       produces:
40812         - application/json
40813         - application/xml
40814       responses:
40815         "200":
40816           description: successful operation
40817           schema:
40818               $ref: "#/getDefinitions/zone"
40819         "default":
40820           description: Response codes found in [response codes](https://wiki.onap.org/).
40821       parameters:
40822         - name: zone-id
40823           in: path
40824           description: Code assigned by AIC to the zone
40825           required: true
40826           type: string
40827           example: __ZONE-ID__
40828     put:
40829       tags:
40830         - Network
40831       summary: create or update an existing zone
40832       description: |
40833         Create or update an existing zone.
40834         #
40835         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40836       operationId: createOrUpdateNetworkZonesZone
40837       consumes:
40838         - application/json
40839         - application/xml
40840       produces:
40841         - application/json
40842         - application/xml
40843       responses:
40844         "default":
40845           description: Response codes found in [response codes](https://wiki.onap.org/).
40846       parameters:
40847         - name: zone-id
40848           in: path
40849           description: Code assigned by AIC to the zone
40850           required: true
40851           type: string
40852           example: __ZONE-ID__
40853         - name: body
40854           in: body
40855           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json)
40856           required: true
40857           schema:
40858             $ref: "#/definitions/zone"
40859     patch:
40860       tags:
40861         - Network
40862       summary: update an existing zone
40863       description: |
40864         Update an existing zone
40865         #
40866         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40867         The PUT operation will entirely replace an existing object.
40868         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40869         #
40870         Other differences between PUT and PATCH are:
40871         #
40872         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40873         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40874         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40875       operationId: UpdateNetworkZonesZone
40876       consumes:
40877         - application/json
40878         - application/xml
40879       produces:
40880         - application/json
40881         - application/xml
40882       responses:
40883         "default":
40884           description: Response codes found in [response codes](https://wiki.onap.org/).
40885       parameters:
40886         - name: zone-id
40887           in: path
40888           description: Code assigned by AIC to the zone
40889           required: true
40890           type: string
40891           example: __ZONE-ID__
40892         - name: body
40893           in: body
40894           description: zone object that needs to be updated.
40895           required: true
40896           schema:
40897             $ref: "#/patchDefinitions/zone"
40898     delete:
40899       tags:
40900         - Network
40901       summary: delete an existing zone
40902       description: delete an existing zone
40903       operationId: deleteNetworkZonesZone
40904       consumes:
40905         - application/json
40906         - application/xml
40907       produces:
40908         - application/json
40909         - application/xml
40910       responses:
40911         "default":
40912           description: Response codes found in [response codes](https://wiki.onap.org/).
40913       parameters:
40914         - name: zone-id
40915           in: path
40916           description: Code assigned by AIC to the zone
40917           required: true
40918           type: string
40919           example: __ZONE-ID__
40920         - name: resource-version
40921           in: query
40922           description: resource-version for concurrency
40923           required: true
40924           type: string
40925   /network/zones:
40926     get:
40927       tags:
40928         - Network
40929       summary: returns zones
40930       description: returns zones
40931       operationId: getNetworkZones
40932       produces:
40933         - application/json
40934         - application/xml
40935       responses:
40936         "200":
40937           description: successful operation
40938           schema:
40939               $ref: "#/getDefinitions/zones"
40940         "default":
40941           description: Response codes found in [response codes](https://wiki.onap.org/).
40942       parameters:
40943         - name: zone-id
40944           in: query
40945           description:
40946           required: false
40947           type: string
40948         - name: design-type
40949           in: query
40950           description:
40951           required: false
40952           type: string
40953         - name: zone-context
40954           in: query
40955           description:
40956           required: false
40957           type: string
40958 definitions:
40959   action:
40960     properties:
40961       action-type:
40962         type: string
40963       action-data:
40964         type: array
40965         items:
40966           $ref: "#/definitions/action-data"
40967   action-data:
40968     properties:
40969       property-name:
40970         type: string
40971       property-value:
40972         type: string
40973   actions:
40974     description: |
40975       APIs that are more action related than REST (e.g., notify, update).
40976     properties:
40977       update:
40978         type: object
40979         $ref: "#/definitions/update"
40980       notify:
40981         type: object
40982         $ref: "#/definitions/notify"
40983   allotted-resource:
40984     description: |
40985       Represents a slice or partial piece of a resource that gets separately allotted
40986       ###### Related Nodes
40987       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
40988       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
40989       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
40990       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
40991       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
40992       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
40993       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
40994
40995       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
40996       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
40997     required:
40998     - id
40999     properties:
41000       id:
41001         type: string
41002         description: Allotted Resource id UUID assigned to this instance.
41003       description:
41004         type: string
41005         description: The descriptive information assigned to this allotted resource instance
41006       selflink:
41007         type: string
41008         description: Link back to more information in the controller
41009       persona-model-id:
41010         type: string
41011         description: the ASDC model id for this resource or service model.
41012       persona-model-version:
41013         type: string
41014         description: the ASDC model version for this resource or service model.
41015       model-version-id:
41016         type: string
41017         description: the ASDC model version for this resource or service model.
41018       persona-model-customization-id:
41019         type: string
41020         description: captures the id of all the configuration used to customize the resource for the service.
41021       resource-version:
41022         type: string
41023         description: Concurrency value
41024       tunnel-xconnects:
41025         type: array
41026         items:
41027           $ref: "#/definitions/tunnel-xconnect"
41028       relationship-list:
41029         type: array
41030         items:
41031           $ref: "#/definitions/relationship"
41032   allotted-resources:
41033     description: |
41034       This object is used to store slices of services being offered
41035     properties:
41036       allotted-resource:
41037         type: array
41038         items:
41039           $ref: "#/definitions/allotted-resource"
41040   availability-zone:
41041     description: |
41042       Availability zone, a collection of compute hosts/pservers
41043       ###### Related Nodes
41044       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
41045       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
41046       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
41047       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
41048       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
41049       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
41050       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
41051       - FROM vce( vce Uses availability-zone, MANY2MANY)
41052
41053       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
41054       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
41055
41056     required:
41057     - availability-zone-name
41058     - hypervisor-type
41059     properties:
41060       availability-zone-name:
41061         type: string
41062         description: Name of the availability zone.  Unique across a cloud region
41063       hypervisor-type:
41064         type: string
41065         description: Type of hypervisor.  Source of truth should define valid values.
41066       operational-state:
41067         type: string
41068         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
41069       resource-version:
41070         type: string
41071         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41072       relationship-list:
41073         type: array
41074         items:
41075           $ref: "#/definitions/relationship"
41076   availability-zones:
41077     description: |
41078       Collection of availability zones
41079     properties:
41080       availability-zone:
41081         type: array
41082         items:
41083           $ref: "#/definitions/availability-zone"
41084   az-and-dvs-switches:
41085     properties:
41086       dvs-switches:
41087         type: object
41088         $ref: "#/definitions/dvs-switches"
41089       availability-zone:
41090         type: object
41091         $ref: "#/definitions/availability-zone"
41092   business:
41093     description: |
41094       Namespace for business related constructs
41095     properties:
41096       connectors:
41097         type: array
41098         items:
41099           $ref: "#/definitions/connector"
41100       customers:
41101         type: array
41102         items:
41103           $ref: "#/definitions/customer"
41104   class-of-service:
41105     description: |
41106       ###### Related Nodes
41107       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
41108
41109       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
41110     required:
41111     - cos
41112     properties:
41113       cos:
41114         type: string
41115         description: unique identifier of probe
41116       probe-id:
41117         type: string
41118         description: identifier of probe
41119       probe-type:
41120         type: string
41121         description: type of probe
41122       resource-version:
41123         type: string
41124         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41125       relationship-list:
41126         type: array
41127         items:
41128           $ref: "#/definitions/relationship"
41129   classes-of-service:
41130     description: |
41131       class-of-service of probe
41132     properties:
41133       class-of-service:
41134         type: array
41135         items:
41136           $ref: "#/definitions/class-of-service"
41137   cloud-infrastructure:
41138     description: |
41139       Namespace for cloud infrastructure.
41140     properties:
41141       complexes:
41142         type: array
41143         items:
41144           $ref: "#/definitions/complex"
41145       cloud-regions:
41146         type: array
41147         items:
41148           $ref: "#/definitions/cloud-region"
41149       network-profiles:
41150         type: array
41151         items:
41152           $ref: "#/definitions/network-profile"
41153       pservers:
41154         type: array
41155         items:
41156           $ref: "#/definitions/pserver"
41157       virtual-data-centers:
41158         type: array
41159         items:
41160           $ref: "#/definitions/virtual-data-center"
41161   cloud-region:
41162     description: |
41163       cloud-region designates an installation of a cloud cluster or region or instantiation.
41164       ###### Related Nodes
41165       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
41166       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
41167       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
41168       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
41169       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
41170       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
41171       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
41172       - FROM image( image BelongsTo cloud-region, MANY2ONE)
41173       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
41174       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
41175       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
41176       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
41177       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
41178       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
41179
41180       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
41181       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
41182
41183     required:
41184     - cloud-owner
41185     - cloud-region-id
41186     properties:
41187       cloud-owner:
41188         type: string
41189         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
41190       cloud-region-id:
41191         type: string
41192         description: Identifier used by the vendor for the region. Second part of composite key
41193       cloud-type:
41194         type: string
41195         description: Type of the cloud (e.g., openstack)
41196       owner-defined-type:
41197         type: string
41198         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
41199       cloud-region-version:
41200         type: string
41201         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
41202       identity-url:
41203         type: string
41204         description: URL of the keystone identity service
41205       cloud-zone:
41206         type: string
41207         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
41208       complex-name:
41209         type: string
41210         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
41211       resource-version:
41212         type: string
41213         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41214       volume-groups:
41215         type: array
41216         items:
41217           $ref: "#/definitions/volume-group"
41218       tenants:
41219         type: array
41220         items:
41221           $ref: "#/definitions/tenant"
41222       flavors:
41223         type: array
41224         items:
41225           $ref: "#/definitions/flavor"
41226       group-assignments:
41227         type: array
41228         items:
41229           $ref: "#/definitions/group-assignment"
41230       snapshots:
41231         type: array
41232         items:
41233           $ref: "#/definitions/snapshot"
41234       images:
41235         type: array
41236         items:
41237           $ref: "#/definitions/image"
41238       dvs-switches:
41239         type: array
41240         items:
41241           $ref: "#/definitions/dvs-switch"
41242       oam-networks:
41243         type: array
41244         items:
41245           $ref: "#/definitions/oam-network"
41246       availability-zones:
41247         type: array
41248         items:
41249           $ref: "#/definitions/availability-zone"
41250       relationship-list:
41251         type: array
41252         items:
41253           $ref: "#/definitions/relationship"
41254   cloud-regions:
41255     properties:
41256       cloud-region:
41257         type: array
41258         items:
41259           $ref: "#/definitions/cloud-region"
41260   complex:
41261     description: |
41262       Collection of physical locations that can house cloud-regions.
41263       ###### Related Nodes
41264       - TO l3-network( complex Uses l3-network, MANY2MANY)
41265       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
41266       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
41267       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
41268       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
41269       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
41270       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
41271       - FROM vce( vce LocatedIn complex, MANY2MANY)
41272       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
41273       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
41274       - FROM zone( zone LocatedIn complex, MANY2ONE)
41275
41276       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
41277       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
41278
41279     required:
41280     - physical-location-id
41281     - physical-location-type
41282     - street1
41283     - city
41284     - postal-code
41285     - country
41286     - region
41287     properties:
41288       physical-location-id:
41289         type: string
41290         description: Unique identifier for physical location, e.g., CLLI
41291       data-center-code:
41292         type: string
41293         description: Data center code which can be an alternate way to identify a complex
41294       complex-name:
41295         type: string
41296         description: Gamma complex name for LCP instance.
41297       identity-url:
41298         type: string
41299         description: URL of the keystone identity service
41300       resource-version:
41301         type: string
41302         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41303       physical-location-type:
41304         type: string
41305         description: Type, e.g., central office, data center.
41306       street1:
41307         type: string
41308       street2:
41309         type: string
41310       city:
41311         type: string
41312       state:
41313         type: string
41314       postal-code:
41315         type: string
41316       country:
41317         type: string
41318       region:
41319         type: string
41320       latitude:
41321         type: string
41322       longitude:
41323         type: string
41324       elevation:
41325         type: string
41326       lata:
41327         type: string
41328       ctag-pools:
41329         type: array
41330         items:
41331           $ref: "#/definitions/ctag-pool"
41332       relationship-list:
41333         type: array
41334         items:
41335           $ref: "#/definitions/relationship"
41336   complexes:
41337     description: |
41338       Collection of physical locations that can house cloud-regions.
41339     properties:
41340       complex:
41341         type: array
41342         items:
41343           $ref: "#/definitions/complex"
41344   configuration:
41345     description: |
41346       Port Mirror Configuration.
41347       ###### Related Nodes
41348       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
41349       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
41350       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
41351       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
41352       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
41353
41354       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
41355       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
41356       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
41357     required:
41358     - configuration-id
41359     - configuration-type
41360     - configuration-sub-type
41361     - orchestration-status
41362     - operational-status
41363     - configuration-selflink
41364     - model-customization-id
41365     properties:
41366       configuration-id:
41367         type: string
41368         description: UUID assigned to configuration.
41369       management-option:
41370         type: string
41371         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
41372       configuration-name:
41373         type: string
41374         description: Name of the configuration.
41375       configuration-type:
41376         type: string
41377         description: port-mirroring-configuration.
41378       configuration-sub-type:
41379         type: string
41380         description: vprobe, pprobe.
41381       model-invariant-id:
41382         type: string
41383         description: the ASDC model id for this resource or service model.
41384       model-version-id:
41385         type: string
41386         description: the ASDC model version for this resource or service model.
41387       orchestration-status:
41388         type: string
41389         description: Orchestration status of the configuration.
41390       operational-status:
41391         type: string
41392         description: Indicator for whether the resource is considered operational.
41393       configuration-selflink:
41394         type: string
41395         description: URL to endpoint where AAI can get more details from SDN-GC.
41396       model-customization-id:
41397         type: string
41398         description: id of  the configuration used to customize the resource
41399       resource-version:
41400         type: string
41401         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41402       relationship-list:
41403         type: array
41404         items:
41405           $ref: "#/definitions/relationship"
41406       metadata:
41407         type: array
41408         items:
41409           $ref: "#/definitions/metadatum"
41410   configurations:
41411     description: |
41412       Collection of configurations
41413     properties:
41414       configuration:
41415         type: array
41416         items:
41417           $ref: "#/definitions/configuration"
41418   connector:
41419     description: |
41420       Collection of resource instances used to connect a variety of disparate inventory widgets
41421       ###### Related Nodes
41422       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
41423       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
41424       - FROM service-instance( service-instance Uses connector, MANY2MANY)
41425
41426       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
41427     required:
41428     - resource-instance-id
41429     properties:
41430       resource-instance-id:
41431         type: string
41432         description: Unique id of resource instance.
41433       resource-version:
41434         type: string
41435         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41436       persona-model-id:
41437         type: string
41438         description: the ASDC model id for this resource or service model.
41439       persona-model-version:
41440         type: string
41441         description: the ASDC model version for this resource or service model.
41442       model-version-id:
41443         type: string
41444         description: the ASDC model version for this resource or service model.
41445       widget-model-id:
41446         type: string
41447         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41448       widget-model-version:
41449         type: string
41450         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41451       relationship-list:
41452         type: array
41453         items:
41454           $ref: "#/definitions/relationship"
41455       metadata:
41456         type: array
41457         items:
41458           $ref: "#/definitions/metadatum"
41459   connectors:
41460     description: |
41461       Collection of resource instances used to connect a variety of disparate inventory widgets
41462     properties:
41463       connector:
41464         type: array
41465         items:
41466           $ref: "#/definitions/connector"
41467   constrained-element-set:
41468     description: |
41469       This is how we would capture constraints defining allowed sets of elements.
41470       ###### Related Nodes
41471       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
41472       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
41473       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
41474
41475       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
41476       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
41477     required:
41478     - constrained-element-set-uuid
41479     - constraint-type
41480     - check-type
41481     properties:
41482       constrained-element-set-uuid:
41483         type: string
41484       constraint-type:
41485         type: string
41486       check-type:
41487         type: string
41488       resource-version:
41489         type: string
41490       element-choice-sets:
41491         type: array
41492         items:
41493           $ref: "#/definitions/element-choice-set"
41494       relationship-list:
41495         type: array
41496         items:
41497           $ref: "#/definitions/relationship"
41498   constrained-element-sets:
41499     properties:
41500       constrained-element-set:
41501         type: array
41502         items:
41503           $ref: "#/definitions/constrained-element-set"
41504   ctag-assignment:
41505     description: |
41506       ###### Related Nodes
41507       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
41508       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
41509
41510       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
41511     required:
41512     - vlan-id-inner
41513     properties:
41514       vlan-id-inner:
41515         type: integer
41516         format: int64
41517         description: id.
41518       resource-version:
41519         type: string
41520         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41521       relationship-list:
41522         type: array
41523         items:
41524           $ref: "#/definitions/relationship"
41525   ctag-assignments:
41526     properties:
41527       ctag-assignment:
41528         type: array
41529         items:
41530           $ref: "#/definitions/ctag-assignment"
41531   ctag-pool:
41532     description: |
41533       A collection of C tags (vlan tags) grouped for a specific purpose.
41534       ###### Related Nodes
41535       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
41536       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
41537       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
41538
41539       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
41540     required:
41541     - target-pe
41542     - availability-zone-name
41543     - ctag-pool-purpose
41544     properties:
41545       target-pe:
41546         type: string
41547         description: The Target provider edge router
41548       availability-zone-name:
41549         type: string
41550         description: Name of the availability zone
41551       ctag-pool-purpose:
41552         type: string
41553         description: Describes what the intended purpose of this pool is.
41554       ctag-values:
41555         type: string
41556         description: Comma separated list of ctags
41557       resource-version:
41558         type: string
41559         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41560       relationship-list:
41561         type: array
41562         items:
41563           $ref: "#/definitions/relationship"
41564   ctag-pools:
41565     properties:
41566       ctag-pool:
41567         type: array
41568         items:
41569           $ref: "#/definitions/ctag-pool"
41570   customer:
41571     description: |
41572       customer identifiers to provide linkage back to BSS information.
41573       ###### Related Nodes
41574       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
41575
41576       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
41577     required:
41578     - global-customer-id
41579     - subscriber-name
41580     - subscriber-type
41581     properties:
41582       global-customer-id:
41583         type: string
41584         description: Global customer id used across ECOMP to uniquely identify customer.
41585       subscriber-name:
41586         type: string
41587         description: Subscriber name, an alternate way to retrieve a customer.
41588       subscriber-type:
41589         type: string
41590         description: Subscriber type, a way to provide VID with only the INFRA customers.
41591       resource-version:
41592         type: string
41593         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41594       service-subscriptions:
41595         type: array
41596         items:
41597           $ref: "#/definitions/service-subscription"
41598       relationship-list:
41599         type: array
41600         items:
41601           $ref: "#/definitions/relationship"
41602   customers:
41603     description: |
41604       Collection of customer identifiers to provide linkage back to BSS information.
41605     properties:
41606       customer:
41607         type: array
41608         items:
41609           $ref: "#/definitions/customer"
41610   cvlan-tag-entry:
41611     required:
41612     - cvlan-tag
41613     properties:
41614       cvlan-tag:
41615         type: integer
41616         format: int64
41617         description: See mis-na-virtualization-platform.yang
41618       resource-version:
41619         type: string
41620         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41621       relationship-list:
41622         type: array
41623         items:
41624           $ref: "#/definitions/relationship"
41625   cvlan-tags:
41626     properties:
41627       cvlan-tag-entry:
41628         type: array
41629         items:
41630           $ref: "#/definitions/cvlan-tag-entry"
41631   dvs-switch:
41632     description: |
41633       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.
41634       ###### Related Nodes
41635       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
41636       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
41637
41638     required:
41639     - switch-name
41640     - vcenter-url
41641     properties:
41642       switch-name:
41643         type: string
41644         description: DVS switch name
41645       vcenter-url:
41646         type: string
41647         description: URL used to reach the vcenter
41648       resource-version:
41649         type: string
41650         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41651       relationship-list:
41652         type: array
41653         items:
41654           $ref: "#/definitions/relationship"
41655   dvs-switches:
41656     description: |
41657       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
41658     properties:
41659       dvs-switch:
41660         type: array
41661         items:
41662           $ref: "#/definitions/dvs-switch"
41663   edge-prop-names:
41664     description: |
41665       Internal map to define the properties of an edge and interpret the map EdgeRules
41666     properties:
41667       edgeLabel:
41668         type: string
41669       direction:
41670         type: string
41671       multiplicityRule:
41672         type: string
41673       isParent:
41674         type: boolean
41675       usesResource:
41676         type: boolean
41677       hasDelTarget:
41678         type: boolean
41679       SVC-INFRA:
41680         type: boolean
41681       SVC-INFRA-REV:
41682         type: boolean
41683   edge-tag-query-request:
41684     properties:
41685       edge-tag:
41686         type: string
41687       result-detail:
41688         type: string
41689       start-node-type:
41690         type: string
41691       start-node-filter:
41692         type: array
41693         items:
41694           $ref: "#/definitions/start-node-filter"
41695       include-node-filter:
41696         type: array
41697         items:
41698           $ref: "#/definitions/include-node-filter"
41699       secondary-filter:
41700         type: array
41701         items:
41702           $ref: "#/definitions/secondary-filter"
41703   edge-tag-query-result:
41704     properties:
41705       tagged-inventory-item-list:
41706         type: array
41707         items:
41708           $ref: "#/definitions/tagged-inventory-item-list"
41709   element-choice-set:
41710     description: |
41711       This is how we would capture constraints defining allowed sets of elements.
41712       ###### Related Nodes
41713       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
41714       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
41715
41716       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
41717       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
41718     required:
41719     - element-choice-set-uuid
41720     - element-choice-set-name
41721     properties:
41722       element-choice-set-uuid:
41723         type: string
41724       element-choice-set-name:
41725         type: string
41726       cardinality:
41727         type: string
41728       resource-version:
41729         type: string
41730       model-elements:
41731         type: array
41732         items:
41733           $ref: "#/definitions/model-element"
41734       relationship-list:
41735         type: array
41736         items:
41737           $ref: "#/definitions/relationship"
41738   element-choice-sets:
41739     properties:
41740       element-choice-set:
41741         type: array
41742         items:
41743           $ref: "#/definitions/element-choice-set"
41744   entitlement:
41745     description: |
41746       Metadata for entitlement group.
41747       ###### Related Nodes
41748       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
41749       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
41750
41751       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
41752     required:
41753     - group-uuid
41754     - resource-uuid
41755     properties:
41756       group-uuid:
41757         type: string
41758         description: Unique ID for the entitlement group the resource comes from, should be uuid.
41759       resource-uuid:
41760         type: string
41761         description: Unique ID of an entitlement resource.
41762       resource-version:
41763         type: string
41764         description: Concurrency value
41765       relationship-list:
41766         type: array
41767         items:
41768           $ref: "#/definitions/relationship"
41769   entitlements:
41770     description: |
41771       Entitlements, keyed by group-uuid and resource-uuid, related to license management
41772     properties:
41773       entitlement:
41774         type: array
41775         items:
41776           $ref: "#/definitions/entitlement"
41777   esr-ems:
41778     description: |
41779       Persist EMS address information used by EMS driver.
41780       ###### Related Nodes
41781       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
41782
41783       -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
41784     required:
41785     - ems-id
41786     properties:
41787       ems-id:
41788         type: string
41789         description: Unique ID of EMS.
41790       resource-version:
41791         type: string
41792         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41793       esr-system-info-list:
41794         type: object
41795         $ref: "#/definitions/esr-system-info-list"
41796       relationship-list:
41797         type: object
41798         $ref: "#/definitions/relationship-list"
41799   esr-ems-list:
41800     properties:
41801       esr-ems:
41802         type: array
41803         items:
41804           $ref: "#/definitions/esr-ems"
41805   esr-system-info:
41806     description: |
41807       Persist common address information of external systems.
41808       ###### Related Nodes
41809       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
41810       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
41811       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
41812       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
41813
41814       -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
41815     required:
41816     - esr-system-info-id
41817     - user-name
41818     - password
41819     - system-type
41820     properties:
41821       esr-system-info-id:
41822         type: string
41823         description: Unique ID of esr system info.
41824       system-name:
41825         type: string
41826         description: name of external system.
41827       type:
41828         type: string
41829         description: type of external systems.
41830       vendor:
41831         type: string
41832         description: vendor of external systems.
41833       version:
41834         type: string
41835         description: version of external systems.
41836       service-url:
41837         type: string
41838         description: url used to access external systems.
41839       user-name:
41840         type: string
41841         description: username used to access external systems.
41842       password:
41843         type: string
41844         description: password used to access external systems.
41845       system-type:
41846         type: string
41847         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
41848       protocol:
41849         type: string
41850         description: protocol of third party SDNC, for example netconf/snmp.
41851       ssl-cacert:
41852         type: string
41853         description: ca file content if enabled ssl on auth-url.
41854       ssl-insecure:
41855         type: boolean
41856         description: Whether to verify VIM's certificate.
41857       ip-address:
41858         type: string
41859         description: service IP of ftp server.
41860       port:
41861         type: string
41862         description: service port of ftp server.
41863       cloud-domain:
41864         type: string
41865         description: domain info for authentication.
41866       default-tenant:
41867         type: string
41868         description: default tenant of VIM.
41869       passive:
41870         type: boolean
41871         description: ftp passive mode or not.
41872       remote-path:
41873         type: string
41874         description: resource or performance data file path.
41875       system-status:
41876         type: string
41877         description: the status of external system.
41878       resource-version:
41879         type: string
41880         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41881       relationship-list:
41882         type: array
41883         items:
41884           $ref: "#/definitions/relationship"
41885   esr-system-info-list:
41886     description: |
41887       Collection of persistent block-level external system auth info.
41888     properties:
41889       esr-system-info:
41890         type: array
41891         items:
41892           $ref: "#/definitions/esr-system-info"
41893   esr-thirdparty-sdnc:
41894     description: |
41895       Persist SDNC address information used by ONAP SDNC.
41896       ###### Related Nodes
41897       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
41898       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
41899
41900       -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
41901     required:
41902     - thirdparty-sdnc-id
41903     properties:
41904       thirdparty-sdnc-id:
41905         type: string
41906         description: Unique ID of SDNC.
41907       location:
41908         type: string
41909         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
41910       product-name:
41911         type: string
41912         description: password used to access SDNC server.
41913       resource-version:
41914         type: string
41915         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41916       esr-system-info-list:
41917         type: object
41918         $ref: "#/definitions/esr-system-info-list"
41919       relationship-list:
41920         type: object
41921         $ref: "#/definitions/relationship-list"
41922   esr-thirdparty-sdnc-list:
41923     properties:
41924       esr-thirdparty-sdnc:
41925         type: array
41926         items:
41927           $ref: "#/definitions/esr-thirdparty-sdnc"
41928   esr-vnfm:
41929     description: |
41930       Persist VNFM address information used by VF-C.
41931       ###### Related Nodes
41932       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
41933
41934       -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
41935     required:
41936     - vnfm-id
41937     properties:
41938       vnfm-id:
41939         type: string
41940         description: Unique ID of VNFM.
41941       vim-id:
41942         type: string
41943         description: indecate the VIM to deploy VNF.
41944       certificate-url:
41945         type: string
41946         description: certificate url of VNFM.
41947       resource-version:
41948         type: string
41949         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
41950       esr-system-info-list:
41951         type: object
41952         $ref: "#/definitions/esr-system-info-list"
41953       relationship-list:
41954         type: object
41955         $ref: "#/definitions/relationship-list"
41956   esr-vnfm-list:
41957     properties:
41958       esr-vnfm:
41959         type: array
41960         items:
41961           $ref: "#/definitions/esr-vnfm"
41962   evc:
41963     description: |
41964       evc object is an optional child object of the Configuration object.
41965       ###### Related Nodes
41966       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
41967
41968       -(4) IF this TO node is deleted, this EVC is DELETED also
41969     required:
41970     - evc-id
41971     properties:
41972       evc-id:
41973         type: string
41974         description: Unique/key field for the evc object
41975       forwarding-path-topology:
41976         type: string
41977         description: Point-to-Point, Multi-Point
41978       cir-value:
41979         type: string
41980         description: Commited Information Rate
41981       cir-units:
41982         type: string
41983         description: CIR units
41984       connection-diversity-group-id:
41985         type: string
41986         description: Diversity Group ID
41987       service-hours:
41988         type: string
41989         description: formerly Performance Group
41990       esp-evc-circuit-id:
41991         type: string
41992         description: EVC Circuit ID of ESP EVC
41993       esp-evc-cir-value:
41994         type: string
41995         description: Committed Information Rate (For ESP)
41996       esp-evc-cir-units:
41997         type: string
41998         description: CIR units (For ESP)
41999       esp-itu-code:
42000         type: string
42001         description: Identifies ESP
42002       collector-pop-clli:
42003         type: string
42004         description: Collector POP CLLI (from the hostname of the access pnf)
42005       inter-connect-type-ingress:
42006         type: string
42007         description: Interconnect type on ingress side of EVC.
42008       tagmode-access-ingress:
42009         type: string
42010         description: tagode for collector side of EVC
42011       tagmode-access-egress:
42012         type: string
42013         description: tagMode for network side of EVC
42014       relationship-list:
42015         type: array
42016         items:
42017           $ref: "#/definitions/relationship"
42018       resource-version:
42019         type: string
42020         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42021   evcs:
42022     properties:
42023       evc:
42024         type: array
42025         items:
42026           $ref: "#/definitions/evc"
42027   external-system:
42028     description: |
42029       Namespace for external system.
42030     properties:
42031       esr-ems-list:
42032         type: object
42033         $ref: "#/definitions/esr-ems-list"
42034       esr-vnfm-list:
42035         type: object
42036         $ref: "#/definitions/esr-vnfm-list"
42037       esr-thirdparty-sdnc-list:
42038         type: object
42039         $ref: "#/definitions/esr-thirdparty-sdnc-list"
42040   extra-properties:
42041     description: |
42042       Extra properties for inventory item for response list
42043   extra-property:
42044     properties:
42045       property-name:
42046         type: string
42047   flavor:
42048     description: |
42049       Openstack flavor.
42050       ###### Related Nodes
42051       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
42052       - FROM vserver( vserver Uses flavor, MANY2ONE)
42053
42054       -FLAVOR cannot be deleted if related to VSERVER
42055
42056     required:
42057     - flavor-id
42058     - flavor-name
42059     - flavor-selflink
42060     properties:
42061       flavor-id:
42062         type: string
42063         description: Flavor id, expected to be unique across cloud-region.
42064       flavor-name:
42065         type: string
42066         description: Flavor name
42067       flavor-vcpus:
42068         type: integer
42069         format: int32
42070         description: Number of CPUs
42071       flavor-ram:
42072         type: integer
42073         format: int32
42074         description: Amount of memory
42075       flavor-disk:
42076         type: integer
42077         format: int32
42078         description: Disk space
42079       flavor-ephemeral:
42080         type: integer
42081         format: int32
42082         description: Amount of ephemeral disk space
42083       flavor-swap:
42084         type: string
42085         description: amount of swap space allocation
42086       flavor-is-public:
42087         type: boolean
42088         description: whether flavor is available to all users or private to the tenant it was created in.
42089       flavor-selflink:
42090         type: string
42091         description: URL to endpoint where AAI can get more details
42092       flavor-disabled:
42093         type: boolean
42094         description: Boolean as to whether this flavor is no longer enabled
42095       resource-version:
42096         type: string
42097         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42098       relationship-list:
42099         type: array
42100         items:
42101           $ref: "#/definitions/relationship"
42102   flavors:
42103     description: |
42104       Collection of openstack flavors.
42105     properties:
42106       flavor:
42107         type: array
42108         items:
42109           $ref: "#/definitions/flavor"
42110   forwarder:
42111     description: |
42112       Entity describing a sequenced segment of forwarding path
42113       ###### Related Nodes
42114       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
42115       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
42116       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
42117       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
42118       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
42119
42120       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
42121       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
42122     required:
42123     - sequence
42124     properties:
42125       sequence:
42126         type: integer
42127         format: int32
42128         description: Unique ID of this segmentation
42129       forwarder-role:
42130         type: string
42131         description: ingress, intermediate, egress
42132       relationship-list:
42133         type: array
42134         items:
42135           $ref: "#/definitions/relationship"
42136       resource-version:
42137         type: string
42138         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42139   forwarder-evc:
42140     description: |
42141       forwarder object is an optional child object of the Configuration object.
42142       ###### Related Nodes
42143       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
42144
42145       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
42146     required:
42147     - forwarder-evc-id
42148     properties:
42149       forwarder-evc-id:
42150         type: string
42151         description: Key for forwarder-evc object
42152       circuit-id:
42153         type: string
42154         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
42155       ivlan:
42156         type: string
42157         description: Internal VLAN.
42158       svlan:
42159         type: string
42160         description: SVLAN value for ingress of egress forwarder.
42161       cvlan:
42162         type: string
42163         description: CVLAN value for ingress of egress forwarder.
42164       relationship-list:
42165         type: array
42166         items:
42167           $ref: "#/definitions/relationship"
42168       resource-version:
42169         type: string
42170         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42171   forwarder-evcs:
42172     properties:
42173       forwarder-evc:
42174         type: array
42175         items:
42176           $ref: "#/definitions/forwarder-evc"
42177   forwarders:
42178     properties:
42179       forwarder:
42180         type: array
42181         items:
42182           $ref: "#/definitions/forwarder"
42183   forwarding-path:
42184     description: |
42185       Entity that describes the sequenced forwarding path between interfaces of services or resources
42186       ###### Related Nodes
42187       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
42188       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
42189       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
42190
42191       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
42192       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
42193       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
42194     required:
42195     - forwarding-path-id
42196     - forwarding-path-name
42197     properties:
42198       forwarding-path-id:
42199         type: string
42200         description: Unique ID of this FP
42201       forwarding-path-name:
42202         type: string
42203         description: Name of the FP
42204       relationship-list:
42205         type: array
42206         items:
42207           $ref: "#/definitions/relationship"
42208       resource-version:
42209         type: string
42210         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42211       selflink:
42212         type: string
42213         description: the self link for this FP
42214       forwarders:
42215         type: array
42216         items:
42217           $ref: "#/definitions/forwarder"
42218   forwarding-paths:
42219     properties:
42220       forwarding-path:
42221         type: array
42222         items:
42223           $ref: "#/definitions/forwarding-path"
42224   generic-vnf:
42225     description: |
42226       General purpose VNF
42227       ###### Related Nodes
42228       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
42229       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
42230       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
42231       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
42232       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
42233       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
42234       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
42235       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
42236       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
42237       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
42238       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
42239       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
42240       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
42241       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
42242       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
42243       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
42244       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
42245       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
42246       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
42247       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
42248       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
42249
42250       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
42251     required:
42252     - vnf-id
42253     - vnf-name
42254     - vnf-type
42255     - in-maint
42256     - is-closed-loop-disabled
42257     properties:
42258       vnf-id:
42259         type: string
42260         description: Unique id of VNF.  This is unique across the graph.
42261       vnf-name:
42262         type: string
42263         description: Name of VNF.
42264       vnf-name2:
42265         type: string
42266         description: Alternate name of VNF.
42267       vnf-type:
42268         type: string
42269         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.
42270       service-id:
42271         type: string
42272         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42273       regional-resource-zone:
42274         type: string
42275         description: Regional way of organizing pservers, source of truth should define values
42276       prov-status:
42277         type: string
42278         description: Trigger for operational monitoring of this resource by Service Assurance systems.
42279       operational-state:
42280         type: string
42281         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
42282       license-key:
42283         type: string
42284         description: OBSOLETE -  do not use
42285       equipment-role:
42286         type: string
42287         description: Client should send valid enumerated value
42288       orchestration-status:
42289         type: string
42290         description: Orchestration status of this VNF, used by MSO.
42291       heat-stack-id:
42292         type: string
42293         description: Heat stack id corresponding to this instance, managed by MSO
42294       mso-catalog-key:
42295         type: string
42296         description: Corresponds to the SDN-C catalog id used to configure this VCE
42297       management-option:
42298         type: string
42299         description: identifier of managed by company or customer
42300       ipv4-oam-address:
42301         type: string
42302         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
42303       ipv4-loopback0-address:
42304         type: string
42305         description: v4 Loopback0 address
42306       nm-lan-v6-address:
42307         type: string
42308         description: v6 Loopback address
42309       management-v6-address:
42310         type: string
42311         description: v6 management address
42312       vcpu:
42313         type: integer
42314         format: int64
42315         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42316       vcpu-units:
42317         type: string
42318         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
42319       vmemory:
42320         type: integer
42321         format: int64
42322         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42323       vmemory-units:
42324         type: string
42325         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
42326       vdisk:
42327         type: integer
42328         format: int64
42329         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42330       vdisk-units:
42331         type: string
42332         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
42333       in-maint:
42334         type: boolean
42335         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.
42336       is-closed-loop-disabled:
42337         type: boolean
42338         description: used to indicate whether closed loop function is enabled on this node
42339       resource-version:
42340         type: string
42341         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42342       summary-status:
42343         type: string
42344         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
42345       encrypted-access-flag:
42346         type: boolean
42347         description: indicates whether generic-vnf access uses SSH
42348       persona-model-id:
42349         type: string
42350         description: the ASDC model id for this resource or service model.
42351       persona-model-version:
42352         type: string
42353         description: the ASDC model version for this resource or service model.
42354       model-version-id:
42355         type: string
42356         description: the ASDC model version for this resource or service model.
42357       persona-model-customization-id:
42358         type: string
42359         description: captures the id of all the configuration used to customize the resource for the service.
42360       widget-model-id:
42361         type: string
42362         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42363       widget-model-version:
42364         type: string
42365         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42366       as-number:
42367         type: string
42368         description: as-number of the VNF
42369       regional-resource-subzone:
42370         type: string
42371         description: represents sub zone of the rr plane
42372       selflink:
42373         type: string
42374         description: Path to the controller object.
42375       relationship-list:
42376         type: array
42377         items:
42378           $ref: "#/definitions/relationship"
42379       l-interfaces:
42380         type: array
42381         items:
42382           $ref: "#/definitions/l-interface"
42383       lag-interfaces:
42384         type: array
42385         items:
42386           $ref: "#/definitions/lag-interface"
42387       vf-modules:
42388         type: array
42389         items:
42390           $ref: "#/definitions/vf-module"
42391       licenses:
42392         type: array
42393         items:
42394           $ref: "#/definitions/license"
42395       entitlements:
42396         type: array
42397         items:
42398           $ref: "#/definitions/entitlement"
42399   generic-vnfs:
42400     description: |
42401       Collection of VNFs
42402     properties:
42403       generic-vnf:
42404         type: array
42405         items:
42406           $ref: "#/definitions/generic-vnf"
42407   group-assignment:
42408     description: |
42409       Openstack group-assignment used to store exclusivity groups (EG).
42410       ###### Related Nodes
42411       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
42412       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
42413       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
42414
42415     required:
42416     - group-id
42417     - group-type
42418     - group-name
42419     properties:
42420       group-id:
42421         type: string
42422         description: Group id, expected to be unique across cloud-region.
42423       group-type:
42424         type: string
42425         description: Group type - the type of group this instance refers to
42426       group-name:
42427         type: string
42428         description: Group name - name assigned to the group
42429       group-description:
42430         type: string
42431         description: Group description - description of the group
42432       resource-version:
42433         type: string
42434         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42435       relationship-list:
42436         type: array
42437         items:
42438           $ref: "#/definitions/relationship"
42439   group-assignments:
42440     description: |
42441       Collection of openstack group assignments
42442     properties:
42443       group-assignment:
42444         type: array
42445         items:
42446           $ref: "#/definitions/group-assignment"
42447   host-route:
42448     description: |
42449       ###### Related Nodes
42450       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
42451
42452       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
42453     required:
42454     - host-route-id
42455     - route-prefix
42456     - next-hop
42457     properties:
42458       host-route-id:
42459         type: string
42460         description: host-route id
42461       route-prefix:
42462         type: string
42463         description: subnet prefix
42464       next-hop:
42465         type: string
42466         description: Could be ip-address, hostname, or service-instance
42467       next-hop-type:
42468         type: string
42469         description: Should be ip-address, hostname, or service-instance to match next-hop
42470       resource-version:
42471         type: string
42472         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42473       relationship-list:
42474         type: array
42475         items:
42476           $ref: "#/definitions/relationship"
42477   host-routes:
42478     properties:
42479       host-route:
42480         type: array
42481         items:
42482           $ref: "#/definitions/host-route"
42483   hpa-capabilities:
42484     description: |
42485       Collection of HPA Capabilities
42486     properties:
42487       hpa-capability:
42488         type: array
42489         items:
42490           $ref: "#/definitions/hpa-capability"
42491   hpa-capability:
42492     description: |
42493       Represents a HPA capability
42494       ###### Related Nodes
42495       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
42496       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
42497       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
42498
42499       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
42500     required:
42501     - hpa-capability-id
42502     - hpa-feature
42503     properties:
42504       hpa-capability-id:
42505         type: string
42506         description: UUID to uniquely identify a HPA capability
42507       hpa-feature:
42508         type: string
42509         description: Name of the HPACapability
42510       hpa-version:
42511         type: string
42512         description: HPA schema version
42513       architecture:
42514         type: string
42515         description: Hardware architecture
42516       resource-version:
42517         type: string
42518         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42519       relationship-list:
42520         type: array
42521         items:
42522           $ref: "#/definitions/relationship"
42523       hpa-feature-attributes:
42524         type: array
42525         items:
42526           $ref: "#/definitions/hpa-feature-attributes"
42527   hpa-feature-attributes:
42528     description: |
42529       HPA Capability Feature attributes
42530       ###### Related Nodes
42531       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
42532
42533       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
42534     required:
42535     - hpa-attribute-key
42536     properties:
42537       hpa-attribute-key:
42538         type: string
42539         description: name of the specific HPA attribute
42540       hpa-attribute-value:
42541         type: string
42542         description: JSON string specifying the value, unit and type of the specific HPA attribute
42543       resource-version:
42544         type: string
42545         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42546       relationship-list:
42547         type: array
42548         items:
42549           $ref: "#/definitions/relationship"
42550   image:
42551     description: |
42552       Openstack image.
42553       ###### Related Nodes
42554       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
42555       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
42556       - FROM vserver( vserver Uses image, MANY2ONE)
42557
42558       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
42559       -IMAGE cannot be deleted if related to VSERVER
42560
42561     required:
42562     - image-id
42563     - image-name
42564     - image-os-distro
42565     - image-os-version
42566     - image-selflink
42567     properties:
42568       image-id:
42569         type: string
42570         description: Image id, expected to be unique across cloud region
42571       image-name:
42572         type: string
42573         description: Image name
42574       image-architecture:
42575         type: string
42576         description: Operating system architecture.
42577       image-os-distro:
42578         type: string
42579         description: The common name of the operating system distribution in lowercase
42580       image-os-version:
42581         type: string
42582         description: The operating system version as specified by the distributor.
42583       application:
42584         type: string
42585         description: The application that the image instantiates.
42586       application-vendor:
42587         type: string
42588         description: The vendor of the application.
42589       application-version:
42590         type: string
42591         description: The version of the application.
42592       image-selflink:
42593         type: string
42594         description: URL to endpoint where AAI can get more details
42595       resource-version:
42596         type: string
42597         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42598       relationship-list:
42599         type: array
42600         items:
42601           $ref: "#/definitions/relationship"
42602       metadata:
42603         type: array
42604         items:
42605           $ref: "#/definitions/metadatum"
42606   images:
42607     description: |
42608       Collectio of Openstack images.
42609     properties:
42610       image:
42611         type: array
42612         items:
42613           $ref: "#/definitions/image"
42614   include-node-filter:
42615     properties:
42616       include-node-type:
42617         type: string
42618   instance-filter:
42619     description: |
42620       InstanceFilter for performing a named-query or model query
42621   instance-filters:
42622     description: |
42623       InstanceFilters for performing a named-query or model query
42624     properties:
42625       instance-filter:
42626         type: array
42627         items:
42628           $ref: "#/definitions/instance-filter"
42629   instance-group:
42630     description: |
42631       General mechanism for grouping instances
42632       ###### Related Nodes
42633       - TO model( instance-group Targets model, MANY2MANY)
42634       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
42635       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
42636       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
42637       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
42638
42639     required:
42640     - id
42641     - description
42642     - type
42643     properties:
42644       id:
42645         type: string
42646         description: Instance Group ID, UUID assigned to this instance.
42647       description:
42648         type: string
42649         description: Descriptive text to help identify the usage of this instance-group
42650       type:
42651         type: string
42652         description: Only valid value today is lower case ha for high availability
42653       sub-type:
42654         type: string
42655         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
42656       resource-version:
42657         type: string
42658         description: Concurrency value
42659       relationship-list:
42660         type: array
42661         items:
42662           $ref: "#/definitions/relationship"
42663   instance-groups:
42664     description: |
42665       Collection of openstack route table references
42666     properties:
42667       instance-group:
42668         type: array
42669         items:
42670           $ref: "#/definitions/instance-group"
42671   inventory:
42672     properties:
42673       search:
42674         type: object
42675         $ref: "#/definitions/search"
42676       actions:
42677         type: object
42678         $ref: "#/definitions/actions"
42679       cloud-infrastructure:
42680         type: object
42681         $ref: "#/definitions/cloud-infrastructure"
42682       business:
42683         type: object
42684         $ref: "#/definitions/business"
42685       service-design-and-creation:
42686         type: object
42687         $ref: "#/definitions/service-design-and-creation"
42688       network:
42689         type: object
42690         $ref: "#/definitions/network"
42691       nodes:
42692         type: object
42693         $ref: "#/definitions/nodes"
42694   inventory-item:
42695     properties:
42696       inventory-item-type:
42697         type: string
42698       inventory-item-link:
42699         type: string
42700       inventory-item-data:
42701         type: array
42702         items:
42703           $ref: "#/definitions/inventory-item-data"
42704       tagged-inventory-item-list:
42705         type: array
42706         items:
42707           $ref: "#/definitions/tagged-inventory-item-list"
42708   inventory-item-data:
42709     properties:
42710       property-name:
42711         type: string
42712       property-value:
42713         type: string
42714   inventory-response-item:
42715     description: |
42716       Inventory item for response list
42717     properties:
42718       model-name:
42719         type: string
42720       extra-properties:
42721         type: object
42722         $ref: "#/definitions/extra-properties"
42723       inventory-response-items:
42724         type: object
42725         $ref: "#/definitions/inventory-response-items"
42726   inventory-response-items:
42727     description: |
42728       Container for inventory items in response list
42729     properties:
42730       inventory-response-item:
42731         type: array
42732         items:
42733           $ref: "#/definitions/inventory-response-item"
42734   ipsec-configuration:
42735     description: |
42736       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
42737       ###### Related Nodes
42738       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
42739       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
42740
42741       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
42742     required:
42743     - ipsec-configuration-id
42744     properties:
42745       ipsec-configuration-id:
42746         type: string
42747         description: UUID of this configuration
42748       requested-vig-address-type:
42749         type: string
42750         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
42751       requested-encryption-strength:
42752         type: string
42753         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
42754       requested-dmz-type:
42755         type: string
42756         description: can offer a shared DMZ or a DMZ specific to a customer
42757       shared-dmz-network-address:
42758         type: string
42759         description: Network address of shared DMZ
42760       requested-customer-name:
42761         type: string
42762         description: If the DMZ is a custom DMZ, this field will indicate the customer information
42763       ike-version:
42764         type: string
42765         description: can be 1 or 2
42766       ikev1-authentication:
42767         type: string
42768         description: Contains values like md5, sha1, sha256, sha384
42769       ikev1-encryption:
42770         type: string
42771         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
42772       ikev1-dh-group:
42773         type: string
42774         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
42775       ikev1-am-group-id:
42776         type: string
42777         description: Group name defined in VIG for clients using aggressive mode
42778       ikev1-am-password:
42779         type: string
42780         description: pre-shared key for the above group name
42781       ikev1-sa-lifetime:
42782         type: string
42783         description: Lifetime for IKEv1 SA
42784       ipsec-authentication:
42785         type: string
42786         description: md5, sha1, sha256, sha384
42787       ipsec-encryption:
42788         type: string
42789         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
42790       ipsec-sa-lifetime:
42791         type: string
42792         description: Life time for IPSec SA
42793       ipsec-pfs:
42794         type: string
42795         description: enable PFS or not
42796       xauth-userid:
42797         type: string
42798         description: user ID for xAuth, sm-user, ,nmteHostName
42799       xauth-user-password:
42800         type: string
42801         description: Encrypted using the Juniper $9$ algorithm
42802       dpd-interval:
42803         type: string
42804         description: The time between DPD probe
42805       dpd-frequency:
42806         type: string
42807         description: Maximum number of DPD before claiming the tunnel is down
42808       resource-version:
42809         type: string
42810         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42811       relationship-list:
42812         type: array
42813         items:
42814           $ref: "#/definitions/relationship"
42815       vig-servers:
42816         type: array
42817         items:
42818           $ref: "#/definitions/vig-server"
42819   ipsec-configurations:
42820     properties:
42821       ipsec-configuration:
42822         type: array
42823         items:
42824           $ref: "#/definitions/ipsec-configuration"
42825   key-data:
42826     properties:
42827       key-name:
42828         type: string
42829       key-value:
42830         type: string
42831   l-interface:
42832     description: |
42833       Logical interfaces, e.g., a vnic.
42834       ###### Related Nodes
42835       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
42836       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
42837       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
42838       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
42839       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
42840       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
42841       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
42842       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
42843       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
42844       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
42845
42846       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
42847       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
42848       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
42849     required:
42850     - interface-name
42851     properties:
42852       interface-name:
42853         type: string
42854         description: Name given to the interface
42855       interface-role:
42856         type: string
42857         description: E.g., CUSTOMER, UPLINK, etc.
42858       v6-wan-link-ip:
42859         type: string
42860         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
42861       selflink:
42862         type: string
42863         description: URL to endpoint where AAI can get more details
42864       interface-id:
42865         type: string
42866         description: ID of interface
42867       macaddr:
42868         type: string
42869         description: MAC address for the interface
42870       network-name:
42871         type: string
42872         description: Name of the network
42873       management-option:
42874         type: string
42875         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
42876       interface-description:
42877         type: string
42878         description: Human friendly text regarding this interface.
42879       resource-version:
42880         type: string
42881         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42882       vlans:
42883         type: array
42884         items:
42885           $ref: "#/definitions/vlan"
42886       sriov-vfs:
42887         type: array
42888         items:
42889           $ref: "#/definitions/sriov-vf"
42890       relationship-list:
42891         type: array
42892         items:
42893           $ref: "#/definitions/relationship"
42894       l3-interface-ipv4-address-list:
42895         type: array
42896         items:
42897           $ref: "#/definitions/l3-interface-ipv4-address-list"
42898       l3-interface-ipv6-address-list:
42899         type: array
42900         items:
42901           $ref: "#/definitions/l3-interface-ipv6-address-list"
42902   l-interfaces:
42903     description: |
42904       Collection of logical interfaces.
42905     properties:
42906       l-interface:
42907         type: array
42908         items:
42909           $ref: "#/definitions/l-interface"
42910   l3-interface-ipv4-address-list:
42911     description: |
42912       IPv4 Address Range
42913       ###### Related Nodes
42914       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
42915       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
42916       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
42917       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
42918
42919       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
42920     required:
42921     - l3-interface-ipv4-address
42922     properties:
42923       l3-interface-ipv4-address:
42924         type: string
42925         description: IP address
42926       l3-interface-ipv4-prefix-length:
42927         type: integer
42928         format: int64
42929         description: Prefix length, 32 for single address
42930       vlan-id-inner:
42931         type: integer
42932         format: int64
42933         description: Inner VLAN tag
42934       vlan-id-outer:
42935         type: integer
42936         format: int64
42937         description: Outer VLAN tag
42938       is-floating:
42939         type: boolean
42940         description: Indicator of fixed or floating address
42941       resource-version:
42942         type: string
42943         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42944       neutron-network-id:
42945         type: string
42946         description: Neutron network id of the interface that address belongs to
42947       neutron-subnet-id:
42948         type: string
42949         description: Neutron id of subnet that address belongs to
42950       relationship-list:
42951         type: array
42952         items:
42953           $ref: "#/definitions/relationship"
42954   l3-interface-ipv6-address-list:
42955     description: |
42956       IPv6 Address Range
42957       ###### Related Nodes
42958       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
42959       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
42960       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
42961       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
42962
42963       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
42964     required:
42965     - l3-interface-ipv6-address
42966     properties:
42967       l3-interface-ipv6-address:
42968         type: string
42969         description: IP address
42970       l3-interface-ipv6-prefix-length:
42971         type: integer
42972         format: int64
42973         description: Prefix length, 128 for single address
42974       vlan-id-inner:
42975         type: integer
42976         format: int64
42977         description: Inner VLAN tag
42978       vlan-id-outer:
42979         type: integer
42980         format: int64
42981         description: Outer VLAN tag
42982       is-floating:
42983         type: boolean
42984         description: Indicator of fixed or floating address
42985       resource-version:
42986         type: string
42987         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
42988       neutron-network-id:
42989         type: string
42990         description: Neutron network id of the interface that address belongs to
42991       neutron-subnet-id:
42992         type: string
42993         description: Neutron id of subnet that address belongs to
42994       relationship-list:
42995         type: array
42996         items:
42997           $ref: "#/definitions/relationship"
42998   l3-network:
42999     description: |
43000       Generic network definition
43001       ###### Related Nodes
43002       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
43003       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
43004       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
43005       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
43006       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
43007       - FROM complex( complex Uses l3-network, MANY2MANY)
43008       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
43009       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
43010       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
43011       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
43012       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
43013       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
43014       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
43015       - FROM tenant( tenant Uses l3-network, MANY2MANY)
43016       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
43017
43018       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
43019     required:
43020     - network-id
43021     - network-name
43022     - is-bound-to-vpn
43023     - is-provider-network
43024     - is-shared-network
43025     - is-external-network
43026     properties:
43027       network-id:
43028         type: string
43029         description: Network ID, should be uuid. Unique across A&AI.
43030       network-name:
43031         type: string
43032         description: Name of the network, governed by some naming convention..
43033       network-type:
43034         type: string
43035         description: Type of the network - who defines these values?
43036       network-role:
43037         type: string
43038         description: Role the network plans - who defines these values?
43039       network-technology:
43040         type: string
43041         description: Network technology - who defines these values?
43042       neutron-network-id:
43043         type: string
43044         description: Neutron network id of this Interface
43045       is-bound-to-vpn:
43046         type: boolean
43047         description: Set to true if bound to VPN
43048       service-id:
43049         type: string
43050         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
43051       network-role-instance:
43052         type: integer
43053         format: int64
43054         description: network role instance
43055       resource-version:
43056         type: string
43057         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43058       orchestration-status:
43059         type: string
43060         description: Orchestration status of this VNF, mastered by MSO
43061       heat-stack-id:
43062         type: string
43063         description: Heat stack id corresponding to this instance, managed by MSO
43064       mso-catalog-key:
43065         type: string
43066         description: Corresponds to the SDN-C catalog id used to configure this VCE
43067       contrail-network-fqdn:
43068         type: string
43069         description: Contrail FQDN for the network
43070       persona-model-id:
43071         type: string
43072         description: the ASDC model id for this resource or service model.
43073       persona-model-version:
43074         type: string
43075         description: the ASDC model version for this resource or service model.
43076       model-version-id:
43077         type: string
43078         description: the ASDC model version for this resource or service model.
43079       persona-model-customization-id:
43080         type: string
43081         description: captures the id of all the configuration used to customize the resource for the service.
43082       widget-model-id:
43083         type: string
43084         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43085       widget-model-version:
43086         type: string
43087         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43088       physical-network-name:
43089         type: string
43090         description: Name associated with the physical network.
43091       is-provider-network:
43092         type: boolean
43093         description: boolean indicatating whether or not network is a provider network.
43094       is-shared-network:
43095         type: boolean
43096         description: boolean indicatating whether or not network is a shared network.
43097       is-external-network:
43098         type: boolean
43099         description: boolean indicatating whether or not network is an external network.
43100       selflink:
43101         type: string
43102         description: Path to the controller object.
43103       subnets:
43104         type: array
43105         items:
43106           $ref: "#/definitions/subnet"
43107       ctag-assignments:
43108         type: array
43109         items:
43110           $ref: "#/definitions/ctag-assignment"
43111       segmentation-assignments:
43112         type: array
43113         items:
43114           $ref: "#/definitions/segmentation-assignment"
43115       relationship-list:
43116         type: array
43117         items:
43118           $ref: "#/definitions/relationship"
43119         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
43120   l3-networks:
43121     properties:
43122       l3-network:
43123         type: array
43124         items:
43125           $ref: "#/definitions/l3-network"
43126   lag-interface:
43127     description: |
43128       Link aggregate interface
43129       ###### Related Nodes
43130       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
43131       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
43132       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
43133       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
43134       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
43135       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
43136       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
43137
43138       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
43139       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
43140       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
43141     required:
43142     - interface-name
43143     properties:
43144       interface-name:
43145         type: string
43146         description: Name that identifies the link aggregate interface
43147       interface-description:
43148         type: string
43149         description: Human friendly text regarding this interface.
43150       resource-version:
43151         type: string
43152         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43153       speed-value:
43154         type: string
43155         description: Captures the numeric part of the speed
43156       speed-units:
43157         type: string
43158         description: Captures the units corresponding to the speed
43159       interface-id:
43160         type: string
43161         description: ID of interface
43162       interface-role:
43163         type: string
43164         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
43165       prov-status:
43166         type: string
43167         description: Trigger for operational monitoring of this resource by Service Assurance systems.
43168       relationship-list:
43169         type: array
43170         items:
43171           $ref: "#/definitions/relationship"
43172       l-interfaces:
43173         type: array
43174         items:
43175           $ref: "#/definitions/l-interface"
43176   lag-interfaces:
43177     description: |
43178       Collection of link aggregate interfaces.
43179     properties:
43180       lag-interface:
43181         type: array
43182         items:
43183           $ref: "#/definitions/lag-interface"
43184   lag-link:
43185     description: |
43186       LAG links can connect lag-interfaces
43187       ###### Related Nodes
43188       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
43189       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
43190
43191       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
43192     required:
43193     - link-name
43194     properties:
43195       link-name:
43196         type: string
43197         description: Alphabetical concatenation of lag-interface names
43198       resource-version:
43199         type: string
43200         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43201       relationship-list:
43202         type: array
43203         items:
43204           $ref: "#/definitions/relationship"
43205   lag-links:
43206     description: |
43207       Collection of link aggregation connections
43208     properties:
43209       lag-link:
43210         type: array
43211         items:
43212           $ref: "#/definitions/lag-link"
43213   license:
43214     description: |
43215       Metadata for license group.
43216       ###### Related Nodes
43217       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
43218       - TO vce( license BelongsTo vce, MANY2ONE)(4)
43219
43220       -(4) IF this TO node is deleted, this LICENSE is DELETED also
43221     required:
43222     - group-uuid
43223     - resource-uuid
43224     properties:
43225       group-uuid:
43226         type: string
43227         description: Unique ID for the license group the resource belongs to, should be uuid.
43228       resource-uuid:
43229         type: string
43230         description: Unique ID of a license resource.
43231       resource-version:
43232         type: string
43233         description: Concurrency value
43234       relationship-list:
43235         type: array
43236         items:
43237           $ref: "#/definitions/relationship"
43238   licenses:
43239     description: |
43240       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
43241     properties:
43242       license:
43243         type: array
43244         items:
43245           $ref: "#/definitions/license"
43246   line-of-business:
43247     description: |
43248       describes a line-of-business
43249       ###### Related Nodes
43250       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
43251
43252     required:
43253     - line-of-business-name
43254     properties:
43255       line-of-business-name:
43256         type: string
43257         description: Name of the line-of-business (product)
43258       resource-version:
43259         type: string
43260         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43261       relationship-list:
43262         type: array
43263         items:
43264           $ref: "#/definitions/relationship"
43265   lines-of-business:
43266     description: |
43267       Collection of lines-of-business
43268     properties:
43269       line-of-business:
43270         type: array
43271         items:
43272           $ref: "#/definitions/line-of-business"
43273   logical-link:
43274     description: |
43275       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
43276       ###### Related Nodes
43277       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
43278       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
43279       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
43280       - TO logical-link( logical-link Uses logical-link, ONE2MANY)
43281       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
43282       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
43283       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
43284       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
43285       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
43286       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
43287       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
43288       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
43289       - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
43290
43291       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
43292     required:
43293     - link-name
43294     - link-type
43295     properties:
43296       link-name:
43297         type: string
43298         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
43299       link-type:
43300         type: string
43301         description: Type of logical link, e.g., evc
43302       speed-value:
43303         type: string
43304         description: Captures the numeric part of the speed
43305       speed-units:
43306         type: string
43307         description: Captures the units corresponding to the speed
43308       ip-version:
43309         type: string
43310         description: v4, v6, or ds for dual stack
43311       routing-protocol:
43312         type: string
43313         description: For example, static or BGP
43314       resource-version:
43315         type: string
43316         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43317       persona-model-id:
43318         type: string
43319         description: the ASDC model id for this resource or service model.
43320       persona-model-version:
43321         type: string
43322         description: the ASDC model version for this resource or service model.
43323       model-version-id:
43324         type: string
43325         description: the ASDC model version for this resource or service model.
43326       widget-model-id:
43327         type: string
43328         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43329       widget-model-version:
43330         type: string
43331         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43332       operational-status:
43333         type: string
43334         description: Indication of operational status of the logical link.
43335       prov-status:
43336         type: string
43337         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43338       link-role:
43339         type: string
43340         description: Indication of the network use of the logical link.
43341       link-name2:
43342         type: string
43343         description: Alias or alternate name (CLCI or D1 name).
43344       link-id:
43345         type: string
43346         description: UUID of the logical-link, SDNC generates this.
43347       circuit-id:
43348         type: string
43349         description: Circuit id
43350       purpose:
43351         type: string
43352         description: Reason for this entity, role it is playing
43353       relationship-list:
43354         type: array
43355         items:
43356           $ref: "#/definitions/relationship"
43357   logical-links:
43358     description: |
43359       Collection of logical connections
43360     properties:
43361       logical-link:
43362         type: array
43363         items:
43364           $ref: "#/definitions/logical-link"
43365   metadata:
43366     description: |
43367       Collection of metadatum (key/value pairs)
43368     properties:
43369       metadatum:
43370         type: array
43371         items:
43372           $ref: "#/definitions/metadatum"
43373   metadatum:
43374     description: |
43375       Key/value pairs
43376       ###### Related Nodes
43377       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
43378       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
43379       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
43380       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
43381
43382       -(4) IF this TO node is deleted, this METADATUM is DELETED also
43383     required:
43384     - metaname
43385     - metaval
43386     properties:
43387       metaname:
43388         type: string
43389       metaval:
43390         type: string
43391       resource-version:
43392         type: string
43393         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43394   model:
43395     description: |
43396       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
43397       ###### Related Nodes
43398       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
43399       - FROM instance-group( instance-group Targets model, MANY2MANY)
43400       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
43401       - FROM named-query( named-query AppliesTo model, ONE2MANY)
43402       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
43403
43404       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
43405       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
43406
43407     required:
43408     - model-invariant-id
43409     - model-type
43410     properties:
43411       model-invariant-id:
43412         type: string
43413         description: Unique identifier corresponding to the main definition of a model in ASDC
43414       model-type:
43415         type: string
43416         description: Type of the model, e.g., service, resource, widget, etc.
43417       resource-version:
43418         type: string
43419         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43420       model-vers:
43421         type: array
43422         items:
43423           $ref: "#/definitions/model-ver"
43424       relationship-list:
43425         type: array
43426         items:
43427           $ref: "#/definitions/relationship"
43428   model-and-named-query-search:
43429     description: |
43430       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
43431     properties:
43432       query-parameters:
43433         type: object
43434         $ref: "#/definitions/query-parameters"
43435       instance-filters:
43436         type: object
43437         $ref: "#/definitions/instance-filters"
43438       secondary-filts:
43439         type: object
43440         $ref: "#/definitions/secondary-filts"
43441       top-node-type:
43442         type: string
43443       secondary-filter-cut-point:
43444         type: string
43445   model-constraint:
43446     description: |
43447       This is how we would capture constraints defining allowed sets of elements.
43448       ###### Related Nodes
43449       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
43450       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
43451
43452       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
43453       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
43454     required:
43455     - model-constraint-uuid
43456     - constrained-element-set-uuid-to-replace
43457     properties:
43458       model-constraint-uuid:
43459         type: string
43460       constrained-element-set-uuid-to-replace:
43461         type: string
43462       constrained-element-sets:
43463         type: array
43464         items:
43465           $ref: "#/definitions/constrained-element-set"
43466       resource-version:
43467         type: string
43468         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43469   model-constraints:
43470     properties:
43471       model-constraint:
43472         type: array
43473         items:
43474           $ref: "#/definitions/model-constraint"
43475   model-element:
43476     description: |
43477       Defines how other models combine to make up a higher-level model.
43478       ###### Related Nodes
43479       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
43480       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
43481       - TO model-ver( model-element IsA model-ver, MANY2ONE)
43482       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
43483       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
43484       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
43485       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
43486
43487       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
43488       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
43489     required:
43490     - model-element-uuid
43491     - new-data-del-flag
43492     - cardinality
43493     properties:
43494       model-element-uuid:
43495         type: string
43496       new-data-del-flag:
43497         type: string
43498         description: Indicates whether this element was created as part of instantiation from this model
43499       cardinality:
43500         type: string
43501         description: How many of this type of element are required/allowed
43502       linkage-points:
43503         type: string
43504       resource-version:
43505         type: string
43506         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43507       model-elements:
43508         type: array
43509         items:
43510           $ref: "#/definitions/model-element"
43511         description: Defines how other models combine to make up a higher-level model
43512       model-constraints:
43513         type: array
43514         items:
43515           $ref: "#/definitions/model-constraint"
43516         description: Describes new constraints on this model element that are not part of that model's definition
43517       relationship-list:
43518         type: array
43519         items:
43520           $ref: "#/definitions/relationship"
43521   model-elements:
43522     properties:
43523       model-element:
43524         type: array
43525         items:
43526           $ref: "#/definitions/model-element"
43527   model-ver:
43528     description: |
43529       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
43530       ###### Related Nodes
43531       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
43532       - FROM model-element( model-element IsA model-ver, MANY2ONE)
43533       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
43534       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
43535
43536       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
43537       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
43538       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
43539
43540     required:
43541     - model-version-id
43542     - model-name
43543     - model-version
43544     properties:
43545       model-version-id:
43546         type: string
43547         description: Unique identifier corresponding to one version of a model in ASDC
43548       model-name:
43549         type: string
43550         description: Name of the model, which can change from version to version.
43551       model-version:
43552         type: string
43553         description: Version
43554       model-description:
43555         type: string
43556         description: Description
43557       resource-version:
43558         type: string
43559         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43560       model-elements:
43561         type: array
43562         items:
43563           $ref: "#/definitions/model-element"
43564       metadata:
43565         type: array
43566         items:
43567           $ref: "#/definitions/metadatum"
43568       relationship-list:
43569         type: array
43570         items:
43571           $ref: "#/definitions/relationship"
43572   model-vers:
43573     properties:
43574       model-ver:
43575         type: array
43576         items:
43577           $ref: "#/definitions/model-ver"
43578   models:
43579     description: |
43580       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
43581     properties:
43582       model:
43583         type: array
43584         items:
43585           $ref: "#/definitions/model"
43586   multicast-configuration:
43587     description: |
43588       ###### Related Nodes
43589       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
43590
43591     required:
43592     - multicast-configuration-id
43593     - multicast-protocol
43594     - rp-type
43595     properties:
43596       multicast-configuration-id:
43597         type: string
43598         description: Unique id of multicast configuration.
43599       multicast-protocol:
43600         type: string
43601         description: protocol of multicast configuration
43602       rp-type:
43603         type: string
43604         description: rp type of multicast configuration
43605       resource-version:
43606         type: string
43607         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43608       relationship-list:
43609         type: array
43610         items:
43611           $ref: "#/definitions/relationship"
43612   multicast-configurations:
43613     description: |
43614       multicast configuration of generic-vnf ip-address
43615     properties:
43616       multicast-configuration:
43617         type: array
43618         items:
43619           $ref: "#/definitions/multicast-configuration"
43620   named-queries:
43621     properties:
43622       named-query:
43623         type: array
43624         items:
43625           $ref: "#/definitions/named-query"
43626   named-query:
43627     description: |
43628       TBD
43629       ###### Related Nodes
43630       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
43631       - TO model( named-query AppliesTo model, ONE2MANY)
43632       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
43633
43634       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
43635     required:
43636     - named-query-uuid
43637     - named-query-name
43638     - named-query-version
43639     properties:
43640       named-query-uuid:
43641         type: string
43642       named-query-name:
43643         type: string
43644       named-query-version:
43645         type: string
43646       required-input-param:
43647         type: string
43648       description:
43649         type: string
43650       resource-version:
43651         type: string
43652       named-query-elements:
43653         type: array
43654         items:
43655           $ref: "#/definitions/named-query-element"
43656       relationship-list:
43657         type: array
43658         items:
43659           $ref: "#/definitions/relationship"
43660   named-query-element:
43661     description: |
43662       TBD
43663       ###### Related Nodes
43664       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
43665       - TO model( named-query-element IsA model, MANY2ONE)
43666       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
43667       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
43668       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
43669       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
43670
43671       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
43672       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
43673     required:
43674     - named-query-element-uuid
43675     properties:
43676       named-query-element-uuid:
43677         type: string
43678       property-collect-list:
43679         type: string
43680       resource-version:
43681         type: string
43682       property-limit-desc:
43683         type: string
43684       do-not-output:
43685         type: string
43686       named-query-elements:
43687         type: array
43688         items:
43689           $ref: "#/definitions/named-query-element"
43690       related-lookups:
43691         type: array
43692         items:
43693           $ref: "#/definitions/related-lookup"
43694       property-constraints:
43695         type: array
43696         items:
43697           $ref: "#/definitions/property-constraint"
43698       relationship-list:
43699         type: array
43700         items:
43701           $ref: "#/definitions/relationship"
43702   named-query-elements:
43703     properties:
43704       named-query-element:
43705         type: array
43706         items:
43707           $ref: "#/definitions/named-query-element"
43708   network:
43709     description: |
43710       Namespace for network inventory resources.
43711     properties:
43712       logical-links:
43713         type: array
43714         items:
43715           $ref: "#/definitions/logical-link"
43716       site-pair-sets:
43717         type: array
43718         items:
43719           $ref: "#/definitions/site-pair-set"
43720       vpn-bindings:
43721         type: array
43722         items:
43723           $ref: "#/definitions/vpn-binding"
43724       vpls-pes:
43725         type: array
43726         items:
43727           $ref: "#/definitions/vpls-pe"
43728       multicast-configurations:
43729         type: array
43730         items:
43731           $ref: "#/definitions/multicast-configuration"
43732       vces:
43733         type: array
43734         items:
43735           $ref: "#/definitions/vce"
43736       vnfcs:
43737         type: array
43738         items:
43739           $ref: "#/definitions/vnfc"
43740       l3-networks:
43741         type: array
43742         items:
43743           $ref: "#/definitions/l3-network"
43744       network-policies:
43745         type: array
43746         items:
43747           $ref: "#/definitions/network-policy"
43748       generic-vnfs:
43749         type: array
43750         items:
43751           $ref: "#/definitions/generic-vnf"
43752       lag-links:
43753         type: array
43754         items:
43755           $ref: "#/definitions/lag-link"
43756       newvces:
43757         type: array
43758         items:
43759           $ref: "#/definitions/newvce"
43760       pnfs:
43761         type: array
43762         items:
43763           $ref: "#/definitions/pnf"
43764       physical-links:
43765         type: array
43766         items:
43767           $ref: "#/definitions/physical-link"
43768       ipsec-configurations:
43769         type: array
43770         items:
43771           $ref: "#/definitions/ipsec-configuration"
43772       route-table-references:
43773         type: array
43774         items:
43775           $ref: "#/definitions/route-table-reference"
43776       instance-groups:
43777         type: array
43778         items:
43779           $ref: "#/definitions/instance-group"
43780       zones:
43781         type: array
43782         items:
43783           $ref: "#/definitions/zone"
43784   network-policies:
43785     properties:
43786       network-policy:
43787         type: array
43788         items:
43789           $ref: "#/definitions/network-policy"
43790   network-policy:
43791     description: |
43792       ###### Related Nodes
43793       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
43794
43795     required:
43796     - network-policy-id
43797     properties:
43798       network-policy-id:
43799         type: string
43800         description: UUID representing unique key to this instance
43801       network-policy-fqdn:
43802         type: string
43803         description: Contrail FQDN for the policy
43804       heat-stack-id:
43805         type: string
43806         description: ID for the openStack Heat instance
43807       resource-version:
43808         type: string
43809         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43810       relationship-list:
43811         type: array
43812         items:
43813           $ref: "#/definitions/relationship"
43814   network-profile:
43815     description: |
43816       Network profile populated by SDN-GP for SNMP
43817       ###### Related Nodes
43818       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
43819
43820     required:
43821     - nm-profile-name
43822     properties:
43823       nm-profile-name:
43824         type: string
43825         description: Unique name of network profile.
43826       community-string:
43827         type: string
43828         description: Encrypted SNMP community string
43829       resource-version:
43830         type: string
43831         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43832       relationship-list:
43833         type: array
43834         items:
43835           $ref: "#/definitions/relationship"
43836   network-profiles:
43837     description: |
43838       Collection of network profiles
43839     properties:
43840       network-profile:
43841         type: array
43842         items:
43843           $ref: "#/definitions/network-profile"
43844   newvce:
43845     description: |
43846       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
43847       ###### Related Nodes
43848       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
43849
43850       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
43851     required:
43852     - vnf-id2
43853     - vnf-name
43854     - vnf-type
43855     properties:
43856       vnf-id2:
43857         type: string
43858         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43859       vnf-name:
43860         type: string
43861         description: Name of VNF.
43862       vnf-name2:
43863         type: string
43864         description: Alternate name of VNF.
43865       vnf-type:
43866         type: string
43867         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.
43868       prov-status:
43869         type: string
43870         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43871       operational-state:
43872         type: string
43873         description: Indicator for whether the resource is considered operational
43874       license-key:
43875         type: string
43876         description: OBSOLETE -  do not use
43877       ipv4-oam-address:
43878         type: string
43879         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
43880       equipment-role:
43881         type: string
43882         description: Client should send valid enumerated value.
43883       resource-version:
43884         type: string
43885         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43886       ipv4-loopback0-address:
43887         type: string
43888         description: v4 Loopback0 address
43889       orchestration-status:
43890         type: string
43891         description: Orchestration status of this VNF, mastered by MSO.
43892       heat-stack-id:
43893         type: string
43894         description: Heat stack id corresponding to this instance, managed by MSO
43895       mso-catalog-key:
43896         type: string
43897         description: Corresponds to the SDN-C catalog id used to configure this VCE
43898       relationship-list:
43899         type: array
43900         items:
43901           $ref: "#/definitions/relationship"
43902       l-interfaces:
43903         type: array
43904         items:
43905           $ref: "#/definitions/l-interface"
43906   newvces:
43907     description: |
43908       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
43909     properties:
43910       newvce:
43911         type: array
43912         items:
43913           $ref: "#/definitions/newvce"
43914   nodes:
43915     properties:
43916       inventory-item-data:
43917         type: array
43918         items:
43919           $ref: "#/definitions/inventory-item-data"
43920   notification-event:
43921     properties:
43922       cambria.partition:
43923         type: string
43924       notification-event-header:
43925         type: object
43926         $ref: "#/definitions/notification-event-header"
43927   notification-event-header:
43928     properties:
43929       id:
43930         type: string
43931       timestamp:
43932         type: string
43933       source-name:
43934         type: string
43935       domain:
43936         type: string
43937       sequence-number:
43938         type: string
43939       severity:
43940         type: string
43941       event-type:
43942         type: string
43943       version:
43944         type: string
43945       action:
43946         type: string
43947       entity-type:
43948         type: string
43949       top-entity-type:
43950         type: string
43951       entity-link:
43952         type: string
43953       status:
43954         type: string
43955   notify:
43956     required:
43957     - event-id
43958     properties:
43959       event-id:
43960         type: string
43961       node-type:
43962         type: string
43963       event-trigger:
43964         type: string
43965       key-data:
43966         type: array
43967         items:
43968           $ref: "#/definitions/key-data"
43969       selflink:
43970         type: string
43971   oam-network:
43972     description: |
43973       OAM network, to be deprecated shortly.  Do not use for new purposes.
43974       ###### Related Nodes
43975       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
43976       - TO complex( oam-network AppliesTo complex, MANY2MANY)
43977       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
43978
43979     required:
43980     - network-uuid
43981     - network-name
43982     - cvlan-tag
43983     properties:
43984       network-uuid:
43985         type: string
43986         description: UUID of the network. Unique across a cloud-region
43987       network-name:
43988         type: string
43989         description: Name of the network.
43990       cvlan-tag:
43991         type: integer
43992         format: int64
43993         description: cvlan-id
43994       ipv4-oam-gateway-address:
43995         type: string
43996         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
43997       ipv4-oam-gateway-address-prefix-length:
43998         type: integer
43999         format: int32
44000         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
44001       resource-version:
44002         type: string
44003         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44004       relationship-list:
44005         type: array
44006         items:
44007           $ref: "#/definitions/relationship"
44008   oam-networks:
44009     description: |
44010       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
44011     properties:
44012       oam-network:
44013         type: array
44014         items:
44015           $ref: "#/definitions/oam-network"
44016   operational-environment:
44017     description: |
44018       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
44019       ###### Related Nodes
44020       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
44021       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
44022
44023     required:
44024     - operational-environment-id
44025     - operational-environment-name
44026     - operational-environment-type
44027     - operational-environment-status
44028     - tenant-context
44029     - workload-context
44030     properties:
44031       operational-environment-id:
44032         type: string
44033         description: UUID of an operational environment
44034       operational-environment-name:
44035         type: string
44036         description: Operational Environment name
44037       operational-environment-type:
44038         type: string
44039         description: Operational Environment Type.
44040       operational-environment-status:
44041         type: string
44042         description: Status
44043       tenant-context:
44044         type: string
44045         description: Tenant Context.
44046       workload-context:
44047         type: string
44048         description: Workload Context.
44049       resource-version:
44050         type: string
44051         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44052       relationship-list:
44053         type: array
44054         items:
44055           $ref: "#/definitions/relationship"
44056   operational-environments:
44057     description: |
44058       a logical partition of the cloud which allows to have multiple environments in the production AIC.
44059     properties:
44060       operational-environment:
44061         type: array
44062         items:
44063           $ref: "#/definitions/operational-environment"
44064   overloaded-model:
44065     description: |
44066       Allows for legacy POST of old-style and new-style models
44067     required:
44068     - model-invariant-id
44069     - model-name-version-id
44070     - model-type
44071     - model-name
44072     - model-id
44073     - model-version
44074     properties:
44075       model-invariant-id:
44076         type: string
44077         description: Unique identifier corresponding to the main definition of a model in ASDC
44078       model-name-version-id:
44079         type: string
44080         description: Unique identifier corresponding to one version of a model in ASDC
44081       model-type:
44082         type: string
44083         description: Type of the model, e.g., service, resource, widget, etc.
44084       model-name:
44085         type: string
44086         description: Name of the model, which can change from version to version.
44087       model-id:
44088         type: string
44089         description: Invariant unique ID which does not change from version to version
44090       model-version:
44091         type: string
44092         description: Version
44093       model-description:
44094         type: string
44095         description: Description
44096       resource-version:
44097         type: string
44098         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44099       model-vers:
44100         type: object
44101         $ref: "#/definitions/model-vers"
44102       relationship-list:
44103         type: object
44104         $ref: "#/definitions/relationship-list"
44105   owning-entities:
44106     description: |
44107       Collection of owning-entities
44108     properties:
44109       owning-entity:
44110         type: array
44111         items:
44112           $ref: "#/definitions/owning-entity"
44113   owning-entity:
44114     description: |
44115       describes an owning-entity
44116       ###### Related Nodes
44117       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
44118
44119     required:
44120     - owning-entity-id
44121     - owning-entity-name
44122     properties:
44123       owning-entity-id:
44124         type: string
44125         description: UUID of an owning entity
44126       owning-entity-name:
44127         type: string
44128         description: Owning entity name
44129       resource-version:
44130         type: string
44131         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44132       relationship-list:
44133         type: array
44134         items:
44135           $ref: "#/definitions/relationship"
44136   p-interface:
44137     description: |
44138       Physical interface (e.g., nic)
44139       ###### Related Nodes
44140       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
44141       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
44142       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
44143       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
44144       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
44145       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
44146       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
44147
44148       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
44149       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
44150       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
44151     required:
44152     - interface-name
44153     properties:
44154       interface-name:
44155         type: string
44156         description: Name that identifies the physical interface
44157       speed-value:
44158         type: string
44159         description: Captures the numeric part of the speed
44160       speed-units:
44161         type: string
44162         description: Captures the units corresponding to the speed
44163       port-description:
44164         type: string
44165         description: Nature of the services and connectivity on this port.
44166       equipment-identifier:
44167         type: string
44168         description: CLEI or other specification for p-interface hardware.
44169       interface-role:
44170         type: string
44171         description: Role specification for p-interface hardware.
44172       interface-type:
44173         type: string
44174         description: Indicates the physical properties of the interface.
44175       prov-status:
44176         type: string
44177         description: Trigger for operational monitoring of this resource by Service Assurance systems.
44178       resource-version:
44179         type: string
44180         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44181       relationship-list:
44182         type: array
44183         items:
44184           $ref: "#/definitions/relationship"
44185       l-interfaces:
44186         type: array
44187         items:
44188           $ref: "#/definitions/l-interface"
44189   p-interfaces:
44190     description: |
44191       Collection of physical interfaces.
44192     properties:
44193       p-interface:
44194         type: array
44195         items:
44196           $ref: "#/definitions/p-interface"
44197   physical-link:
44198     description: |
44199       Collection of physical connections, typically between p-interfaces
44200       ###### Related Nodes
44201       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
44202
44203       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
44204     required:
44205     - link-name
44206     properties:
44207       link-name:
44208         type: string
44209         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44210       speed-value:
44211         type: string
44212         description: Captures the numeric part of the speed
44213       speed-units:
44214         type: string
44215         description: Captures the units corresponding to the speed
44216       circuit-id:
44217         type: string
44218         description: Circuit it
44219       dual-mode:
44220         type: string
44221         description: Dual access mode (e.g., primary, secondary
44222       management-option:
44223         type: string
44224         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
44225       service-provider-name:
44226         type: string
44227         description: Name of the service Provider on this link.
44228       resource-version:
44229         type: string
44230         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44231       relationship-list:
44232         type: array
44233         items:
44234           $ref: "#/definitions/relationship"
44235   physical-links:
44236     description: |
44237       Collection of physical connections, typically between p-interfaces
44238     properties:
44239       physical-link:
44240         type: array
44241         items:
44242           $ref: "#/definitions/physical-link"
44243   platform:
44244     description: |
44245       describes a platform
44246       ###### Related Nodes
44247       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
44248
44249     required:
44250     - platform-name
44251     properties:
44252       platform-name:
44253         type: string
44254         description: Name of the platform
44255       resource-version:
44256         type: string
44257         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44258       relationship-list:
44259         type: array
44260         items:
44261           $ref: "#/definitions/relationship"
44262   platforms:
44263     description: |
44264       Collection of platforms
44265     properties:
44266       platform:
44267         type: array
44268         items:
44269           $ref: "#/definitions/platform"
44270   pnf:
44271     description: |
44272       PNF represents a physical network function. typically equipment used in the D1 world.
44273       ###### Related Nodes
44274       - TO complex( pnf LocatedIn complex, MANY2ONE)
44275       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
44276       - TO zone( pnf LocatedIn zone, MANY2ONE)
44277       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
44278       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
44279       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
44280       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
44281
44282       -(1) IF this PNF node is deleted, this FROM node is DELETED also
44283     required:
44284     - pnf-name
44285     - in-maint
44286     properties:
44287       pnf-name:
44288         type: string
44289         description: unique name of Physical Network Function.
44290       pnf-name2:
44291         type: string
44292         description: name of Physical Network Function.
44293       pnf-name2-source:
44294         type: string
44295         description: source of name2
44296       pnf-id:
44297         type: string
44298         description: id of pnf
44299       equip-type:
44300         type: string
44301         description: Equipment type.  Source of truth should define valid values.
44302       equip-vendor:
44303         type: string
44304         description: Equipment vendor.  Source of truth should define valid values.
44305       equip-model:
44306         type: string
44307         description: Equipment model.  Source of truth should define valid values.
44308       management-option:
44309         type: string
44310         description: identifier of managed by company or customer
44311       ipaddress-v4-oam:
44312         type: string
44313         description: ipv4-oam-address with new naming convention for IP addresses
44314       sw-version:
44315         type: string
44316         description: sw-version is the version of SW for the hosted application on the PNF.
44317       in-maint:
44318         type: boolean
44319         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.
44320       frame-id:
44321         type: string
44322         description: ID of the physical frame (relay rack) where pnf is installed.
44323       serial-number:
44324         type: string
44325         description: Serial number of the device
44326       ipaddress-v4-loopback-0:
44327         type: string
44328         description: IPV4 Loopback 0 address
44329       ipaddress-v6-loopback-0:
44330         type: string
44331         description: IPV6 Loopback 0 address
44332       ipaddress-v4-aim:
44333         type: string
44334         description: IPV4 AIM address
44335       ipaddress-v6-aim:
44336         type: string
44337         description: IPV6 AIM address
44338       ipaddress-v6-oam:
44339         type: string
44340         description: IPV6 OAM address
44341       inv-status:
44342         type: string
44343         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44344       resource-version:
44345         type: string
44346         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44347       prov-status:
44348         type: string
44349         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
44350       nf-role:
44351         type: string
44352         description: Nf Role is the role performed by this instance in the network.
44353       relationship-list:
44354         type: array
44355         items:
44356           $ref: "#/definitions/relationship"
44357       p-interfaces:
44358         type: array
44359         items:
44360           $ref: "#/definitions/p-interface"
44361       lag-interfaces:
44362         type: array
44363         items:
44364           $ref: "#/definitions/lag-interface"
44365   pnfs:
44366     description: |
44367       Collection of Physical Network Functions.
44368     properties:
44369       pnf:
44370         type: array
44371         items:
44372           $ref: "#/definitions/pnf"
44373   port-group:
44374     description: |
44375       Used to capture the network interfaces of this VCE
44376       ###### Related Nodes
44377       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
44378       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
44379
44380       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
44381       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
44382     required:
44383     - interface-id
44384     - orchestration-status
44385     properties:
44386       interface-id:
44387         type: string
44388         description: Unique ID of the interface
44389       neutron-network-id:
44390         type: string
44391         description: Neutron network id of this Interface
44392       neutron-network-name:
44393         type: string
44394         description: Neutron network name of this Interface
44395       interface-role:
44396         type: string
44397         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44398       resource-version:
44399         type: string
44400         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44401       port-group-id:
44402         type: string
44403         description: Unique ID for port group in vmware
44404       port-group-name:
44405         type: string
44406         description: Likely to duplicate value of neutron network name
44407       switch-name:
44408         type: string
44409         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
44410       orchestration-status:
44411         type: string
44412         description: Orchestration status of this VNF, mastered by MSO
44413       heat-stack-id:
44414         type: string
44415         description: Heat stack id corresponding to this instance, managed by MSO
44416       mso-catalog-key:
44417         type: string
44418         description: Corresponds to the SDN-C catalog id used to configure this VCE
44419       cvlan-tags:
44420         type: array
44421         items:
44422           $ref: "#/definitions/cvlan-tag-entry"
44423       relationship-list:
44424         type: array
44425         items:
44426           $ref: "#/definitions/relationship"
44427   port-groups:
44428     properties:
44429       port-group:
44430         type: array
44431         items:
44432           $ref: "#/definitions/port-group"
44433   project:
44434     description: |
44435       describes the project
44436       ###### Related Nodes
44437       - TO service-instance( project Uses service-instance, ONE2MANY)
44438
44439     required:
44440     - project-name
44441     properties:
44442       project-name:
44443         type: string
44444         description: Name of the project deploying a service
44445       resource-version:
44446         type: string
44447         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44448       relationship-list:
44449         type: array
44450         items:
44451           $ref: "#/definitions/relationship"
44452   projects:
44453     description: |
44454       Collection of projects
44455     properties:
44456       project:
44457         type: array
44458         items:
44459           $ref: "#/definitions/project"
44460   properties:
44461     description: |
44462       Property holder for query properties or instance properties
44463     properties:
44464       property-name:
44465         type: string
44466       property-value:
44467         type: string
44468   property-constraint:
44469     description: |
44470       TBD
44471       ###### Related Nodes
44472       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
44473
44474       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
44475     required:
44476     - property-constraint-uuid
44477     - constraint-type
44478     - property-name
44479     - property-value
44480     properties:
44481       property-constraint-uuid:
44482         type: string
44483       constraint-type:
44484         type: string
44485       property-name:
44486         type: string
44487       property-value:
44488         type: string
44489       resource-version:
44490         type: string
44491   property-constraints:
44492     properties:
44493       property-constraint:
44494         type: array
44495         items:
44496           $ref: "#/definitions/property-constraint"
44497   pserver:
44498     description: |
44499       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
44500       ###### Related Nodes
44501       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
44502       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
44503       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
44504       - TO complex( pserver LocatedIn complex, MANY2ONE)
44505       - TO zone( pserver LocatedIn zone, MANY2ONE)
44506       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
44507       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
44508       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
44509       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
44510       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
44511
44512       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
44513       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
44514
44515     required:
44516     - hostname
44517     - in-maint
44518     properties:
44519       hostname:
44520         type: string
44521         description: Value from executing hostname on the compute node.
44522       ptnii-equip-name:
44523         type: string
44524         description: PTNII name
44525       number-of-cpus:
44526         type: integer
44527         format: int32
44528         description: Number of cpus
44529       disk-in-gigabytes:
44530         type: integer
44531         format: int32
44532         description: Disk size, in GBs
44533       ram-in-megabytes:
44534         type: integer
44535         format: int32
44536         description: RAM size, in MBs
44537       equip-type:
44538         type: string
44539         description: Equipment type.  Source of truth should define valid values.
44540       equip-vendor:
44541         type: string
44542         description: Equipment vendor.  Source of truth should define valid values.
44543       equip-model:
44544         type: string
44545         description: Equipment model.  Source of truth should define valid values.
44546       fqdn:
44547         type: string
44548         description: Fully-qualified domain name
44549       pserver-selflink:
44550         type: string
44551         description: URL to endpoint where AAI can get more details
44552       ipv4-oam-address:
44553         type: string
44554         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
44555       serial-number:
44556         type: string
44557         description: Serial number, may be queried
44558       ipaddress-v4-loopback-0:
44559         type: string
44560         description: IPV4 Loopback 0 address
44561       ipaddress-v6-loopback-0:
44562         type: string
44563         description: IPV6 Loopback 0 address
44564       ipaddress-v4-aim:
44565         type: string
44566         description: IPV4 AIM address
44567       ipaddress-v6-aim:
44568         type: string
44569         description: IPV6 AIM address
44570       ipaddress-v6-oam:
44571         type: string
44572         description: IPV6 OAM address
44573       inv-status:
44574         type: string
44575         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44576       pserver-id:
44577         type: string
44578         description: ID of Pserver
44579       internet-topology:
44580         type: string
44581         description: internet topology of Pserver
44582       in-maint:
44583         type: boolean
44584         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.
44585       resource-version:
44586         type: string
44587         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44588       pserver-name2:
44589         type: string
44590         description: alternative pserver name
44591       purpose:
44592         type: string
44593         description: purpose of pserver
44594       prov-status:
44595         type: string
44596         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
44597       relationship-list:
44598         type: array
44599         items:
44600           $ref: "#/definitions/relationship"
44601       p-interfaces:
44602         type: array
44603         items:
44604           $ref: "#/definitions/p-interface"
44605       lag-interfaces:
44606         type: array
44607         items:
44608           $ref: "#/definitions/lag-interface"
44609   pservers:
44610     description: |
44611       Collection of compute hosts.
44612     properties:
44613       pserver:
44614         type: array
44615         items:
44616           $ref: "#/definitions/pserver"
44617   query-parameters:
44618     description: |
44619       QueryParameters for performing a named-query or model query
44620     properties:
44621       named-query:
44622         type: object
44623         $ref: "#/definitions/named-query"
44624       overloaded-model:
44625         type: object
44626         $ref: "#/definitions/overloaded-model"
44627   related-lookup:
44628     description: |
44629       TBD
44630       ###### Related Nodes
44631       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
44632
44633       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
44634     required:
44635     - related-lookup-uuid
44636     - source-node-type
44637     - source-node-property
44638     - target-node-type
44639     - target-node-property
44640     properties:
44641       related-lookup-uuid:
44642         type: string
44643       source-node-type:
44644         type: string
44645       source-node-property:
44646         type: string
44647       target-node-type:
44648         type: string
44649       target-node-property:
44650         type: string
44651       property-collect-list:
44652         type: string
44653       resource-version:
44654         type: string
44655       relationship-list:
44656         type: array
44657         items:
44658           $ref: "#/definitions/relationship"
44659   related-lookups:
44660     properties:
44661       related-lookup:
44662         type: array
44663         items:
44664           $ref: "#/definitions/related-lookup"
44665   related-to-property:
44666     properties:
44667       property-key:
44668         type: string
44669         description: Key part of a key/value pair
44670       property-value:
44671         type: string
44672         description: Value part of a key/value pair
44673   relationship:
44674     properties:
44675       related-to:
44676         type: string
44677         description: A keyword provided by A&AI to indicate type of node.
44678       related-link:
44679         type: string
44680         description: URL to the object in A&AI.
44681       relationship-data:
44682         type: array
44683         items:
44684           $ref: "#/definitions/relationship-data"
44685   relationship-data:
44686     required:
44687     - relationship-key
44688     - relationship-value
44689     properties:
44690       relationship-key:
44691         type: string
44692         description: A keyword provided by A&AI to indicate an attribute.
44693       relationship-value:
44694         type: string
44695         description: Value of the attribute.
44696   relationship-list:
44697     properties:
44698       relationship:
44699         type: array
44700         items:
44701           $ref: "#/definitions/relationship"
44702   reserved-prop-names:
44703     description: |
44704       Internal map to define some reserved properties of a vertex
44705     properties:
44706       last-mod-source-of-truth:
44707         type: string
44708       aai-node-type:
44709         type: string
44710       aai-created-ts:
44711         type: integer
44712         format: int64
44713       aai-unique-key:
44714         type: string
44715       aai-last-mod-ts:
44716         type: integer
44717         format: int64
44718       source-of-truth:
44719         type: string
44720       aai-uri:
44721         type: string
44722   response-list:
44723     description: |
44724       Response container for the results of a named-query or model query
44725     properties:
44726       inventory-response-items:
44727         type: object
44728         $ref: "#/definitions/inventory-response-items"
44729   result-data:
44730     properties:
44731       resource-type:
44732         type: string
44733         description: The specific type of node in the A&AI graph
44734       resource-link:
44735         type: string
44736         description: The URL to the specific resource
44737   route-table-reference:
44738     description: |
44739       Openstack route table reference.
44740       ###### Related Nodes
44741       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
44742
44743     required:
44744     - route-table-reference-id
44745     - route-table-reference-fqdn
44746     properties:
44747       route-table-reference-id:
44748         type: string
44749         description: Route Table Reference id, UUID assigned to this instance.
44750       route-table-reference-fqdn:
44751         type: string
44752         description: FQDN entry in the route table.
44753       resource-version:
44754         type: string
44755         description: Concurrency value
44756       relationship-list:
44757         type: array
44758         items:
44759           $ref: "#/definitions/relationship"
44760   route-table-references:
44761     description: |
44762       Collection of openstack route table references
44763     properties:
44764       route-table-reference:
44765         type: array
44766         items:
44767           $ref: "#/definitions/route-table-reference"
44768   route-target:
44769     description: |
44770       Route target information
44771       ###### Related Nodes
44772       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
44773
44774       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
44775     required:
44776     - global-route-target
44777     - route-target-role
44778     properties:
44779       global-route-target:
44780         type: string
44781         description: Number used to identify an RT, globally unique in the network
44782       route-target-role:
44783         type: string
44784         description: Role assigned to this route target
44785       resource-version:
44786         type: string
44787         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44788       relationship-list:
44789         type: array
44790         items:
44791           $ref: "#/definitions/relationship"
44792   route-targets:
44793     description: |
44794       Collection of route target information
44795     properties:
44796       route-target:
44797         type: array
44798         items:
44799           $ref: "#/definitions/route-target"
44800   routing-instance:
44801     description: |
44802       ###### Related Nodes
44803       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
44804       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
44805
44806       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
44807       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
44808     required:
44809     - routing-instance-id
44810     properties:
44811       routing-instance-id:
44812         type: string
44813         description: Unique id of routing instance
44814       rpm-owner:
44815         type: string
44816         description: rpm owner
44817       resource-version:
44818         type: string
44819         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44820       site-pairs:
44821         type: array
44822         items:
44823           $ref: "#/definitions/site-pair"
44824       relationship-list:
44825         type: array
44826         items:
44827           $ref: "#/definitions/relationship"
44828   routing-instances:
44829     description: |
44830       set of probes related to generic-vnf routing instance
44831     properties:
44832       routing-instance:
44833         type: array
44834         items:
44835           $ref: "#/definitions/routing-instance"
44836   sdn-zone-response:
44837     properties:
44838       oam-networks:
44839         type: object
44840         $ref: "#/definitions/oam-networks"
44841       az-and-dvs-switches:
44842         type: array
44843         items:
44844           $ref: "#/definitions/az-and-dvs-switches"
44845   search:
44846     properties:
44847       edge-tag-query-result:
44848         type: object
44849         $ref: "#/definitions/edge-tag-query-result"
44850       edge-tag-query-request:
44851         type: object
44852         $ref: "#/definitions/edge-tag-query-request"
44853       search-results:
44854         type: object
44855         $ref: "#/definitions/search-results"
44856       sdn-zone-response:
44857         type: object
44858         $ref: "#/definitions/sdn-zone-response"
44859   search-results:
44860     properties:
44861       result-data:
44862         type: array
44863         items:
44864           $ref: "#/definitions/result-data"
44865   secondary-filt:
44866     description: |
44867       SecondaryFilt for performing a named-query or model query
44868   secondary-filter:
44869     properties:
44870       property-name:
44871         type: string
44872       filter-type:
44873         type: string
44874       property-value:
44875         type: string
44876   secondary-filts:
44877     description: |
44878       SecondaryFilts for performing a named-query or model query
44879     properties:
44880       secondary-filt:
44881         type: array
44882         items:
44883           $ref: "#/definitions/secondary-filt"
44884   segmentation-assignment:
44885     description: |
44886       Openstack segmentation assignment.
44887       ###### Related Nodes
44888       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
44889
44890       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
44891     required:
44892     - segmentation-id
44893     properties:
44894       segmentation-id:
44895         type: string
44896         description: Route Table Reference id, UUID assigned to this instance.
44897       resource-version:
44898         type: string
44899         description: Concurrency value
44900       relationship-list:
44901         type: array
44902         items:
44903           $ref: "#/definitions/relationship"
44904   segmentation-assignments:
44905     description: |
44906       Collection of openstack segmentation assignments
44907     properties:
44908       segmentation-assignment:
44909         type: array
44910         items:
44911           $ref: "#/definitions/segmentation-assignment"
44912   service:
44913     description: |
44914       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
44915     required:
44916     - service-id
44917     - service-description
44918     properties:
44919       service-id:
44920         type: string
44921         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
44922       service-description:
44923         type: string
44924         description: Description of the service
44925       service-selflink:
44926         type: string
44927         description: URL to endpoint where AAI can get more details
44928       resource-version:
44929         type: string
44930         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44931       service-version:
44932         type: string
44933         description: service version
44934       relationship-list:
44935         type: array
44936         items:
44937           $ref: "#/definitions/relationship"
44938   service-capabilities:
44939     description: |
44940       Collection of service capabilities.
44941     properties:
44942       service-capability:
44943         type: array
44944         items:
44945           $ref: "#/definitions/service-capability"
44946   service-capability:
44947     description: |
44948       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
44949       ###### Related Nodes
44950       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
44951       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
44952
44953       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
44954
44955     required:
44956     - service-type
44957     - vnf-type
44958     properties:
44959       service-type:
44960         type: string
44961         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
44962       vnf-type:
44963         type: string
44964         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.
44965       resource-version:
44966         type: string
44967         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44968       relationship-list:
44969         type: array
44970         items:
44971           $ref: "#/definitions/relationship"
44972   service-design-and-creation:
44973     description: |
44974       Namespace for objects managed by ASDC
44975     properties:
44976       vnf-images:
44977         type: array
44978         items:
44979           $ref: "#/definitions/vnf-image"
44980       services:
44981         type: array
44982         items:
44983           $ref: "#/definitions/service"
44984       service-capabilities:
44985         type: array
44986         items:
44987           $ref: "#/definitions/service-capability"
44988       models:
44989         type: array
44990         items:
44991           $ref: "#/definitions/model"
44992       named-queries:
44993         type: array
44994         items:
44995           $ref: "#/definitions/named-query"
44996   service-instance:
44997     description: |
44998       Instance of a service
44999       ###### Related Nodes
45000       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
45001       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
45002       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
45003       - TO connector( service-instance Uses connector, MANY2MANY)
45004       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
45005       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
45006       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
45007       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
45008       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
45009       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
45010       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
45011       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
45012       - TO vce( service-instance ComposedOf vce, ONE2MANY)
45013       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
45014       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
45015       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
45016
45017       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
45018       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
45019       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
45020     required:
45021     - service-instance-id
45022     properties:
45023       service-instance-id:
45024         type: string
45025         description: Uniquely identifies this instance of a service
45026       service-instance-name:
45027         type: string
45028         description: This field will store a name assigned to the service-instance.
45029       persona-model-id:
45030         type: string
45031         description: the ASDC model id for this resource or service model.
45032       persona-model-version:
45033         type: string
45034         description: the ASDC model version for this resource or service model.
45035       model-version-id:
45036         type: string
45037         description: the ASDC model version for this resource or service model.
45038       widget-model-id:
45039         type: string
45040         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45041       widget-model-version:
45042         type: string
45043         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45044       bandwidth-total:
45045         type: string
45046         description: Indicates the total bandwidth to be used for this service.
45047       bandwidth-up-wan1:
45048         type: string
45049         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
45050       bandwidth-down-wan1:
45051         type: string
45052         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
45053       bandwidth-up-wan2:
45054         type: string
45055         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
45056       bandwidth-down-wan2:
45057         type: string
45058         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
45059       vhn-portal-url:
45060         type: string
45061         description: URL customers will use to access the vHN Portal.
45062       service-instance-location-id:
45063         type: string
45064         description: An identifier that customers assign to the location where this service is being used.
45065       resource-version:
45066         type: string
45067         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45068       selflink:
45069         type: string
45070         description: Path to the controller object.
45071       orchestration-status:
45072         type: string
45073         description: Orchestration status of this service.
45074       relationship-list:
45075         type: array
45076         items:
45077           $ref: "#/definitions/relationship"
45078       metadata:
45079         type: array
45080         items:
45081           $ref: "#/definitions/metadatum"
45082       allotted-resources:
45083         type: array
45084         items:
45085           $ref: "#/definitions/allotted-resource"
45086   service-instances:
45087     description: |
45088       Collection of service instances
45089     properties:
45090       service-instance:
45091         type: array
45092         items:
45093           $ref: "#/definitions/service-instance"
45094   service-subscription:
45095     description: |
45096       Object that group service instances.
45097       ###### Related Nodes
45098       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
45099       - TO tenant( service-subscription Uses tenant, MANY2MANY)
45100       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
45101
45102       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
45103       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
45104     required:
45105     - service-type
45106     properties:
45107       service-type:
45108         type: string
45109         description: Value defined by orchestration to identify this service across ECOMP.
45110       temp-ub-sub-account-id:
45111         type: string
45112         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
45113       resource-version:
45114         type: string
45115         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45116       service-instances:
45117         type: array
45118         items:
45119           $ref: "#/definitions/service-instance"
45120       relationship-list:
45121         type: array
45122         items:
45123           $ref: "#/definitions/relationship"
45124   service-subscriptions:
45125     description: |
45126       Collection of objects that group service instances.
45127     properties:
45128       service-subscription:
45129         type: array
45130         items:
45131           $ref: "#/definitions/service-subscription"
45132   services:
45133     description: |
45134       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
45135     properties:
45136       service:
45137         type: array
45138         items:
45139           $ref: "#/definitions/service"
45140   site-pair:
45141     description: |
45142       ###### Related Nodes
45143       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
45144       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
45145
45146       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
45147       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
45148     required:
45149     - site-pair-id
45150     properties:
45151       site-pair-id:
45152         type: string
45153         description: unique identifier of probe
45154       source-ip:
45155         type: string
45156         description: Prefix address
45157       destination-ip:
45158         type: string
45159         description: Prefix address
45160       ip-version:
45161         type: string
45162         description: ip version, v4, v6
45163       destination-hostname:
45164         type: string
45165         description: Hostname of the destination equipment to which SLAs are measured against.
45166       destination-equip-type:
45167         type: string
45168         description: The type of destinatination equipment. Could be Router, etc.
45169       resource-version:
45170         type: string
45171         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45172       classes-of-service:
45173         type: array
45174         items:
45175           $ref: "#/definitions/class-of-service"
45176       relationship-list:
45177         type: array
45178         items:
45179           $ref: "#/definitions/relationship"
45180   site-pair-set:
45181     description: |
45182       Set of instances for probes used to measure service level agreements
45183       ###### Related Nodes
45184       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
45185       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
45186
45187       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
45188     required:
45189     - site-pair-set-id
45190     properties:
45191       site-pair-set-id:
45192         type: string
45193         description: Unique id of site pair set.
45194       resource-version:
45195         type: string
45196         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45197       routing-instances:
45198         type: array
45199         items:
45200           $ref: "#/definitions/routing-instance"
45201       relationship-list:
45202         type: array
45203         items:
45204           $ref: "#/definitions/relationship"
45205   site-pair-sets:
45206     description: |
45207       Collection of sets of instances for probes related to generic-vnf
45208     properties:
45209       site-pair-set:
45210         type: array
45211         items:
45212           $ref: "#/definitions/site-pair-set"
45213   site-pairs:
45214     description: |
45215       probe within a set
45216     properties:
45217       site-pair:
45218         type: array
45219         items:
45220           $ref: "#/definitions/site-pair"
45221   snapshot:
45222     description: |
45223       Openstack snapshot
45224       ###### Related Nodes
45225       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
45226       - FROM vserver( vserver Uses snapshot, ONE2ONE)
45227
45228     required:
45229     - snapshot-id
45230     properties:
45231       snapshot-id:
45232         type: string
45233         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
45234       snapshot-name:
45235         type: string
45236         description: Snapshot name
45237       snapshot-architecture:
45238         type: string
45239         description: Operating system architecture
45240       snapshot-os-distro:
45241         type: string
45242         description: The common name of the operating system distribution in lowercase
45243       snapshot-os-version:
45244         type: string
45245         description: The operating system version as specified by the distributor.
45246       application:
45247         type: string
45248         description: The application that the image instantiates.
45249       application-vendor:
45250         type: string
45251         description: The vendor of the application.
45252       application-version:
45253         type: string
45254         description: The version of the application.
45255       snapshot-selflink:
45256         type: string
45257         description: URL to endpoint where AAI can get more details
45258       prev-snapshot-id:
45259         type: string
45260         description: This field contains the UUID of the previous snapshot (if any).
45261       resource-version:
45262         type: string
45263         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45264       relationship-list:
45265         type: array
45266         items:
45267           $ref: "#/definitions/relationship"
45268   snapshots:
45269     description: |
45270       Collection of openstack snapshots
45271     properties:
45272       snapshot:
45273         type: array
45274         items:
45275           $ref: "#/definitions/snapshot"
45276   sriov-pf:
45277     description: |
45278       SR-IOV Physical Function
45279       ###### Related Nodes
45280       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
45281       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
45282
45283       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
45284     required:
45285     - pf-pci-id
45286     properties:
45287       pf-pci-id:
45288         type: string
45289         description: Identifier for the sriov-pf
45290       resource-version:
45291         type: string
45292         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45293       relationship-list:
45294         type: array
45295         items:
45296           $ref: "#/definitions/relationship"
45297   sriov-pfs:
45298     description: |
45299       Collection of SR-IOV Physical Functions.
45300     properties:
45301       sriov-pf:
45302         type: array
45303         items:
45304           $ref: "#/definitions/sriov-pf"
45305   sriov-vf:
45306     description: |
45307       SR-IOV Virtual Function (not to be confused with virtual network function)
45308       ###### Related Nodes
45309       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
45310
45311       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
45312     required:
45313     - pci-id
45314     properties:
45315       pci-id:
45316         type: string
45317         description: PCI ID used to identify the sriov-vf
45318       vf-vlan-filter:
45319         type: string
45320         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
45321       vf-mac-filter:
45322         type: string
45323         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
45324       vf-vlan-strip:
45325         type: boolean
45326         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
45327       vf-vlan-anti-spoof-check:
45328         type: boolean
45329         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.
45330       vf-mac-anti-spoof-check:
45331         type: boolean
45332         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.
45333       vf-mirrors:
45334         type: string
45335         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
45336       vf-broadcast-allow:
45337         type: boolean
45338         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
45339       vf-unknown-multicast-allow:
45340         type: boolean
45341         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
45342       vf-unknown-unicast-allow:
45343         type: boolean
45344         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
45345       vf-insert-stag:
45346         type: boolean
45347         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
45348       vf-link-status:
45349         type: string
45350         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
45351       resource-version:
45352         type: string
45353         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45354       neutron-network-id:
45355         type: string
45356         description: Neutron network id of the interface
45357       relationship-list:
45358         type: array
45359         items:
45360           $ref: "#/definitions/relationship"
45361   sriov-vfs:
45362     description: |
45363       Collection of SR-IOV Virtual Functions.
45364     properties:
45365       sriov-vf:
45366         type: array
45367         items:
45368           $ref: "#/definitions/sriov-vf"
45369   start-node-filter:
45370     properties:
45371       property-name:
45372         type: string
45373       property-value:
45374         type: string
45375   subnet:
45376     description: |
45377       ###### Related Nodes
45378       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
45379       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
45380       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
45381
45382       -(4) IF this TO node is deleted, this SUBNET is DELETED also
45383       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
45384
45385     required:
45386     - subnet-id
45387     - dhcp-enabled
45388     properties:
45389       subnet-id:
45390         type: string
45391         description: Subnet ID, should be UUID.
45392       subnet-name:
45393         type: string
45394         description: Name associated with the subnet.
45395       neutron-subnet-id:
45396         type: string
45397         description: Neutron id of this subnet
45398       gateway-address:
45399         type: string
45400         description: gateway ip address
45401       network-start-address:
45402         type: string
45403         description: network start address
45404       cidr-mask:
45405         type: string
45406         description: cidr mask
45407       ip-version:
45408         type: string
45409         description: ip version
45410       orchestration-status:
45411         type: string
45412         description: Orchestration status of this VNF, mastered by MSO
45413       dhcp-enabled:
45414         type: boolean
45415         description: dhcp enabled
45416       dhcp-start:
45417         type: string
45418         description: the start address reserved for use by dhcp
45419       dhcp-end:
45420         type: string
45421         description: the last address reserved for use by dhcp
45422       resource-version:
45423         type: string
45424         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45425       relationship-list:
45426         type: array
45427         items:
45428           $ref: "#/definitions/relationship"
45429   subnets:
45430     properties:
45431       subnet:
45432         type: array
45433         items:
45434           $ref: "#/definitions/subnet"
45435   tagged-inventory-item-list:
45436     properties:
45437       inventory-item:
45438         type: array
45439         items:
45440           $ref: "#/definitions/inventory-item"
45441   tenant:
45442     description: |
45443       Openstack tenant
45444       ###### Related Nodes
45445       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
45446       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
45447       - TO l3-network( tenant Uses l3-network, MANY2MANY)
45448       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
45449       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
45450       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
45451
45452       -TENANT cannot be deleted if related to VSERVER
45453
45454     required:
45455     - tenant-id
45456     - tenant-name
45457     properties:
45458       tenant-id:
45459         type: string
45460         description: Unique id relative to the cloud-region.
45461       tenant-name:
45462         type: string
45463         description: Readable name of tenant
45464       resource-version:
45465         type: string
45466         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45467       vservers:
45468         type: array
45469         items:
45470           $ref: "#/definitions/vserver"
45471       relationship-list:
45472         type: array
45473         items:
45474           $ref: "#/definitions/relationship"
45475   tenants:
45476     description: |
45477       Collection of openstack tenants.
45478     properties:
45479       tenant:
45480         type: array
45481         items:
45482           $ref: "#/definitions/tenant"
45483   tunnel-xconnect:
45484     description: |
45485       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
45486       ###### Related Nodes
45487       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
45488
45489       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
45490     required:
45491     - id
45492     - bandwidth-up-wan1
45493     - bandwidth-down-wan1
45494     - bandwidth-up-wan2
45495     - bandwidth-down-wan2
45496     properties:
45497       id:
45498         type: string
45499         description: Allotted Resource id UUID assigned to this instance.
45500       bandwidth-up-wan1:
45501         type: string
45502         description: The WAN uplink bandwidth for WAN1
45503       bandwidth-down-wan1:
45504         type: string
45505         description: The WAN downlink bandwidth for WAN1
45506       bandwidth-up-wan2:
45507         type: string
45508         description: The WAN uplink bandwidth for WAN2
45509       bandwidth-down-wan2:
45510         type: string
45511         description: The WAN downlink bandwidth for WAN2
45512       resource-version:
45513         type: string
45514         description: Concurrency value
45515       relationship-list:
45516         type: array
45517         items:
45518           $ref: "#/definitions/relationship"
45519   tunnel-xconnects:
45520     description: |
45521       This object is used to store the specific tunnel cross connect aspects of an allotted resource
45522     properties:
45523       tunnel-xconnect:
45524         type: array
45525         items:
45526           $ref: "#/definitions/tunnel-xconnect"
45527   update:
45528     description: |
45529       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
45530     required:
45531     - update-node-type
45532     properties:
45533       update-node-type:
45534         type: string
45535       update-node-key:
45536         type: array
45537         items:
45538           $ref: "#/definitions/update-node-key"
45539       update-node-uri:
45540         type: string
45541       action:
45542         type: array
45543         items:
45544           $ref: "#/definitions/action"
45545   update-node-key:
45546     properties:
45547       key-name:
45548         type: string
45549       key-value:
45550         type: string
45551   vce:
45552     description: |
45553       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
45554       ###### Related Nodes
45555       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
45556       - TO complex( vce LocatedIn complex, MANY2MANY)
45557       - TO vserver( vce HostedOn vserver, ONE2MANY)
45558       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
45559       - FROM license( license BelongsTo vce, MANY2ONE)(1)
45560       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
45561       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
45562
45563       -(1) IF this VCE node is deleted, this FROM node is DELETED also
45564     required:
45565     - vnf-id
45566     - vnf-name
45567     - vnf-type
45568     properties:
45569       vnf-id:
45570         type: string
45571         description: Unique id of VNF.  This is unique across the graph.
45572       vnf-name:
45573         type: string
45574         description: Name of VNF.
45575       vnf-name2:
45576         type: string
45577         description: Alternate name of VNF.
45578       vnf-type:
45579         type: string
45580         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.
45581       service-id:
45582         type: string
45583         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
45584       regional-resource-zone:
45585         type: string
45586         description: Regional way of organizing pservers, source of truth should define values
45587       prov-status:
45588         type: string
45589         description: Trigger for operational monitoring of this resource by Service Assurance systems.
45590       operational-state:
45591         type: string
45592         description: Indicator for whether the resource is considered operational
45593       license-key:
45594         type: string
45595         description: OBSOLETE -  do not use
45596       equipment-role:
45597         type: string
45598         description: Network role being played by this VNF
45599       orchestration-status:
45600         type: string
45601         description: Orchestration status of this VNF, mastered by MSO
45602       heat-stack-id:
45603         type: string
45604         description: Heat stack id corresponding to this instance, managed by MSO
45605       mso-catalog-key:
45606         type: string
45607         description: Corresponds to the SDN-C catalog id used to configure this VCE
45608       vpe-id:
45609         type: string
45610         description: Unique ID of VPE connected to this VCE.
45611       v6-vce-wan-address:
45612         type: string
45613         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
45614       ipv4-oam-address:
45615         type: string
45616         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
45617       resource-version:
45618         type: string
45619         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45620       ipv4-loopback0-address:
45621         type: string
45622         description: Loopback0 address
45623       entitlement-resource-uuid:
45624         type: string
45625         description: OBSOLETE -  see child relationships
45626       port-groups:
45627         type: array
45628         items:
45629           $ref: "#/definitions/port-group"
45630       licenses:
45631         type: array
45632         items:
45633           $ref: "#/definitions/license"
45634       entitlements:
45635         type: array
45636         items:
45637           $ref: "#/definitions/entitlement"
45638       relationship-list:
45639         type: array
45640         items:
45641           $ref: "#/definitions/relationship"
45642   vces:
45643     description: |
45644       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
45645     properties:
45646       vce:
45647         type: array
45648         items:
45649           $ref: "#/definitions/vce"
45650   vf-module:
45651     description: |
45652       a deployment unit of VNFCs
45653       ###### Related Nodes
45654       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
45655       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
45656       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
45657       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
45658       - TO vserver( vf-module Uses vserver, ONE2MANY)
45659
45660       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
45661       -VF-MODULE cannot be deleted if related to VNFC
45662
45663     required:
45664     - vf-module-id
45665     - is-base-vf-module
45666     properties:
45667       vf-module-id:
45668         type: string
45669         description: Unique ID of vf-module.
45670       vf-module-name:
45671         type: string
45672         description: Name of vf-module
45673       heat-stack-id:
45674         type: string
45675         description: Heat stack id corresponding to this instance.
45676       orchestration-status:
45677         type: string
45678         description: orchestration status of this vf-module, mastered by MSO
45679       is-base-vf-module:
45680         type: boolean
45681         description: used to indicate whether or not this object is base vf module
45682       resource-version:
45683         type: string
45684         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45685       persona-model-id:
45686         type: string
45687         description: the ASDC model id for this resource or service model.
45688       persona-model-version:
45689         type: string
45690         description: the ASDC model version for this resource or service model.
45691       model-version-id:
45692         type: string
45693         description: the ASDC model version for this resource or service model.
45694       persona-model-customization-id:
45695         type: string
45696         description: captures the id of all the configuration used to customize the resource for the service.
45697       widget-model-id:
45698         type: string
45699         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45700       widget-model-version:
45701         type: string
45702         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45703       contrail-service-instance-fqdn:
45704         type: string
45705         description: the Contrail unique ID for a service-instance
45706       module-index:
45707         type: integer
45708         format: int32
45709         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
45710       selflink:
45711         type: string
45712         description: Path to the controller object.
45713       relationship-list:
45714         type: array
45715         items:
45716           $ref: "#/definitions/relationship"
45717   vf-modules:
45718     description: |
45719       Collection of vf-modules, a deployment unit of VNFCs
45720     properties:
45721       vf-module:
45722         type: array
45723         items:
45724           $ref: "#/definitions/vf-module"
45725   vig-server:
45726     description: |
45727       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
45728       ###### Related Nodes
45729       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
45730
45731       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
45732     required:
45733     - vig-address-type
45734     properties:
45735       vig-address-type:
45736         type: string
45737         description: indicates whether the VIG is for AVPN or INTERNET
45738       ipaddress-v4-vig:
45739         type: string
45740         description: v4 IP of the vig server
45741       ipaddress-v6-vig:
45742         type: string
45743         description: v6 IP of the vig server
45744       resource-version:
45745         type: string
45746         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45747       relationship-list:
45748         type: array
45749         items:
45750           $ref: "#/definitions/relationship"
45751   vig-servers:
45752     properties:
45753       vig-server:
45754         type: array
45755         items:
45756           $ref: "#/definitions/vig-server"
45757   vip-ipv4-address-list:
45758     description: |
45759       IPv4 Address Range
45760       ###### Related Nodes
45761       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
45762       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
45763       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
45764       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
45765
45766     required:
45767     - vip-ipv4-address
45768     properties:
45769       vip-ipv4-address:
45770         type: string
45771         description: IP address
45772       vip-ipv4-prefix-length:
45773         type: integer
45774         format: int64
45775         description: Prefix length, 32 for single address
45776       vlan-id-inner:
45777         type: integer
45778         format: int64
45779         description: Inner VLAN tag
45780       vlan-id-outer:
45781         type: integer
45782         format: int64
45783         description: Outer VLAN tag
45784       is-floating:
45785         type: boolean
45786         description: Indicator of fixed or floating address
45787       resource-version:
45788         type: string
45789         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45790       neutron-network-id:
45791         type: string
45792         description: Neutron network id of the interface that address belongs to
45793       neutron-subnet-id:
45794         type: string
45795         description: Neutron id of subnet that address belongs to
45796       relationship-list:
45797         type: array
45798         items:
45799           $ref: "#/definitions/relationship"
45800   vip-ipv6-address-list:
45801     description: |
45802       IPv6 Address Range
45803       ###### Related Nodes
45804       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
45805       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
45806       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
45807       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
45808
45809     required:
45810     - vip-ipv6-address
45811     properties:
45812       vip-ipv6-address:
45813         type: string
45814         description: IP address
45815       vip-ipv6-prefix-length:
45816         type: integer
45817         format: int64
45818         description: Prefix length, 128 for single address
45819       vlan-id-inner:
45820         type: integer
45821         format: int64
45822         description: Inner VLAN tag
45823       vlan-id-outer:
45824         type: integer
45825         format: int64
45826         description: Outer VLAN tag
45827       is-floating:
45828         type: boolean
45829         description: Indicator of fixed or floating address
45830       resource-version:
45831         type: string
45832         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45833       neutron-network-id:
45834         type: string
45835         description: Neutron network id of the interface that address belongs to
45836       neutron-subnet-id:
45837         type: string
45838         description: Neutron id of subnet that address belongs to
45839       relationship-list:
45840         type: array
45841         items:
45842           $ref: "#/definitions/relationship"
45843   virtual-data-center:
45844     description: |
45845       Virtual organization of cloud infrastructure elements in a data center context
45846       ###### Related Nodes
45847       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
45848       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
45849       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
45850
45851     required:
45852     - vdc-id
45853     - vdc-name
45854     properties:
45855       vdc-id:
45856         type: string
45857         description: Unique ID of the vdc
45858       vdc-name:
45859         type: string
45860         description: Name of the virtual data center
45861       resource-version:
45862         type: string
45863         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45864       relationship-list:
45865         type: array
45866         items:
45867           $ref: "#/definitions/relationship"
45868   virtual-data-centers:
45869     description: |
45870       Virtual organization of cloud infrastructure elements in a data center context
45871     properties:
45872       virtual-data-center:
45873         type: array
45874         items:
45875           $ref: "#/definitions/virtual-data-center"
45876   vlan:
45877     description: |
45878       Definition of vlan
45879       ###### Related Nodes
45880       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
45881       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
45882       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
45883       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
45884       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
45885       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
45886       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
45887
45888       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
45889       -(2) IF this VLAN node is deleted, this TO node is DELETED also
45890       -(4) IF this TO node is deleted, this VLAN is DELETED also
45891     required:
45892     - vlan-interface
45893     properties:
45894       vlan-interface:
45895         type: string
45896         description: String that identifies the interface
45897       vlan-id-inner:
45898         type: integer
45899         format: int64
45900         description: Inner VLAN tag
45901       vlan-id-outer:
45902         type: integer
45903         format: int64
45904         description: Outer VLAN tag
45905       resource-version:
45906         type: string
45907         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45908       speed-value:
45909         type: string
45910         description: Captures the numeric part of the speed
45911       speed-units:
45912         type: string
45913         description: Captures the units corresponding to the speed
45914       vlan-description:
45915         type: string
45916         description: Used to describe (the service associated with) the vlan
45917       backdoor-connection:
45918         type: string
45919         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
45920       vpn-id:
45921         type: string
45922         description: This indicates the customers VPN ID associated with this vlan
45923       orchestration-status:
45924         type: string
45925         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
45926       relationship-list:
45927         type: array
45928         items:
45929           $ref: "#/definitions/relationship"
45930       l3-interface-ipv4-address-list:
45931         type: array
45932         items:
45933           $ref: "#/definitions/l3-interface-ipv4-address-list"
45934       l3-interface-ipv6-address-list:
45935         type: array
45936         items:
45937           $ref: "#/definitions/l3-interface-ipv6-address-list"
45938   vlans:
45939     properties:
45940       vlan:
45941         type: array
45942         items:
45943           $ref: "#/definitions/vlan"
45944   vnf:
45945     description: |
45946       Abstract vnf class
45947     required:
45948     - vnf-id
45949     properties:
45950       vnf-id:
45951         type: string
45952         description: Unique id of VNF.  This is unique across the graph.
45953   vnf-image:
45954     description: |
45955       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
45956       ###### Related Nodes
45957       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
45958
45959       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
45960
45961     required:
45962     - vnf-image-uuid
45963     - application
45964     - application-vendor
45965     properties:
45966       vnf-image-uuid:
45967         type: string
45968         description: Unique ID of this asset
45969       application:
45970         type: string
45971         description: The application that the image instantiates.
45972       application-vendor:
45973         type: string
45974         description: The vendor of the application.
45975       application-version:
45976         type: string
45977         description: The version of the application.
45978       selflink:
45979         type: string
45980         description: URL to endpoint where AAI can get more details
45981       resource-version:
45982         type: string
45983         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45984       relationship-list:
45985         type: array
45986         items:
45987           $ref: "#/definitions/relationship"
45988   vnf-images:
45989     description: |
45990       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
45991     properties:
45992       vnf-image:
45993         type: array
45994         items:
45995           $ref: "#/definitions/vnf-image"
45996   vnfc:
45997     description: |
45998       ###### Related Nodes
45999       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
46000       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
46001       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
46002
46003       -(4) IF this TO node is deleted, this VNFC is DELETED also
46004     required:
46005     - vnfc-name
46006     - vnfc-function-code
46007     - vnfc-type
46008     - in-maint
46009     - is-closed-loop-disabled
46010     properties:
46011       vnfc-name:
46012         type: string
46013         description: Unique ID of vnfc.
46014       vnfc-function-code:
46015         type: string
46016         description: function code
46017       vnfc-type:
46018         type: string
46019         description: type
46020       prov-status:
46021         type: string
46022         description: prov status of this vnfc
46023       orchestration-status:
46024         type: string
46025         description: Orchestration status of this VNF, mastered by APP-C
46026       ipaddress-v4-oam-vip:
46027         type: string
46028         description: Oam V4 vip address of this vnfc
46029       in-maint:
46030         type: boolean
46031         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
46032       is-closed-loop-disabled:
46033         type: boolean
46034         description: used to indicate whether closed loop function is enabled on this node
46035       group-notation:
46036         type: string
46037         description: Group notation of VNFC
46038       resource-version:
46039         type: string
46040         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46041       relationship-list:
46042         type: array
46043         items:
46044           $ref: "#/definitions/relationship"
46045   vnfcs:
46046     description: |
46047       virtual network components associated with a vserver from application controller.
46048     properties:
46049       vnfc:
46050         type: array
46051         items:
46052           $ref: "#/definitions/vnfc"
46053   volume:
46054     description: |
46055       Ephemeral Block storage volume.
46056       ###### Related Nodes
46057       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
46058
46059       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
46060     required:
46061     - volume-id
46062     - volume-selflink
46063     properties:
46064       volume-id:
46065         type: string
46066         description: Unique ID of block storage volume relative to the vserver.
46067       volume-selflink:
46068         type: string
46069         description: URL to endpoint where AAI can get more details
46070       resource-version:
46071         type: string
46072         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46073       relationship-list:
46074         type: array
46075         items:
46076           $ref: "#/definitions/relationship"
46077   volume-group:
46078     description: |
46079       Persistent block-level storage.
46080       ###### Related Nodes
46081       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
46082       - TO complex( volume-group LocatedIn complex, MANY2ONE)
46083       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
46084       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
46085       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
46086
46087     required:
46088     - volume-group-id
46089     - volume-group-name
46090     - vnf-type
46091     properties:
46092       volume-group-id:
46093         type: string
46094         description: Unique ID of volume-group.
46095       volume-group-name:
46096         type: string
46097         description: Name of the volume group.
46098       heat-stack-id:
46099         type: string
46100         description: Heat stack id corresponding to this volume-group
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       orchestration-status:
46105         type: string
46106         description: Orchestration status of this volume-group
46107       persona-model-customization-id:
46108         type: string
46109         description: captures the id of all the configuration used to customize the resource for the service.
46110       vf-module-persona-model-customization-id:
46111         type: string
46112         description: helps relate the volume group to the vf-module whose components will require the volume group
46113       resource-version:
46114         type: string
46115         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46116       relationship-list:
46117         type: array
46118         items:
46119           $ref: "#/definitions/relationship"
46120   volume-groups:
46121     description: |
46122       Collection of persistent block-level storage.
46123     properties:
46124       volume-group:
46125         type: array
46126         items:
46127           $ref: "#/definitions/volume-group"
46128   volumes:
46129     description: |
46130       Collection of ephemeral Block storage volumes.
46131     properties:
46132       volume:
46133         type: array
46134         items:
46135           $ref: "#/definitions/volume"
46136   vpls-pe:
46137     description: |
46138       VPLS Provider Edge routers.
46139       ###### Related Nodes
46140       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
46141       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
46142       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
46143       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
46144
46145       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
46146     required:
46147     - equipment-name
46148     properties:
46149       equipment-name:
46150         type: string
46151       prov-status:
46152         type: string
46153         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
46154       ipv4-oam-address:
46155         type: string
46156         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
46157       equipment-role:
46158         type: string
46159         description: Client should send valid enumerated value, e.g., VPLS-PE.
46160       vlan-id-outer:
46161         type: integer
46162         format: int64
46163         description: Temporary location for stag to get to VCE
46164       resource-version:
46165         type: string
46166         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46167       relationship-list:
46168         type: array
46169         items:
46170           $ref: "#/definitions/relationship"
46171       p-interfaces:
46172         type: array
46173         items:
46174           $ref: "#/definitions/p-interface"
46175       lag-interfaces:
46176         type: array
46177         items:
46178           $ref: "#/definitions/lag-interface"
46179   vpls-pes:
46180     description: |
46181       Collection of VPLS Provider Edge routers
46182     properties:
46183       vpls-pe:
46184         type: array
46185         items:
46186           $ref: "#/definitions/vpls-pe"
46187   vpn-binding:
46188     description: |
46189       VPN binding
46190       ###### Related Nodes
46191       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
46192       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
46193
46194       -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
46195
46196     required:
46197     - vpn-id
46198     - vpn-name
46199     - global-route-target
46200     - route-target-role
46201     properties:
46202       vpn-id:
46203         type: string
46204         description: VPN ID, globally unique within A&AI
46205       vpn-name:
46206         type: string
46207         description: VPN Name
46208       global-route-target:
46209         type: string
46210         description: Number used to identify a VPN, globally unique in the network
46211       vpn-platform:
46212         type: string
46213         description: the platform associated with the VPN example AVPN, Mobility
46214       vpn-type:
46215         type: string
46216         description: Type of the vpn, should be taken from enumerated/valid values
46217       route-distinguisher:
46218         type: string
46219         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
46220       route-target-role:
46221         type: string
46222         description: Role assigned to this route target
46223       resource-version:
46224         type: string
46225         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46226       relationship-list:
46227         type: array
46228         items:
46229           $ref: "#/definitions/relationship"
46230         description: l3-networks relate to vpn-bindings
46231   vpn-bindings:
46232     properties:
46233       vpn-binding:
46234         type: array
46235         items:
46236           $ref: "#/definitions/vpn-binding"
46237   vserver:
46238     description: |
46239       Virtual Servers, aka virtual machine or VM.
46240       ###### Related Nodes
46241       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
46242       - TO flavor( vserver Uses flavor, MANY2ONE)
46243       - TO image( vserver Uses image, MANY2ONE)
46244       - TO pserver( vserver HostedOn pserver, MANY2ONE)
46245       - TO snapshot( vserver Uses snapshot, ONE2ONE)
46246       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
46247       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
46248       - FROM vce( vce HostedOn vserver, ONE2MANY)
46249       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
46250       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
46251       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
46252
46253       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
46254       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
46255     required:
46256     - vserver-id
46257     - vserver-name
46258     - vserver-selflink
46259     - in-maint
46260     - is-closed-loop-disabled
46261     properties:
46262       vserver-id:
46263         type: string
46264         description: Unique identifier for this vserver relative to its tenant
46265       vserver-name:
46266         type: string
46267         description: Name of vserver
46268       vserver-name2:
46269         type: string
46270         description: Alternative name of vserver
46271       prov-status:
46272         type: string
46273         description: Trigger for operational monitoring of this resource by Service Assurance systems.
46274       vserver-selflink:
46275         type: string
46276         description: URL to endpoint where AAI can get more details
46277       in-maint:
46278         type: boolean
46279         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.
46280       is-closed-loop-disabled:
46281         type: boolean
46282         description: Used to indicate whether closed loop function is enabled on this node
46283       resource-version:
46284         type: string
46285         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46286       volumes:
46287         type: array
46288         items:
46289           $ref: "#/definitions/volume"
46290       relationship-list:
46291         type: array
46292         items:
46293           $ref: "#/definitions/relationship"
46294       l-interfaces:
46295         type: array
46296         items:
46297           $ref: "#/definitions/l-interface"
46298   vservers:
46299     description: |
46300       Collection of virtual Servers, aka virtual machines or VMs.
46301     properties:
46302       vserver:
46303         type: array
46304         items:
46305           $ref: "#/definitions/vserver"
46306   zone:
46307     description: |
46308       A zone is a grouping of assets in a location homing to the same connections into the CBB
46309       ###### Related Nodes
46310       - TO complex( zone LocatedIn complex, MANY2ONE)
46311       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
46312       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
46313       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
46314
46315     required:
46316     - zone-id
46317     - zone-name
46318     - design-type
46319     - zone-context
46320     properties:
46321       zone-id:
46322         type: string
46323         description: Code assigned by AIC to the zone
46324       zone-name:
46325         type: string
46326         description: English name associated with the zone
46327       design-type:
46328         type: string
46329         description: Design of zone [Medium/Large?]
46330       zone-context:
46331         type: string
46332         description: Context of zone [production/test]
46333       status:
46334         type: string
46335         description: Status of a zone.
46336       resource-version:
46337         type: string
46338         description: Concurrency value
46339       relationship-list:
46340         type: array
46341         items:
46342           $ref: "#/definitions/relationship"
46343   zones:
46344     description: |
46345       Collection of zones
46346     properties:
46347       zone:
46348         type: array
46349         items:
46350           $ref: "#/definitions/zone"
46351 patchDefinitions:
46352   action:
46353     properties:
46354       action-type:
46355         type: string
46356       action-data:
46357         type: array
46358         items:
46359           $ref: "#/patchDefinitions/action-data"
46360   action-data:
46361     properties:
46362       property-name:
46363         type: string
46364       property-value:
46365         type: string
46366   actions:
46367     description: |
46368       APIs that are more action related than REST (e.g., notify, update).
46369     properties:
46370       update:
46371         type: object
46372         $ref: "#/patchDefinitions/update"
46373       notify:
46374         type: object
46375         $ref: "#/patchDefinitions/notify"
46376   allotted-resource:
46377     description: |
46378       Represents a slice or partial piece of a resource that gets separately allotted
46379       ###### Related Nodes
46380       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
46381       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
46382       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
46383       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
46384       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
46385       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
46386       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
46387
46388       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
46389       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
46390     required:
46391     - id
46392     properties:
46393       id:
46394         type: string
46395         description: Allotted Resource id UUID assigned to this instance.
46396       description:
46397         type: string
46398         description: The descriptive information assigned to this allotted resource instance
46399       selflink:
46400         type: string
46401         description: Link back to more information in the controller
46402       persona-model-id:
46403         type: string
46404         description: the ASDC model id for this resource or service model.
46405       persona-model-version:
46406         type: string
46407         description: the ASDC model version for this resource or service model.
46408       model-version-id:
46409         type: string
46410         description: the ASDC model version for this resource or service model.
46411       persona-model-customization-id:
46412         type: string
46413         description: captures the id of all the configuration used to customize the resource for the service.
46414   allotted-resources:
46415     description: |
46416       This object is used to store slices of services being offered
46417     properties:
46418       allotted-resource:
46419         type: array
46420         items:
46421           $ref: "#/patchDefinitions/allotted-resource"
46422   availability-zone:
46423     description: |
46424       Availability zone, a collection of compute hosts/pservers
46425       ###### Related Nodes
46426       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
46427       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
46428       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
46429       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
46430       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
46431       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
46432       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
46433       - FROM vce( vce Uses availability-zone, MANY2MANY)
46434
46435       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
46436       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
46437
46438     required:
46439     - availability-zone-name
46440     - hypervisor-type
46441     properties:
46442       availability-zone-name:
46443         type: string
46444         description: Name of the availability zone.  Unique across a cloud region
46445       hypervisor-type:
46446         type: string
46447         description: Type of hypervisor.  Source of truth should define valid values.
46448       operational-state:
46449         type: string
46450         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
46451   availability-zones:
46452     description: |
46453       Collection of availability zones
46454     properties:
46455       availability-zone:
46456         type: array
46457         items:
46458           $ref: "#/patchDefinitions/availability-zone"
46459   az-and-dvs-switches:
46460     properties:
46461       dvs-switches:
46462         type: object
46463         $ref: "#/patchDefinitions/dvs-switches"
46464       availability-zone:
46465         type: object
46466         $ref: "#/patchDefinitions/availability-zone"
46467   business:
46468     description: |
46469       Namespace for business related constructs
46470     properties:
46471       connectors:
46472         type: array
46473         items:
46474           $ref: "#/patchDefinitions/connector"
46475       customers:
46476         type: array
46477         items:
46478           $ref: "#/patchDefinitions/customer"
46479   class-of-service:
46480     description: |
46481       ###### Related Nodes
46482       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
46483
46484       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
46485     required:
46486     - cos
46487     properties:
46488       cos:
46489         type: string
46490         description: unique identifier of probe
46491       probe-id:
46492         type: string
46493         description: identifier of probe
46494       probe-type:
46495         type: string
46496         description: type of probe
46497   classes-of-service:
46498     description: |
46499       class-of-service of probe
46500     properties:
46501       class-of-service:
46502         type: array
46503         items:
46504           $ref: "#/patchDefinitions/class-of-service"
46505   cloud-infrastructure:
46506     description: |
46507       Namespace for cloud infrastructure.
46508     properties:
46509       complexes:
46510         type: array
46511         items:
46512           $ref: "#/patchDefinitions/complex"
46513       cloud-regions:
46514         type: array
46515         items:
46516           $ref: "#/patchDefinitions/cloud-region"
46517       network-profiles:
46518         type: array
46519         items:
46520           $ref: "#/patchDefinitions/network-profile"
46521       pservers:
46522         type: array
46523         items:
46524           $ref: "#/patchDefinitions/pserver"
46525       virtual-data-centers:
46526         type: array
46527         items:
46528           $ref: "#/patchDefinitions/virtual-data-center"
46529   cloud-region:
46530     description: |
46531       cloud-region designates an installation of a cloud cluster or region or instantiation.
46532       ###### Related Nodes
46533       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
46534       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
46535       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
46536       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
46537       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
46538       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
46539       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
46540       - FROM image( image BelongsTo cloud-region, MANY2ONE)
46541       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
46542       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
46543       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
46544       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
46545       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
46546       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
46547
46548       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
46549       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
46550
46551     required:
46552     - cloud-owner
46553     - cloud-region-id
46554     properties:
46555       cloud-owner:
46556         type: string
46557         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
46558       cloud-region-id:
46559         type: string
46560         description: Identifier used by the vendor for the region. Second part of composite key
46561       cloud-type:
46562         type: string
46563         description: Type of the cloud (e.g., openstack)
46564       owner-defined-type:
46565         type: string
46566         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
46567       cloud-region-version:
46568         type: string
46569         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
46570       identity-url:
46571         type: string
46572         description: URL of the keystone identity service
46573       cloud-zone:
46574         type: string
46575         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
46576       complex-name:
46577         type: string
46578         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
46579   cloud-regions:
46580     properties:
46581       cloud-region:
46582         type: array
46583         items:
46584           $ref: "#/patchDefinitions/cloud-region"
46585   complex:
46586     description: |
46587       Collection of physical locations that can house cloud-regions.
46588       ###### Related Nodes
46589       - TO l3-network( complex Uses l3-network, MANY2MANY)
46590       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
46591       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
46592       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
46593       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
46594       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
46595       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
46596       - FROM vce( vce LocatedIn complex, MANY2MANY)
46597       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
46598       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
46599       - FROM zone( zone LocatedIn complex, MANY2ONE)
46600
46601       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
46602       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
46603
46604     required:
46605     - physical-location-id
46606     - physical-location-type
46607     - street1
46608     - city
46609     - postal-code
46610     - country
46611     - region
46612     properties:
46613       physical-location-id:
46614         type: string
46615         description: Unique identifier for physical location, e.g., CLLI
46616       data-center-code:
46617         type: string
46618         description: Data center code which can be an alternate way to identify a complex
46619       complex-name:
46620         type: string
46621         description: Gamma complex name for LCP instance.
46622       identity-url:
46623         type: string
46624         description: URL of the keystone identity service
46625   complexes:
46626     description: |
46627       Collection of physical locations that can house cloud-regions.
46628     properties:
46629       complex:
46630         type: array
46631         items:
46632           $ref: "#/patchDefinitions/complex"
46633   configuration:
46634     description: |
46635       Port Mirror Configuration.
46636       ###### Related Nodes
46637       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
46638       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
46639       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
46640       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
46641       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
46642
46643       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
46644       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
46645       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
46646     required:
46647     - configuration-id
46648     - configuration-type
46649     - configuration-sub-type
46650     - orchestration-status
46651     - operational-status
46652     - configuration-selflink
46653     - model-customization-id
46654     properties:
46655       configuration-id:
46656         type: string
46657         description: UUID assigned to configuration.
46658       management-option:
46659         type: string
46660         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
46661       configuration-name:
46662         type: string
46663         description: Name of the configuration.
46664       configuration-type:
46665         type: string
46666         description: port-mirroring-configuration.
46667       configuration-sub-type:
46668         type: string
46669         description: vprobe, pprobe.
46670       model-invariant-id:
46671         type: string
46672         description: the ASDC model id for this resource or service model.
46673       model-version-id:
46674         type: string
46675         description: the ASDC model version for this resource or service model.
46676       orchestration-status:
46677         type: string
46678         description: Orchestration status of the configuration.
46679       operational-status:
46680         type: string
46681         description: Indicator for whether the resource is considered operational.
46682       configuration-selflink:
46683         type: string
46684         description: URL to endpoint where AAI can get more details from SDN-GC.
46685       model-customization-id:
46686         type: string
46687         description: id of  the configuration used to customize the resource
46688   configurations:
46689     description: |
46690       Collection of configurations
46691     properties:
46692       configuration:
46693         type: array
46694         items:
46695           $ref: "#/patchDefinitions/configuration"
46696   connector:
46697     description: |
46698       Collection of resource instances used to connect a variety of disparate inventory widgets
46699       ###### Related Nodes
46700       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
46701       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
46702       - FROM service-instance( service-instance Uses connector, MANY2MANY)
46703
46704       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
46705     required:
46706     - resource-instance-id
46707     properties:
46708       resource-instance-id:
46709         type: string
46710         description: Unique id of resource instance.
46711   connectors:
46712     description: |
46713       Collection of resource instances used to connect a variety of disparate inventory widgets
46714     properties:
46715       connector:
46716         type: array
46717         items:
46718           $ref: "#/patchDefinitions/connector"
46719   constrained-element-set:
46720     description: |
46721       This is how we would capture constraints defining allowed sets of elements.
46722       ###### Related Nodes
46723       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
46724       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
46725       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
46726
46727       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
46728       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
46729     required:
46730     - constrained-element-set-uuid
46731     - constraint-type
46732     - check-type
46733     properties:
46734       constrained-element-set-uuid:
46735         type: string
46736       constraint-type:
46737         type: string
46738       check-type:
46739         type: string
46740   constrained-element-sets:
46741     properties:
46742       constrained-element-set:
46743         type: array
46744         items:
46745           $ref: "#/patchDefinitions/constrained-element-set"
46746   ctag-assignment:
46747     description: |
46748       ###### Related Nodes
46749       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
46750       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
46751
46752       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
46753     required:
46754     - vlan-id-inner
46755     properties:
46756       vlan-id-inner:
46757         type: integer
46758         format: int64
46759         description: id.
46760   ctag-assignments:
46761     properties:
46762       ctag-assignment:
46763         type: array
46764         items:
46765           $ref: "#/patchDefinitions/ctag-assignment"
46766   ctag-pool:
46767     description: |
46768       A collection of C tags (vlan tags) grouped for a specific purpose.
46769       ###### Related Nodes
46770       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
46771       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
46772       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
46773
46774       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
46775     required:
46776     - target-pe
46777     - availability-zone-name
46778     - ctag-pool-purpose
46779     properties:
46780       target-pe:
46781         type: string
46782         description: The Target provider edge router
46783       availability-zone-name:
46784         type: string
46785         description: Name of the availability zone
46786       ctag-pool-purpose:
46787         type: string
46788         description: Describes what the intended purpose of this pool is.
46789       ctag-values:
46790         type: string
46791         description: Comma separated list of ctags
46792   ctag-pools:
46793     properties:
46794       ctag-pool:
46795         type: array
46796         items:
46797           $ref: "#/patchDefinitions/ctag-pool"
46798   customer:
46799     description: |
46800       customer identifiers to provide linkage back to BSS information.
46801       ###### Related Nodes
46802       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
46803
46804       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
46805     required:
46806     - global-customer-id
46807     - subscriber-name
46808     - subscriber-type
46809     properties:
46810       global-customer-id:
46811         type: string
46812         description: Global customer id used across ECOMP to uniquely identify customer.
46813       subscriber-name:
46814         type: string
46815         description: Subscriber name, an alternate way to retrieve a customer.
46816       subscriber-type:
46817         type: string
46818         description: Subscriber type, a way to provide VID with only the INFRA customers.
46819   customers:
46820     description: |
46821       Collection of customer identifiers to provide linkage back to BSS information.
46822     properties:
46823       customer:
46824         type: array
46825         items:
46826           $ref: "#/patchDefinitions/customer"
46827   cvlan-tag-entry:
46828     required:
46829     - cvlan-tag
46830     properties:
46831       cvlan-tag:
46832         type: integer
46833         format: int64
46834         description: See mis-na-virtualization-platform.yang
46835   cvlan-tags:
46836     properties:
46837       cvlan-tag-entry:
46838         type: array
46839         items:
46840           $ref: "#/patchDefinitions/cvlan-tag-entry"
46841   dvs-switch:
46842     description: |
46843       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.
46844       ###### Related Nodes
46845       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
46846       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
46847
46848     required:
46849     - switch-name
46850     - vcenter-url
46851     properties:
46852       switch-name:
46853         type: string
46854         description: DVS switch name
46855       vcenter-url:
46856         type: string
46857         description: URL used to reach the vcenter
46858   dvs-switches:
46859     description: |
46860       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
46861     properties:
46862       dvs-switch:
46863         type: array
46864         items:
46865           $ref: "#/patchDefinitions/dvs-switch"
46866   edge-prop-names:
46867     description: |
46868       Internal map to define the properties of an edge and interpret the map EdgeRules
46869     properties:
46870       edgeLabel:
46871         type: string
46872       direction:
46873         type: string
46874       multiplicityRule:
46875         type: string
46876       isParent:
46877         type: boolean
46878       usesResource:
46879         type: boolean
46880       hasDelTarget:
46881         type: boolean
46882       SVC-INFRA:
46883         type: boolean
46884       SVC-INFRA-REV:
46885         type: boolean
46886   edge-tag-query-request:
46887     properties:
46888       edge-tag:
46889         type: string
46890       result-detail:
46891         type: string
46892       start-node-type:
46893         type: string
46894       start-node-filter:
46895         type: array
46896         items:
46897           $ref: "#/patchDefinitions/start-node-filter"
46898       include-node-filter:
46899         type: array
46900         items:
46901           $ref: "#/patchDefinitions/include-node-filter"
46902       secondary-filter:
46903         type: array
46904         items:
46905           $ref: "#/patchDefinitions/secondary-filter"
46906   edge-tag-query-result:
46907     properties:
46908       tagged-inventory-item-list:
46909         type: array
46910         items:
46911           $ref: "#/patchDefinitions/tagged-inventory-item-list"
46912   element-choice-set:
46913     description: |
46914       This is how we would capture constraints defining allowed sets of elements.
46915       ###### Related Nodes
46916       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
46917       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
46918
46919       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
46920       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
46921     required:
46922     - element-choice-set-uuid
46923     - element-choice-set-name
46924     properties:
46925       element-choice-set-uuid:
46926         type: string
46927       element-choice-set-name:
46928         type: string
46929       cardinality:
46930         type: string
46931   element-choice-sets:
46932     properties:
46933       element-choice-set:
46934         type: array
46935         items:
46936           $ref: "#/patchDefinitions/element-choice-set"
46937   entitlement:
46938     description: |
46939       Metadata for entitlement group.
46940       ###### Related Nodes
46941       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
46942       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
46943
46944       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
46945     required:
46946     - group-uuid
46947     - resource-uuid
46948     properties:
46949       group-uuid:
46950         type: string
46951         description: Unique ID for the entitlement group the resource comes from, should be uuid.
46952       resource-uuid:
46953         type: string
46954         description: Unique ID of an entitlement resource.
46955   entitlements:
46956     description: |
46957       Entitlements, keyed by group-uuid and resource-uuid, related to license management
46958     properties:
46959       entitlement:
46960         type: array
46961         items:
46962           $ref: "#/patchDefinitions/entitlement"
46963   esr-ems:
46964     description: |
46965       Persist EMS address information used by EMS driver.
46966       ###### Related Nodes
46967       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
46968
46969       -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
46970     required:
46971     - ems-id
46972     properties:
46973       ems-id:
46974         type: string
46975         description: Unique ID of EMS.
46976   esr-ems-list:
46977     properties:
46978       esr-ems:
46979         type: array
46980         items:
46981           $ref: "#/patchDefinitions/esr-ems"
46982   esr-system-info:
46983     description: |
46984       Persist common address information of external systems.
46985       ###### Related Nodes
46986       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
46987       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
46988       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
46989       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
46990
46991       -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
46992     required:
46993     - esr-system-info-id
46994     - user-name
46995     - password
46996     - system-type
46997     properties:
46998       esr-system-info-id:
46999         type: string
47000         description: Unique ID of esr system info.
47001       system-name:
47002         type: string
47003         description: name of external system.
47004       type:
47005         type: string
47006         description: type of external systems.
47007       vendor:
47008         type: string
47009         description: vendor of external systems.
47010       version:
47011         type: string
47012         description: version of external systems.
47013       service-url:
47014         type: string
47015         description: url used to access external systems.
47016       user-name:
47017         type: string
47018         description: username used to access external systems.
47019       password:
47020         type: string
47021         description: password used to access external systems.
47022       system-type:
47023         type: string
47024         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
47025       protocol:
47026         type: string
47027         description: protocol of third party SDNC, for example netconf/snmp.
47028       ssl-cacert:
47029         type: string
47030         description: ca file content if enabled ssl on auth-url.
47031       ssl-insecure:
47032         type: boolean
47033         description: Whether to verify VIM's certificate.
47034       ip-address:
47035         type: string
47036         description: service IP of ftp server.
47037       port:
47038         type: string
47039         description: service port of ftp server.
47040       cloud-domain:
47041         type: string
47042         description: domain info for authentication.
47043       default-tenant:
47044         type: string
47045         description: default tenant of VIM.
47046       passive:
47047         type: boolean
47048         description: ftp passive mode or not.
47049       remote-path:
47050         type: string
47051         description: resource or performance data file path.
47052       system-status:
47053         type: string
47054         description: the status of external system.
47055   esr-system-info-list:
47056     description: |
47057       Collection of persistent block-level external system auth info.
47058     properties:
47059       esr-system-info:
47060         type: array
47061         items:
47062           $ref: "#/patchDefinitions/esr-system-info"
47063   esr-thirdparty-sdnc:
47064     description: |
47065       Persist SDNC address information used by ONAP SDNC.
47066       ###### Related Nodes
47067       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
47068       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
47069
47070       -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
47071     required:
47072     - thirdparty-sdnc-id
47073     properties:
47074       thirdparty-sdnc-id:
47075         type: string
47076         description: Unique ID of SDNC.
47077       location:
47078         type: string
47079         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
47080       product-name:
47081         type: string
47082         description: password used to access SDNC server.
47083   esr-thirdparty-sdnc-list:
47084     properties:
47085       esr-thirdparty-sdnc:
47086         type: array
47087         items:
47088           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
47089   esr-vnfm:
47090     description: |
47091       Persist VNFM address information used by VF-C.
47092       ###### Related Nodes
47093       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
47094
47095       -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
47096     required:
47097     - vnfm-id
47098     properties:
47099       vnfm-id:
47100         type: string
47101         description: Unique ID of VNFM.
47102       vim-id:
47103         type: string
47104         description: indecate the VIM to deploy VNF.
47105       certificate-url:
47106         type: string
47107         description: certificate url of VNFM.
47108   esr-vnfm-list:
47109     properties:
47110       esr-vnfm:
47111         type: array
47112         items:
47113           $ref: "#/patchDefinitions/esr-vnfm"
47114   evc:
47115     description: |
47116       evc object is an optional child object of the Configuration object.
47117       ###### Related Nodes
47118       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
47119
47120       -(4) IF this TO node is deleted, this EVC is DELETED also
47121     required:
47122     - evc-id
47123     properties:
47124       evc-id:
47125         type: string
47126         description: Unique/key field for the evc object
47127       forwarding-path-topology:
47128         type: string
47129         description: Point-to-Point, Multi-Point
47130       cir-value:
47131         type: string
47132         description: Commited Information Rate
47133       cir-units:
47134         type: string
47135         description: CIR units
47136       connection-diversity-group-id:
47137         type: string
47138         description: Diversity Group ID
47139       service-hours:
47140         type: string
47141         description: formerly Performance Group
47142       esp-evc-circuit-id:
47143         type: string
47144         description: EVC Circuit ID of ESP EVC
47145       esp-evc-cir-value:
47146         type: string
47147         description: Committed Information Rate (For ESP)
47148       esp-evc-cir-units:
47149         type: string
47150         description: CIR units (For ESP)
47151       esp-itu-code:
47152         type: string
47153         description: Identifies ESP
47154       collector-pop-clli:
47155         type: string
47156         description: Collector POP CLLI (from the hostname of the access pnf)
47157       inter-connect-type-ingress:
47158         type: string
47159         description: Interconnect type on ingress side of EVC.
47160       tagmode-access-ingress:
47161         type: string
47162         description: tagode for collector side of EVC
47163       tagmode-access-egress:
47164         type: string
47165         description: tagMode for network side of EVC
47166   evcs:
47167     properties:
47168       evc:
47169         type: array
47170         items:
47171           $ref: "#/patchDefinitions/evc"
47172   external-system:
47173     description: |
47174       Namespace for external system.
47175     properties:
47176       esr-ems-list:
47177         type: object
47178         $ref: "#/patchDefinitions/esr-ems-list"
47179       esr-vnfm-list:
47180         type: object
47181         $ref: "#/patchDefinitions/esr-vnfm-list"
47182       esr-thirdparty-sdnc-list:
47183         type: object
47184         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
47185   extra-properties:
47186     description: |
47187       Extra properties for inventory item for response list
47188   extra-property:
47189     properties:
47190       property-name:
47191         type: string
47192   flavor:
47193     description: |
47194       Openstack flavor.
47195       ###### Related Nodes
47196       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
47197       - FROM vserver( vserver Uses flavor, MANY2ONE)
47198
47199       -FLAVOR cannot be deleted if related to VSERVER
47200
47201     required:
47202     - flavor-id
47203     - flavor-name
47204     - flavor-selflink
47205     properties:
47206       flavor-id:
47207         type: string
47208         description: Flavor id, expected to be unique across cloud-region.
47209       flavor-name:
47210         type: string
47211         description: Flavor name
47212       flavor-vcpus:
47213         type: integer
47214         format: int32
47215         description: Number of CPUs
47216       flavor-ram:
47217         type: integer
47218         format: int32
47219         description: Amount of memory
47220       flavor-disk:
47221         type: integer
47222         format: int32
47223         description: Disk space
47224       flavor-ephemeral:
47225         type: integer
47226         format: int32
47227         description: Amount of ephemeral disk space
47228       flavor-swap:
47229         type: string
47230         description: amount of swap space allocation
47231       flavor-is-public:
47232         type: boolean
47233         description: whether flavor is available to all users or private to the tenant it was created in.
47234       flavor-selflink:
47235         type: string
47236         description: URL to endpoint where AAI can get more details
47237       flavor-disabled:
47238         type: boolean
47239         description: Boolean as to whether this flavor is no longer enabled
47240   flavors:
47241     description: |
47242       Collection of openstack flavors.
47243     properties:
47244       flavor:
47245         type: array
47246         items:
47247           $ref: "#/patchDefinitions/flavor"
47248   forwarder:
47249     description: |
47250       Entity describing a sequenced segment of forwarding path
47251       ###### Related Nodes
47252       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
47253       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
47254       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
47255       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
47256       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
47257
47258       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
47259       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
47260     required:
47261     - sequence
47262     properties:
47263       sequence:
47264         type: integer
47265         format: int32
47266         description: Unique ID of this segmentation
47267       forwarder-role:
47268         type: string
47269         description: ingress, intermediate, egress
47270   forwarder-evc:
47271     description: |
47272       forwarder object is an optional child object of the Configuration object.
47273       ###### Related Nodes
47274       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
47275
47276       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
47277     required:
47278     - forwarder-evc-id
47279     properties:
47280       forwarder-evc-id:
47281         type: string
47282         description: Key for forwarder-evc object
47283       circuit-id:
47284         type: string
47285         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
47286       ivlan:
47287         type: string
47288         description: Internal VLAN.
47289       svlan:
47290         type: string
47291         description: SVLAN value for ingress of egress forwarder.
47292       cvlan:
47293         type: string
47294         description: CVLAN value for ingress of egress forwarder.
47295   forwarder-evcs:
47296     properties:
47297       forwarder-evc:
47298         type: array
47299         items:
47300           $ref: "#/patchDefinitions/forwarder-evc"
47301   forwarders:
47302     properties:
47303       forwarder:
47304         type: array
47305         items:
47306           $ref: "#/patchDefinitions/forwarder"
47307   forwarding-path:
47308     description: |
47309       Entity that describes the sequenced forwarding path between interfaces of services or resources
47310       ###### Related Nodes
47311       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
47312       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
47313       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
47314
47315       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
47316       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
47317       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
47318     required:
47319     - forwarding-path-id
47320     - forwarding-path-name
47321     properties:
47322       forwarding-path-id:
47323         type: string
47324         description: Unique ID of this FP
47325       forwarding-path-name:
47326         type: string
47327         description: Name of the FP
47328   forwarding-paths:
47329     properties:
47330       forwarding-path:
47331         type: array
47332         items:
47333           $ref: "#/patchDefinitions/forwarding-path"
47334   generic-vnf:
47335     description: |
47336       General purpose VNF
47337       ###### Related Nodes
47338       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
47339       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
47340       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
47341       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
47342       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
47343       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
47344       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
47345       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
47346       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
47347       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
47348       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
47349       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
47350       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
47351       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
47352       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
47353       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
47354       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
47355       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
47356       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
47357       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
47358       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
47359
47360       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
47361     required:
47362     - vnf-id
47363     - vnf-name
47364     - vnf-type
47365     - in-maint
47366     - is-closed-loop-disabled
47367     properties:
47368       vnf-id:
47369         type: string
47370         description: Unique id of VNF.  This is unique across the graph.
47371       vnf-name:
47372         type: string
47373         description: Name of VNF.
47374       vnf-name2:
47375         type: string
47376         description: Alternate name of VNF.
47377       vnf-type:
47378         type: string
47379         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.
47380       service-id:
47381         type: string
47382         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
47383       regional-resource-zone:
47384         type: string
47385         description: Regional way of organizing pservers, source of truth should define values
47386       prov-status:
47387         type: string
47388         description: Trigger for operational monitoring of this resource by Service Assurance systems.
47389       operational-state:
47390         type: string
47391         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
47392       license-key:
47393         type: string
47394         description: OBSOLETE -  do not use
47395       equipment-role:
47396         type: string
47397         description: Client should send valid enumerated value
47398       orchestration-status:
47399         type: string
47400         description: Orchestration status of this VNF, used by MSO.
47401       heat-stack-id:
47402         type: string
47403         description: Heat stack id corresponding to this instance, managed by MSO
47404       mso-catalog-key:
47405         type: string
47406         description: Corresponds to the SDN-C catalog id used to configure this VCE
47407       management-option:
47408         type: string
47409         description: identifier of managed by company or customer
47410       ipv4-oam-address:
47411         type: string
47412         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
47413       ipv4-loopback0-address:
47414         type: string
47415         description: v4 Loopback0 address
47416       nm-lan-v6-address:
47417         type: string
47418         description: v6 Loopback address
47419       management-v6-address:
47420         type: string
47421         description: v6 management address
47422       vcpu:
47423         type: integer
47424         format: int64
47425         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47426       vcpu-units:
47427         type: string
47428         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
47429       vmemory:
47430         type: integer
47431         format: int64
47432         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47433       vmemory-units:
47434         type: string
47435         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
47436       vdisk:
47437         type: integer
47438         format: int64
47439         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47440       vdisk-units:
47441         type: string
47442         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
47443       in-maint:
47444         type: boolean
47445         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.
47446       is-closed-loop-disabled:
47447         type: boolean
47448         description: used to indicate whether closed loop function is enabled on this node
47449   generic-vnfs:
47450     description: |
47451       Collection of VNFs
47452     properties:
47453       generic-vnf:
47454         type: array
47455         items:
47456           $ref: "#/patchDefinitions/generic-vnf"
47457   group-assignment:
47458     description: |
47459       Openstack group-assignment used to store exclusivity groups (EG).
47460       ###### Related Nodes
47461       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
47462       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
47463       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
47464
47465     required:
47466     - group-id
47467     - group-type
47468     - group-name
47469     properties:
47470       group-id:
47471         type: string
47472         description: Group id, expected to be unique across cloud-region.
47473       group-type:
47474         type: string
47475         description: Group type - the type of group this instance refers to
47476       group-name:
47477         type: string
47478         description: Group name - name assigned to the group
47479       group-description:
47480         type: string
47481         description: Group description - description of the group
47482   group-assignments:
47483     description: |
47484       Collection of openstack group assignments
47485     properties:
47486       group-assignment:
47487         type: array
47488         items:
47489           $ref: "#/patchDefinitions/group-assignment"
47490   host-route:
47491     description: |
47492       ###### Related Nodes
47493       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
47494
47495       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
47496     required:
47497     - host-route-id
47498     - route-prefix
47499     - next-hop
47500     properties:
47501       host-route-id:
47502         type: string
47503         description: host-route id
47504       route-prefix:
47505         type: string
47506         description: subnet prefix
47507       next-hop:
47508         type: string
47509         description: Could be ip-address, hostname, or service-instance
47510       next-hop-type:
47511         type: string
47512         description: Should be ip-address, hostname, or service-instance to match next-hop
47513   host-routes:
47514     properties:
47515       host-route:
47516         type: array
47517         items:
47518           $ref: "#/patchDefinitions/host-route"
47519   hpa-capabilities:
47520     description: |
47521       Collection of HPA Capabilities
47522     properties:
47523       hpa-capability:
47524         type: array
47525         items:
47526           $ref: "#/patchDefinitions/hpa-capability"
47527   hpa-capability:
47528     description: |
47529       Represents a HPA capability
47530       ###### Related Nodes
47531       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
47532       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
47533       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
47534
47535       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
47536     required:
47537     - hpa-capability-id
47538     - hpa-feature
47539     properties:
47540       hpa-capability-id:
47541         type: string
47542         description: UUID to uniquely identify a HPA capability
47543       hpa-feature:
47544         type: string
47545         description: Name of the HPACapability
47546       hpa-version:
47547         type: string
47548         description: HPA schema version
47549       architecture:
47550         type: string
47551         description: Hardware architecture
47552   hpa-feature-attributes:
47553     description: |
47554       HPA Capability Feature attributes
47555       ###### Related Nodes
47556       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
47557
47558       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
47559     required:
47560     - hpa-attribute-key
47561     properties:
47562       hpa-attribute-key:
47563         type: string
47564         description: name of the specific HPA attribute
47565       hpa-attribute-value:
47566         type: string
47567         description: JSON string specifying the value, unit and type of the specific HPA attribute
47568   image:
47569     description: |
47570       Openstack image.
47571       ###### Related Nodes
47572       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
47573       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
47574       - FROM vserver( vserver Uses image, MANY2ONE)
47575
47576       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
47577       -IMAGE cannot be deleted if related to VSERVER
47578
47579     required:
47580     - image-id
47581     - image-name
47582     - image-os-distro
47583     - image-os-version
47584     - image-selflink
47585     properties:
47586       image-id:
47587         type: string
47588         description: Image id, expected to be unique across cloud region
47589       image-name:
47590         type: string
47591         description: Image name
47592       image-architecture:
47593         type: string
47594         description: Operating system architecture.
47595       image-os-distro:
47596         type: string
47597         description: The common name of the operating system distribution in lowercase
47598       image-os-version:
47599         type: string
47600         description: The operating system version as specified by the distributor.
47601       application:
47602         type: string
47603         description: The application that the image instantiates.
47604       application-vendor:
47605         type: string
47606         description: The vendor of the application.
47607       application-version:
47608         type: string
47609         description: The version of the application.
47610       image-selflink:
47611         type: string
47612         description: URL to endpoint where AAI can get more details
47613   images:
47614     description: |
47615       Collectio of Openstack images.
47616     properties:
47617       image:
47618         type: array
47619         items:
47620           $ref: "#/patchDefinitions/image"
47621   include-node-filter:
47622     properties:
47623       include-node-type:
47624         type: string
47625   instance-filter:
47626     description: |
47627       InstanceFilter for performing a named-query or model query
47628   instance-filters:
47629     description: |
47630       InstanceFilters for performing a named-query or model query
47631     properties:
47632       instance-filter:
47633         type: array
47634         items:
47635           $ref: "#/patchDefinitions/instance-filter"
47636   instance-group:
47637     description: |
47638       General mechanism for grouping instances
47639       ###### Related Nodes
47640       - TO model( instance-group Targets model, MANY2MANY)
47641       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
47642       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
47643       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
47644       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
47645
47646     required:
47647     - id
47648     - description
47649     - type
47650     properties:
47651       id:
47652         type: string
47653         description: Instance Group ID, UUID assigned to this instance.
47654       description:
47655         type: string
47656         description: Descriptive text to help identify the usage of this instance-group
47657       type:
47658         type: string
47659         description: Only valid value today is lower case ha for high availability
47660       sub-type:
47661         type: string
47662         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
47663   instance-groups:
47664     description: |
47665       Collection of openstack route table references
47666     properties:
47667       instance-group:
47668         type: array
47669         items:
47670           $ref: "#/patchDefinitions/instance-group"
47671   inventory:
47672     properties:
47673       search:
47674         type: object
47675         $ref: "#/patchDefinitions/search"
47676       actions:
47677         type: object
47678         $ref: "#/patchDefinitions/actions"
47679       cloud-infrastructure:
47680         type: object
47681         $ref: "#/patchDefinitions/cloud-infrastructure"
47682       business:
47683         type: object
47684         $ref: "#/patchDefinitions/business"
47685       service-design-and-creation:
47686         type: object
47687         $ref: "#/patchDefinitions/service-design-and-creation"
47688       network:
47689         type: object
47690         $ref: "#/patchDefinitions/network"
47691       nodes:
47692         type: object
47693         $ref: "#/patchDefinitions/nodes"
47694   inventory-item:
47695     properties:
47696       inventory-item-type:
47697         type: string
47698       inventory-item-link:
47699         type: string
47700       inventory-item-data:
47701         type: array
47702         items:
47703           $ref: "#/patchDefinitions/inventory-item-data"
47704       tagged-inventory-item-list:
47705         type: array
47706         items:
47707           $ref: "#/patchDefinitions/tagged-inventory-item-list"
47708   inventory-item-data:
47709     properties:
47710       property-name:
47711         type: string
47712       property-value:
47713         type: string
47714   inventory-response-item:
47715     description: |
47716       Inventory item for response list
47717     properties:
47718       model-name:
47719         type: string
47720       extra-properties:
47721         type: object
47722         $ref: "#/patchDefinitions/extra-properties"
47723       inventory-response-items:
47724         type: object
47725         $ref: "#/patchDefinitions/inventory-response-items"
47726   inventory-response-items:
47727     description: |
47728       Container for inventory items in response list
47729     properties:
47730       inventory-response-item:
47731         type: array
47732         items:
47733           $ref: "#/patchDefinitions/inventory-response-item"
47734   ipsec-configuration:
47735     description: |
47736       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
47737       ###### Related Nodes
47738       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
47739       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
47740
47741       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
47742     required:
47743     - ipsec-configuration-id
47744     properties:
47745       ipsec-configuration-id:
47746         type: string
47747         description: UUID of this configuration
47748       requested-vig-address-type:
47749         type: string
47750         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
47751       requested-encryption-strength:
47752         type: string
47753         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
47754       requested-dmz-type:
47755         type: string
47756         description: can offer a shared DMZ or a DMZ specific to a customer
47757       shared-dmz-network-address:
47758         type: string
47759         description: Network address of shared DMZ
47760       requested-customer-name:
47761         type: string
47762         description: If the DMZ is a custom DMZ, this field will indicate the customer information
47763       ike-version:
47764         type: string
47765         description: can be 1 or 2
47766       ikev1-authentication:
47767         type: string
47768         description: Contains values like md5, sha1, sha256, sha384
47769       ikev1-encryption:
47770         type: string
47771         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
47772       ikev1-dh-group:
47773         type: string
47774         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
47775       ikev1-am-group-id:
47776         type: string
47777         description: Group name defined in VIG for clients using aggressive mode
47778       ikev1-am-password:
47779         type: string
47780         description: pre-shared key for the above group name
47781       ikev1-sa-lifetime:
47782         type: string
47783         description: Lifetime for IKEv1 SA
47784       ipsec-authentication:
47785         type: string
47786         description: md5, sha1, sha256, sha384
47787       ipsec-encryption:
47788         type: string
47789         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
47790       ipsec-sa-lifetime:
47791         type: string
47792         description: Life time for IPSec SA
47793       ipsec-pfs:
47794         type: string
47795         description: enable PFS or not
47796       xauth-userid:
47797         type: string
47798         description: user ID for xAuth, sm-user, ,nmteHostName
47799       xauth-user-password:
47800         type: string
47801         description: Encrypted using the Juniper $9$ algorithm
47802       dpd-interval:
47803         type: string
47804         description: The time between DPD probe
47805       dpd-frequency:
47806         type: string
47807         description: Maximum number of DPD before claiming the tunnel is down
47808   ipsec-configurations:
47809     properties:
47810       ipsec-configuration:
47811         type: array
47812         items:
47813           $ref: "#/patchDefinitions/ipsec-configuration"
47814   key-data:
47815     properties:
47816       key-name:
47817         type: string
47818       key-value:
47819         type: string
47820   l-interface:
47821     description: |
47822       Logical interfaces, e.g., a vnic.
47823       ###### Related Nodes
47824       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
47825       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
47826       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
47827       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
47828       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
47829       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
47830       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
47831       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
47832       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
47833       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
47834
47835       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
47836       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
47837       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
47838     required:
47839     - interface-name
47840     properties:
47841       interface-name:
47842         type: string
47843         description: Name given to the interface
47844       interface-role:
47845         type: string
47846         description: E.g., CUSTOMER, UPLINK, etc.
47847       v6-wan-link-ip:
47848         type: string
47849         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
47850       selflink:
47851         type: string
47852         description: URL to endpoint where AAI can get more details
47853       interface-id:
47854         type: string
47855         description: ID of interface
47856       macaddr:
47857         type: string
47858         description: MAC address for the interface
47859       network-name:
47860         type: string
47861         description: Name of the network
47862       management-option:
47863         type: string
47864         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
47865       interface-description:
47866         type: string
47867         description: Human friendly text regarding this interface.
47868   l-interfaces:
47869     description: |
47870       Collection of logical interfaces.
47871     properties:
47872       l-interface:
47873         type: array
47874         items:
47875           $ref: "#/patchDefinitions/l-interface"
47876   l3-interface-ipv4-address-list:
47877     description: |
47878       IPv4 Address Range
47879       ###### Related Nodes
47880       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
47881       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
47882       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
47883       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
47884
47885       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
47886     required:
47887     - l3-interface-ipv4-address
47888     properties:
47889       l3-interface-ipv4-address:
47890         type: string
47891         description: IP address
47892       l3-interface-ipv4-prefix-length:
47893         type: integer
47894         format: int64
47895         description: Prefix length, 32 for single address
47896       vlan-id-inner:
47897         type: integer
47898         format: int64
47899         description: Inner VLAN tag
47900       vlan-id-outer:
47901         type: integer
47902         format: int64
47903         description: Outer VLAN tag
47904       is-floating:
47905         type: boolean
47906         description: Indicator of fixed or floating address
47907   l3-interface-ipv6-address-list:
47908     description: |
47909       IPv6 Address Range
47910       ###### Related Nodes
47911       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
47912       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
47913       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
47914       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
47915
47916       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
47917     required:
47918     - l3-interface-ipv6-address
47919     properties:
47920       l3-interface-ipv6-address:
47921         type: string
47922         description: IP address
47923       l3-interface-ipv6-prefix-length:
47924         type: integer
47925         format: int64
47926         description: Prefix length, 128 for single address
47927       vlan-id-inner:
47928         type: integer
47929         format: int64
47930         description: Inner VLAN tag
47931       vlan-id-outer:
47932         type: integer
47933         format: int64
47934         description: Outer VLAN tag
47935       is-floating:
47936         type: boolean
47937         description: Indicator of fixed or floating address
47938   l3-network:
47939     description: |
47940       Generic network definition
47941       ###### Related Nodes
47942       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
47943       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
47944       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
47945       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
47946       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
47947       - FROM complex( complex Uses l3-network, MANY2MANY)
47948       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
47949       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
47950       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
47951       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
47952       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
47953       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
47954       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
47955       - FROM tenant( tenant Uses l3-network, MANY2MANY)
47956       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
47957
47958       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
47959     required:
47960     - network-id
47961     - network-name
47962     - is-bound-to-vpn
47963     - is-provider-network
47964     - is-shared-network
47965     - is-external-network
47966     properties:
47967       network-id:
47968         type: string
47969         description: Network ID, should be uuid. Unique across A&AI.
47970       network-name:
47971         type: string
47972         description: Name of the network, governed by some naming convention..
47973       network-type:
47974         type: string
47975         description: Type of the network - who defines these values?
47976       network-role:
47977         type: string
47978         description: Role the network plans - who defines these values?
47979       network-technology:
47980         type: string
47981         description: Network technology - who defines these values?
47982       neutron-network-id:
47983         type: string
47984         description: Neutron network id of this Interface
47985       is-bound-to-vpn:
47986         type: boolean
47987         description: Set to true if bound to VPN
47988       service-id:
47989         type: string
47990         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
47991       network-role-instance:
47992         type: integer
47993         format: int64
47994         description: network role instance
47995   l3-networks:
47996     properties:
47997       l3-network:
47998         type: array
47999         items:
48000           $ref: "#/patchDefinitions/l3-network"
48001   lag-interface:
48002     description: |
48003       Link aggregate interface
48004       ###### Related Nodes
48005       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
48006       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
48007       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
48008       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
48009       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
48010       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
48011       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
48012
48013       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
48014       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
48015       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
48016     required:
48017     - interface-name
48018     properties:
48019       interface-name:
48020         type: string
48021         description: Name that identifies the link aggregate interface
48022       interface-description:
48023         type: string
48024         description: Human friendly text regarding this interface.
48025   lag-interfaces:
48026     description: |
48027       Collection of link aggregate interfaces.
48028     properties:
48029       lag-interface:
48030         type: array
48031         items:
48032           $ref: "#/patchDefinitions/lag-interface"
48033   lag-link:
48034     description: |
48035       LAG links can connect lag-interfaces
48036       ###### Related Nodes
48037       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
48038       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
48039
48040       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
48041     required:
48042     - link-name
48043     properties:
48044       link-name:
48045         type: string
48046         description: Alphabetical concatenation of lag-interface names
48047   lag-links:
48048     description: |
48049       Collection of link aggregation connections
48050     properties:
48051       lag-link:
48052         type: array
48053         items:
48054           $ref: "#/patchDefinitions/lag-link"
48055   license:
48056     description: |
48057       Metadata for license group.
48058       ###### Related Nodes
48059       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
48060       - TO vce( license BelongsTo vce, MANY2ONE)(4)
48061
48062       -(4) IF this TO node is deleted, this LICENSE is DELETED also
48063     required:
48064     - group-uuid
48065     - resource-uuid
48066     properties:
48067       group-uuid:
48068         type: string
48069         description: Unique ID for the license group the resource belongs to, should be uuid.
48070       resource-uuid:
48071         type: string
48072         description: Unique ID of a license resource.
48073   licenses:
48074     description: |
48075       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
48076     properties:
48077       license:
48078         type: array
48079         items:
48080           $ref: "#/patchDefinitions/license"
48081   line-of-business:
48082     description: |
48083       describes a line-of-business
48084       ###### Related Nodes
48085       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
48086
48087     required:
48088     - line-of-business-name
48089     properties:
48090       line-of-business-name:
48091         type: string
48092         description: Name of the line-of-business (product)
48093   lines-of-business:
48094     description: |
48095       Collection of lines-of-business
48096     properties:
48097       line-of-business:
48098         type: array
48099         items:
48100           $ref: "#/patchDefinitions/line-of-business"
48101   logical-link:
48102     description: |
48103       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
48104       ###### Related Nodes
48105       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
48106       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
48107       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
48108       - TO logical-link( logical-link Uses logical-link, ONE2MANY)
48109       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
48110       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
48111       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
48112       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
48113       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
48114       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
48115       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
48116       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
48117       - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
48118
48119       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
48120     required:
48121     - link-name
48122     - link-type
48123     properties:
48124       link-name:
48125         type: string
48126         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
48127       link-type:
48128         type: string
48129         description: Type of logical link, e.g., evc
48130       speed-value:
48131         type: string
48132         description: Captures the numeric part of the speed
48133       speed-units:
48134         type: string
48135         description: Captures the units corresponding to the speed
48136       ip-version:
48137         type: string
48138         description: v4, v6, or ds for dual stack
48139       routing-protocol:
48140         type: string
48141         description: For example, static or BGP
48142   logical-links:
48143     description: |
48144       Collection of logical connections
48145     properties:
48146       logical-link:
48147         type: array
48148         items:
48149           $ref: "#/patchDefinitions/logical-link"
48150   metadata:
48151     description: |
48152       Collection of metadatum (key/value pairs)
48153     properties:
48154       metadatum:
48155         type: array
48156         items:
48157           $ref: "#/patchDefinitions/metadatum"
48158   metadatum:
48159     description: |
48160       Key/value pairs
48161       ###### Related Nodes
48162       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
48163       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
48164       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
48165       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
48166
48167       -(4) IF this TO node is deleted, this METADATUM is DELETED also
48168     required:
48169     - metaname
48170     - metaval
48171     properties:
48172       metaname:
48173         type: string
48174       metaval:
48175         type: string
48176   model:
48177     description: |
48178       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
48179       ###### Related Nodes
48180       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
48181       - FROM instance-group( instance-group Targets model, MANY2MANY)
48182       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
48183       - FROM named-query( named-query AppliesTo model, ONE2MANY)
48184       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
48185
48186       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
48187       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
48188
48189     required:
48190     - model-invariant-id
48191     - model-type
48192     properties:
48193       model-invariant-id:
48194         type: string
48195         description: Unique identifier corresponding to the main definition of a model in ASDC
48196       model-type:
48197         type: string
48198         description: Type of the model, e.g., service, resource, widget, etc.
48199   model-and-named-query-search:
48200     description: |
48201       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
48202     properties:
48203       query-parameters:
48204         type: object
48205         $ref: "#/patchDefinitions/query-parameters"
48206       instance-filters:
48207         type: object
48208         $ref: "#/patchDefinitions/instance-filters"
48209       secondary-filts:
48210         type: object
48211         $ref: "#/patchDefinitions/secondary-filts"
48212       top-node-type:
48213         type: string
48214       secondary-filter-cut-point:
48215         type: string
48216   model-constraint:
48217     description: |
48218       This is how we would capture constraints defining allowed sets of elements.
48219       ###### Related Nodes
48220       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
48221       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
48222
48223       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
48224       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
48225     required:
48226     - model-constraint-uuid
48227     - constrained-element-set-uuid-to-replace
48228     properties:
48229       model-constraint-uuid:
48230         type: string
48231       constrained-element-set-uuid-to-replace:
48232         type: string
48233       constrained-element-sets:
48234         type: array
48235         items:
48236           $ref: "#/patchDefinitions/constrained-element-set"
48237   model-constraints:
48238     properties:
48239       model-constraint:
48240         type: array
48241         items:
48242           $ref: "#/patchDefinitions/model-constraint"
48243   model-element:
48244     description: |
48245       Defines how other models combine to make up a higher-level model.
48246       ###### Related Nodes
48247       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
48248       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
48249       - TO model-ver( model-element IsA model-ver, MANY2ONE)
48250       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
48251       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
48252       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
48253       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
48254
48255       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
48256       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
48257     required:
48258     - model-element-uuid
48259     - new-data-del-flag
48260     - cardinality
48261     properties:
48262       model-element-uuid:
48263         type: string
48264       new-data-del-flag:
48265         type: string
48266         description: Indicates whether this element was created as part of instantiation from this model
48267       cardinality:
48268         type: string
48269         description: How many of this type of element are required/allowed
48270       linkage-points:
48271         type: string
48272   model-elements:
48273     properties:
48274       model-element:
48275         type: array
48276         items:
48277           $ref: "#/patchDefinitions/model-element"
48278   model-ver:
48279     description: |
48280       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
48281       ###### Related Nodes
48282       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
48283       - FROM model-element( model-element IsA model-ver, MANY2ONE)
48284       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
48285       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
48286
48287       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
48288       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
48289       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
48290
48291     required:
48292     - model-version-id
48293     - model-name
48294     - model-version
48295     properties:
48296       model-version-id:
48297         type: string
48298         description: Unique identifier corresponding to one version of a model in ASDC
48299       model-name:
48300         type: string
48301         description: Name of the model, which can change from version to version.
48302       model-version:
48303         type: string
48304         description: Version
48305       model-description:
48306         type: string
48307         description: Description
48308   model-vers:
48309     properties:
48310       model-ver:
48311         type: array
48312         items:
48313           $ref: "#/patchDefinitions/model-ver"
48314   models:
48315     description: |
48316       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
48317     properties:
48318       model:
48319         type: array
48320         items:
48321           $ref: "#/patchDefinitions/model"
48322   multicast-configuration:
48323     description: |
48324       ###### Related Nodes
48325       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
48326
48327     required:
48328     - multicast-configuration-id
48329     - multicast-protocol
48330     - rp-type
48331     properties:
48332       multicast-configuration-id:
48333         type: string
48334         description: Unique id of multicast configuration.
48335       multicast-protocol:
48336         type: string
48337         description: protocol of multicast configuration
48338       rp-type:
48339         type: string
48340         description: rp type of multicast configuration
48341   multicast-configurations:
48342     description: |
48343       multicast configuration of generic-vnf ip-address
48344     properties:
48345       multicast-configuration:
48346         type: array
48347         items:
48348           $ref: "#/patchDefinitions/multicast-configuration"
48349   named-queries:
48350     properties:
48351       named-query:
48352         type: array
48353         items:
48354           $ref: "#/patchDefinitions/named-query"
48355   named-query:
48356     description: |
48357       TBD
48358       ###### Related Nodes
48359       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
48360       - TO model( named-query AppliesTo model, ONE2MANY)
48361       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
48362
48363       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
48364     required:
48365     - named-query-uuid
48366     - named-query-name
48367     - named-query-version
48368     properties:
48369       named-query-uuid:
48370         type: string
48371       named-query-name:
48372         type: string
48373       named-query-version:
48374         type: string
48375       required-input-param:
48376         type: string
48377       description:
48378         type: string
48379   named-query-element:
48380     description: |
48381       TBD
48382       ###### Related Nodes
48383       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
48384       - TO model( named-query-element IsA model, MANY2ONE)
48385       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
48386       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
48387       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
48388       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
48389
48390       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
48391       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
48392     required:
48393     - named-query-element-uuid
48394     properties:
48395       named-query-element-uuid:
48396         type: string
48397       property-collect-list:
48398         type: string
48399   named-query-elements:
48400     properties:
48401       named-query-element:
48402         type: array
48403         items:
48404           $ref: "#/patchDefinitions/named-query-element"
48405   network:
48406     description: |
48407       Namespace for network inventory resources.
48408     properties:
48409       logical-links:
48410         type: array
48411         items:
48412           $ref: "#/patchDefinitions/logical-link"
48413       site-pair-sets:
48414         type: array
48415         items:
48416           $ref: "#/patchDefinitions/site-pair-set"
48417       vpn-bindings:
48418         type: array
48419         items:
48420           $ref: "#/patchDefinitions/vpn-binding"
48421       vpls-pes:
48422         type: array
48423         items:
48424           $ref: "#/patchDefinitions/vpls-pe"
48425       multicast-configurations:
48426         type: array
48427         items:
48428           $ref: "#/patchDefinitions/multicast-configuration"
48429       vces:
48430         type: array
48431         items:
48432           $ref: "#/patchDefinitions/vce"
48433       vnfcs:
48434         type: array
48435         items:
48436           $ref: "#/patchDefinitions/vnfc"
48437       l3-networks:
48438         type: array
48439         items:
48440           $ref: "#/patchDefinitions/l3-network"
48441       network-policies:
48442         type: array
48443         items:
48444           $ref: "#/patchDefinitions/network-policy"
48445       generic-vnfs:
48446         type: array
48447         items:
48448           $ref: "#/patchDefinitions/generic-vnf"
48449       lag-links:
48450         type: array
48451         items:
48452           $ref: "#/patchDefinitions/lag-link"
48453       newvces:
48454         type: array
48455         items:
48456           $ref: "#/patchDefinitions/newvce"
48457       pnfs:
48458         type: array
48459         items:
48460           $ref: "#/patchDefinitions/pnf"
48461       physical-links:
48462         type: array
48463         items:
48464           $ref: "#/patchDefinitions/physical-link"
48465       ipsec-configurations:
48466         type: array
48467         items:
48468           $ref: "#/patchDefinitions/ipsec-configuration"
48469       route-table-references:
48470         type: array
48471         items:
48472           $ref: "#/patchDefinitions/route-table-reference"
48473       instance-groups:
48474         type: array
48475         items:
48476           $ref: "#/patchDefinitions/instance-group"
48477       zones:
48478         type: array
48479         items:
48480           $ref: "#/patchDefinitions/zone"
48481   network-policies:
48482     properties:
48483       network-policy:
48484         type: array
48485         items:
48486           $ref: "#/patchDefinitions/network-policy"
48487   network-policy:
48488     description: |
48489       ###### Related Nodes
48490       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
48491
48492     required:
48493     - network-policy-id
48494     properties:
48495       network-policy-id:
48496         type: string
48497         description: UUID representing unique key to this instance
48498       network-policy-fqdn:
48499         type: string
48500         description: Contrail FQDN for the policy
48501       heat-stack-id:
48502         type: string
48503         description: ID for the openStack Heat instance
48504   network-profile:
48505     description: |
48506       Network profile populated by SDN-GP for SNMP
48507       ###### Related Nodes
48508       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
48509
48510     required:
48511     - nm-profile-name
48512     properties:
48513       nm-profile-name:
48514         type: string
48515         description: Unique name of network profile.
48516       community-string:
48517         type: string
48518         description: Encrypted SNMP community string
48519   network-profiles:
48520     description: |
48521       Collection of network profiles
48522     properties:
48523       network-profile:
48524         type: array
48525         items:
48526           $ref: "#/patchDefinitions/network-profile"
48527   newvce:
48528     description: |
48529       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
48530       ###### Related Nodes
48531       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
48532
48533       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
48534     required:
48535     - vnf-id2
48536     - vnf-name
48537     - vnf-type
48538     properties:
48539       vnf-id2:
48540         type: string
48541         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
48542       vnf-name:
48543         type: string
48544         description: Name of VNF.
48545       vnf-name2:
48546         type: string
48547         description: Alternate name of VNF.
48548       vnf-type:
48549         type: string
48550         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.
48551       prov-status:
48552         type: string
48553         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
48554       operational-state:
48555         type: string
48556         description: Indicator for whether the resource is considered operational
48557       license-key:
48558         type: string
48559         description: OBSOLETE -  do not use
48560       ipv4-oam-address:
48561         type: string
48562         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
48563       equipment-role:
48564         type: string
48565         description: Client should send valid enumerated value.
48566   newvces:
48567     description: |
48568       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
48569     properties:
48570       newvce:
48571         type: array
48572         items:
48573           $ref: "#/patchDefinitions/newvce"
48574   nodes:
48575     properties:
48576       inventory-item-data:
48577         type: array
48578         items:
48579           $ref: "#/patchDefinitions/inventory-item-data"
48580   notification-event:
48581     properties:
48582       cambria.partition:
48583         type: string
48584       notification-event-header:
48585         type: object
48586         $ref: "#/patchDefinitions/notification-event-header"
48587   notification-event-header:
48588     properties:
48589       id:
48590         type: string
48591       timestamp:
48592         type: string
48593       source-name:
48594         type: string
48595       domain:
48596         type: string
48597       sequence-number:
48598         type: string
48599       severity:
48600         type: string
48601       event-type:
48602         type: string
48603       version:
48604         type: string
48605       action:
48606         type: string
48607       entity-type:
48608         type: string
48609       top-entity-type:
48610         type: string
48611       entity-link:
48612         type: string
48613       status:
48614         type: string
48615   notify:
48616     required:
48617     - event-id
48618     properties:
48619       event-id:
48620         type: string
48621       node-type:
48622         type: string
48623       event-trigger:
48624         type: string
48625       key-data:
48626         type: array
48627         items:
48628           $ref: "#/patchDefinitions/key-data"
48629       selflink:
48630         type: string
48631   oam-network:
48632     description: |
48633       OAM network, to be deprecated shortly.  Do not use for new purposes.
48634       ###### Related Nodes
48635       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
48636       - TO complex( oam-network AppliesTo complex, MANY2MANY)
48637       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
48638
48639     required:
48640     - network-uuid
48641     - network-name
48642     - cvlan-tag
48643     properties:
48644       network-uuid:
48645         type: string
48646         description: UUID of the network. Unique across a cloud-region
48647       network-name:
48648         type: string
48649         description: Name of the network.
48650       cvlan-tag:
48651         type: integer
48652         format: int64
48653         description: cvlan-id
48654       ipv4-oam-gateway-address:
48655         type: string
48656         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
48657       ipv4-oam-gateway-address-prefix-length:
48658         type: integer
48659         format: int32
48660         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
48661   oam-networks:
48662     description: |
48663       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
48664     properties:
48665       oam-network:
48666         type: array
48667         items:
48668           $ref: "#/patchDefinitions/oam-network"
48669   operational-environment:
48670     description: |
48671       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
48672       ###### Related Nodes
48673       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
48674       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
48675
48676     required:
48677     - operational-environment-id
48678     - operational-environment-name
48679     - operational-environment-type
48680     - operational-environment-status
48681     - tenant-context
48682     - workload-context
48683     properties:
48684       operational-environment-id:
48685         type: string
48686         description: UUID of an operational environment
48687       operational-environment-name:
48688         type: string
48689         description: Operational Environment name
48690       operational-environment-type:
48691         type: string
48692         description: Operational Environment Type.
48693       operational-environment-status:
48694         type: string
48695         description: Status
48696       tenant-context:
48697         type: string
48698         description: Tenant Context.
48699       workload-context:
48700         type: string
48701         description: Workload Context.
48702   operational-environments:
48703     description: |
48704       a logical partition of the cloud which allows to have multiple environments in the production AIC.
48705     properties:
48706       operational-environment:
48707         type: array
48708         items:
48709           $ref: "#/patchDefinitions/operational-environment"
48710   overloaded-model:
48711     description: |
48712       Allows for legacy POST of old-style and new-style models
48713     required:
48714     - model-invariant-id
48715     - model-name-version-id
48716     - model-type
48717     - model-name
48718     - model-id
48719     - model-version
48720     properties:
48721       model-invariant-id:
48722         type: string
48723         description: Unique identifier corresponding to the main definition of a model in ASDC
48724       model-name-version-id:
48725         type: string
48726         description: Unique identifier corresponding to one version of a model in ASDC
48727       model-type:
48728         type: string
48729         description: Type of the model, e.g., service, resource, widget, etc.
48730       model-name:
48731         type: string
48732         description: Name of the model, which can change from version to version.
48733       model-id:
48734         type: string
48735         description: Invariant unique ID which does not change from version to version
48736       model-version:
48737         type: string
48738         description: Version
48739       model-description:
48740         type: string
48741         description: Description
48742   owning-entities:
48743     description: |
48744       Collection of owning-entities
48745     properties:
48746       owning-entity:
48747         type: array
48748         items:
48749           $ref: "#/patchDefinitions/owning-entity"
48750   owning-entity:
48751     description: |
48752       describes an owning-entity
48753       ###### Related Nodes
48754       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
48755
48756     required:
48757     - owning-entity-id
48758     - owning-entity-name
48759     properties:
48760       owning-entity-id:
48761         type: string
48762         description: UUID of an owning entity
48763       owning-entity-name:
48764         type: string
48765         description: Owning entity name
48766   p-interface:
48767     description: |
48768       Physical interface (e.g., nic)
48769       ###### Related Nodes
48770       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
48771       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
48772       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
48773       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
48774       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
48775       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
48776       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
48777
48778       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
48779       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
48780       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
48781     required:
48782     - interface-name
48783     properties:
48784       interface-name:
48785         type: string
48786         description: Name that identifies the physical interface
48787       speed-value:
48788         type: string
48789         description: Captures the numeric part of the speed
48790       speed-units:
48791         type: string
48792         description: Captures the units corresponding to the speed
48793       port-description:
48794         type: string
48795         description: Nature of the services and connectivity on this port.
48796       equipment-identifier:
48797         type: string
48798         description: CLEI or other specification for p-interface hardware.
48799       interface-role:
48800         type: string
48801         description: Role specification for p-interface hardware.
48802       interface-type:
48803         type: string
48804         description: Indicates the physical properties of the interface.
48805       prov-status:
48806         type: string
48807         description: Trigger for operational monitoring of this resource by Service Assurance systems.
48808   p-interfaces:
48809     description: |
48810       Collection of physical interfaces.
48811     properties:
48812       p-interface:
48813         type: array
48814         items:
48815           $ref: "#/patchDefinitions/p-interface"
48816   physical-link:
48817     description: |
48818       Collection of physical connections, typically between p-interfaces
48819       ###### Related Nodes
48820       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
48821
48822       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
48823     required:
48824     - link-name
48825     properties:
48826       link-name:
48827         type: string
48828         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
48829       speed-value:
48830         type: string
48831         description: Captures the numeric part of the speed
48832       speed-units:
48833         type: string
48834         description: Captures the units corresponding to the speed
48835       circuit-id:
48836         type: string
48837         description: Circuit it
48838       dual-mode:
48839         type: string
48840         description: Dual access mode (e.g., primary, secondary
48841       management-option:
48842         type: string
48843         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
48844       service-provider-name:
48845         type: string
48846         description: Name of the service Provider on this link.
48847   physical-links:
48848     description: |
48849       Collection of physical connections, typically between p-interfaces
48850     properties:
48851       physical-link:
48852         type: array
48853         items:
48854           $ref: "#/patchDefinitions/physical-link"
48855   platform:
48856     description: |
48857       describes a platform
48858       ###### Related Nodes
48859       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
48860
48861     required:
48862     - platform-name
48863     properties:
48864       platform-name:
48865         type: string
48866         description: Name of the platform
48867   platforms:
48868     description: |
48869       Collection of platforms
48870     properties:
48871       platform:
48872         type: array
48873         items:
48874           $ref: "#/patchDefinitions/platform"
48875   pnf:
48876     description: |
48877       PNF represents a physical network function. typically equipment used in the D1 world.
48878       ###### Related Nodes
48879       - TO complex( pnf LocatedIn complex, MANY2ONE)
48880       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
48881       - TO zone( pnf LocatedIn zone, MANY2ONE)
48882       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
48883       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
48884       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
48885       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
48886
48887       -(1) IF this PNF node is deleted, this FROM node is DELETED also
48888     required:
48889     - pnf-name
48890     - in-maint
48891     properties:
48892       pnf-name:
48893         type: string
48894         description: unique name of Physical Network Function.
48895       pnf-name2:
48896         type: string
48897         description: name of Physical Network Function.
48898       pnf-name2-source:
48899         type: string
48900         description: source of name2
48901       pnf-id:
48902         type: string
48903         description: id of pnf
48904       equip-type:
48905         type: string
48906         description: Equipment type.  Source of truth should define valid values.
48907       equip-vendor:
48908         type: string
48909         description: Equipment vendor.  Source of truth should define valid values.
48910       equip-model:
48911         type: string
48912         description: Equipment model.  Source of truth should define valid values.
48913       management-option:
48914         type: string
48915         description: identifier of managed by company or customer
48916       ipaddress-v4-oam:
48917         type: string
48918         description: ipv4-oam-address with new naming convention for IP addresses
48919       sw-version:
48920         type: string
48921         description: sw-version is the version of SW for the hosted application on the PNF.
48922       in-maint:
48923         type: boolean
48924         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.
48925       frame-id:
48926         type: string
48927         description: ID of the physical frame (relay rack) where pnf is installed.
48928       serial-number:
48929         type: string
48930         description: Serial number of the device
48931       ipaddress-v4-loopback-0:
48932         type: string
48933         description: IPV4 Loopback 0 address
48934       ipaddress-v6-loopback-0:
48935         type: string
48936         description: IPV6 Loopback 0 address
48937       ipaddress-v4-aim:
48938         type: string
48939         description: IPV4 AIM address
48940       ipaddress-v6-aim:
48941         type: string
48942         description: IPV6 AIM address
48943       ipaddress-v6-oam:
48944         type: string
48945         description: IPV6 OAM address
48946       inv-status:
48947         type: string
48948         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48949   pnfs:
48950     description: |
48951       Collection of Physical Network Functions.
48952     properties:
48953       pnf:
48954         type: array
48955         items:
48956           $ref: "#/patchDefinitions/pnf"
48957   port-group:
48958     description: |
48959       Used to capture the network interfaces of this VCE
48960       ###### Related Nodes
48961       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
48962       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
48963
48964       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
48965       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
48966     required:
48967     - interface-id
48968     - orchestration-status
48969     properties:
48970       interface-id:
48971         type: string
48972         description: Unique ID of the interface
48973       neutron-network-id:
48974         type: string
48975         description: Neutron network id of this Interface
48976       neutron-network-name:
48977         type: string
48978         description: Neutron network name of this Interface
48979       interface-role:
48980         type: string
48981         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48982   port-groups:
48983     properties:
48984       port-group:
48985         type: array
48986         items:
48987           $ref: "#/patchDefinitions/port-group"
48988   project:
48989     description: |
48990       describes the project
48991       ###### Related Nodes
48992       - TO service-instance( project Uses service-instance, ONE2MANY)
48993
48994     required:
48995     - project-name
48996     properties:
48997       project-name:
48998         type: string
48999         description: Name of the project deploying a service
49000   projects:
49001     description: |
49002       Collection of projects
49003     properties:
49004       project:
49005         type: array
49006         items:
49007           $ref: "#/patchDefinitions/project"
49008   properties:
49009     description: |
49010       Property holder for query properties or instance properties
49011     properties:
49012       property-name:
49013         type: string
49014       property-value:
49015         type: string
49016   property-constraint:
49017     description: |
49018       TBD
49019       ###### Related Nodes
49020       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
49021
49022       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
49023     required:
49024     - property-constraint-uuid
49025     - constraint-type
49026     - property-name
49027     - property-value
49028     properties:
49029       property-constraint-uuid:
49030         type: string
49031       constraint-type:
49032         type: string
49033       property-name:
49034         type: string
49035       property-value:
49036         type: string
49037   property-constraints:
49038     properties:
49039       property-constraint:
49040         type: array
49041         items:
49042           $ref: "#/patchDefinitions/property-constraint"
49043   pserver:
49044     description: |
49045       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
49046       ###### Related Nodes
49047       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
49048       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
49049       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
49050       - TO complex( pserver LocatedIn complex, MANY2ONE)
49051       - TO zone( pserver LocatedIn zone, MANY2ONE)
49052       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
49053       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
49054       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
49055       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
49056       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
49057
49058       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
49059       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
49060
49061     required:
49062     - hostname
49063     - in-maint
49064     properties:
49065       hostname:
49066         type: string
49067         description: Value from executing hostname on the compute node.
49068       ptnii-equip-name:
49069         type: string
49070         description: PTNII name
49071       number-of-cpus:
49072         type: integer
49073         format: int32
49074         description: Number of cpus
49075       disk-in-gigabytes:
49076         type: integer
49077         format: int32
49078         description: Disk size, in GBs
49079       ram-in-megabytes:
49080         type: integer
49081         format: int32
49082         description: RAM size, in MBs
49083       equip-type:
49084         type: string
49085         description: Equipment type.  Source of truth should define valid values.
49086       equip-vendor:
49087         type: string
49088         description: Equipment vendor.  Source of truth should define valid values.
49089       equip-model:
49090         type: string
49091         description: Equipment model.  Source of truth should define valid values.
49092       fqdn:
49093         type: string
49094         description: Fully-qualified domain name
49095       pserver-selflink:
49096         type: string
49097         description: URL to endpoint where AAI can get more details
49098       ipv4-oam-address:
49099         type: string
49100         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
49101       serial-number:
49102         type: string
49103         description: Serial number, may be queried
49104       ipaddress-v4-loopback-0:
49105         type: string
49106         description: IPV4 Loopback 0 address
49107       ipaddress-v6-loopback-0:
49108         type: string
49109         description: IPV6 Loopback 0 address
49110       ipaddress-v4-aim:
49111         type: string
49112         description: IPV4 AIM address
49113       ipaddress-v6-aim:
49114         type: string
49115         description: IPV6 AIM address
49116       ipaddress-v6-oam:
49117         type: string
49118         description: IPV6 OAM address
49119       inv-status:
49120         type: string
49121         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49122       pserver-id:
49123         type: string
49124         description: ID of Pserver
49125       internet-topology:
49126         type: string
49127         description: internet topology of Pserver
49128       in-maint:
49129         type: boolean
49130         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.
49131   pservers:
49132     description: |
49133       Collection of compute hosts.
49134     properties:
49135       pserver:
49136         type: array
49137         items:
49138           $ref: "#/patchDefinitions/pserver"
49139   query-parameters:
49140     description: |
49141       QueryParameters for performing a named-query or model query
49142     properties:
49143       named-query:
49144         type: object
49145         $ref: "#/patchDefinitions/named-query"
49146       overloaded-model:
49147         type: object
49148         $ref: "#/patchDefinitions/overloaded-model"
49149   related-lookup:
49150     description: |
49151       TBD
49152       ###### Related Nodes
49153       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
49154
49155       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
49156     required:
49157     - related-lookup-uuid
49158     - source-node-type
49159     - source-node-property
49160     - target-node-type
49161     - target-node-property
49162     properties:
49163       related-lookup-uuid:
49164         type: string
49165       source-node-type:
49166         type: string
49167       source-node-property:
49168         type: string
49169       target-node-type:
49170         type: string
49171       target-node-property:
49172         type: string
49173       property-collect-list:
49174         type: string
49175   related-lookups:
49176     properties:
49177       related-lookup:
49178         type: array
49179         items:
49180           $ref: "#/patchDefinitions/related-lookup"
49181   related-to-property:
49182     properties:
49183       property-key:
49184         type: string
49185         description: Key part of a key/value pair
49186       property-value:
49187         type: string
49188         description: Value part of a key/value pair
49189   relationship:
49190     properties:
49191       related-to:
49192         type: string
49193         description: A keyword provided by A&AI to indicate type of node.
49194       related-link:
49195         type: string
49196         description: URL to the object in A&AI.
49197       relationship-data:
49198         type: array
49199         items:
49200           $ref: "#/patchDefinitions/relationship-data"
49201       related-to-property:
49202         type: array
49203         items:
49204           $ref: "#/patchDefinitions/related-to-property"
49205   relationship-data:
49206     required:
49207     - relationship-key
49208     - relationship-value
49209     properties:
49210       relationship-key:
49211         type: string
49212         description: A keyword provided by A&AI to indicate an attribute.
49213       relationship-value:
49214         type: string
49215         description: Value of the attribute.
49216   reserved-prop-names:
49217     description: |
49218       Internal map to define some reserved properties of a vertex
49219     properties:
49220       last-mod-source-of-truth:
49221         type: string
49222       aai-node-type:
49223         type: string
49224       aai-created-ts:
49225         type: integer
49226         format: int64
49227       aai-unique-key:
49228         type: string
49229       aai-last-mod-ts:
49230         type: integer
49231         format: int64
49232       source-of-truth:
49233         type: string
49234       aai-uri:
49235         type: string
49236   response-list:
49237     description: |
49238       Response container for the results of a named-query or model query
49239     properties:
49240       inventory-response-items:
49241         type: object
49242         $ref: "#/patchDefinitions/inventory-response-items"
49243   result-data:
49244     properties:
49245       resource-type:
49246         type: string
49247         description: The specific type of node in the A&AI graph
49248       resource-link:
49249         type: string
49250         description: The URL to the specific resource
49251   route-table-reference:
49252     description: |
49253       Openstack route table reference.
49254       ###### Related Nodes
49255       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
49256
49257     required:
49258     - route-table-reference-id
49259     - route-table-reference-fqdn
49260     properties:
49261       route-table-reference-id:
49262         type: string
49263         description: Route Table Reference id, UUID assigned to this instance.
49264       route-table-reference-fqdn:
49265         type: string
49266         description: FQDN entry in the route table.
49267   route-table-references:
49268     description: |
49269       Collection of openstack route table references
49270     properties:
49271       route-table-reference:
49272         type: array
49273         items:
49274           $ref: "#/patchDefinitions/route-table-reference"
49275   route-target:
49276     description: |
49277       Route target information
49278       ###### Related Nodes
49279       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
49280
49281       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
49282     required:
49283     - global-route-target
49284     - route-target-role
49285     properties:
49286       global-route-target:
49287         type: string
49288         description: Number used to identify an RT, globally unique in the network
49289       route-target-role:
49290         type: string
49291         description: Role assigned to this route target
49292   route-targets:
49293     description: |
49294       Collection of route target information
49295     properties:
49296       route-target:
49297         type: array
49298         items:
49299           $ref: "#/patchDefinitions/route-target"
49300   routing-instance:
49301     description: |
49302       ###### Related Nodes
49303       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
49304       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
49305
49306       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
49307       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
49308     required:
49309     - routing-instance-id
49310     properties:
49311       routing-instance-id:
49312         type: string
49313         description: Unique id of routing instance
49314       rpm-owner:
49315         type: string
49316         description: rpm owner
49317   routing-instances:
49318     description: |
49319       set of probes related to generic-vnf routing instance
49320     properties:
49321       routing-instance:
49322         type: array
49323         items:
49324           $ref: "#/patchDefinitions/routing-instance"
49325   sdn-zone-response:
49326     properties:
49327       oam-networks:
49328         type: object
49329         $ref: "#/patchDefinitions/oam-networks"
49330       az-and-dvs-switches:
49331         type: array
49332         items:
49333           $ref: "#/patchDefinitions/az-and-dvs-switches"
49334   search:
49335     properties:
49336       edge-tag-query-result:
49337         type: object
49338         $ref: "#/patchDefinitions/edge-tag-query-result"
49339       edge-tag-query-request:
49340         type: object
49341         $ref: "#/patchDefinitions/edge-tag-query-request"
49342       search-results:
49343         type: object
49344         $ref: "#/patchDefinitions/search-results"
49345       sdn-zone-response:
49346         type: object
49347         $ref: "#/patchDefinitions/sdn-zone-response"
49348   search-results:
49349     properties:
49350       result-data:
49351         type: array
49352         items:
49353           $ref: "#/patchDefinitions/result-data"
49354   secondary-filt:
49355     description: |
49356       SecondaryFilt for performing a named-query or model query
49357   secondary-filter:
49358     properties:
49359       property-name:
49360         type: string
49361       filter-type:
49362         type: string
49363       property-value:
49364         type: string
49365   secondary-filts:
49366     description: |
49367       SecondaryFilts for performing a named-query or model query
49368     properties:
49369       secondary-filt:
49370         type: array
49371         items:
49372           $ref: "#/patchDefinitions/secondary-filt"
49373   segmentation-assignment:
49374     description: |
49375       Openstack segmentation assignment.
49376       ###### Related Nodes
49377       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
49378
49379       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
49380     required:
49381     - segmentation-id
49382     properties:
49383       segmentation-id:
49384         type: string
49385         description: Route Table Reference id, UUID assigned to this instance.
49386   segmentation-assignments:
49387     description: |
49388       Collection of openstack segmentation assignments
49389     properties:
49390       segmentation-assignment:
49391         type: array
49392         items:
49393           $ref: "#/patchDefinitions/segmentation-assignment"
49394   service:
49395     description: |
49396       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
49397     required:
49398     - service-id
49399     - service-description
49400     properties:
49401       service-id:
49402         type: string
49403         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
49404       service-description:
49405         type: string
49406         description: Description of the service
49407       service-selflink:
49408         type: string
49409         description: URL to endpoint where AAI can get more details
49410   service-capabilities:
49411     description: |
49412       Collection of service capabilities.
49413     properties:
49414       service-capability:
49415         type: array
49416         items:
49417           $ref: "#/patchDefinitions/service-capability"
49418   service-capability:
49419     description: |
49420       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
49421       ###### Related Nodes
49422       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
49423       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
49424
49425       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
49426
49427     required:
49428     - service-type
49429     - vnf-type
49430     properties:
49431       service-type:
49432         type: string
49433         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
49434       vnf-type:
49435         type: string
49436         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.
49437   service-design-and-creation:
49438     description: |
49439       Namespace for objects managed by ASDC
49440     properties:
49441       vnf-images:
49442         type: array
49443         items:
49444           $ref: "#/patchDefinitions/vnf-image"
49445       services:
49446         type: array
49447         items:
49448           $ref: "#/patchDefinitions/service"
49449       service-capabilities:
49450         type: array
49451         items:
49452           $ref: "#/patchDefinitions/service-capability"
49453       models:
49454         type: array
49455         items:
49456           $ref: "#/patchDefinitions/model"
49457       named-queries:
49458         type: array
49459         items:
49460           $ref: "#/patchDefinitions/named-query"
49461   service-instance:
49462     description: |
49463       Instance of a service
49464       ###### Related Nodes
49465       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
49466       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
49467       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
49468       - TO connector( service-instance Uses connector, MANY2MANY)
49469       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
49470       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
49471       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
49472       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
49473       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
49474       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49475       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
49476       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
49477       - TO vce( service-instance ComposedOf vce, ONE2MANY)
49478       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
49479       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
49480       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49481
49482       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
49483       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
49484       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
49485     required:
49486     - service-instance-id
49487     properties:
49488       service-instance-id:
49489         type: string
49490         description: Uniquely identifies this instance of a service
49491       service-instance-name:
49492         type: string
49493         description: This field will store a name assigned to the service-instance.
49494       persona-model-id:
49495         type: string
49496         description: the ASDC model id for this resource or service model.
49497       persona-model-version:
49498         type: string
49499         description: the ASDC model version for this resource or service model.
49500       model-version-id:
49501         type: string
49502         description: the ASDC model version for this resource or service model.
49503       widget-model-id:
49504         type: string
49505         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49506       widget-model-version:
49507         type: string
49508         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49509       bandwidth-total:
49510         type: string
49511         description: Indicates the total bandwidth to be used for this service.
49512       bandwidth-up-wan1:
49513         type: string
49514         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
49515       bandwidth-down-wan1:
49516         type: string
49517         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
49518       bandwidth-up-wan2:
49519         type: string
49520         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
49521       bandwidth-down-wan2:
49522         type: string
49523         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
49524       vhn-portal-url:
49525         type: string
49526         description: URL customers will use to access the vHN Portal.
49527       service-instance-location-id:
49528         type: string
49529         description: An identifier that customers assign to the location where this service is being used.
49530   service-instances:
49531     description: |
49532       Collection of service instances
49533     properties:
49534       service-instance:
49535         type: array
49536         items:
49537           $ref: "#/patchDefinitions/service-instance"
49538   service-subscription:
49539     description: |
49540       Object that group service instances.
49541       ###### Related Nodes
49542       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
49543       - TO tenant( service-subscription Uses tenant, MANY2MANY)
49544       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
49545
49546       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
49547       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
49548     required:
49549     - service-type
49550     properties:
49551       service-type:
49552         type: string
49553         description: Value defined by orchestration to identify this service across ECOMP.
49554       temp-ub-sub-account-id:
49555         type: string
49556         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
49557   service-subscriptions:
49558     description: |
49559       Collection of objects that group service instances.
49560     properties:
49561       service-subscription:
49562         type: array
49563         items:
49564           $ref: "#/patchDefinitions/service-subscription"
49565   services:
49566     description: |
49567       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
49568     properties:
49569       service:
49570         type: array
49571         items:
49572           $ref: "#/patchDefinitions/service"
49573   site-pair:
49574     description: |
49575       ###### Related Nodes
49576       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
49577       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
49578
49579       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
49580       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
49581     required:
49582     - site-pair-id
49583     properties:
49584       site-pair-id:
49585         type: string
49586         description: unique identifier of probe
49587       source-ip:
49588         type: string
49589         description: Prefix address
49590       destination-ip:
49591         type: string
49592         description: Prefix address
49593       ip-version:
49594         type: string
49595         description: ip version, v4, v6
49596       destination-hostname:
49597         type: string
49598         description: Hostname of the destination equipment to which SLAs are measured against.
49599       destination-equip-type:
49600         type: string
49601         description: The type of destinatination equipment. Could be Router, etc.
49602   site-pair-set:
49603     description: |
49604       Set of instances for probes used to measure service level agreements
49605       ###### Related Nodes
49606       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
49607       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
49608
49609       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
49610     required:
49611     - site-pair-set-id
49612     properties:
49613       site-pair-set-id:
49614         type: string
49615         description: Unique id of site pair set.
49616   site-pair-sets:
49617     description: |
49618       Collection of sets of instances for probes related to generic-vnf
49619     properties:
49620       site-pair-set:
49621         type: array
49622         items:
49623           $ref: "#/patchDefinitions/site-pair-set"
49624   site-pairs:
49625     description: |
49626       probe within a set
49627     properties:
49628       site-pair:
49629         type: array
49630         items:
49631           $ref: "#/patchDefinitions/site-pair"
49632   snapshot:
49633     description: |
49634       Openstack snapshot
49635       ###### Related Nodes
49636       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
49637       - FROM vserver( vserver Uses snapshot, ONE2ONE)
49638
49639     required:
49640     - snapshot-id
49641     properties:
49642       snapshot-id:
49643         type: string
49644         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
49645       snapshot-name:
49646         type: string
49647         description: Snapshot name
49648       snapshot-architecture:
49649         type: string
49650         description: Operating system architecture
49651       snapshot-os-distro:
49652         type: string
49653         description: The common name of the operating system distribution in lowercase
49654       snapshot-os-version:
49655         type: string
49656         description: The operating system version as specified by the distributor.
49657       application:
49658         type: string
49659         description: The application that the image instantiates.
49660       application-vendor:
49661         type: string
49662         description: The vendor of the application.
49663       application-version:
49664         type: string
49665         description: The version of the application.
49666       snapshot-selflink:
49667         type: string
49668         description: URL to endpoint where AAI can get more details
49669       prev-snapshot-id:
49670         type: string
49671         description: This field contains the UUID of the previous snapshot (if any).
49672   snapshots:
49673     description: |
49674       Collection of openstack snapshots
49675     properties:
49676       snapshot:
49677         type: array
49678         items:
49679           $ref: "#/patchDefinitions/snapshot"
49680   sriov-pf:
49681     description: |
49682       SR-IOV Physical Function
49683       ###### Related Nodes
49684       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
49685       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
49686
49687       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
49688     required:
49689     - pf-pci-id
49690     properties:
49691       pf-pci-id:
49692         type: string
49693         description: Identifier for the sriov-pf
49694   sriov-pfs:
49695     description: |
49696       Collection of SR-IOV Physical Functions.
49697     properties:
49698       sriov-pf:
49699         type: array
49700         items:
49701           $ref: "#/patchDefinitions/sriov-pf"
49702   sriov-vf:
49703     description: |
49704       SR-IOV Virtual Function (not to be confused with virtual network function)
49705       ###### Related Nodes
49706       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
49707
49708       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
49709     required:
49710     - pci-id
49711     properties:
49712       pci-id:
49713         type: string
49714         description: PCI ID used to identify the sriov-vf
49715       vf-vlan-filter:
49716         type: string
49717         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
49718       vf-mac-filter:
49719         type: string
49720         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
49721       vf-vlan-strip:
49722         type: boolean
49723         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
49724       vf-vlan-anti-spoof-check:
49725         type: boolean
49726         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.
49727       vf-mac-anti-spoof-check:
49728         type: boolean
49729         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.
49730       vf-mirrors:
49731         type: string
49732         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
49733       vf-broadcast-allow:
49734         type: boolean
49735         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
49736       vf-unknown-multicast-allow:
49737         type: boolean
49738         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
49739       vf-unknown-unicast-allow:
49740         type: boolean
49741         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
49742       vf-insert-stag:
49743         type: boolean
49744         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
49745       vf-link-status:
49746         type: string
49747         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
49748   sriov-vfs:
49749     description: |
49750       Collection of SR-IOV Virtual Functions.
49751     properties:
49752       sriov-vf:
49753         type: array
49754         items:
49755           $ref: "#/patchDefinitions/sriov-vf"
49756   start-node-filter:
49757     properties:
49758       property-name:
49759         type: string
49760       property-value:
49761         type: string
49762   subnet:
49763     description: |
49764       ###### Related Nodes
49765       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
49766       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
49767       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
49768
49769       -(4) IF this TO node is deleted, this SUBNET is DELETED also
49770       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
49771
49772     required:
49773     - subnet-id
49774     - dhcp-enabled
49775     properties:
49776       subnet-id:
49777         type: string
49778         description: Subnet ID, should be UUID.
49779       subnet-name:
49780         type: string
49781         description: Name associated with the subnet.
49782       neutron-subnet-id:
49783         type: string
49784         description: Neutron id of this subnet
49785       gateway-address:
49786         type: string
49787         description: gateway ip address
49788       network-start-address:
49789         type: string
49790         description: network start address
49791       cidr-mask:
49792         type: string
49793         description: cidr mask
49794       ip-version:
49795         type: string
49796         description: ip version
49797       orchestration-status:
49798         type: string
49799         description: Orchestration status of this VNF, mastered by MSO
49800       dhcp-enabled:
49801         type: boolean
49802         description: dhcp enabled
49803       dhcp-start:
49804         type: string
49805         description: the start address reserved for use by dhcp
49806       dhcp-end:
49807         type: string
49808         description: the last address reserved for use by dhcp
49809   subnets:
49810     properties:
49811       subnet:
49812         type: array
49813         items:
49814           $ref: "#/patchDefinitions/subnet"
49815   tagged-inventory-item-list:
49816     properties:
49817       inventory-item:
49818         type: array
49819         items:
49820           $ref: "#/patchDefinitions/inventory-item"
49821   tenant:
49822     description: |
49823       Openstack tenant
49824       ###### Related Nodes
49825       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
49826       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
49827       - TO l3-network( tenant Uses l3-network, MANY2MANY)
49828       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
49829       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
49830       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
49831
49832       -TENANT cannot be deleted if related to VSERVER
49833
49834     required:
49835     - tenant-id
49836     - tenant-name
49837     properties:
49838       tenant-id:
49839         type: string
49840         description: Unique id relative to the cloud-region.
49841       tenant-name:
49842         type: string
49843         description: Readable name of tenant
49844   tenants:
49845     description: |
49846       Collection of openstack tenants.
49847     properties:
49848       tenant:
49849         type: array
49850         items:
49851           $ref: "#/patchDefinitions/tenant"
49852   tunnel-xconnect:
49853     description: |
49854       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
49855       ###### Related Nodes
49856       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
49857
49858       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
49859     required:
49860     - id
49861     - bandwidth-up-wan1
49862     - bandwidth-down-wan1
49863     - bandwidth-up-wan2
49864     - bandwidth-down-wan2
49865     properties:
49866       id:
49867         type: string
49868         description: Allotted Resource id UUID assigned to this instance.
49869       bandwidth-up-wan1:
49870         type: string
49871         description: The WAN uplink bandwidth for WAN1
49872       bandwidth-down-wan1:
49873         type: string
49874         description: The WAN downlink bandwidth for WAN1
49875       bandwidth-up-wan2:
49876         type: string
49877         description: The WAN uplink bandwidth for WAN2
49878       bandwidth-down-wan2:
49879         type: string
49880         description: The WAN downlink bandwidth for WAN2
49881   tunnel-xconnects:
49882     description: |
49883       This object is used to store the specific tunnel cross connect aspects of an allotted resource
49884     properties:
49885       tunnel-xconnect:
49886         type: array
49887         items:
49888           $ref: "#/patchDefinitions/tunnel-xconnect"
49889   update:
49890     description: |
49891       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
49892     required:
49893     - update-node-type
49894     properties:
49895       update-node-type:
49896         type: string
49897       update-node-key:
49898         type: array
49899         items:
49900           $ref: "#/patchDefinitions/update-node-key"
49901       update-node-uri:
49902         type: string
49903       action:
49904         type: array
49905         items:
49906           $ref: "#/patchDefinitions/action"
49907   update-node-key:
49908     properties:
49909       key-name:
49910         type: string
49911       key-value:
49912         type: string
49913   vce:
49914     description: |
49915       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
49916       ###### Related Nodes
49917       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
49918       - TO complex( vce LocatedIn complex, MANY2MANY)
49919       - TO vserver( vce HostedOn vserver, ONE2MANY)
49920       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
49921       - FROM license( license BelongsTo vce, MANY2ONE)(1)
49922       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
49923       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
49924
49925       -(1) IF this VCE node is deleted, this FROM node is DELETED also
49926     required:
49927     - vnf-id
49928     - vnf-name
49929     - vnf-type
49930     properties:
49931       vnf-id:
49932         type: string
49933         description: Unique id of VNF.  This is unique across the graph.
49934       vnf-name:
49935         type: string
49936         description: Name of VNF.
49937       vnf-name2:
49938         type: string
49939         description: Alternate name of VNF.
49940       vnf-type:
49941         type: string
49942         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.
49943       service-id:
49944         type: string
49945         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
49946       regional-resource-zone:
49947         type: string
49948         description: Regional way of organizing pservers, source of truth should define values
49949       prov-status:
49950         type: string
49951         description: Trigger for operational monitoring of this resource by Service Assurance systems.
49952       operational-state:
49953         type: string
49954         description: Indicator for whether the resource is considered operational
49955       license-key:
49956         type: string
49957         description: OBSOLETE -  do not use
49958       equipment-role:
49959         type: string
49960         description: Network role being played by this VNF
49961       orchestration-status:
49962         type: string
49963         description: Orchestration status of this VNF, mastered by MSO
49964       heat-stack-id:
49965         type: string
49966         description: Heat stack id corresponding to this instance, managed by MSO
49967       mso-catalog-key:
49968         type: string
49969         description: Corresponds to the SDN-C catalog id used to configure this VCE
49970       vpe-id:
49971         type: string
49972         description: Unique ID of VPE connected to this VCE.
49973       v6-vce-wan-address:
49974         type: string
49975         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
49976       ipv4-oam-address:
49977         type: string
49978         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
49979   vces:
49980     description: |
49981       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
49982     properties:
49983       vce:
49984         type: array
49985         items:
49986           $ref: "#/patchDefinitions/vce"
49987   vf-module:
49988     description: |
49989       a deployment unit of VNFCs
49990       ###### Related Nodes
49991       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
49992       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
49993       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
49994       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
49995       - TO vserver( vf-module Uses vserver, ONE2MANY)
49996
49997       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
49998       -VF-MODULE cannot be deleted if related to VNFC
49999
50000     required:
50001     - vf-module-id
50002     - is-base-vf-module
50003     properties:
50004       vf-module-id:
50005         type: string
50006         description: Unique ID of vf-module.
50007       vf-module-name:
50008         type: string
50009         description: Name of vf-module
50010       heat-stack-id:
50011         type: string
50012         description: Heat stack id corresponding to this instance.
50013       orchestration-status:
50014         type: string
50015         description: orchestration status of this vf-module, mastered by MSO
50016       is-base-vf-module:
50017         type: boolean
50018         description: used to indicate whether or not this object is base vf module
50019   vf-modules:
50020     description: |
50021       Collection of vf-modules, a deployment unit of VNFCs
50022     properties:
50023       vf-module:
50024         type: array
50025         items:
50026           $ref: "#/patchDefinitions/vf-module"
50027   vig-server:
50028     description: |
50029       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
50030       ###### Related Nodes
50031       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
50032
50033       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
50034     required:
50035     - vig-address-type
50036     properties:
50037       vig-address-type:
50038         type: string
50039         description: indicates whether the VIG is for AVPN or INTERNET
50040       ipaddress-v4-vig:
50041         type: string
50042         description: v4 IP of the vig server
50043       ipaddress-v6-vig:
50044         type: string
50045         description: v6 IP of the vig server
50046   vig-servers:
50047     properties:
50048       vig-server:
50049         type: array
50050         items:
50051           $ref: "#/patchDefinitions/vig-server"
50052   vip-ipv4-address-list:
50053     description: |
50054       IPv4 Address Range
50055       ###### Related Nodes
50056       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
50057       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
50058       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
50059       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
50060
50061     required:
50062     - vip-ipv4-address
50063     properties:
50064       vip-ipv4-address:
50065         type: string
50066         description: IP address
50067       vip-ipv4-prefix-length:
50068         type: integer
50069         format: int64
50070         description: Prefix length, 32 for single address
50071       vlan-id-inner:
50072         type: integer
50073         format: int64
50074         description: Inner VLAN tag
50075       vlan-id-outer:
50076         type: integer
50077         format: int64
50078         description: Outer VLAN tag
50079       is-floating:
50080         type: boolean
50081         description: Indicator of fixed or floating address
50082   vip-ipv6-address-list:
50083     description: |
50084       IPv6 Address Range
50085       ###### Related Nodes
50086       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
50087       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
50088       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
50089       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
50090
50091     required:
50092     - vip-ipv6-address
50093     properties:
50094       vip-ipv6-address:
50095         type: string
50096         description: IP address
50097       vip-ipv6-prefix-length:
50098         type: integer
50099         format: int64
50100         description: Prefix length, 128 for single address
50101       vlan-id-inner:
50102         type: integer
50103         format: int64
50104         description: Inner VLAN tag
50105       vlan-id-outer:
50106         type: integer
50107         format: int64
50108         description: Outer VLAN tag
50109       is-floating:
50110         type: boolean
50111         description: Indicator of fixed or floating address
50112   virtual-data-center:
50113     description: |
50114       Virtual organization of cloud infrastructure elements in a data center context
50115       ###### Related Nodes
50116       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
50117       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
50118       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
50119
50120     required:
50121     - vdc-id
50122     - vdc-name
50123     properties:
50124       vdc-id:
50125         type: string
50126         description: Unique ID of the vdc
50127       vdc-name:
50128         type: string
50129         description: Name of the virtual data center
50130   virtual-data-centers:
50131     description: |
50132       Virtual organization of cloud infrastructure elements in a data center context
50133     properties:
50134       virtual-data-center:
50135         type: array
50136         items:
50137           $ref: "#/patchDefinitions/virtual-data-center"
50138   vlan:
50139     description: |
50140       Definition of vlan
50141       ###### Related Nodes
50142       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
50143       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
50144       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
50145       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
50146       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
50147       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
50148       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
50149
50150       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
50151       -(2) IF this VLAN node is deleted, this TO node is DELETED also
50152       -(4) IF this TO node is deleted, this VLAN is DELETED also
50153     required:
50154     - vlan-interface
50155     properties:
50156       vlan-interface:
50157         type: string
50158         description: String that identifies the interface
50159       vlan-id-inner:
50160         type: integer
50161         format: int64
50162         description: Inner VLAN tag
50163       vlan-id-outer:
50164         type: integer
50165         format: int64
50166         description: Outer VLAN tag
50167   vlans:
50168     properties:
50169       vlan:
50170         type: array
50171         items:
50172           $ref: "#/patchDefinitions/vlan"
50173   vnf:
50174     description: |
50175       Abstract vnf class
50176     required:
50177     - vnf-id
50178     properties:
50179       vnf-id:
50180         type: string
50181         description: Unique id of VNF.  This is unique across the graph.
50182   vnf-image:
50183     description: |
50184       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
50185       ###### Related Nodes
50186       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
50187
50188       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
50189
50190     required:
50191     - vnf-image-uuid
50192     - application
50193     - application-vendor
50194     properties:
50195       vnf-image-uuid:
50196         type: string
50197         description: Unique ID of this asset
50198       application:
50199         type: string
50200         description: The application that the image instantiates.
50201       application-vendor:
50202         type: string
50203         description: The vendor of the application.
50204       application-version:
50205         type: string
50206         description: The version of the application.
50207       selflink:
50208         type: string
50209         description: URL to endpoint where AAI can get more details
50210   vnf-images:
50211     description: |
50212       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
50213     properties:
50214       vnf-image:
50215         type: array
50216         items:
50217           $ref: "#/patchDefinitions/vnf-image"
50218   vnfc:
50219     description: |
50220       ###### Related Nodes
50221       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
50222       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
50223       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
50224
50225       -(4) IF this TO node is deleted, this VNFC is DELETED also
50226     required:
50227     - vnfc-name
50228     - vnfc-function-code
50229     - vnfc-type
50230     - in-maint
50231     - is-closed-loop-disabled
50232     properties:
50233       vnfc-name:
50234         type: string
50235         description: Unique ID of vnfc.
50236       vnfc-function-code:
50237         type: string
50238         description: function code
50239       vnfc-type:
50240         type: string
50241         description: type
50242       prov-status:
50243         type: string
50244         description: prov status of this vnfc
50245       orchestration-status:
50246         type: string
50247         description: Orchestration status of this VNF, mastered by APP-C
50248       ipaddress-v4-oam-vip:
50249         type: string
50250         description: Oam V4 vip address of this vnfc
50251       in-maint:
50252         type: boolean
50253         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50254       is-closed-loop-disabled:
50255         type: boolean
50256         description: used to indicate whether closed loop function is enabled on this node
50257       group-notation:
50258         type: string
50259         description: Group notation of VNFC
50260   vnfcs:
50261     description: |
50262       virtual network components associated with a vserver from application controller.
50263     properties:
50264       vnfc:
50265         type: array
50266         items:
50267           $ref: "#/patchDefinitions/vnfc"
50268   volume:
50269     description: |
50270       Ephemeral Block storage volume.
50271       ###### Related Nodes
50272       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
50273
50274       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
50275     required:
50276     - volume-id
50277     - volume-selflink
50278     properties:
50279       volume-id:
50280         type: string
50281         description: Unique ID of block storage volume relative to the vserver.
50282       volume-selflink:
50283         type: string
50284         description: URL to endpoint where AAI can get more details
50285   volume-group:
50286     description: |
50287       Persistent block-level storage.
50288       ###### Related Nodes
50289       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
50290       - TO complex( volume-group LocatedIn complex, MANY2ONE)
50291       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
50292       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
50293       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
50294
50295     required:
50296     - volume-group-id
50297     - volume-group-name
50298     - vnf-type
50299     properties:
50300       volume-group-id:
50301         type: string
50302         description: Unique ID of volume-group.
50303       volume-group-name:
50304         type: string
50305         description: Name of the volume group.
50306       heat-stack-id:
50307         type: string
50308         description: Heat stack id corresponding to this volume-group
50309       vnf-type:
50310         type: string
50311         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.
50312       orchestration-status:
50313         type: string
50314         description: Orchestration status of this volume-group
50315       persona-model-customization-id:
50316         type: string
50317         description: captures the id of all the configuration used to customize the resource for the service.
50318       vf-module-persona-model-customization-id:
50319         type: string
50320         description: helps relate the volume group to the vf-module whose components will require the volume group
50321   volume-groups:
50322     description: |
50323       Collection of persistent block-level storage.
50324     properties:
50325       volume-group:
50326         type: array
50327         items:
50328           $ref: "#/patchDefinitions/volume-group"
50329   volumes:
50330     description: |
50331       Collection of ephemeral Block storage volumes.
50332     properties:
50333       volume:
50334         type: array
50335         items:
50336           $ref: "#/patchDefinitions/volume"
50337   vpls-pe:
50338     description: |
50339       VPLS Provider Edge routers.
50340       ###### Related Nodes
50341       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
50342       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
50343       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
50344       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
50345
50346       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
50347     required:
50348     - equipment-name
50349     properties:
50350       equipment-name:
50351         type: string
50352       prov-status:
50353         type: string
50354         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50355       ipv4-oam-address:
50356         type: string
50357         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
50358       equipment-role:
50359         type: string
50360         description: Client should send valid enumerated value, e.g., VPLS-PE.
50361       vlan-id-outer:
50362         type: integer
50363         format: int64
50364         description: Temporary location for stag to get to VCE
50365   vpls-pes:
50366     description: |
50367       Collection of VPLS Provider Edge routers
50368     properties:
50369       vpls-pe:
50370         type: array
50371         items:
50372           $ref: "#/patchDefinitions/vpls-pe"
50373   vpn-binding:
50374     description: |
50375       VPN binding
50376       ###### Related Nodes
50377       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
50378       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
50379
50380       -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
50381
50382     required:
50383     - vpn-id
50384     - vpn-name
50385     - global-route-target
50386     - route-target-role
50387     properties:
50388       vpn-id:
50389         type: string
50390         description: VPN ID, globally unique within A&AI
50391       vpn-name:
50392         type: string
50393         description: VPN Name
50394       global-route-target:
50395         type: string
50396         description: Number used to identify a VPN, globally unique in the network
50397       vpn-platform:
50398         type: string
50399         description: the platform associated with the VPN example AVPN, Mobility
50400       vpn-type:
50401         type: string
50402         description: Type of the vpn, should be taken from enumerated/valid values
50403       route-distinguisher:
50404         type: string
50405         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
50406       route-target-role:
50407         type: string
50408         description: Role assigned to this route target
50409   vpn-bindings:
50410     properties:
50411       vpn-binding:
50412         type: array
50413         items:
50414           $ref: "#/patchDefinitions/vpn-binding"
50415   vserver:
50416     description: |
50417       Virtual Servers, aka virtual machine or VM.
50418       ###### Related Nodes
50419       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
50420       - TO flavor( vserver Uses flavor, MANY2ONE)
50421       - TO image( vserver Uses image, MANY2ONE)
50422       - TO pserver( vserver HostedOn pserver, MANY2ONE)
50423       - TO snapshot( vserver Uses snapshot, ONE2ONE)
50424       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
50425       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
50426       - FROM vce( vce HostedOn vserver, ONE2MANY)
50427       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
50428       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
50429       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
50430
50431       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
50432       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
50433     required:
50434     - vserver-id
50435     - vserver-name
50436     - vserver-selflink
50437     - in-maint
50438     - is-closed-loop-disabled
50439     properties:
50440       vserver-id:
50441         type: string
50442         description: Unique identifier for this vserver relative to its tenant
50443       vserver-name:
50444         type: string
50445         description: Name of vserver
50446       vserver-name2:
50447         type: string
50448         description: Alternative name of vserver
50449       prov-status:
50450         type: string
50451         description: Trigger for operational monitoring of this resource by Service Assurance systems.
50452       vserver-selflink:
50453         type: string
50454         description: URL to endpoint where AAI can get more details
50455       in-maint:
50456         type: boolean
50457         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.
50458       is-closed-loop-disabled:
50459         type: boolean
50460         description: Used to indicate whether closed loop function is enabled on this node
50461   vservers:
50462     description: |
50463       Collection of virtual Servers, aka virtual machines or VMs.
50464     properties:
50465       vserver:
50466         type: array
50467         items:
50468           $ref: "#/patchDefinitions/vserver"
50469   zone:
50470     description: |
50471       A zone is a grouping of assets in a location homing to the same connections into the CBB
50472       ###### Related Nodes
50473       - TO complex( zone LocatedIn complex, MANY2ONE)
50474       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
50475       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
50476       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
50477
50478     required:
50479     - zone-id
50480     - zone-name
50481     - design-type
50482     - zone-context
50483     properties:
50484       zone-id:
50485         type: string
50486         description: Code assigned by AIC to the zone
50487       zone-name:
50488         type: string
50489         description: English name associated with the zone
50490       design-type:
50491         type: string
50492         description: Design of zone [Medium/Large?]
50493       zone-context:
50494         type: string
50495         description: Context of zone [production/test]
50496       status:
50497         type: string
50498         description: Status of a zone.
50499   zones:
50500     description: |
50501       Collection of zones
50502     properties:
50503       zone:
50504         type: array
50505         items:
50506           $ref: "#/patchDefinitions/zone"
50507 getDefinitions:
50508   action:
50509     properties:
50510       action-type:
50511         type: string
50512       action-data:
50513         type: array
50514         items:
50515           $ref: "#/getDefinitions/action-data"
50516   action-data:
50517     properties:
50518       property-name:
50519         type: string
50520       property-value:
50521         type: string
50522   actions:
50523     description: |
50524       APIs that are more action related than REST (e.g., notify, update).
50525     properties:
50526       update:
50527         type: object
50528         $ref: "#/getDefinitions/update"
50529       notify:
50530         type: object
50531         $ref: "#/getDefinitions/notify"
50532   allotted-resource:
50533     description: |
50534       Represents a slice or partial piece of a resource that gets separately allotted
50535       ###### Related Nodes
50536       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
50537       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
50538       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
50539       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
50540       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
50541       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
50542       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
50543
50544       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
50545       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
50546     required:
50547     - id
50548     properties:
50549       id:
50550         type: string
50551         description: Allotted Resource id UUID assigned to this instance.
50552       description:
50553         type: string
50554         description: The descriptive information assigned to this allotted resource instance
50555       selflink:
50556         type: string
50557         description: Link back to more information in the controller
50558       persona-model-id:
50559         type: string
50560         description: the ASDC model id for this resource or service model.
50561       persona-model-version:
50562         type: string
50563         description: the ASDC model version for this resource or service model.
50564       model-version-id:
50565         type: string
50566         description: the ASDC model version for this resource or service model.
50567       persona-model-customization-id:
50568         type: string
50569         description: captures the id of all the configuration used to customize the resource for the service.
50570       resource-version:
50571         type: string
50572         description: Concurrency value
50573       tunnel-xconnects:
50574         type: array
50575         items:
50576           $ref: "#/getDefinitions/tunnel-xconnect"
50577       relationship-list:
50578         type: array
50579         items:
50580           $ref: "#/getDefinitions/relationship"
50581   allotted-resources:
50582     description: |
50583       This object is used to store slices of services being offered
50584     properties:
50585       allotted-resource:
50586         type: array
50587         items:
50588           $ref: "#/getDefinitions/allotted-resource"
50589   availability-zone:
50590     description: |
50591       Availability zone, a collection of compute hosts/pservers
50592       ###### Related Nodes
50593       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
50594       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
50595       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
50596       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
50597       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
50598       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
50599       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
50600       - FROM vce( vce Uses availability-zone, MANY2MANY)
50601
50602       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
50603       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
50604
50605     required:
50606     - availability-zone-name
50607     - hypervisor-type
50608     properties:
50609       availability-zone-name:
50610         type: string
50611         description: Name of the availability zone.  Unique across a cloud region
50612       hypervisor-type:
50613         type: string
50614         description: Type of hypervisor.  Source of truth should define valid values.
50615       operational-state:
50616         type: string
50617         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
50618       resource-version:
50619         type: string
50620         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50621       relationship-list:
50622         type: array
50623         items:
50624           $ref: "#/getDefinitions/relationship"
50625   availability-zones:
50626     description: |
50627       Collection of availability zones
50628     properties:
50629       availability-zone:
50630         type: array
50631         items:
50632           $ref: "#/getDefinitions/availability-zone"
50633   az-and-dvs-switches:
50634     properties:
50635       dvs-switches:
50636         type: object
50637         $ref: "#/getDefinitions/dvs-switches"
50638       availability-zone:
50639         type: object
50640         $ref: "#/getDefinitions/availability-zone"
50641   business:
50642     description: |
50643       Namespace for business related constructs
50644     properties:
50645       connectors:
50646         type: array
50647         items:
50648           $ref: "#/getDefinitions/connector"
50649       customers:
50650         type: array
50651         items:
50652           $ref: "#/getDefinitions/customer"
50653   class-of-service:
50654     description: |
50655       ###### Related Nodes
50656       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
50657
50658       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
50659     required:
50660     - cos
50661     properties:
50662       cos:
50663         type: string
50664         description: unique identifier of probe
50665       probe-id:
50666         type: string
50667         description: identifier of probe
50668       probe-type:
50669         type: string
50670         description: type of probe
50671       resource-version:
50672         type: string
50673         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50674       relationship-list:
50675         type: array
50676         items:
50677           $ref: "#/getDefinitions/relationship"
50678   classes-of-service:
50679     description: |
50680       class-of-service of probe
50681     properties:
50682       class-of-service:
50683         type: array
50684         items:
50685           $ref: "#/getDefinitions/class-of-service"
50686   cloud-infrastructure:
50687     description: |
50688       Namespace for cloud infrastructure.
50689     properties:
50690       complexes:
50691         type: array
50692         items:
50693           $ref: "#/getDefinitions/complex"
50694       cloud-regions:
50695         type: array
50696         items:
50697           $ref: "#/getDefinitions/cloud-region"
50698       network-profiles:
50699         type: array
50700         items:
50701           $ref: "#/getDefinitions/network-profile"
50702       pservers:
50703         type: array
50704         items:
50705           $ref: "#/getDefinitions/pserver"
50706       virtual-data-centers:
50707         type: array
50708         items:
50709           $ref: "#/getDefinitions/virtual-data-center"
50710   cloud-region:
50711     description: |
50712       cloud-region designates an installation of a cloud cluster or region or instantiation.
50713       ###### Related Nodes
50714       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
50715       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
50716       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
50717       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
50718       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
50719       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
50720       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
50721       - FROM image( image BelongsTo cloud-region, MANY2ONE)
50722       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
50723       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
50724       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
50725       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
50726       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
50727       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
50728
50729       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
50730       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
50731
50732     required:
50733     - cloud-owner
50734     - cloud-region-id
50735     properties:
50736       cloud-owner:
50737         type: string
50738         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
50739       cloud-region-id:
50740         type: string
50741         description: Identifier used by the vendor for the region. Second part of composite key
50742       cloud-type:
50743         type: string
50744         description: Type of the cloud (e.g., openstack)
50745       owner-defined-type:
50746         type: string
50747         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
50748       cloud-region-version:
50749         type: string
50750         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
50751       identity-url:
50752         type: string
50753         description: URL of the keystone identity service
50754       cloud-zone:
50755         type: string
50756         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
50757       complex-name:
50758         type: string
50759         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
50760       resource-version:
50761         type: string
50762         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50763       volume-groups:
50764         type: array
50765         items:
50766           $ref: "#/getDefinitions/volume-group"
50767       tenants:
50768         type: array
50769         items:
50770           $ref: "#/getDefinitions/tenant"
50771       flavors:
50772         type: array
50773         items:
50774           $ref: "#/getDefinitions/flavor"
50775       group-assignments:
50776         type: array
50777         items:
50778           $ref: "#/getDefinitions/group-assignment"
50779       snapshots:
50780         type: array
50781         items:
50782           $ref: "#/getDefinitions/snapshot"
50783       images:
50784         type: array
50785         items:
50786           $ref: "#/getDefinitions/image"
50787       dvs-switches:
50788         type: array
50789         items:
50790           $ref: "#/getDefinitions/dvs-switch"
50791       oam-networks:
50792         type: array
50793         items:
50794           $ref: "#/getDefinitions/oam-network"
50795       availability-zones:
50796         type: array
50797         items:
50798           $ref: "#/getDefinitions/availability-zone"
50799       relationship-list:
50800         type: array
50801         items:
50802           $ref: "#/getDefinitions/relationship"
50803   cloud-regions:
50804     properties:
50805       cloud-region:
50806         type: array
50807         items:
50808           $ref: "#/getDefinitions/cloud-region"
50809   complex:
50810     description: |
50811       Collection of physical locations that can house cloud-regions.
50812       ###### Related Nodes
50813       - TO l3-network( complex Uses l3-network, MANY2MANY)
50814       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
50815       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
50816       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
50817       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
50818       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
50819       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
50820       - FROM vce( vce LocatedIn complex, MANY2MANY)
50821       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
50822       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
50823       - FROM zone( zone LocatedIn complex, MANY2ONE)
50824
50825       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
50826       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
50827
50828     required:
50829     - physical-location-id
50830     - physical-location-type
50831     - street1
50832     - city
50833     - postal-code
50834     - country
50835     - region
50836     properties:
50837       physical-location-id:
50838         type: string
50839         description: Unique identifier for physical location, e.g., CLLI
50840       data-center-code:
50841         type: string
50842         description: Data center code which can be an alternate way to identify a complex
50843       complex-name:
50844         type: string
50845         description: Gamma complex name for LCP instance.
50846       identity-url:
50847         type: string
50848         description: URL of the keystone identity service
50849       resource-version:
50850         type: string
50851         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50852       physical-location-type:
50853         type: string
50854         description: Type, e.g., central office, data center.
50855       street1:
50856         type: string
50857       street2:
50858         type: string
50859       city:
50860         type: string
50861       state:
50862         type: string
50863       postal-code:
50864         type: string
50865       country:
50866         type: string
50867       region:
50868         type: string
50869       latitude:
50870         type: string
50871       longitude:
50872         type: string
50873       elevation:
50874         type: string
50875       lata:
50876         type: string
50877       ctag-pools:
50878         type: array
50879         items:
50880           $ref: "#/getDefinitions/ctag-pool"
50881       relationship-list:
50882         type: array
50883         items:
50884           $ref: "#/getDefinitions/relationship"
50885   complexes:
50886     description: |
50887       Collection of physical locations that can house cloud-regions.
50888     properties:
50889       complex:
50890         type: array
50891         items:
50892           $ref: "#/getDefinitions/complex"
50893   configuration:
50894     description: |
50895       Port Mirror Configuration.
50896       ###### Related Nodes
50897       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
50898       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
50899       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
50900       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
50901       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
50902
50903       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
50904       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
50905       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
50906     required:
50907     - configuration-id
50908     - configuration-type
50909     - configuration-sub-type
50910     - orchestration-status
50911     - operational-status
50912     - configuration-selflink
50913     - model-customization-id
50914     properties:
50915       configuration-id:
50916         type: string
50917         description: UUID assigned to configuration.
50918       management-option:
50919         type: string
50920         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
50921       configuration-name:
50922         type: string
50923         description: Name of the configuration.
50924       configuration-type:
50925         type: string
50926         description: port-mirroring-configuration.
50927       configuration-sub-type:
50928         type: string
50929         description: vprobe, pprobe.
50930       model-invariant-id:
50931         type: string
50932         description: the ASDC model id for this resource or service model.
50933       model-version-id:
50934         type: string
50935         description: the ASDC model version for this resource or service model.
50936       orchestration-status:
50937         type: string
50938         description: Orchestration status of the configuration.
50939       operational-status:
50940         type: string
50941         description: Indicator for whether the resource is considered operational.
50942       configuration-selflink:
50943         type: string
50944         description: URL to endpoint where AAI can get more details from SDN-GC.
50945       model-customization-id:
50946         type: string
50947         description: id of  the configuration used to customize the resource
50948       resource-version:
50949         type: string
50950         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50951       relationship-list:
50952         type: array
50953         items:
50954           $ref: "#/getDefinitions/relationship"
50955       metadata:
50956         type: array
50957         items:
50958           $ref: "#/getDefinitions/metadatum"
50959   configurations:
50960     description: |
50961       Collection of configurations
50962     properties:
50963       configuration:
50964         type: array
50965         items:
50966           $ref: "#/getDefinitions/configuration"
50967   connector:
50968     description: |
50969       Collection of resource instances used to connect a variety of disparate inventory widgets
50970       ###### Related Nodes
50971       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
50972       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
50973       - FROM service-instance( service-instance Uses connector, MANY2MANY)
50974
50975       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
50976     required:
50977     - resource-instance-id
50978     properties:
50979       resource-instance-id:
50980         type: string
50981         description: Unique id of resource instance.
50982       resource-version:
50983         type: string
50984         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50985       persona-model-id:
50986         type: string
50987         description: the ASDC model id for this resource or service model.
50988       persona-model-version:
50989         type: string
50990         description: the ASDC model version for this resource or service model.
50991       model-version-id:
50992         type: string
50993         description: the ASDC model version for this resource or service model.
50994       widget-model-id:
50995         type: string
50996         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
50997       widget-model-version:
50998         type: string
50999         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51000       relationship-list:
51001         type: array
51002         items:
51003           $ref: "#/getDefinitions/relationship"
51004       metadata:
51005         type: array
51006         items:
51007           $ref: "#/getDefinitions/metadatum"
51008   connectors:
51009     description: |
51010       Collection of resource instances used to connect a variety of disparate inventory widgets
51011     properties:
51012       connector:
51013         type: array
51014         items:
51015           $ref: "#/getDefinitions/connector"
51016   constrained-element-set:
51017     description: |
51018       This is how we would capture constraints defining allowed sets of elements.
51019       ###### Related Nodes
51020       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
51021       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
51022       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
51023
51024       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
51025       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
51026     required:
51027     - constrained-element-set-uuid
51028     - constraint-type
51029     - check-type
51030     properties:
51031       constrained-element-set-uuid:
51032         type: string
51033       constraint-type:
51034         type: string
51035       check-type:
51036         type: string
51037       resource-version:
51038         type: string
51039       element-choice-sets:
51040         type: array
51041         items:
51042           $ref: "#/getDefinitions/element-choice-set"
51043       relationship-list:
51044         type: array
51045         items:
51046           $ref: "#/getDefinitions/relationship"
51047   constrained-element-sets:
51048     properties:
51049       constrained-element-set:
51050         type: array
51051         items:
51052           $ref: "#/getDefinitions/constrained-element-set"
51053   ctag-assignment:
51054     description: |
51055       ###### Related Nodes
51056       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
51057       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
51058
51059       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
51060     required:
51061     - vlan-id-inner
51062     properties:
51063       vlan-id-inner:
51064         type: integer
51065         format: int64
51066         description: id.
51067       resource-version:
51068         type: string
51069         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51070       relationship-list:
51071         type: array
51072         items:
51073           $ref: "#/getDefinitions/relationship"
51074   ctag-assignments:
51075     properties:
51076       ctag-assignment:
51077         type: array
51078         items:
51079           $ref: "#/getDefinitions/ctag-assignment"
51080   ctag-pool:
51081     description: |
51082       A collection of C tags (vlan tags) grouped for a specific purpose.
51083       ###### Related Nodes
51084       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
51085       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
51086       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
51087
51088       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
51089     required:
51090     - target-pe
51091     - availability-zone-name
51092     - ctag-pool-purpose
51093     properties:
51094       target-pe:
51095         type: string
51096         description: The Target provider edge router
51097       availability-zone-name:
51098         type: string
51099         description: Name of the availability zone
51100       ctag-pool-purpose:
51101         type: string
51102         description: Describes what the intended purpose of this pool is.
51103       ctag-values:
51104         type: string
51105         description: Comma separated list of ctags
51106       resource-version:
51107         type: string
51108         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51109       relationship-list:
51110         type: array
51111         items:
51112           $ref: "#/getDefinitions/relationship"
51113   ctag-pools:
51114     properties:
51115       ctag-pool:
51116         type: array
51117         items:
51118           $ref: "#/getDefinitions/ctag-pool"
51119   customer:
51120     description: |
51121       customer identifiers to provide linkage back to BSS information.
51122       ###### Related Nodes
51123       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
51124
51125       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
51126     required:
51127     - global-customer-id
51128     - subscriber-name
51129     - subscriber-type
51130     properties:
51131       global-customer-id:
51132         type: string
51133         description: Global customer id used across ECOMP to uniquely identify customer.
51134       subscriber-name:
51135         type: string
51136         description: Subscriber name, an alternate way to retrieve a customer.
51137       subscriber-type:
51138         type: string
51139         description: Subscriber type, a way to provide VID with only the INFRA customers.
51140       resource-version:
51141         type: string
51142         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51143       service-subscriptions:
51144         type: array
51145         items:
51146           $ref: "#/getDefinitions/service-subscription"
51147       relationship-list:
51148         type: array
51149         items:
51150           $ref: "#/getDefinitions/relationship"
51151   customers:
51152     description: |
51153       Collection of customer identifiers to provide linkage back to BSS information.
51154     properties:
51155       customer:
51156         type: array
51157         items:
51158           $ref: "#/getDefinitions/customer"
51159   cvlan-tag-entry:
51160     required:
51161     - cvlan-tag
51162     properties:
51163       cvlan-tag:
51164         type: integer
51165         format: int64
51166         description: See mis-na-virtualization-platform.yang
51167       resource-version:
51168         type: string
51169         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51170       relationship-list:
51171         type: array
51172         items:
51173           $ref: "#/getDefinitions/relationship"
51174   cvlan-tags:
51175     properties:
51176       cvlan-tag-entry:
51177         type: array
51178         items:
51179           $ref: "#/getDefinitions/cvlan-tag-entry"
51180   dvs-switch:
51181     description: |
51182       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.
51183       ###### Related Nodes
51184       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
51185       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
51186
51187     required:
51188     - switch-name
51189     - vcenter-url
51190     properties:
51191       switch-name:
51192         type: string
51193         description: DVS switch name
51194       vcenter-url:
51195         type: string
51196         description: URL used to reach the vcenter
51197       resource-version:
51198         type: string
51199         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51200       relationship-list:
51201         type: array
51202         items:
51203           $ref: "#/getDefinitions/relationship"
51204   dvs-switches:
51205     description: |
51206       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
51207     properties:
51208       dvs-switch:
51209         type: array
51210         items:
51211           $ref: "#/getDefinitions/dvs-switch"
51212   edge-prop-names:
51213     description: |
51214       Internal map to define the properties of an edge and interpret the map EdgeRules
51215     properties:
51216       edgeLabel:
51217         type: string
51218       direction:
51219         type: string
51220       multiplicityRule:
51221         type: string
51222       isParent:
51223         type: boolean
51224       usesResource:
51225         type: boolean
51226       hasDelTarget:
51227         type: boolean
51228       SVC-INFRA:
51229         type: boolean
51230       SVC-INFRA-REV:
51231         type: boolean
51232   edge-tag-query-request:
51233     properties:
51234       edge-tag:
51235         type: string
51236       result-detail:
51237         type: string
51238       start-node-type:
51239         type: string
51240       start-node-filter:
51241         type: array
51242         items:
51243           $ref: "#/getDefinitions/start-node-filter"
51244       include-node-filter:
51245         type: array
51246         items:
51247           $ref: "#/getDefinitions/include-node-filter"
51248       secondary-filter:
51249         type: array
51250         items:
51251           $ref: "#/getDefinitions/secondary-filter"
51252   edge-tag-query-result:
51253     properties:
51254       tagged-inventory-item-list:
51255         type: array
51256         items:
51257           $ref: "#/getDefinitions/tagged-inventory-item-list"
51258   element-choice-set:
51259     description: |
51260       This is how we would capture constraints defining allowed sets of elements.
51261       ###### Related Nodes
51262       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
51263       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
51264
51265       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
51266       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
51267     required:
51268     - element-choice-set-uuid
51269     - element-choice-set-name
51270     properties:
51271       element-choice-set-uuid:
51272         type: string
51273       element-choice-set-name:
51274         type: string
51275       cardinality:
51276         type: string
51277       resource-version:
51278         type: string
51279       model-elements:
51280         type: array
51281         items:
51282           $ref: "#/getDefinitions/model-element"
51283       relationship-list:
51284         type: array
51285         items:
51286           $ref: "#/getDefinitions/relationship"
51287   element-choice-sets:
51288     properties:
51289       element-choice-set:
51290         type: array
51291         items:
51292           $ref: "#/getDefinitions/element-choice-set"
51293   entitlement:
51294     description: |
51295       Metadata for entitlement group.
51296       ###### Related Nodes
51297       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
51298       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
51299
51300       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
51301     required:
51302     - group-uuid
51303     - resource-uuid
51304     properties:
51305       group-uuid:
51306         type: string
51307         description: Unique ID for the entitlement group the resource comes from, should be uuid.
51308       resource-uuid:
51309         type: string
51310         description: Unique ID of an entitlement resource.
51311       resource-version:
51312         type: string
51313         description: Concurrency value
51314       relationship-list:
51315         type: array
51316         items:
51317           $ref: "#/getDefinitions/relationship"
51318   entitlements:
51319     description: |
51320       Entitlements, keyed by group-uuid and resource-uuid, related to license management
51321     properties:
51322       entitlement:
51323         type: array
51324         items:
51325           $ref: "#/getDefinitions/entitlement"
51326   esr-ems:
51327     description: |
51328       Persist EMS address information used by EMS driver.
51329       ###### Related Nodes
51330       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
51331
51332       -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
51333     required:
51334     - ems-id
51335     properties:
51336       ems-id:
51337         type: string
51338         description: Unique ID of EMS.
51339       resource-version:
51340         type: string
51341         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51342       esr-system-info-list:
51343         type: object
51344         $ref: "#/getDefinitions/esr-system-info-list"
51345       relationship-list:
51346         type: object
51347         $ref: "#/getDefinitions/relationship-list"
51348   esr-ems-list:
51349     properties:
51350       esr-ems:
51351         type: array
51352         items:
51353           $ref: "#/getDefinitions/esr-ems"
51354   esr-system-info:
51355     description: |
51356       Persist common address information of external systems.
51357       ###### Related Nodes
51358       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
51359       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
51360       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
51361       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
51362
51363       -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
51364     required:
51365     - esr-system-info-id
51366     - user-name
51367     - password
51368     - system-type
51369     properties:
51370       esr-system-info-id:
51371         type: string
51372         description: Unique ID of esr system info.
51373       system-name:
51374         type: string
51375         description: name of external system.
51376       type:
51377         type: string
51378         description: type of external systems.
51379       vendor:
51380         type: string
51381         description: vendor of external systems.
51382       version:
51383         type: string
51384         description: version of external systems.
51385       service-url:
51386         type: string
51387         description: url used to access external systems.
51388       user-name:
51389         type: string
51390         description: username used to access external systems.
51391       password:
51392         type: string
51393         description: password used to access external systems.
51394       system-type:
51395         type: string
51396         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
51397       protocol:
51398         type: string
51399         description: protocol of third party SDNC, for example netconf/snmp.
51400       ssl-cacert:
51401         type: string
51402         description: ca file content if enabled ssl on auth-url.
51403       ssl-insecure:
51404         type: boolean
51405         description: Whether to verify VIM's certificate.
51406       ip-address:
51407         type: string
51408         description: service IP of ftp server.
51409       port:
51410         type: string
51411         description: service port of ftp server.
51412       cloud-domain:
51413         type: string
51414         description: domain info for authentication.
51415       default-tenant:
51416         type: string
51417         description: default tenant of VIM.
51418       passive:
51419         type: boolean
51420         description: ftp passive mode or not.
51421       remote-path:
51422         type: string
51423         description: resource or performance data file path.
51424       system-status:
51425         type: string
51426         description: the status of external system.
51427       resource-version:
51428         type: string
51429         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51430       relationship-list:
51431         type: array
51432         items:
51433           $ref: "#/getDefinitions/relationship"
51434   esr-system-info-list:
51435     description: |
51436       Collection of persistent block-level external system auth info.
51437     properties:
51438       esr-system-info:
51439         type: array
51440         items:
51441           $ref: "#/getDefinitions/esr-system-info"
51442   esr-thirdparty-sdnc:
51443     description: |
51444       Persist SDNC address information used by ONAP SDNC.
51445       ###### Related Nodes
51446       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
51447       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
51448
51449       -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
51450     required:
51451     - thirdparty-sdnc-id
51452     properties:
51453       thirdparty-sdnc-id:
51454         type: string
51455         description: Unique ID of SDNC.
51456       location:
51457         type: string
51458         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
51459       product-name:
51460         type: string
51461         description: password used to access SDNC server.
51462       resource-version:
51463         type: string
51464         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51465       esr-system-info-list:
51466         type: object
51467         $ref: "#/getDefinitions/esr-system-info-list"
51468       relationship-list:
51469         type: object
51470         $ref: "#/getDefinitions/relationship-list"
51471   esr-thirdparty-sdnc-list:
51472     properties:
51473       esr-thirdparty-sdnc:
51474         type: array
51475         items:
51476           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
51477   esr-vnfm:
51478     description: |
51479       Persist VNFM address information used by VF-C.
51480       ###### Related Nodes
51481       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
51482
51483       -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
51484     required:
51485     - vnfm-id
51486     properties:
51487       vnfm-id:
51488         type: string
51489         description: Unique ID of VNFM.
51490       vim-id:
51491         type: string
51492         description: indecate the VIM to deploy VNF.
51493       certificate-url:
51494         type: string
51495         description: certificate url of VNFM.
51496       resource-version:
51497         type: string
51498         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51499       esr-system-info-list:
51500         type: object
51501         $ref: "#/getDefinitions/esr-system-info-list"
51502       relationship-list:
51503         type: object
51504         $ref: "#/getDefinitions/relationship-list"
51505   esr-vnfm-list:
51506     properties:
51507       esr-vnfm:
51508         type: array
51509         items:
51510           $ref: "#/getDefinitions/esr-vnfm"
51511   evc:
51512     description: |
51513       evc object is an optional child object of the Configuration object.
51514       ###### Related Nodes
51515       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
51516
51517       -(4) IF this TO node is deleted, this EVC is DELETED also
51518     required:
51519     - evc-id
51520     properties:
51521       evc-id:
51522         type: string
51523         description: Unique/key field for the evc object
51524       forwarding-path-topology:
51525         type: string
51526         description: Point-to-Point, Multi-Point
51527       cir-value:
51528         type: string
51529         description: Commited Information Rate
51530       cir-units:
51531         type: string
51532         description: CIR units
51533       connection-diversity-group-id:
51534         type: string
51535         description: Diversity Group ID
51536       service-hours:
51537         type: string
51538         description: formerly Performance Group
51539       esp-evc-circuit-id:
51540         type: string
51541         description: EVC Circuit ID of ESP EVC
51542       esp-evc-cir-value:
51543         type: string
51544         description: Committed Information Rate (For ESP)
51545       esp-evc-cir-units:
51546         type: string
51547         description: CIR units (For ESP)
51548       esp-itu-code:
51549         type: string
51550         description: Identifies ESP
51551       collector-pop-clli:
51552         type: string
51553         description: Collector POP CLLI (from the hostname of the access pnf)
51554       inter-connect-type-ingress:
51555         type: string
51556         description: Interconnect type on ingress side of EVC.
51557       tagmode-access-ingress:
51558         type: string
51559         description: tagode for collector side of EVC
51560       tagmode-access-egress:
51561         type: string
51562         description: tagMode for network side of EVC
51563       relationship-list:
51564         type: array
51565         items:
51566           $ref: "#/getDefinitions/relationship"
51567       resource-version:
51568         type: string
51569         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51570   evcs:
51571     properties:
51572       evc:
51573         type: array
51574         items:
51575           $ref: "#/getDefinitions/evc"
51576   external-system:
51577     description: |
51578       Namespace for external system.
51579     properties:
51580       esr-ems-list:
51581         type: object
51582         $ref: "#/getDefinitions/esr-ems-list"
51583       esr-vnfm-list:
51584         type: object
51585         $ref: "#/getDefinitions/esr-vnfm-list"
51586       esr-thirdparty-sdnc-list:
51587         type: object
51588         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
51589   extra-properties:
51590     description: |
51591       Extra properties for inventory item for response list
51592   extra-property:
51593     properties:
51594       property-name:
51595         type: string
51596   flavor:
51597     description: |
51598       Openstack flavor.
51599       ###### Related Nodes
51600       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
51601       - FROM vserver( vserver Uses flavor, MANY2ONE)
51602
51603       -FLAVOR cannot be deleted if related to VSERVER
51604
51605     required:
51606     - flavor-id
51607     - flavor-name
51608     - flavor-selflink
51609     properties:
51610       flavor-id:
51611         type: string
51612         description: Flavor id, expected to be unique across cloud-region.
51613       flavor-name:
51614         type: string
51615         description: Flavor name
51616       flavor-vcpus:
51617         type: integer
51618         format: int32
51619         description: Number of CPUs
51620       flavor-ram:
51621         type: integer
51622         format: int32
51623         description: Amount of memory
51624       flavor-disk:
51625         type: integer
51626         format: int32
51627         description: Disk space
51628       flavor-ephemeral:
51629         type: integer
51630         format: int32
51631         description: Amount of ephemeral disk space
51632       flavor-swap:
51633         type: string
51634         description: amount of swap space allocation
51635       flavor-is-public:
51636         type: boolean
51637         description: whether flavor is available to all users or private to the tenant it was created in.
51638       flavor-selflink:
51639         type: string
51640         description: URL to endpoint where AAI can get more details
51641       flavor-disabled:
51642         type: boolean
51643         description: Boolean as to whether this flavor is no longer enabled
51644       resource-version:
51645         type: string
51646         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51647       relationship-list:
51648         type: array
51649         items:
51650           $ref: "#/getDefinitions/relationship"
51651   flavors:
51652     description: |
51653       Collection of openstack flavors.
51654     properties:
51655       flavor:
51656         type: array
51657         items:
51658           $ref: "#/getDefinitions/flavor"
51659   forwarder:
51660     description: |
51661       Entity describing a sequenced segment of forwarding path
51662       ###### Related Nodes
51663       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
51664       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
51665       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
51666       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
51667       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
51668
51669       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
51670       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
51671     required:
51672     - sequence
51673     properties:
51674       sequence:
51675         type: integer
51676         format: int32
51677         description: Unique ID of this segmentation
51678       forwarder-role:
51679         type: string
51680         description: ingress, intermediate, egress
51681       relationship-list:
51682         type: array
51683         items:
51684           $ref: "#/getDefinitions/relationship"
51685       resource-version:
51686         type: string
51687         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51688   forwarder-evc:
51689     description: |
51690       forwarder object is an optional child object of the Configuration object.
51691       ###### Related Nodes
51692       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
51693
51694       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
51695     required:
51696     - forwarder-evc-id
51697     properties:
51698       forwarder-evc-id:
51699         type: string
51700         description: Key for forwarder-evc object
51701       circuit-id:
51702         type: string
51703         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
51704       ivlan:
51705         type: string
51706         description: Internal VLAN.
51707       svlan:
51708         type: string
51709         description: SVLAN value for ingress of egress forwarder.
51710       cvlan:
51711         type: string
51712         description: CVLAN value for ingress of egress forwarder.
51713       relationship-list:
51714         type: array
51715         items:
51716           $ref: "#/getDefinitions/relationship"
51717       resource-version:
51718         type: string
51719         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51720   forwarder-evcs:
51721     properties:
51722       forwarder-evc:
51723         type: array
51724         items:
51725           $ref: "#/getDefinitions/forwarder-evc"
51726   forwarders:
51727     properties:
51728       forwarder:
51729         type: array
51730         items:
51731           $ref: "#/getDefinitions/forwarder"
51732   forwarding-path:
51733     description: |
51734       Entity that describes the sequenced forwarding path between interfaces of services or resources
51735       ###### Related Nodes
51736       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
51737       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
51738       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
51739
51740       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
51741       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
51742       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
51743     required:
51744     - forwarding-path-id
51745     - forwarding-path-name
51746     properties:
51747       forwarding-path-id:
51748         type: string
51749         description: Unique ID of this FP
51750       forwarding-path-name:
51751         type: string
51752         description: Name of the FP
51753       relationship-list:
51754         type: array
51755         items:
51756           $ref: "#/getDefinitions/relationship"
51757       resource-version:
51758         type: string
51759         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51760       selflink:
51761         type: string
51762         description: the self link for this FP
51763       forwarders:
51764         type: array
51765         items:
51766           $ref: "#/getDefinitions/forwarder"
51767   forwarding-paths:
51768     properties:
51769       forwarding-path:
51770         type: array
51771         items:
51772           $ref: "#/getDefinitions/forwarding-path"
51773   generic-vnf:
51774     description: |
51775       General purpose VNF
51776       ###### Related Nodes
51777       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
51778       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
51779       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
51780       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
51781       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
51782       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
51783       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
51784       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
51785       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
51786       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
51787       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
51788       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
51789       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
51790       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
51791       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
51792       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
51793       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
51794       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
51795       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51796       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
51797       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
51798
51799       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
51800     required:
51801     - vnf-id
51802     - vnf-name
51803     - vnf-type
51804     - in-maint
51805     - is-closed-loop-disabled
51806     properties:
51807       vnf-id:
51808         type: string
51809         description: Unique id of VNF.  This is unique across the graph.
51810       vnf-name:
51811         type: string
51812         description: Name of VNF.
51813       vnf-name2:
51814         type: string
51815         description: Alternate name of VNF.
51816       vnf-type:
51817         type: string
51818         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.
51819       service-id:
51820         type: string
51821         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
51822       regional-resource-zone:
51823         type: string
51824         description: Regional way of organizing pservers, source of truth should define values
51825       prov-status:
51826         type: string
51827         description: Trigger for operational monitoring of this resource by Service Assurance systems.
51828       operational-state:
51829         type: string
51830         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
51831       license-key:
51832         type: string
51833         description: OBSOLETE -  do not use
51834       equipment-role:
51835         type: string
51836         description: Client should send valid enumerated value
51837       orchestration-status:
51838         type: string
51839         description: Orchestration status of this VNF, used by MSO.
51840       heat-stack-id:
51841         type: string
51842         description: Heat stack id corresponding to this instance, managed by MSO
51843       mso-catalog-key:
51844         type: string
51845         description: Corresponds to the SDN-C catalog id used to configure this VCE
51846       management-option:
51847         type: string
51848         description: identifier of managed by company or customer
51849       ipv4-oam-address:
51850         type: string
51851         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
51852       ipv4-loopback0-address:
51853         type: string
51854         description: v4 Loopback0 address
51855       nm-lan-v6-address:
51856         type: string
51857         description: v6 Loopback address
51858       management-v6-address:
51859         type: string
51860         description: v6 management address
51861       vcpu:
51862         type: integer
51863         format: int64
51864         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
51865       vcpu-units:
51866         type: string
51867         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
51868       vmemory:
51869         type: integer
51870         format: int64
51871         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
51872       vmemory-units:
51873         type: string
51874         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
51875       vdisk:
51876         type: integer
51877         format: int64
51878         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
51879       vdisk-units:
51880         type: string
51881         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
51882       in-maint:
51883         type: boolean
51884         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.
51885       is-closed-loop-disabled:
51886         type: boolean
51887         description: used to indicate whether closed loop function is enabled on this node
51888       resource-version:
51889         type: string
51890         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51891       summary-status:
51892         type: string
51893         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
51894       encrypted-access-flag:
51895         type: boolean
51896         description: indicates whether generic-vnf access uses SSH
51897       persona-model-id:
51898         type: string
51899         description: the ASDC model id for this resource or service model.
51900       persona-model-version:
51901         type: string
51902         description: the ASDC model version for this resource or service model.
51903       model-version-id:
51904         type: string
51905         description: the ASDC model version for this resource or service model.
51906       persona-model-customization-id:
51907         type: string
51908         description: captures the id of all the configuration used to customize the resource for the service.
51909       widget-model-id:
51910         type: string
51911         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51912       widget-model-version:
51913         type: string
51914         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51915       as-number:
51916         type: string
51917         description: as-number of the VNF
51918       regional-resource-subzone:
51919         type: string
51920         description: represents sub zone of the rr plane
51921       selflink:
51922         type: string
51923         description: Path to the controller object.
51924       relationship-list:
51925         type: array
51926         items:
51927           $ref: "#/getDefinitions/relationship"
51928       l-interfaces:
51929         type: array
51930         items:
51931           $ref: "#/getDefinitions/l-interface"
51932       lag-interfaces:
51933         type: array
51934         items:
51935           $ref: "#/getDefinitions/lag-interface"
51936       vf-modules:
51937         type: array
51938         items:
51939           $ref: "#/getDefinitions/vf-module"
51940       licenses:
51941         type: array
51942         items:
51943           $ref: "#/getDefinitions/license"
51944       entitlements:
51945         type: array
51946         items:
51947           $ref: "#/getDefinitions/entitlement"
51948   generic-vnfs:
51949     description: |
51950       Collection of VNFs
51951     properties:
51952       generic-vnf:
51953         type: array
51954         items:
51955           $ref: "#/getDefinitions/generic-vnf"
51956   group-assignment:
51957     description: |
51958       Openstack group-assignment used to store exclusivity groups (EG).
51959       ###### Related Nodes
51960       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
51961       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
51962       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
51963
51964     required:
51965     - group-id
51966     - group-type
51967     - group-name
51968     properties:
51969       group-id:
51970         type: string
51971         description: Group id, expected to be unique across cloud-region.
51972       group-type:
51973         type: string
51974         description: Group type - the type of group this instance refers to
51975       group-name:
51976         type: string
51977         description: Group name - name assigned to the group
51978       group-description:
51979         type: string
51980         description: Group description - description of the group
51981       resource-version:
51982         type: string
51983         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51984       relationship-list:
51985         type: array
51986         items:
51987           $ref: "#/getDefinitions/relationship"
51988   group-assignments:
51989     description: |
51990       Collection of openstack group assignments
51991     properties:
51992       group-assignment:
51993         type: array
51994         items:
51995           $ref: "#/getDefinitions/group-assignment"
51996   host-route:
51997     description: |
51998       ###### Related Nodes
51999       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
52000
52001       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
52002     required:
52003     - host-route-id
52004     - route-prefix
52005     - next-hop
52006     properties:
52007       host-route-id:
52008         type: string
52009         description: host-route id
52010       route-prefix:
52011         type: string
52012         description: subnet prefix
52013       next-hop:
52014         type: string
52015         description: Could be ip-address, hostname, or service-instance
52016       next-hop-type:
52017         type: string
52018         description: Should be ip-address, hostname, or service-instance to match next-hop
52019       resource-version:
52020         type: string
52021         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52022       relationship-list:
52023         type: array
52024         items:
52025           $ref: "#/getDefinitions/relationship"
52026   host-routes:
52027     properties:
52028       host-route:
52029         type: array
52030         items:
52031           $ref: "#/getDefinitions/host-route"
52032   hpa-capabilities:
52033     description: |
52034       Collection of HPA Capabilities
52035     properties:
52036       hpa-capability:
52037         type: array
52038         items:
52039           $ref: "#/getDefinitions/hpa-capability"
52040   hpa-capability:
52041     description: |
52042       Represents a HPA capability
52043       ###### Related Nodes
52044       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
52045       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
52046       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
52047
52048       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
52049     required:
52050     - hpa-capability-id
52051     - hpa-feature
52052     properties:
52053       hpa-capability-id:
52054         type: string
52055         description: UUID to uniquely identify a HPA capability
52056       hpa-feature:
52057         type: string
52058         description: Name of the HPACapability
52059       hpa-version:
52060         type: string
52061         description: HPA schema version
52062       architecture:
52063         type: string
52064         description: Hardware architecture
52065       resource-version:
52066         type: string
52067         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52068       relationship-list:
52069         type: array
52070         items:
52071           $ref: "#/getDefinitions/relationship"
52072       hpa-feature-attributes:
52073         type: array
52074         items:
52075           $ref: "#/getDefinitions/hpa-feature-attributes"
52076   hpa-feature-attributes:
52077     description: |
52078       HPA Capability Feature attributes
52079       ###### Related Nodes
52080       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
52081
52082       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
52083     required:
52084     - hpa-attribute-key
52085     properties:
52086       hpa-attribute-key:
52087         type: string
52088         description: name of the specific HPA attribute
52089       hpa-attribute-value:
52090         type: string
52091         description: JSON string specifying the value, unit and type of the specific HPA attribute
52092       resource-version:
52093         type: string
52094         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52095       relationship-list:
52096         type: array
52097         items:
52098           $ref: "#/getDefinitions/relationship"
52099   image:
52100     description: |
52101       Openstack image.
52102       ###### Related Nodes
52103       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
52104       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
52105       - FROM vserver( vserver Uses image, MANY2ONE)
52106
52107       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
52108       -IMAGE cannot be deleted if related to VSERVER
52109
52110     required:
52111     - image-id
52112     - image-name
52113     - image-os-distro
52114     - image-os-version
52115     - image-selflink
52116     properties:
52117       image-id:
52118         type: string
52119         description: Image id, expected to be unique across cloud region
52120       image-name:
52121         type: string
52122         description: Image name
52123       image-architecture:
52124         type: string
52125         description: Operating system architecture.
52126       image-os-distro:
52127         type: string
52128         description: The common name of the operating system distribution in lowercase
52129       image-os-version:
52130         type: string
52131         description: The operating system version as specified by the distributor.
52132       application:
52133         type: string
52134         description: The application that the image instantiates.
52135       application-vendor:
52136         type: string
52137         description: The vendor of the application.
52138       application-version:
52139         type: string
52140         description: The version of the application.
52141       image-selflink:
52142         type: string
52143         description: URL to endpoint where AAI can get more details
52144       resource-version:
52145         type: string
52146         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52147       relationship-list:
52148         type: array
52149         items:
52150           $ref: "#/getDefinitions/relationship"
52151       metadata:
52152         type: array
52153         items:
52154           $ref: "#/getDefinitions/metadatum"
52155   images:
52156     description: |
52157       Collectio of Openstack images.
52158     properties:
52159       image:
52160         type: array
52161         items:
52162           $ref: "#/getDefinitions/image"
52163   include-node-filter:
52164     properties:
52165       include-node-type:
52166         type: string
52167   instance-filter:
52168     description: |
52169       InstanceFilter for performing a named-query or model query
52170   instance-filters:
52171     description: |
52172       InstanceFilters for performing a named-query or model query
52173     properties:
52174       instance-filter:
52175         type: array
52176         items:
52177           $ref: "#/getDefinitions/instance-filter"
52178   instance-group:
52179     description: |
52180       General mechanism for grouping instances
52181       ###### Related Nodes
52182       - TO model( instance-group Targets model, MANY2MANY)
52183       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
52184       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
52185       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
52186       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
52187
52188     required:
52189     - id
52190     - description
52191     - type
52192     properties:
52193       id:
52194         type: string
52195         description: Instance Group ID, UUID assigned to this instance.
52196       description:
52197         type: string
52198         description: Descriptive text to help identify the usage of this instance-group
52199       type:
52200         type: string
52201         description: Only valid value today is lower case ha for high availability
52202       sub-type:
52203         type: string
52204         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
52205       resource-version:
52206         type: string
52207         description: Concurrency value
52208       relationship-list:
52209         type: array
52210         items:
52211           $ref: "#/getDefinitions/relationship"
52212   instance-groups:
52213     description: |
52214       Collection of openstack route table references
52215     properties:
52216       instance-group:
52217         type: array
52218         items:
52219           $ref: "#/getDefinitions/instance-group"
52220   inventory:
52221     properties:
52222       search:
52223         type: object
52224         $ref: "#/getDefinitions/search"
52225       actions:
52226         type: object
52227         $ref: "#/getDefinitions/actions"
52228       cloud-infrastructure:
52229         type: object
52230         $ref: "#/getDefinitions/cloud-infrastructure"
52231       business:
52232         type: object
52233         $ref: "#/getDefinitions/business"
52234       service-design-and-creation:
52235         type: object
52236         $ref: "#/getDefinitions/service-design-and-creation"
52237       network:
52238         type: object
52239         $ref: "#/getDefinitions/network"
52240       nodes:
52241         type: object
52242         $ref: "#/getDefinitions/nodes"
52243   inventory-item:
52244     properties:
52245       inventory-item-type:
52246         type: string
52247       inventory-item-link:
52248         type: string
52249       inventory-item-data:
52250         type: array
52251         items:
52252           $ref: "#/getDefinitions/inventory-item-data"
52253       tagged-inventory-item-list:
52254         type: array
52255         items:
52256           $ref: "#/getDefinitions/tagged-inventory-item-list"
52257   inventory-item-data:
52258     properties:
52259       property-name:
52260         type: string
52261       property-value:
52262         type: string
52263   inventory-response-item:
52264     description: |
52265       Inventory item for response list
52266     properties:
52267       model-name:
52268         type: string
52269       extra-properties:
52270         type: object
52271         $ref: "#/getDefinitions/extra-properties"
52272       inventory-response-items:
52273         type: object
52274         $ref: "#/getDefinitions/inventory-response-items"
52275   inventory-response-items:
52276     description: |
52277       Container for inventory items in response list
52278     properties:
52279       inventory-response-item:
52280         type: array
52281         items:
52282           $ref: "#/getDefinitions/inventory-response-item"
52283   ipsec-configuration:
52284     description: |
52285       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
52286       ###### Related Nodes
52287       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
52288       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
52289
52290       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
52291     required:
52292     - ipsec-configuration-id
52293     properties:
52294       ipsec-configuration-id:
52295         type: string
52296         description: UUID of this configuration
52297       requested-vig-address-type:
52298         type: string
52299         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
52300       requested-encryption-strength:
52301         type: string
52302         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
52303       requested-dmz-type:
52304         type: string
52305         description: can offer a shared DMZ or a DMZ specific to a customer
52306       shared-dmz-network-address:
52307         type: string
52308         description: Network address of shared DMZ
52309       requested-customer-name:
52310         type: string
52311         description: If the DMZ is a custom DMZ, this field will indicate the customer information
52312       ike-version:
52313         type: string
52314         description: can be 1 or 2
52315       ikev1-authentication:
52316         type: string
52317         description: Contains values like md5, sha1, sha256, sha384
52318       ikev1-encryption:
52319         type: string
52320         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
52321       ikev1-dh-group:
52322         type: string
52323         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
52324       ikev1-am-group-id:
52325         type: string
52326         description: Group name defined in VIG for clients using aggressive mode
52327       ikev1-am-password:
52328         type: string
52329         description: pre-shared key for the above group name
52330       ikev1-sa-lifetime:
52331         type: string
52332         description: Lifetime for IKEv1 SA
52333       ipsec-authentication:
52334         type: string
52335         description: md5, sha1, sha256, sha384
52336       ipsec-encryption:
52337         type: string
52338         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
52339       ipsec-sa-lifetime:
52340         type: string
52341         description: Life time for IPSec SA
52342       ipsec-pfs:
52343         type: string
52344         description: enable PFS or not
52345       xauth-userid:
52346         type: string
52347         description: user ID for xAuth, sm-user, ,nmteHostName
52348       xauth-user-password:
52349         type: string
52350         description: Encrypted using the Juniper $9$ algorithm
52351       dpd-interval:
52352         type: string
52353         description: The time between DPD probe
52354       dpd-frequency:
52355         type: string
52356         description: Maximum number of DPD before claiming the tunnel is down
52357       resource-version:
52358         type: string
52359         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52360       relationship-list:
52361         type: array
52362         items:
52363           $ref: "#/getDefinitions/relationship"
52364       vig-servers:
52365         type: array
52366         items:
52367           $ref: "#/getDefinitions/vig-server"
52368   ipsec-configurations:
52369     properties:
52370       ipsec-configuration:
52371         type: array
52372         items:
52373           $ref: "#/getDefinitions/ipsec-configuration"
52374   key-data:
52375     properties:
52376       key-name:
52377         type: string
52378       key-value:
52379         type: string
52380   l-interface:
52381     description: |
52382       Logical interfaces, e.g., a vnic.
52383       ###### Related Nodes
52384       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
52385       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
52386       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
52387       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
52388       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
52389       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
52390       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
52391       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
52392       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
52393       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
52394
52395       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
52396       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
52397       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
52398     required:
52399     - interface-name
52400     properties:
52401       interface-name:
52402         type: string
52403         description: Name given to the interface
52404       interface-role:
52405         type: string
52406         description: E.g., CUSTOMER, UPLINK, etc.
52407       v6-wan-link-ip:
52408         type: string
52409         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
52410       selflink:
52411         type: string
52412         description: URL to endpoint where AAI can get more details
52413       interface-id:
52414         type: string
52415         description: ID of interface
52416       macaddr:
52417         type: string
52418         description: MAC address for the interface
52419       network-name:
52420         type: string
52421         description: Name of the network
52422       management-option:
52423         type: string
52424         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
52425       interface-description:
52426         type: string
52427         description: Human friendly text regarding this interface.
52428       resource-version:
52429         type: string
52430         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52431       vlans:
52432         type: array
52433         items:
52434           $ref: "#/getDefinitions/vlan"
52435       sriov-vfs:
52436         type: array
52437         items:
52438           $ref: "#/getDefinitions/sriov-vf"
52439       relationship-list:
52440         type: array
52441         items:
52442           $ref: "#/getDefinitions/relationship"
52443       l3-interface-ipv4-address-list:
52444         type: array
52445         items:
52446           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
52447       l3-interface-ipv6-address-list:
52448         type: array
52449         items:
52450           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
52451   l-interfaces:
52452     description: |
52453       Collection of logical interfaces.
52454     properties:
52455       l-interface:
52456         type: array
52457         items:
52458           $ref: "#/getDefinitions/l-interface"
52459   l3-interface-ipv4-address-list:
52460     description: |
52461       IPv4 Address Range
52462       ###### Related Nodes
52463       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52464       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
52465       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
52466       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
52467
52468       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
52469     required:
52470     - l3-interface-ipv4-address
52471     properties:
52472       l3-interface-ipv4-address:
52473         type: string
52474         description: IP address
52475       l3-interface-ipv4-prefix-length:
52476         type: integer
52477         format: int64
52478         description: Prefix length, 32 for single address
52479       vlan-id-inner:
52480         type: integer
52481         format: int64
52482         description: Inner VLAN tag
52483       vlan-id-outer:
52484         type: integer
52485         format: int64
52486         description: Outer VLAN tag
52487       is-floating:
52488         type: boolean
52489         description: Indicator of fixed or floating address
52490       resource-version:
52491         type: string
52492         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52493       neutron-network-id:
52494         type: string
52495         description: Neutron network id of the interface that address belongs to
52496       neutron-subnet-id:
52497         type: string
52498         description: Neutron id of subnet that address belongs to
52499       relationship-list:
52500         type: array
52501         items:
52502           $ref: "#/getDefinitions/relationship"
52503   l3-interface-ipv6-address-list:
52504     description: |
52505       IPv6 Address Range
52506       ###### Related Nodes
52507       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52508       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
52509       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
52510       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
52511
52512       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
52513     required:
52514     - l3-interface-ipv6-address
52515     properties:
52516       l3-interface-ipv6-address:
52517         type: string
52518         description: IP address
52519       l3-interface-ipv6-prefix-length:
52520         type: integer
52521         format: int64
52522         description: Prefix length, 128 for single address
52523       vlan-id-inner:
52524         type: integer
52525         format: int64
52526         description: Inner VLAN tag
52527       vlan-id-outer:
52528         type: integer
52529         format: int64
52530         description: Outer VLAN tag
52531       is-floating:
52532         type: boolean
52533         description: Indicator of fixed or floating address
52534       resource-version:
52535         type: string
52536         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52537       neutron-network-id:
52538         type: string
52539         description: Neutron network id of the interface that address belongs to
52540       neutron-subnet-id:
52541         type: string
52542         description: Neutron id of subnet that address belongs to
52543       relationship-list:
52544         type: array
52545         items:
52546           $ref: "#/getDefinitions/relationship"
52547   l3-network:
52548     description: |
52549       Generic network definition
52550       ###### Related Nodes
52551       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
52552       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
52553       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
52554       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
52555       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
52556       - FROM complex( complex Uses l3-network, MANY2MANY)
52557       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
52558       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52559       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52560       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
52561       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
52562       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
52563       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
52564       - FROM tenant( tenant Uses l3-network, MANY2MANY)
52565       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
52566
52567       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
52568     required:
52569     - network-id
52570     - network-name
52571     - is-bound-to-vpn
52572     - is-provider-network
52573     - is-shared-network
52574     - is-external-network
52575     properties:
52576       network-id:
52577         type: string
52578         description: Network ID, should be uuid. Unique across A&AI.
52579       network-name:
52580         type: string
52581         description: Name of the network, governed by some naming convention..
52582       network-type:
52583         type: string
52584         description: Type of the network - who defines these values?
52585       network-role:
52586         type: string
52587         description: Role the network plans - who defines these values?
52588       network-technology:
52589         type: string
52590         description: Network technology - who defines these values?
52591       neutron-network-id:
52592         type: string
52593         description: Neutron network id of this Interface
52594       is-bound-to-vpn:
52595         type: boolean
52596         description: Set to true if bound to VPN
52597       service-id:
52598         type: string
52599         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
52600       network-role-instance:
52601         type: integer
52602         format: int64
52603         description: network role instance
52604       resource-version:
52605         type: string
52606         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52607       orchestration-status:
52608         type: string
52609         description: Orchestration status of this VNF, mastered by MSO
52610       heat-stack-id:
52611         type: string
52612         description: Heat stack id corresponding to this instance, managed by MSO
52613       mso-catalog-key:
52614         type: string
52615         description: Corresponds to the SDN-C catalog id used to configure this VCE
52616       contrail-network-fqdn:
52617         type: string
52618         description: Contrail FQDN for the network
52619       persona-model-id:
52620         type: string
52621         description: the ASDC model id for this resource or service model.
52622       persona-model-version:
52623         type: string
52624         description: the ASDC model version for this resource or service model.
52625       model-version-id:
52626         type: string
52627         description: the ASDC model version for this resource or service model.
52628       persona-model-customization-id:
52629         type: string
52630         description: captures the id of all the configuration used to customize the resource for the service.
52631       widget-model-id:
52632         type: string
52633         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52634       widget-model-version:
52635         type: string
52636         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52637       physical-network-name:
52638         type: string
52639         description: Name associated with the physical network.
52640       is-provider-network:
52641         type: boolean
52642         description: boolean indicatating whether or not network is a provider network.
52643       is-shared-network:
52644         type: boolean
52645         description: boolean indicatating whether or not network is a shared network.
52646       is-external-network:
52647         type: boolean
52648         description: boolean indicatating whether or not network is an external network.
52649       selflink:
52650         type: string
52651         description: Path to the controller object.
52652       subnets:
52653         type: array
52654         items:
52655           $ref: "#/getDefinitions/subnet"
52656       ctag-assignments:
52657         type: array
52658         items:
52659           $ref: "#/getDefinitions/ctag-assignment"
52660       segmentation-assignments:
52661         type: array
52662         items:
52663           $ref: "#/getDefinitions/segmentation-assignment"
52664       relationship-list:
52665         type: array
52666         items:
52667           $ref: "#/getDefinitions/relationship"
52668         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
52669   l3-networks:
52670     properties:
52671       l3-network:
52672         type: array
52673         items:
52674           $ref: "#/getDefinitions/l3-network"
52675   lag-interface:
52676     description: |
52677       Link aggregate interface
52678       ###### Related Nodes
52679       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
52680       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
52681       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
52682       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
52683       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
52684       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
52685       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
52686
52687       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
52688       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
52689       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
52690     required:
52691     - interface-name
52692     properties:
52693       interface-name:
52694         type: string
52695         description: Name that identifies the link aggregate interface
52696       interface-description:
52697         type: string
52698         description: Human friendly text regarding this interface.
52699       resource-version:
52700         type: string
52701         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52702       speed-value:
52703         type: string
52704         description: Captures the numeric part of the speed
52705       speed-units:
52706         type: string
52707         description: Captures the units corresponding to the speed
52708       interface-id:
52709         type: string
52710         description: ID of interface
52711       interface-role:
52712         type: string
52713         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
52714       prov-status:
52715         type: string
52716         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52717       relationship-list:
52718         type: array
52719         items:
52720           $ref: "#/getDefinitions/relationship"
52721       l-interfaces:
52722         type: array
52723         items:
52724           $ref: "#/getDefinitions/l-interface"
52725   lag-interfaces:
52726     description: |
52727       Collection of link aggregate interfaces.
52728     properties:
52729       lag-interface:
52730         type: array
52731         items:
52732           $ref: "#/getDefinitions/lag-interface"
52733   lag-link:
52734     description: |
52735       LAG links can connect lag-interfaces
52736       ###### Related Nodes
52737       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
52738       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
52739
52740       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
52741     required:
52742     - link-name
52743     properties:
52744       link-name:
52745         type: string
52746         description: Alphabetical concatenation of lag-interface names
52747       resource-version:
52748         type: string
52749         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52750       relationship-list:
52751         type: array
52752         items:
52753           $ref: "#/getDefinitions/relationship"
52754   lag-links:
52755     description: |
52756       Collection of link aggregation connections
52757     properties:
52758       lag-link:
52759         type: array
52760         items:
52761           $ref: "#/getDefinitions/lag-link"
52762   license:
52763     description: |
52764       Metadata for license group.
52765       ###### Related Nodes
52766       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
52767       - TO vce( license BelongsTo vce, MANY2ONE)(4)
52768
52769       -(4) IF this TO node is deleted, this LICENSE is DELETED also
52770     required:
52771     - group-uuid
52772     - resource-uuid
52773     properties:
52774       group-uuid:
52775         type: string
52776         description: Unique ID for the license group the resource belongs to, should be uuid.
52777       resource-uuid:
52778         type: string
52779         description: Unique ID of a license resource.
52780       resource-version:
52781         type: string
52782         description: Concurrency value
52783       relationship-list:
52784         type: array
52785         items:
52786           $ref: "#/getDefinitions/relationship"
52787   licenses:
52788     description: |
52789       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
52790     properties:
52791       license:
52792         type: array
52793         items:
52794           $ref: "#/getDefinitions/license"
52795   line-of-business:
52796     description: |
52797       describes a line-of-business
52798       ###### Related Nodes
52799       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
52800
52801     required:
52802     - line-of-business-name
52803     properties:
52804       line-of-business-name:
52805         type: string
52806         description: Name of the line-of-business (product)
52807       resource-version:
52808         type: string
52809         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52810       relationship-list:
52811         type: array
52812         items:
52813           $ref: "#/getDefinitions/relationship"
52814   lines-of-business:
52815     description: |
52816       Collection of lines-of-business
52817     properties:
52818       line-of-business:
52819         type: array
52820         items:
52821           $ref: "#/getDefinitions/line-of-business"
52822   logical-link:
52823     description: |
52824       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
52825       ###### Related Nodes
52826       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
52827       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
52828       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
52829       - TO logical-link( logical-link Uses logical-link, ONE2MANY)
52830       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
52831       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
52832       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
52833       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
52834       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
52835       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
52836       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
52837       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
52838       - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
52839
52840       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
52841     required:
52842     - link-name
52843     - link-type
52844     properties:
52845       link-name:
52846         type: string
52847         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
52848       link-type:
52849         type: string
52850         description: Type of logical link, e.g., evc
52851       speed-value:
52852         type: string
52853         description: Captures the numeric part of the speed
52854       speed-units:
52855         type: string
52856         description: Captures the units corresponding to the speed
52857       ip-version:
52858         type: string
52859         description: v4, v6, or ds for dual stack
52860       routing-protocol:
52861         type: string
52862         description: For example, static or BGP
52863       resource-version:
52864         type: string
52865         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52866       persona-model-id:
52867         type: string
52868         description: the ASDC model id for this resource or service model.
52869       persona-model-version:
52870         type: string
52871         description: the ASDC model version for this resource or service model.
52872       model-version-id:
52873         type: string
52874         description: the ASDC model version for this resource or service model.
52875       widget-model-id:
52876         type: string
52877         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52878       widget-model-version:
52879         type: string
52880         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52881       operational-status:
52882         type: string
52883         description: Indication of operational status of the logical link.
52884       prov-status:
52885         type: string
52886         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52887       link-role:
52888         type: string
52889         description: Indication of the network use of the logical link.
52890       link-name2:
52891         type: string
52892         description: Alias or alternate name (CLCI or D1 name).
52893       link-id:
52894         type: string
52895         description: UUID of the logical-link, SDNC generates this.
52896       circuit-id:
52897         type: string
52898         description: Circuit id
52899       purpose:
52900         type: string
52901         description: Reason for this entity, role it is playing
52902       relationship-list:
52903         type: array
52904         items:
52905           $ref: "#/getDefinitions/relationship"
52906   logical-links:
52907     description: |
52908       Collection of logical connections
52909     properties:
52910       logical-link:
52911         type: array
52912         items:
52913           $ref: "#/getDefinitions/logical-link"
52914   metadata:
52915     description: |
52916       Collection of metadatum (key/value pairs)
52917     properties:
52918       metadatum:
52919         type: array
52920         items:
52921           $ref: "#/getDefinitions/metadatum"
52922   metadatum:
52923     description: |
52924       Key/value pairs
52925       ###### Related Nodes
52926       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
52927       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
52928       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
52929       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
52930
52931       -(4) IF this TO node is deleted, this METADATUM is DELETED also
52932     required:
52933     - metaname
52934     - metaval
52935     properties:
52936       metaname:
52937         type: string
52938       metaval:
52939         type: string
52940       resource-version:
52941         type: string
52942         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52943   model:
52944     description: |
52945       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
52946       ###### Related Nodes
52947       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
52948       - FROM instance-group( instance-group Targets model, MANY2MANY)
52949       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
52950       - FROM named-query( named-query AppliesTo model, ONE2MANY)
52951       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
52952
52953       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
52954       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
52955
52956     required:
52957     - model-invariant-id
52958     - model-type
52959     properties:
52960       model-invariant-id:
52961         type: string
52962         description: Unique identifier corresponding to the main definition of a model in ASDC
52963       model-type:
52964         type: string
52965         description: Type of the model, e.g., service, resource, widget, etc.
52966       resource-version:
52967         type: string
52968         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52969       model-vers:
52970         type: array
52971         items:
52972           $ref: "#/getDefinitions/model-ver"
52973       relationship-list:
52974         type: array
52975         items:
52976           $ref: "#/getDefinitions/relationship"
52977   model-and-named-query-search:
52978     description: |
52979       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
52980     properties:
52981       query-parameters:
52982         type: object
52983         $ref: "#/getDefinitions/query-parameters"
52984       instance-filters:
52985         type: object
52986         $ref: "#/getDefinitions/instance-filters"
52987       secondary-filts:
52988         type: object
52989         $ref: "#/getDefinitions/secondary-filts"
52990       top-node-type:
52991         type: string
52992       secondary-filter-cut-point:
52993         type: string
52994   model-constraint:
52995     description: |
52996       This is how we would capture constraints defining allowed sets of elements.
52997       ###### Related Nodes
52998       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
52999       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
53000
53001       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
53002       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
53003     required:
53004     - model-constraint-uuid
53005     - constrained-element-set-uuid-to-replace
53006     properties:
53007       model-constraint-uuid:
53008         type: string
53009       constrained-element-set-uuid-to-replace:
53010         type: string
53011       constrained-element-sets:
53012         type: array
53013         items:
53014           $ref: "#/getDefinitions/constrained-element-set"
53015       resource-version:
53016         type: string
53017         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53018   model-constraints:
53019     properties:
53020       model-constraint:
53021         type: array
53022         items:
53023           $ref: "#/getDefinitions/model-constraint"
53024   model-element:
53025     description: |
53026       Defines how other models combine to make up a higher-level model.
53027       ###### Related Nodes
53028       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
53029       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
53030       - TO model-ver( model-element IsA model-ver, MANY2ONE)
53031       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
53032       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
53033       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
53034       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
53035
53036       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
53037       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
53038     required:
53039     - model-element-uuid
53040     - new-data-del-flag
53041     - cardinality
53042     properties:
53043       model-element-uuid:
53044         type: string
53045       new-data-del-flag:
53046         type: string
53047         description: Indicates whether this element was created as part of instantiation from this model
53048       cardinality:
53049         type: string
53050         description: How many of this type of element are required/allowed
53051       linkage-points:
53052         type: string
53053       resource-version:
53054         type: string
53055         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53056       model-elements:
53057         type: array
53058         items:
53059           $ref: "#/getDefinitions/model-element"
53060         description: Defines how other models combine to make up a higher-level model
53061       model-constraints:
53062         type: array
53063         items:
53064           $ref: "#/getDefinitions/model-constraint"
53065         description: Describes new constraints on this model element that are not part of that model's definition
53066       relationship-list:
53067         type: array
53068         items:
53069           $ref: "#/getDefinitions/relationship"
53070   model-elements:
53071     properties:
53072       model-element:
53073         type: array
53074         items:
53075           $ref: "#/getDefinitions/model-element"
53076   model-ver:
53077     description: |
53078       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
53079       ###### Related Nodes
53080       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
53081       - FROM model-element( model-element IsA model-ver, MANY2ONE)
53082       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
53083       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
53084
53085       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
53086       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
53087       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
53088
53089     required:
53090     - model-version-id
53091     - model-name
53092     - model-version
53093     properties:
53094       model-version-id:
53095         type: string
53096         description: Unique identifier corresponding to one version of a model in ASDC
53097       model-name:
53098         type: string
53099         description: Name of the model, which can change from version to version.
53100       model-version:
53101         type: string
53102         description: Version
53103       model-description:
53104         type: string
53105         description: Description
53106       resource-version:
53107         type: string
53108         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53109       model-elements:
53110         type: array
53111         items:
53112           $ref: "#/getDefinitions/model-element"
53113       metadata:
53114         type: array
53115         items:
53116           $ref: "#/getDefinitions/metadatum"
53117       relationship-list:
53118         type: array
53119         items:
53120           $ref: "#/getDefinitions/relationship"
53121   model-vers:
53122     properties:
53123       model-ver:
53124         type: array
53125         items:
53126           $ref: "#/getDefinitions/model-ver"
53127   models:
53128     description: |
53129       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
53130     properties:
53131       model:
53132         type: array
53133         items:
53134           $ref: "#/getDefinitions/model"
53135   multicast-configuration:
53136     description: |
53137       ###### Related Nodes
53138       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
53139
53140     required:
53141     - multicast-configuration-id
53142     - multicast-protocol
53143     - rp-type
53144     properties:
53145       multicast-configuration-id:
53146         type: string
53147         description: Unique id of multicast configuration.
53148       multicast-protocol:
53149         type: string
53150         description: protocol of multicast configuration
53151       rp-type:
53152         type: string
53153         description: rp type of multicast configuration
53154       resource-version:
53155         type: string
53156         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53157       relationship-list:
53158         type: array
53159         items:
53160           $ref: "#/getDefinitions/relationship"
53161   multicast-configurations:
53162     description: |
53163       multicast configuration of generic-vnf ip-address
53164     properties:
53165       multicast-configuration:
53166         type: array
53167         items:
53168           $ref: "#/getDefinitions/multicast-configuration"
53169   named-queries:
53170     properties:
53171       named-query:
53172         type: array
53173         items:
53174           $ref: "#/getDefinitions/named-query"
53175   named-query:
53176     description: |
53177       TBD
53178       ###### Related Nodes
53179       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
53180       - TO model( named-query AppliesTo model, ONE2MANY)
53181       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
53182
53183       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
53184     required:
53185     - named-query-uuid
53186     - named-query-name
53187     - named-query-version
53188     properties:
53189       named-query-uuid:
53190         type: string
53191       named-query-name:
53192         type: string
53193       named-query-version:
53194         type: string
53195       required-input-param:
53196         type: string
53197       description:
53198         type: string
53199       resource-version:
53200         type: string
53201       named-query-elements:
53202         type: array
53203         items:
53204           $ref: "#/getDefinitions/named-query-element"
53205       relationship-list:
53206         type: array
53207         items:
53208           $ref: "#/getDefinitions/relationship"
53209   named-query-element:
53210     description: |
53211       TBD
53212       ###### Related Nodes
53213       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
53214       - TO model( named-query-element IsA model, MANY2ONE)
53215       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
53216       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
53217       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
53218       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
53219
53220       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
53221       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
53222     required:
53223     - named-query-element-uuid
53224     properties:
53225       named-query-element-uuid:
53226         type: string
53227       property-collect-list:
53228         type: string
53229       resource-version:
53230         type: string
53231       property-limit-desc:
53232         type: string
53233       do-not-output:
53234         type: string
53235       named-query-elements:
53236         type: array
53237         items:
53238           $ref: "#/getDefinitions/named-query-element"
53239       related-lookups:
53240         type: array
53241         items:
53242           $ref: "#/getDefinitions/related-lookup"
53243       property-constraints:
53244         type: array
53245         items:
53246           $ref: "#/getDefinitions/property-constraint"
53247       relationship-list:
53248         type: array
53249         items:
53250           $ref: "#/getDefinitions/relationship"
53251   named-query-elements:
53252     properties:
53253       named-query-element:
53254         type: array
53255         items:
53256           $ref: "#/getDefinitions/named-query-element"
53257   network:
53258     description: |
53259       Namespace for network inventory resources.
53260     properties:
53261       logical-links:
53262         type: array
53263         items:
53264           $ref: "#/getDefinitions/logical-link"
53265       site-pair-sets:
53266         type: array
53267         items:
53268           $ref: "#/getDefinitions/site-pair-set"
53269       vpn-bindings:
53270         type: array
53271         items:
53272           $ref: "#/getDefinitions/vpn-binding"
53273       vpls-pes:
53274         type: array
53275         items:
53276           $ref: "#/getDefinitions/vpls-pe"
53277       multicast-configurations:
53278         type: array
53279         items:
53280           $ref: "#/getDefinitions/multicast-configuration"
53281       vces:
53282         type: array
53283         items:
53284           $ref: "#/getDefinitions/vce"
53285       vnfcs:
53286         type: array
53287         items:
53288           $ref: "#/getDefinitions/vnfc"
53289       l3-networks:
53290         type: array
53291         items:
53292           $ref: "#/getDefinitions/l3-network"
53293       network-policies:
53294         type: array
53295         items:
53296           $ref: "#/getDefinitions/network-policy"
53297       generic-vnfs:
53298         type: array
53299         items:
53300           $ref: "#/getDefinitions/generic-vnf"
53301       lag-links:
53302         type: array
53303         items:
53304           $ref: "#/getDefinitions/lag-link"
53305       newvces:
53306         type: array
53307         items:
53308           $ref: "#/getDefinitions/newvce"
53309       pnfs:
53310         type: array
53311         items:
53312           $ref: "#/getDefinitions/pnf"
53313       physical-links:
53314         type: array
53315         items:
53316           $ref: "#/getDefinitions/physical-link"
53317       ipsec-configurations:
53318         type: array
53319         items:
53320           $ref: "#/getDefinitions/ipsec-configuration"
53321       route-table-references:
53322         type: array
53323         items:
53324           $ref: "#/getDefinitions/route-table-reference"
53325       instance-groups:
53326         type: array
53327         items:
53328           $ref: "#/getDefinitions/instance-group"
53329       zones:
53330         type: array
53331         items:
53332           $ref: "#/getDefinitions/zone"
53333   network-policies:
53334     properties:
53335       network-policy:
53336         type: array
53337         items:
53338           $ref: "#/getDefinitions/network-policy"
53339   network-policy:
53340     description: |
53341       ###### Related Nodes
53342       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
53343
53344     required:
53345     - network-policy-id
53346     properties:
53347       network-policy-id:
53348         type: string
53349         description: UUID representing unique key to this instance
53350       network-policy-fqdn:
53351         type: string
53352         description: Contrail FQDN for the policy
53353       heat-stack-id:
53354         type: string
53355         description: ID for the openStack Heat instance
53356       resource-version:
53357         type: string
53358         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53359       relationship-list:
53360         type: array
53361         items:
53362           $ref: "#/getDefinitions/relationship"
53363   network-profile:
53364     description: |
53365       Network profile populated by SDN-GP for SNMP
53366       ###### Related Nodes
53367       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
53368
53369     required:
53370     - nm-profile-name
53371     properties:
53372       nm-profile-name:
53373         type: string
53374         description: Unique name of network profile.
53375       community-string:
53376         type: string
53377         description: Encrypted SNMP community string
53378       resource-version:
53379         type: string
53380         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53381       relationship-list:
53382         type: array
53383         items:
53384           $ref: "#/getDefinitions/relationship"
53385   network-profiles:
53386     description: |
53387       Collection of network profiles
53388     properties:
53389       network-profile:
53390         type: array
53391         items:
53392           $ref: "#/getDefinitions/network-profile"
53393   newvce:
53394     description: |
53395       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
53396       ###### Related Nodes
53397       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
53398
53399       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
53400     required:
53401     - vnf-id2
53402     - vnf-name
53403     - vnf-type
53404     properties:
53405       vnf-id2:
53406         type: string
53407         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
53408       vnf-name:
53409         type: string
53410         description: Name of VNF.
53411       vnf-name2:
53412         type: string
53413         description: Alternate name of VNF.
53414       vnf-type:
53415         type: string
53416         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.
53417       prov-status:
53418         type: string
53419         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
53420       operational-state:
53421         type: string
53422         description: Indicator for whether the resource is considered operational
53423       license-key:
53424         type: string
53425         description: OBSOLETE -  do not use
53426       ipv4-oam-address:
53427         type: string
53428         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
53429       equipment-role:
53430         type: string
53431         description: Client should send valid enumerated value.
53432       resource-version:
53433         type: string
53434         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53435       ipv4-loopback0-address:
53436         type: string
53437         description: v4 Loopback0 address
53438       orchestration-status:
53439         type: string
53440         description: Orchestration status of this VNF, mastered by MSO.
53441       heat-stack-id:
53442         type: string
53443         description: Heat stack id corresponding to this instance, managed by MSO
53444       mso-catalog-key:
53445         type: string
53446         description: Corresponds to the SDN-C catalog id used to configure this VCE
53447       relationship-list:
53448         type: array
53449         items:
53450           $ref: "#/getDefinitions/relationship"
53451       l-interfaces:
53452         type: array
53453         items:
53454           $ref: "#/getDefinitions/l-interface"
53455   newvces:
53456     description: |
53457       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
53458     properties:
53459       newvce:
53460         type: array
53461         items:
53462           $ref: "#/getDefinitions/newvce"
53463   nodes:
53464     properties:
53465       inventory-item-data:
53466         type: array
53467         items:
53468           $ref: "#/getDefinitions/inventory-item-data"
53469   notification-event:
53470     properties:
53471       cambria.partition:
53472         type: string
53473       notification-event-header:
53474         type: object
53475         $ref: "#/getDefinitions/notification-event-header"
53476   notification-event-header:
53477     properties:
53478       id:
53479         type: string
53480       timestamp:
53481         type: string
53482       source-name:
53483         type: string
53484       domain:
53485         type: string
53486       sequence-number:
53487         type: string
53488       severity:
53489         type: string
53490       event-type:
53491         type: string
53492       version:
53493         type: string
53494       action:
53495         type: string
53496       entity-type:
53497         type: string
53498       top-entity-type:
53499         type: string
53500       entity-link:
53501         type: string
53502       status:
53503         type: string
53504   notify:
53505     required:
53506     - event-id
53507     properties:
53508       event-id:
53509         type: string
53510       node-type:
53511         type: string
53512       event-trigger:
53513         type: string
53514       key-data:
53515         type: array
53516         items:
53517           $ref: "#/getDefinitions/key-data"
53518       selflink:
53519         type: string
53520   oam-network:
53521     description: |
53522       OAM network, to be deprecated shortly.  Do not use for new purposes.
53523       ###### Related Nodes
53524       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
53525       - TO complex( oam-network AppliesTo complex, MANY2MANY)
53526       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
53527
53528     required:
53529     - network-uuid
53530     - network-name
53531     - cvlan-tag
53532     properties:
53533       network-uuid:
53534         type: string
53535         description: UUID of the network. Unique across a cloud-region
53536       network-name:
53537         type: string
53538         description: Name of the network.
53539       cvlan-tag:
53540         type: integer
53541         format: int64
53542         description: cvlan-id
53543       ipv4-oam-gateway-address:
53544         type: string
53545         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
53546       ipv4-oam-gateway-address-prefix-length:
53547         type: integer
53548         format: int32
53549         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
53550       resource-version:
53551         type: string
53552         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53553       relationship-list:
53554         type: array
53555         items:
53556           $ref: "#/getDefinitions/relationship"
53557   oam-networks:
53558     description: |
53559       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
53560     properties:
53561       oam-network:
53562         type: array
53563         items:
53564           $ref: "#/getDefinitions/oam-network"
53565   operational-environment:
53566     description: |
53567       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
53568       ###### Related Nodes
53569       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
53570       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
53571
53572     required:
53573     - operational-environment-id
53574     - operational-environment-name
53575     - operational-environment-type
53576     - operational-environment-status
53577     - tenant-context
53578     - workload-context
53579     properties:
53580       operational-environment-id:
53581         type: string
53582         description: UUID of an operational environment
53583       operational-environment-name:
53584         type: string
53585         description: Operational Environment name
53586       operational-environment-type:
53587         type: string
53588         description: Operational Environment Type.
53589       operational-environment-status:
53590         type: string
53591         description: Status
53592       tenant-context:
53593         type: string
53594         description: Tenant Context.
53595       workload-context:
53596         type: string
53597         description: Workload Context.
53598       resource-version:
53599         type: string
53600         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53601       relationship-list:
53602         type: array
53603         items:
53604           $ref: "#/getDefinitions/relationship"
53605   operational-environments:
53606     description: |
53607       a logical partition of the cloud which allows to have multiple environments in the production AIC.
53608     properties:
53609       operational-environment:
53610         type: array
53611         items:
53612           $ref: "#/getDefinitions/operational-environment"
53613   overloaded-model:
53614     description: |
53615       Allows for legacy POST of old-style and new-style models
53616     required:
53617     - model-invariant-id
53618     - model-name-version-id
53619     - model-type
53620     - model-name
53621     - model-id
53622     - model-version
53623     properties:
53624       model-invariant-id:
53625         type: string
53626         description: Unique identifier corresponding to the main definition of a model in ASDC
53627       model-name-version-id:
53628         type: string
53629         description: Unique identifier corresponding to one version of a model in ASDC
53630       model-type:
53631         type: string
53632         description: Type of the model, e.g., service, resource, widget, etc.
53633       model-name:
53634         type: string
53635         description: Name of the model, which can change from version to version.
53636       model-id:
53637         type: string
53638         description: Invariant unique ID which does not change from version to version
53639       model-version:
53640         type: string
53641         description: Version
53642       model-description:
53643         type: string
53644         description: Description
53645       resource-version:
53646         type: string
53647         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53648       model-vers:
53649         type: object
53650         $ref: "#/getDefinitions/model-vers"
53651       relationship-list:
53652         type: object
53653         $ref: "#/getDefinitions/relationship-list"
53654   owning-entities:
53655     description: |
53656       Collection of owning-entities
53657     properties:
53658       owning-entity:
53659         type: array
53660         items:
53661           $ref: "#/getDefinitions/owning-entity"
53662   owning-entity:
53663     description: |
53664       describes an owning-entity
53665       ###### Related Nodes
53666       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
53667
53668     required:
53669     - owning-entity-id
53670     - owning-entity-name
53671     properties:
53672       owning-entity-id:
53673         type: string
53674         description: UUID of an owning entity
53675       owning-entity-name:
53676         type: string
53677         description: Owning entity name
53678       resource-version:
53679         type: string
53680         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53681       relationship-list:
53682         type: array
53683         items:
53684           $ref: "#/getDefinitions/relationship"
53685   p-interface:
53686     description: |
53687       Physical interface (e.g., nic)
53688       ###### Related Nodes
53689       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
53690       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
53691       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
53692       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
53693       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
53694       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
53695       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
53696
53697       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
53698       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
53699       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
53700     required:
53701     - interface-name
53702     properties:
53703       interface-name:
53704         type: string
53705         description: Name that identifies the physical interface
53706       speed-value:
53707         type: string
53708         description: Captures the numeric part of the speed
53709       speed-units:
53710         type: string
53711         description: Captures the units corresponding to the speed
53712       port-description:
53713         type: string
53714         description: Nature of the services and connectivity on this port.
53715       equipment-identifier:
53716         type: string
53717         description: CLEI or other specification for p-interface hardware.
53718       interface-role:
53719         type: string
53720         description: Role specification for p-interface hardware.
53721       interface-type:
53722         type: string
53723         description: Indicates the physical properties of the interface.
53724       prov-status:
53725         type: string
53726         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53727       resource-version:
53728         type: string
53729         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53730       relationship-list:
53731         type: array
53732         items:
53733           $ref: "#/getDefinitions/relationship"
53734       l-interfaces:
53735         type: array
53736         items:
53737           $ref: "#/getDefinitions/l-interface"
53738   p-interfaces:
53739     description: |
53740       Collection of physical interfaces.
53741     properties:
53742       p-interface:
53743         type: array
53744         items:
53745           $ref: "#/getDefinitions/p-interface"
53746   physical-link:
53747     description: |
53748       Collection of physical connections, typically between p-interfaces
53749       ###### Related Nodes
53750       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
53751
53752       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
53753     required:
53754     - link-name
53755     properties:
53756       link-name:
53757         type: string
53758         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
53759       speed-value:
53760         type: string
53761         description: Captures the numeric part of the speed
53762       speed-units:
53763         type: string
53764         description: Captures the units corresponding to the speed
53765       circuit-id:
53766         type: string
53767         description: Circuit it
53768       dual-mode:
53769         type: string
53770         description: Dual access mode (e.g., primary, secondary
53771       management-option:
53772         type: string
53773         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
53774       service-provider-name:
53775         type: string
53776         description: Name of the service Provider on this link.
53777       resource-version:
53778         type: string
53779         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53780       relationship-list:
53781         type: array
53782         items:
53783           $ref: "#/getDefinitions/relationship"
53784   physical-links:
53785     description: |
53786       Collection of physical connections, typically between p-interfaces
53787     properties:
53788       physical-link:
53789         type: array
53790         items:
53791           $ref: "#/getDefinitions/physical-link"
53792   platform:
53793     description: |
53794       describes a platform
53795       ###### Related Nodes
53796       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
53797
53798     required:
53799     - platform-name
53800     properties:
53801       platform-name:
53802         type: string
53803         description: Name of the platform
53804       resource-version:
53805         type: string
53806         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53807       relationship-list:
53808         type: array
53809         items:
53810           $ref: "#/getDefinitions/relationship"
53811   platforms:
53812     description: |
53813       Collection of platforms
53814     properties:
53815       platform:
53816         type: array
53817         items:
53818           $ref: "#/getDefinitions/platform"
53819   pnf:
53820     description: |
53821       PNF represents a physical network function. typically equipment used in the D1 world.
53822       ###### Related Nodes
53823       - TO complex( pnf LocatedIn complex, MANY2ONE)
53824       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
53825       - TO zone( pnf LocatedIn zone, MANY2ONE)
53826       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
53827       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
53828       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
53829       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
53830
53831       -(1) IF this PNF node is deleted, this FROM node is DELETED also
53832     required:
53833     - pnf-name
53834     - in-maint
53835     properties:
53836       pnf-name:
53837         type: string
53838         description: unique name of Physical Network Function.
53839       pnf-name2:
53840         type: string
53841         description: name of Physical Network Function.
53842       pnf-name2-source:
53843         type: string
53844         description: source of name2
53845       pnf-id:
53846         type: string
53847         description: id of pnf
53848       equip-type:
53849         type: string
53850         description: Equipment type.  Source of truth should define valid values.
53851       equip-vendor:
53852         type: string
53853         description: Equipment vendor.  Source of truth should define valid values.
53854       equip-model:
53855         type: string
53856         description: Equipment model.  Source of truth should define valid values.
53857       management-option:
53858         type: string
53859         description: identifier of managed by company or customer
53860       ipaddress-v4-oam:
53861         type: string
53862         description: ipv4-oam-address with new naming convention for IP addresses
53863       sw-version:
53864         type: string
53865         description: sw-version is the version of SW for the hosted application on the PNF.
53866       in-maint:
53867         type: boolean
53868         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.
53869       frame-id:
53870         type: string
53871         description: ID of the physical frame (relay rack) where pnf is installed.
53872       serial-number:
53873         type: string
53874         description: Serial number of the device
53875       ipaddress-v4-loopback-0:
53876         type: string
53877         description: IPV4 Loopback 0 address
53878       ipaddress-v6-loopback-0:
53879         type: string
53880         description: IPV6 Loopback 0 address
53881       ipaddress-v4-aim:
53882         type: string
53883         description: IPV4 AIM address
53884       ipaddress-v6-aim:
53885         type: string
53886         description: IPV6 AIM address
53887       ipaddress-v6-oam:
53888         type: string
53889         description: IPV6 OAM address
53890       inv-status:
53891         type: string
53892         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
53893       resource-version:
53894         type: string
53895         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53896       prov-status:
53897         type: string
53898         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
53899       nf-role:
53900         type: string
53901         description: Nf Role is the role performed by this instance in the network.
53902       relationship-list:
53903         type: array
53904         items:
53905           $ref: "#/getDefinitions/relationship"
53906       p-interfaces:
53907         type: array
53908         items:
53909           $ref: "#/getDefinitions/p-interface"
53910       lag-interfaces:
53911         type: array
53912         items:
53913           $ref: "#/getDefinitions/lag-interface"
53914   pnfs:
53915     description: |
53916       Collection of Physical Network Functions.
53917     properties:
53918       pnf:
53919         type: array
53920         items:
53921           $ref: "#/getDefinitions/pnf"
53922   port-group:
53923     description: |
53924       Used to capture the network interfaces of this VCE
53925       ###### Related Nodes
53926       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
53927       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
53928
53929       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
53930       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
53931     required:
53932     - interface-id
53933     - orchestration-status
53934     properties:
53935       interface-id:
53936         type: string
53937         description: Unique ID of the interface
53938       neutron-network-id:
53939         type: string
53940         description: Neutron network id of this Interface
53941       neutron-network-name:
53942         type: string
53943         description: Neutron network name of this Interface
53944       interface-role:
53945         type: string
53946         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
53947       resource-version:
53948         type: string
53949         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53950       port-group-id:
53951         type: string
53952         description: Unique ID for port group in vmware
53953       port-group-name:
53954         type: string
53955         description: Likely to duplicate value of neutron network name
53956       switch-name:
53957         type: string
53958         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
53959       orchestration-status:
53960         type: string
53961         description: Orchestration status of this VNF, mastered by MSO
53962       heat-stack-id:
53963         type: string
53964         description: Heat stack id corresponding to this instance, managed by MSO
53965       mso-catalog-key:
53966         type: string
53967         description: Corresponds to the SDN-C catalog id used to configure this VCE
53968       cvlan-tags:
53969         type: array
53970         items:
53971           $ref: "#/getDefinitions/cvlan-tag-entry"
53972       relationship-list:
53973         type: array
53974         items:
53975           $ref: "#/getDefinitions/relationship"
53976   port-groups:
53977     properties:
53978       port-group:
53979         type: array
53980         items:
53981           $ref: "#/getDefinitions/port-group"
53982   project:
53983     description: |
53984       describes the project
53985       ###### Related Nodes
53986       - TO service-instance( project Uses service-instance, ONE2MANY)
53987
53988     required:
53989     - project-name
53990     properties:
53991       project-name:
53992         type: string
53993         description: Name of the project deploying a service
53994       resource-version:
53995         type: string
53996         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53997       relationship-list:
53998         type: array
53999         items:
54000           $ref: "#/getDefinitions/relationship"
54001   projects:
54002     description: |
54003       Collection of projects
54004     properties:
54005       project:
54006         type: array
54007         items:
54008           $ref: "#/getDefinitions/project"
54009   properties:
54010     description: |
54011       Property holder for query properties or instance properties
54012     properties:
54013       property-name:
54014         type: string
54015       property-value:
54016         type: string
54017   property-constraint:
54018     description: |
54019       TBD
54020       ###### Related Nodes
54021       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
54022
54023       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
54024     required:
54025     - property-constraint-uuid
54026     - constraint-type
54027     - property-name
54028     - property-value
54029     properties:
54030       property-constraint-uuid:
54031         type: string
54032       constraint-type:
54033         type: string
54034       property-name:
54035         type: string
54036       property-value:
54037         type: string
54038       resource-version:
54039         type: string
54040   property-constraints:
54041     properties:
54042       property-constraint:
54043         type: array
54044         items:
54045           $ref: "#/getDefinitions/property-constraint"
54046   pserver:
54047     description: |
54048       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
54049       ###### Related Nodes
54050       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
54051       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
54052       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
54053       - TO complex( pserver LocatedIn complex, MANY2ONE)
54054       - TO zone( pserver LocatedIn zone, MANY2ONE)
54055       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
54056       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
54057       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
54058       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
54059       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
54060
54061       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
54062       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
54063
54064     required:
54065     - hostname
54066     - in-maint
54067     properties:
54068       hostname:
54069         type: string
54070         description: Value from executing hostname on the compute node.
54071       ptnii-equip-name:
54072         type: string
54073         description: PTNII name
54074       number-of-cpus:
54075         type: integer
54076         format: int32
54077         description: Number of cpus
54078       disk-in-gigabytes:
54079         type: integer
54080         format: int32
54081         description: Disk size, in GBs
54082       ram-in-megabytes:
54083         type: integer
54084         format: int32
54085         description: RAM size, in MBs
54086       equip-type:
54087         type: string
54088         description: Equipment type.  Source of truth should define valid values.
54089       equip-vendor:
54090         type: string
54091         description: Equipment vendor.  Source of truth should define valid values.
54092       equip-model:
54093         type: string
54094         description: Equipment model.  Source of truth should define valid values.
54095       fqdn:
54096         type: string
54097         description: Fully-qualified domain name
54098       pserver-selflink:
54099         type: string
54100         description: URL to endpoint where AAI can get more details
54101       ipv4-oam-address:
54102         type: string
54103         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
54104       serial-number:
54105         type: string
54106         description: Serial number, may be queried
54107       ipaddress-v4-loopback-0:
54108         type: string
54109         description: IPV4 Loopback 0 address
54110       ipaddress-v6-loopback-0:
54111         type: string
54112         description: IPV6 Loopback 0 address
54113       ipaddress-v4-aim:
54114         type: string
54115         description: IPV4 AIM address
54116       ipaddress-v6-aim:
54117         type: string
54118         description: IPV6 AIM address
54119       ipaddress-v6-oam:
54120         type: string
54121         description: IPV6 OAM address
54122       inv-status:
54123         type: string
54124         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
54125       pserver-id:
54126         type: string
54127         description: ID of Pserver
54128       internet-topology:
54129         type: string
54130         description: internet topology of Pserver
54131       in-maint:
54132         type: boolean
54133         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.
54134       resource-version:
54135         type: string
54136         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54137       pserver-name2:
54138         type: string
54139         description: alternative pserver name
54140       purpose:
54141         type: string
54142         description: purpose of pserver
54143       prov-status:
54144         type: string
54145         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
54146       relationship-list:
54147         type: array
54148         items:
54149           $ref: "#/getDefinitions/relationship"
54150       p-interfaces:
54151         type: array
54152         items:
54153           $ref: "#/getDefinitions/p-interface"
54154       lag-interfaces:
54155         type: array
54156         items:
54157           $ref: "#/getDefinitions/lag-interface"
54158   pservers:
54159     description: |
54160       Collection of compute hosts.
54161     properties:
54162       pserver:
54163         type: array
54164         items:
54165           $ref: "#/getDefinitions/pserver"
54166   query-parameters:
54167     description: |
54168       QueryParameters for performing a named-query or model query
54169     properties:
54170       named-query:
54171         type: object
54172         $ref: "#/getDefinitions/named-query"
54173       overloaded-model:
54174         type: object
54175         $ref: "#/getDefinitions/overloaded-model"
54176   related-lookup:
54177     description: |
54178       TBD
54179       ###### Related Nodes
54180       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
54181
54182       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
54183     required:
54184     - related-lookup-uuid
54185     - source-node-type
54186     - source-node-property
54187     - target-node-type
54188     - target-node-property
54189     properties:
54190       related-lookup-uuid:
54191         type: string
54192       source-node-type:
54193         type: string
54194       source-node-property:
54195         type: string
54196       target-node-type:
54197         type: string
54198       target-node-property:
54199         type: string
54200       property-collect-list:
54201         type: string
54202       resource-version:
54203         type: string
54204       relationship-list:
54205         type: array
54206         items:
54207           $ref: "#/getDefinitions/relationship"
54208   related-lookups:
54209     properties:
54210       related-lookup:
54211         type: array
54212         items:
54213           $ref: "#/getDefinitions/related-lookup"
54214   related-to-property:
54215     properties:
54216       property-key:
54217         type: string
54218         description: Key part of a key/value pair
54219       property-value:
54220         type: string
54221         description: Value part of a key/value pair
54222   relationship:
54223     properties:
54224       related-to:
54225         type: string
54226         description: A keyword provided by A&AI to indicate type of node.
54227       related-link:
54228         type: string
54229         description: URL to the object in A&AI.
54230       relationship-data:
54231         type: array
54232         items:
54233           $ref: "#/getDefinitions/relationship-data"
54234       related-to-property:
54235         type: array
54236         items:
54237           $ref: "#/getDefinitions/related-to-property"
54238   relationship-data:
54239     required:
54240     - relationship-key
54241     - relationship-value
54242     properties:
54243       relationship-key:
54244         type: string
54245         description: A keyword provided by A&AI to indicate an attribute.
54246       relationship-value:
54247         type: string
54248         description: Value of the attribute.
54249   relationship-list:
54250     properties:
54251       relationship:
54252         type: array
54253         items:
54254           $ref: "#/getDefinitions/relationship"
54255   reserved-prop-names:
54256     description: |
54257       Internal map to define some reserved properties of a vertex
54258     properties:
54259       last-mod-source-of-truth:
54260         type: string
54261       aai-node-type:
54262         type: string
54263       aai-created-ts:
54264         type: integer
54265         format: int64
54266       aai-unique-key:
54267         type: string
54268       aai-last-mod-ts:
54269         type: integer
54270         format: int64
54271       source-of-truth:
54272         type: string
54273       aai-uri:
54274         type: string
54275   response-list:
54276     description: |
54277       Response container for the results of a named-query or model query
54278     properties:
54279       inventory-response-items:
54280         type: object
54281         $ref: "#/getDefinitions/inventory-response-items"
54282   result-data:
54283     properties:
54284       resource-type:
54285         type: string
54286         description: The specific type of node in the A&AI graph
54287       resource-link:
54288         type: string
54289         description: The URL to the specific resource
54290   route-table-reference:
54291     description: |
54292       Openstack route table reference.
54293       ###### Related Nodes
54294       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
54295
54296     required:
54297     - route-table-reference-id
54298     - route-table-reference-fqdn
54299     properties:
54300       route-table-reference-id:
54301         type: string
54302         description: Route Table Reference id, UUID assigned to this instance.
54303       route-table-reference-fqdn:
54304         type: string
54305         description: FQDN entry in the route table.
54306       resource-version:
54307         type: string
54308         description: Concurrency value
54309       relationship-list:
54310         type: array
54311         items:
54312           $ref: "#/getDefinitions/relationship"
54313   route-table-references:
54314     description: |
54315       Collection of openstack route table references
54316     properties:
54317       route-table-reference:
54318         type: array
54319         items:
54320           $ref: "#/getDefinitions/route-table-reference"
54321   route-target:
54322     description: |
54323       Route target information
54324       ###### Related Nodes
54325       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
54326
54327       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
54328     required:
54329     - global-route-target
54330     - route-target-role
54331     properties:
54332       global-route-target:
54333         type: string
54334         description: Number used to identify an RT, globally unique in the network
54335       route-target-role:
54336         type: string
54337         description: Role assigned to this route target
54338       resource-version:
54339         type: string
54340         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54341       relationship-list:
54342         type: array
54343         items:
54344           $ref: "#/getDefinitions/relationship"
54345   route-targets:
54346     description: |
54347       Collection of route target information
54348     properties:
54349       route-target:
54350         type: array
54351         items:
54352           $ref: "#/getDefinitions/route-target"
54353   routing-instance:
54354     description: |
54355       ###### Related Nodes
54356       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
54357       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
54358
54359       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
54360       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
54361     required:
54362     - routing-instance-id
54363     properties:
54364       routing-instance-id:
54365         type: string
54366         description: Unique id of routing instance
54367       rpm-owner:
54368         type: string
54369         description: rpm owner
54370       resource-version:
54371         type: string
54372         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54373       site-pairs:
54374         type: array
54375         items:
54376           $ref: "#/getDefinitions/site-pair"
54377       relationship-list:
54378         type: array
54379         items:
54380           $ref: "#/getDefinitions/relationship"
54381   routing-instances:
54382     description: |
54383       set of probes related to generic-vnf routing instance
54384     properties:
54385       routing-instance:
54386         type: array
54387         items:
54388           $ref: "#/getDefinitions/routing-instance"
54389   sdn-zone-response:
54390     properties:
54391       oam-networks:
54392         type: object
54393         $ref: "#/getDefinitions/oam-networks"
54394       az-and-dvs-switches:
54395         type: array
54396         items:
54397           $ref: "#/getDefinitions/az-and-dvs-switches"
54398   search:
54399     properties:
54400       edge-tag-query-result:
54401         type: object
54402         $ref: "#/getDefinitions/edge-tag-query-result"
54403       edge-tag-query-request:
54404         type: object
54405         $ref: "#/getDefinitions/edge-tag-query-request"
54406       search-results:
54407         type: object
54408         $ref: "#/getDefinitions/search-results"
54409       sdn-zone-response:
54410         type: object
54411         $ref: "#/getDefinitions/sdn-zone-response"
54412   search-results:
54413     properties:
54414       result-data:
54415         type: array
54416         items:
54417           $ref: "#/getDefinitions/result-data"
54418   secondary-filt:
54419     description: |
54420       SecondaryFilt for performing a named-query or model query
54421   secondary-filter:
54422     properties:
54423       property-name:
54424         type: string
54425       filter-type:
54426         type: string
54427       property-value:
54428         type: string
54429   secondary-filts:
54430     description: |
54431       SecondaryFilts for performing a named-query or model query
54432     properties:
54433       secondary-filt:
54434         type: array
54435         items:
54436           $ref: "#/getDefinitions/secondary-filt"
54437   segmentation-assignment:
54438     description: |
54439       Openstack segmentation assignment.
54440       ###### Related Nodes
54441       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
54442
54443       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
54444     required:
54445     - segmentation-id
54446     properties:
54447       segmentation-id:
54448         type: string
54449         description: Route Table Reference id, UUID assigned to this instance.
54450       resource-version:
54451         type: string
54452         description: Concurrency value
54453       relationship-list:
54454         type: array
54455         items:
54456           $ref: "#/getDefinitions/relationship"
54457   segmentation-assignments:
54458     description: |
54459       Collection of openstack segmentation assignments
54460     properties:
54461       segmentation-assignment:
54462         type: array
54463         items:
54464           $ref: "#/getDefinitions/segmentation-assignment"
54465   service:
54466     description: |
54467       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
54468     required:
54469     - service-id
54470     - service-description
54471     properties:
54472       service-id:
54473         type: string
54474         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
54475       service-description:
54476         type: string
54477         description: Description of the service
54478       service-selflink:
54479         type: string
54480         description: URL to endpoint where AAI can get more details
54481       resource-version:
54482         type: string
54483         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54484       service-version:
54485         type: string
54486         description: service version
54487       relationship-list:
54488         type: array
54489         items:
54490           $ref: "#/getDefinitions/relationship"
54491   service-capabilities:
54492     description: |
54493       Collection of service capabilities.
54494     properties:
54495       service-capability:
54496         type: array
54497         items:
54498           $ref: "#/getDefinitions/service-capability"
54499   service-capability:
54500     description: |
54501       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
54502       ###### Related Nodes
54503       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
54504       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
54505
54506       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
54507
54508     required:
54509     - service-type
54510     - vnf-type
54511     properties:
54512       service-type:
54513         type: string
54514         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
54515       vnf-type:
54516         type: string
54517         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.
54518       resource-version:
54519         type: string
54520         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54521       relationship-list:
54522         type: array
54523         items:
54524           $ref: "#/getDefinitions/relationship"
54525   service-design-and-creation:
54526     description: |
54527       Namespace for objects managed by ASDC
54528     properties:
54529       vnf-images:
54530         type: array
54531         items:
54532           $ref: "#/getDefinitions/vnf-image"
54533       services:
54534         type: array
54535         items:
54536           $ref: "#/getDefinitions/service"
54537       service-capabilities:
54538         type: array
54539         items:
54540           $ref: "#/getDefinitions/service-capability"
54541       models:
54542         type: array
54543         items:
54544           $ref: "#/getDefinitions/model"
54545       named-queries:
54546         type: array
54547         items:
54548           $ref: "#/getDefinitions/named-query"
54549   service-instance:
54550     description: |
54551       Instance of a service
54552       ###### Related Nodes
54553       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
54554       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
54555       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
54556       - TO connector( service-instance Uses connector, MANY2MANY)
54557       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
54558       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
54559       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
54560       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
54561       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
54562       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
54563       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
54564       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
54565       - TO vce( service-instance ComposedOf vce, ONE2MANY)
54566       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
54567       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
54568       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
54569
54570       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
54571       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
54572       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
54573     required:
54574     - service-instance-id
54575     properties:
54576       service-instance-id:
54577         type: string
54578         description: Uniquely identifies this instance of a service
54579       service-instance-name:
54580         type: string
54581         description: This field will store a name assigned to the service-instance.
54582       persona-model-id:
54583         type: string
54584         description: the ASDC model id for this resource or service model.
54585       persona-model-version:
54586         type: string
54587         description: the ASDC model version for this resource or service model.
54588       model-version-id:
54589         type: string
54590         description: the ASDC model version for this resource or service model.
54591       widget-model-id:
54592         type: string
54593         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54594       widget-model-version:
54595         type: string
54596         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54597       bandwidth-total:
54598         type: string
54599         description: Indicates the total bandwidth to be used for this service.
54600       bandwidth-up-wan1:
54601         type: string
54602         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
54603       bandwidth-down-wan1:
54604         type: string
54605         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
54606       bandwidth-up-wan2:
54607         type: string
54608         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
54609       bandwidth-down-wan2:
54610         type: string
54611         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
54612       vhn-portal-url:
54613         type: string
54614         description: URL customers will use to access the vHN Portal.
54615       service-instance-location-id:
54616         type: string
54617         description: An identifier that customers assign to the location where this service is being used.
54618       resource-version:
54619         type: string
54620         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54621       selflink:
54622         type: string
54623         description: Path to the controller object.
54624       orchestration-status:
54625         type: string
54626         description: Orchestration status of this service.
54627       relationship-list:
54628         type: array
54629         items:
54630           $ref: "#/getDefinitions/relationship"
54631       metadata:
54632         type: array
54633         items:
54634           $ref: "#/getDefinitions/metadatum"
54635       allotted-resources:
54636         type: array
54637         items:
54638           $ref: "#/getDefinitions/allotted-resource"
54639   service-instances:
54640     description: |
54641       Collection of service instances
54642     properties:
54643       service-instance:
54644         type: array
54645         items:
54646           $ref: "#/getDefinitions/service-instance"
54647   service-subscription:
54648     description: |
54649       Object that group service instances.
54650       ###### Related Nodes
54651       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
54652       - TO tenant( service-subscription Uses tenant, MANY2MANY)
54653       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
54654
54655       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
54656       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
54657     required:
54658     - service-type
54659     properties:
54660       service-type:
54661         type: string
54662         description: Value defined by orchestration to identify this service across ECOMP.
54663       temp-ub-sub-account-id:
54664         type: string
54665         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
54666       resource-version:
54667         type: string
54668         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54669       service-instances:
54670         type: array
54671         items:
54672           $ref: "#/getDefinitions/service-instance"
54673       relationship-list:
54674         type: array
54675         items:
54676           $ref: "#/getDefinitions/relationship"
54677   service-subscriptions:
54678     description: |
54679       Collection of objects that group service instances.
54680     properties:
54681       service-subscription:
54682         type: array
54683         items:
54684           $ref: "#/getDefinitions/service-subscription"
54685   services:
54686     description: |
54687       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
54688     properties:
54689       service:
54690         type: array
54691         items:
54692           $ref: "#/getDefinitions/service"
54693   site-pair:
54694     description: |
54695       ###### Related Nodes
54696       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
54697       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
54698
54699       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
54700       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
54701     required:
54702     - site-pair-id
54703     properties:
54704       site-pair-id:
54705         type: string
54706         description: unique identifier of probe
54707       source-ip:
54708         type: string
54709         description: Prefix address
54710       destination-ip:
54711         type: string
54712         description: Prefix address
54713       ip-version:
54714         type: string
54715         description: ip version, v4, v6
54716       destination-hostname:
54717         type: string
54718         description: Hostname of the destination equipment to which SLAs are measured against.
54719       destination-equip-type:
54720         type: string
54721         description: The type of destinatination equipment. Could be Router, etc.
54722       resource-version:
54723         type: string
54724         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54725       classes-of-service:
54726         type: array
54727         items:
54728           $ref: "#/getDefinitions/class-of-service"
54729       relationship-list:
54730         type: array
54731         items:
54732           $ref: "#/getDefinitions/relationship"
54733   site-pair-set:
54734     description: |
54735       Set of instances for probes used to measure service level agreements
54736       ###### Related Nodes
54737       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
54738       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
54739
54740       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
54741     required:
54742     - site-pair-set-id
54743     properties:
54744       site-pair-set-id:
54745         type: string
54746         description: Unique id of site pair set.
54747       resource-version:
54748         type: string
54749         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54750       routing-instances:
54751         type: array
54752         items:
54753           $ref: "#/getDefinitions/routing-instance"
54754       relationship-list:
54755         type: array
54756         items:
54757           $ref: "#/getDefinitions/relationship"
54758   site-pair-sets:
54759     description: |
54760       Collection of sets of instances for probes related to generic-vnf
54761     properties:
54762       site-pair-set:
54763         type: array
54764         items:
54765           $ref: "#/getDefinitions/site-pair-set"
54766   site-pairs:
54767     description: |
54768       probe within a set
54769     properties:
54770       site-pair:
54771         type: array
54772         items:
54773           $ref: "#/getDefinitions/site-pair"
54774   snapshot:
54775     description: |
54776       Openstack snapshot
54777       ###### Related Nodes
54778       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
54779       - FROM vserver( vserver Uses snapshot, ONE2ONE)
54780
54781     required:
54782     - snapshot-id
54783     properties:
54784       snapshot-id:
54785         type: string
54786         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
54787       snapshot-name:
54788         type: string
54789         description: Snapshot name
54790       snapshot-architecture:
54791         type: string
54792         description: Operating system architecture
54793       snapshot-os-distro:
54794         type: string
54795         description: The common name of the operating system distribution in lowercase
54796       snapshot-os-version:
54797         type: string
54798         description: The operating system version as specified by the distributor.
54799       application:
54800         type: string
54801         description: The application that the image instantiates.
54802       application-vendor:
54803         type: string
54804         description: The vendor of the application.
54805       application-version:
54806         type: string
54807         description: The version of the application.
54808       snapshot-selflink:
54809         type: string
54810         description: URL to endpoint where AAI can get more details
54811       prev-snapshot-id:
54812         type: string
54813         description: This field contains the UUID of the previous snapshot (if any).
54814       resource-version:
54815         type: string
54816         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54817       relationship-list:
54818         type: array
54819         items:
54820           $ref: "#/getDefinitions/relationship"
54821   snapshots:
54822     description: |
54823       Collection of openstack snapshots
54824     properties:
54825       snapshot:
54826         type: array
54827         items:
54828           $ref: "#/getDefinitions/snapshot"
54829   sriov-pf:
54830     description: |
54831       SR-IOV Physical Function
54832       ###### Related Nodes
54833       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
54834       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
54835
54836       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
54837     required:
54838     - pf-pci-id
54839     properties:
54840       pf-pci-id:
54841         type: string
54842         description: Identifier for the sriov-pf
54843       resource-version:
54844         type: string
54845         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54846       relationship-list:
54847         type: array
54848         items:
54849           $ref: "#/getDefinitions/relationship"
54850   sriov-pfs:
54851     description: |
54852       Collection of SR-IOV Physical Functions.
54853     properties:
54854       sriov-pf:
54855         type: array
54856         items:
54857           $ref: "#/getDefinitions/sriov-pf"
54858   sriov-vf:
54859     description: |
54860       SR-IOV Virtual Function (not to be confused with virtual network function)
54861       ###### Related Nodes
54862       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
54863
54864       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
54865     required:
54866     - pci-id
54867     properties:
54868       pci-id:
54869         type: string
54870         description: PCI ID used to identify the sriov-vf
54871       vf-vlan-filter:
54872         type: string
54873         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
54874       vf-mac-filter:
54875         type: string
54876         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
54877       vf-vlan-strip:
54878         type: boolean
54879         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
54880       vf-vlan-anti-spoof-check:
54881         type: boolean
54882         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.
54883       vf-mac-anti-spoof-check:
54884         type: boolean
54885         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.
54886       vf-mirrors:
54887         type: string
54888         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
54889       vf-broadcast-allow:
54890         type: boolean
54891         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
54892       vf-unknown-multicast-allow:
54893         type: boolean
54894         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
54895       vf-unknown-unicast-allow:
54896         type: boolean
54897         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
54898       vf-insert-stag:
54899         type: boolean
54900         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
54901       vf-link-status:
54902         type: string
54903         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
54904       resource-version:
54905         type: string
54906         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54907       neutron-network-id:
54908         type: string
54909         description: Neutron network id of the interface
54910       relationship-list:
54911         type: array
54912         items:
54913           $ref: "#/getDefinitions/relationship"
54914   sriov-vfs:
54915     description: |
54916       Collection of SR-IOV Virtual Functions.
54917     properties:
54918       sriov-vf:
54919         type: array
54920         items:
54921           $ref: "#/getDefinitions/sriov-vf"
54922   start-node-filter:
54923     properties:
54924       property-name:
54925         type: string
54926       property-value:
54927         type: string
54928   subnet:
54929     description: |
54930       ###### Related Nodes
54931       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
54932       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
54933       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
54934
54935       -(4) IF this TO node is deleted, this SUBNET is DELETED also
54936       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
54937
54938     required:
54939     - subnet-id
54940     - dhcp-enabled
54941     properties:
54942       subnet-id:
54943         type: string
54944         description: Subnet ID, should be UUID.
54945       subnet-name:
54946         type: string
54947         description: Name associated with the subnet.
54948       neutron-subnet-id:
54949         type: string
54950         description: Neutron id of this subnet
54951       gateway-address:
54952         type: string
54953         description: gateway ip address
54954       network-start-address:
54955         type: string
54956         description: network start address
54957       cidr-mask:
54958         type: string
54959         description: cidr mask
54960       ip-version:
54961         type: string
54962         description: ip version
54963       orchestration-status:
54964         type: string
54965         description: Orchestration status of this VNF, mastered by MSO
54966       dhcp-enabled:
54967         type: boolean
54968         description: dhcp enabled
54969       dhcp-start:
54970         type: string
54971         description: the start address reserved for use by dhcp
54972       dhcp-end:
54973         type: string
54974         description: the last address reserved for use by dhcp
54975       resource-version:
54976         type: string
54977         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54978       relationship-list:
54979         type: array
54980         items:
54981           $ref: "#/getDefinitions/relationship"
54982   subnets:
54983     properties:
54984       subnet:
54985         type: array
54986         items:
54987           $ref: "#/getDefinitions/subnet"
54988   tagged-inventory-item-list:
54989     properties:
54990       inventory-item:
54991         type: array
54992         items:
54993           $ref: "#/getDefinitions/inventory-item"
54994   tenant:
54995     description: |
54996       Openstack tenant
54997       ###### Related Nodes
54998       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
54999       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
55000       - TO l3-network( tenant Uses l3-network, MANY2MANY)
55001       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
55002       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
55003       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
55004
55005       -TENANT cannot be deleted if related to VSERVER
55006
55007     required:
55008     - tenant-id
55009     - tenant-name
55010     properties:
55011       tenant-id:
55012         type: string
55013         description: Unique id relative to the cloud-region.
55014       tenant-name:
55015         type: string
55016         description: Readable name of tenant
55017       resource-version:
55018         type: string
55019         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55020       vservers:
55021         type: array
55022         items:
55023           $ref: "#/getDefinitions/vserver"
55024       relationship-list:
55025         type: array
55026         items:
55027           $ref: "#/getDefinitions/relationship"
55028   tenants:
55029     description: |
55030       Collection of openstack tenants.
55031     properties:
55032       tenant:
55033         type: array
55034         items:
55035           $ref: "#/getDefinitions/tenant"
55036   tunnel-xconnect:
55037     description: |
55038       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
55039       ###### Related Nodes
55040       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
55041
55042       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
55043     required:
55044     - id
55045     - bandwidth-up-wan1
55046     - bandwidth-down-wan1
55047     - bandwidth-up-wan2
55048     - bandwidth-down-wan2
55049     properties:
55050       id:
55051         type: string
55052         description: Allotted Resource id UUID assigned to this instance.
55053       bandwidth-up-wan1:
55054         type: string
55055         description: The WAN uplink bandwidth for WAN1
55056       bandwidth-down-wan1:
55057         type: string
55058         description: The WAN downlink bandwidth for WAN1
55059       bandwidth-up-wan2:
55060         type: string
55061         description: The WAN uplink bandwidth for WAN2
55062       bandwidth-down-wan2:
55063         type: string
55064         description: The WAN downlink bandwidth for WAN2
55065       resource-version:
55066         type: string
55067         description: Concurrency value
55068       relationship-list:
55069         type: array
55070         items:
55071           $ref: "#/getDefinitions/relationship"
55072   tunnel-xconnects:
55073     description: |
55074       This object is used to store the specific tunnel cross connect aspects of an allotted resource
55075     properties:
55076       tunnel-xconnect:
55077         type: array
55078         items:
55079           $ref: "#/getDefinitions/tunnel-xconnect"
55080   update:
55081     description: |
55082       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
55083     required:
55084     - update-node-type
55085     properties:
55086       update-node-type:
55087         type: string
55088       update-node-key:
55089         type: array
55090         items:
55091           $ref: "#/getDefinitions/update-node-key"
55092       update-node-uri:
55093         type: string
55094       action:
55095         type: array
55096         items:
55097           $ref: "#/getDefinitions/action"
55098   update-node-key:
55099     properties:
55100       key-name:
55101         type: string
55102       key-value:
55103         type: string
55104   vce:
55105     description: |
55106       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
55107       ###### Related Nodes
55108       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
55109       - TO complex( vce LocatedIn complex, MANY2MANY)
55110       - TO vserver( vce HostedOn vserver, ONE2MANY)
55111       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
55112       - FROM license( license BelongsTo vce, MANY2ONE)(1)
55113       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
55114       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
55115
55116       -(1) IF this VCE node is deleted, this FROM node is DELETED also
55117     required:
55118     - vnf-id
55119     - vnf-name
55120     - vnf-type
55121     properties:
55122       vnf-id:
55123         type: string
55124         description: Unique id of VNF.  This is unique across the graph.
55125       vnf-name:
55126         type: string
55127         description: Name of VNF.
55128       vnf-name2:
55129         type: string
55130         description: Alternate name of VNF.
55131       vnf-type:
55132         type: string
55133         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.
55134       service-id:
55135         type: string
55136         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
55137       regional-resource-zone:
55138         type: string
55139         description: Regional way of organizing pservers, source of truth should define values
55140       prov-status:
55141         type: string
55142         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55143       operational-state:
55144         type: string
55145         description: Indicator for whether the resource is considered operational
55146       license-key:
55147         type: string
55148         description: OBSOLETE -  do not use
55149       equipment-role:
55150         type: string
55151         description: Network role being played by this VNF
55152       orchestration-status:
55153         type: string
55154         description: Orchestration status of this VNF, mastered by MSO
55155       heat-stack-id:
55156         type: string
55157         description: Heat stack id corresponding to this instance, managed by MSO
55158       mso-catalog-key:
55159         type: string
55160         description: Corresponds to the SDN-C catalog id used to configure this VCE
55161       vpe-id:
55162         type: string
55163         description: Unique ID of VPE connected to this VCE.
55164       v6-vce-wan-address:
55165         type: string
55166         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
55167       ipv4-oam-address:
55168         type: string
55169         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
55170       resource-version:
55171         type: string
55172         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55173       ipv4-loopback0-address:
55174         type: string
55175         description: Loopback0 address
55176       entitlement-resource-uuid:
55177         type: string
55178         description: OBSOLETE -  see child relationships
55179       port-groups:
55180         type: array
55181         items:
55182           $ref: "#/getDefinitions/port-group"
55183       licenses:
55184         type: array
55185         items:
55186           $ref: "#/getDefinitions/license"
55187       entitlements:
55188         type: array
55189         items:
55190           $ref: "#/getDefinitions/entitlement"
55191       relationship-list:
55192         type: array
55193         items:
55194           $ref: "#/getDefinitions/relationship"
55195   vces:
55196     description: |
55197       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
55198     properties:
55199       vce:
55200         type: array
55201         items:
55202           $ref: "#/getDefinitions/vce"
55203   vf-module:
55204     description: |
55205       a deployment unit of VNFCs
55206       ###### Related Nodes
55207       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
55208       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
55209       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
55210       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
55211       - TO vserver( vf-module Uses vserver, ONE2MANY)
55212
55213       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
55214       -VF-MODULE cannot be deleted if related to VNFC
55215
55216     required:
55217     - vf-module-id
55218     - is-base-vf-module
55219     properties:
55220       vf-module-id:
55221         type: string
55222         description: Unique ID of vf-module.
55223       vf-module-name:
55224         type: string
55225         description: Name of vf-module
55226       heat-stack-id:
55227         type: string
55228         description: Heat stack id corresponding to this instance.
55229       orchestration-status:
55230         type: string
55231         description: orchestration status of this vf-module, mastered by MSO
55232       is-base-vf-module:
55233         type: boolean
55234         description: used to indicate whether or not this object is base vf module
55235       resource-version:
55236         type: string
55237         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55238       persona-model-id:
55239         type: string
55240         description: the ASDC model id for this resource or service model.
55241       persona-model-version:
55242         type: string
55243         description: the ASDC model version for this resource or service model.
55244       model-version-id:
55245         type: string
55246         description: the ASDC model version for this resource or service model.
55247       persona-model-customization-id:
55248         type: string
55249         description: captures the id of all the configuration used to customize the resource for the service.
55250       widget-model-id:
55251         type: string
55252         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55253       widget-model-version:
55254         type: string
55255         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55256       contrail-service-instance-fqdn:
55257         type: string
55258         description: the Contrail unique ID for a service-instance
55259       module-index:
55260         type: integer
55261         format: int32
55262         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
55263       selflink:
55264         type: string
55265         description: Path to the controller object.
55266       relationship-list:
55267         type: array
55268         items:
55269           $ref: "#/getDefinitions/relationship"
55270   vf-modules:
55271     description: |
55272       Collection of vf-modules, a deployment unit of VNFCs
55273     properties:
55274       vf-module:
55275         type: array
55276         items:
55277           $ref: "#/getDefinitions/vf-module"
55278   vig-server:
55279     description: |
55280       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
55281       ###### Related Nodes
55282       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
55283
55284       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
55285     required:
55286     - vig-address-type
55287     properties:
55288       vig-address-type:
55289         type: string
55290         description: indicates whether the VIG is for AVPN or INTERNET
55291       ipaddress-v4-vig:
55292         type: string
55293         description: v4 IP of the vig server
55294       ipaddress-v6-vig:
55295         type: string
55296         description: v6 IP of the vig server
55297       resource-version:
55298         type: string
55299         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55300       relationship-list:
55301         type: array
55302         items:
55303           $ref: "#/getDefinitions/relationship"
55304   vig-servers:
55305     properties:
55306       vig-server:
55307         type: array
55308         items:
55309           $ref: "#/getDefinitions/vig-server"
55310   vip-ipv4-address-list:
55311     description: |
55312       IPv4 Address Range
55313       ###### Related Nodes
55314       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
55315       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
55316       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
55317       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
55318
55319     required:
55320     - vip-ipv4-address
55321     properties:
55322       vip-ipv4-address:
55323         type: string
55324         description: IP address
55325       vip-ipv4-prefix-length:
55326         type: integer
55327         format: int64
55328         description: Prefix length, 32 for single address
55329       vlan-id-inner:
55330         type: integer
55331         format: int64
55332         description: Inner VLAN tag
55333       vlan-id-outer:
55334         type: integer
55335         format: int64
55336         description: Outer VLAN tag
55337       is-floating:
55338         type: boolean
55339         description: Indicator of fixed or floating address
55340       resource-version:
55341         type: string
55342         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55343       neutron-network-id:
55344         type: string
55345         description: Neutron network id of the interface that address belongs to
55346       neutron-subnet-id:
55347         type: string
55348         description: Neutron id of subnet that address belongs to
55349       relationship-list:
55350         type: array
55351         items:
55352           $ref: "#/getDefinitions/relationship"
55353   vip-ipv6-address-list:
55354     description: |
55355       IPv6 Address Range
55356       ###### Related Nodes
55357       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
55358       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
55359       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
55360       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
55361
55362     required:
55363     - vip-ipv6-address
55364     properties:
55365       vip-ipv6-address:
55366         type: string
55367         description: IP address
55368       vip-ipv6-prefix-length:
55369         type: integer
55370         format: int64
55371         description: Prefix length, 128 for single address
55372       vlan-id-inner:
55373         type: integer
55374         format: int64
55375         description: Inner VLAN tag
55376       vlan-id-outer:
55377         type: integer
55378         format: int64
55379         description: Outer VLAN tag
55380       is-floating:
55381         type: boolean
55382         description: Indicator of fixed or floating address
55383       resource-version:
55384         type: string
55385         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55386       neutron-network-id:
55387         type: string
55388         description: Neutron network id of the interface that address belongs to
55389       neutron-subnet-id:
55390         type: string
55391         description: Neutron id of subnet that address belongs to
55392       relationship-list:
55393         type: array
55394         items:
55395           $ref: "#/getDefinitions/relationship"
55396   virtual-data-center:
55397     description: |
55398       Virtual organization of cloud infrastructure elements in a data center context
55399       ###### Related Nodes
55400       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
55401       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
55402       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
55403
55404     required:
55405     - vdc-id
55406     - vdc-name
55407     properties:
55408       vdc-id:
55409         type: string
55410         description: Unique ID of the vdc
55411       vdc-name:
55412         type: string
55413         description: Name of the virtual data center
55414       resource-version:
55415         type: string
55416         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55417       relationship-list:
55418         type: array
55419         items:
55420           $ref: "#/getDefinitions/relationship"
55421   virtual-data-centers:
55422     description: |
55423       Virtual organization of cloud infrastructure elements in a data center context
55424     properties:
55425       virtual-data-center:
55426         type: array
55427         items:
55428           $ref: "#/getDefinitions/virtual-data-center"
55429   vlan:
55430     description: |
55431       Definition of vlan
55432       ###### Related Nodes
55433       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
55434       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
55435       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
55436       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
55437       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
55438       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
55439       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
55440
55441       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
55442       -(2) IF this VLAN node is deleted, this TO node is DELETED also
55443       -(4) IF this TO node is deleted, this VLAN is DELETED also
55444     required:
55445     - vlan-interface
55446     properties:
55447       vlan-interface:
55448         type: string
55449         description: String that identifies the interface
55450       vlan-id-inner:
55451         type: integer
55452         format: int64
55453         description: Inner VLAN tag
55454       vlan-id-outer:
55455         type: integer
55456         format: int64
55457         description: Outer VLAN tag
55458       resource-version:
55459         type: string
55460         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55461       speed-value:
55462         type: string
55463         description: Captures the numeric part of the speed
55464       speed-units:
55465         type: string
55466         description: Captures the units corresponding to the speed
55467       vlan-description:
55468         type: string
55469         description: Used to describe (the service associated with) the vlan
55470       backdoor-connection:
55471         type: string
55472         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
55473       vpn-id:
55474         type: string
55475         description: This indicates the customers VPN ID associated with this vlan
55476       orchestration-status:
55477         type: string
55478         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
55479       relationship-list:
55480         type: array
55481         items:
55482           $ref: "#/getDefinitions/relationship"
55483       l3-interface-ipv4-address-list:
55484         type: array
55485         items:
55486           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
55487       l3-interface-ipv6-address-list:
55488         type: array
55489         items:
55490           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
55491   vlans:
55492     properties:
55493       vlan:
55494         type: array
55495         items:
55496           $ref: "#/getDefinitions/vlan"
55497   vnf:
55498     description: |
55499       Abstract vnf class
55500     required:
55501     - vnf-id
55502     properties:
55503       vnf-id:
55504         type: string
55505         description: Unique id of VNF.  This is unique across the graph.
55506   vnf-image:
55507     description: |
55508       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
55509       ###### Related Nodes
55510       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
55511
55512       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
55513
55514     required:
55515     - vnf-image-uuid
55516     - application
55517     - application-vendor
55518     properties:
55519       vnf-image-uuid:
55520         type: string
55521         description: Unique ID of this asset
55522       application:
55523         type: string
55524         description: The application that the image instantiates.
55525       application-vendor:
55526         type: string
55527         description: The vendor of the application.
55528       application-version:
55529         type: string
55530         description: The version of the application.
55531       selflink:
55532         type: string
55533         description: URL to endpoint where AAI can get more details
55534       resource-version:
55535         type: string
55536         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55537       relationship-list:
55538         type: array
55539         items:
55540           $ref: "#/getDefinitions/relationship"
55541   vnf-images:
55542     description: |
55543       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
55544     properties:
55545       vnf-image:
55546         type: array
55547         items:
55548           $ref: "#/getDefinitions/vnf-image"
55549   vnfc:
55550     description: |
55551       ###### Related Nodes
55552       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
55553       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
55554       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
55555
55556       -(4) IF this TO node is deleted, this VNFC is DELETED also
55557     required:
55558     - vnfc-name
55559     - vnfc-function-code
55560     - vnfc-type
55561     - in-maint
55562     - is-closed-loop-disabled
55563     properties:
55564       vnfc-name:
55565         type: string
55566         description: Unique ID of vnfc.
55567       vnfc-function-code:
55568         type: string
55569         description: function code
55570       vnfc-type:
55571         type: string
55572         description: type
55573       prov-status:
55574         type: string
55575         description: prov status of this vnfc
55576       orchestration-status:
55577         type: string
55578         description: Orchestration status of this VNF, mastered by APP-C
55579       ipaddress-v4-oam-vip:
55580         type: string
55581         description: Oam V4 vip address of this vnfc
55582       in-maint:
55583         type: boolean
55584         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
55585       is-closed-loop-disabled:
55586         type: boolean
55587         description: used to indicate whether closed loop function is enabled on this node
55588       group-notation:
55589         type: string
55590         description: Group notation of VNFC
55591       resource-version:
55592         type: string
55593         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55594       relationship-list:
55595         type: array
55596         items:
55597           $ref: "#/getDefinitions/relationship"
55598   vnfcs:
55599     description: |
55600       virtual network components associated with a vserver from application controller.
55601     properties:
55602       vnfc:
55603         type: array
55604         items:
55605           $ref: "#/getDefinitions/vnfc"
55606   volume:
55607     description: |
55608       Ephemeral Block storage volume.
55609       ###### Related Nodes
55610       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
55611
55612       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
55613     required:
55614     - volume-id
55615     - volume-selflink
55616     properties:
55617       volume-id:
55618         type: string
55619         description: Unique ID of block storage volume relative to the vserver.
55620       volume-selflink:
55621         type: string
55622         description: URL to endpoint where AAI can get more details
55623       resource-version:
55624         type: string
55625         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55626       relationship-list:
55627         type: array
55628         items:
55629           $ref: "#/getDefinitions/relationship"
55630   volume-group:
55631     description: |
55632       Persistent block-level storage.
55633       ###### Related Nodes
55634       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
55635       - TO complex( volume-group LocatedIn complex, MANY2ONE)
55636       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
55637       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
55638       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
55639
55640     required:
55641     - volume-group-id
55642     - volume-group-name
55643     - vnf-type
55644     properties:
55645       volume-group-id:
55646         type: string
55647         description: Unique ID of volume-group.
55648       volume-group-name:
55649         type: string
55650         description: Name of the volume group.
55651       heat-stack-id:
55652         type: string
55653         description: Heat stack id corresponding to this volume-group
55654       vnf-type:
55655         type: string
55656         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.
55657       orchestration-status:
55658         type: string
55659         description: Orchestration status of this volume-group
55660       persona-model-customization-id:
55661         type: string
55662         description: captures the id of all the configuration used to customize the resource for the service.
55663       vf-module-persona-model-customization-id:
55664         type: string
55665         description: helps relate the volume group to the vf-module whose components will require the volume group
55666       resource-version:
55667         type: string
55668         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55669       relationship-list:
55670         type: array
55671         items:
55672           $ref: "#/getDefinitions/relationship"
55673   volume-groups:
55674     description: |
55675       Collection of persistent block-level storage.
55676     properties:
55677       volume-group:
55678         type: array
55679         items:
55680           $ref: "#/getDefinitions/volume-group"
55681   volumes:
55682     description: |
55683       Collection of ephemeral Block storage volumes.
55684     properties:
55685       volume:
55686         type: array
55687         items:
55688           $ref: "#/getDefinitions/volume"
55689   vpls-pe:
55690     description: |
55691       VPLS Provider Edge routers.
55692       ###### Related Nodes
55693       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
55694       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
55695       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
55696       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
55697
55698       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
55699     required:
55700     - equipment-name
55701     properties:
55702       equipment-name:
55703         type: string
55704       prov-status:
55705         type: string
55706         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55707       ipv4-oam-address:
55708         type: string
55709         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
55710       equipment-role:
55711         type: string
55712         description: Client should send valid enumerated value, e.g., VPLS-PE.
55713       vlan-id-outer:
55714         type: integer
55715         format: int64
55716         description: Temporary location for stag to get to VCE
55717       resource-version:
55718         type: string
55719         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55720       relationship-list:
55721         type: array
55722         items:
55723           $ref: "#/getDefinitions/relationship"
55724       p-interfaces:
55725         type: array
55726         items:
55727           $ref: "#/getDefinitions/p-interface"
55728       lag-interfaces:
55729         type: array
55730         items:
55731           $ref: "#/getDefinitions/lag-interface"
55732   vpls-pes:
55733     description: |
55734       Collection of VPLS Provider Edge routers
55735     properties:
55736       vpls-pe:
55737         type: array
55738         items:
55739           $ref: "#/getDefinitions/vpls-pe"
55740   vpn-binding:
55741     description: |
55742       VPN binding
55743       ###### Related Nodes
55744       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
55745       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
55746
55747       -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
55748
55749     required:
55750     - vpn-id
55751     - vpn-name
55752     - global-route-target
55753     - route-target-role
55754     properties:
55755       vpn-id:
55756         type: string
55757         description: VPN ID, globally unique within A&AI
55758       vpn-name:
55759         type: string
55760         description: VPN Name
55761       global-route-target:
55762         type: string
55763         description: Number used to identify a VPN, globally unique in the network
55764       vpn-platform:
55765         type: string
55766         description: the platform associated with the VPN example AVPN, Mobility
55767       vpn-type:
55768         type: string
55769         description: Type of the vpn, should be taken from enumerated/valid values
55770       route-distinguisher:
55771         type: string
55772         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
55773       route-target-role:
55774         type: string
55775         description: Role assigned to this route target
55776       resource-version:
55777         type: string
55778         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55779       relationship-list:
55780         type: array
55781         items:
55782           $ref: "#/getDefinitions/relationship"
55783         description: l3-networks relate to vpn-bindings
55784   vpn-bindings:
55785     properties:
55786       vpn-binding:
55787         type: array
55788         items:
55789           $ref: "#/getDefinitions/vpn-binding"
55790   vserver:
55791     description: |
55792       Virtual Servers, aka virtual machine or VM.
55793       ###### Related Nodes
55794       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
55795       - TO flavor( vserver Uses flavor, MANY2ONE)
55796       - TO image( vserver Uses image, MANY2ONE)
55797       - TO pserver( vserver HostedOn pserver, MANY2ONE)
55798       - TO snapshot( vserver Uses snapshot, ONE2ONE)
55799       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
55800       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
55801       - FROM vce( vce HostedOn vserver, ONE2MANY)
55802       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
55803       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
55804       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
55805
55806       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
55807       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
55808     required:
55809     - vserver-id
55810     - vserver-name
55811     - vserver-selflink
55812     - in-maint
55813     - is-closed-loop-disabled
55814     properties:
55815       vserver-id:
55816         type: string
55817         description: Unique identifier for this vserver relative to its tenant
55818       vserver-name:
55819         type: string
55820         description: Name of vserver
55821       vserver-name2:
55822         type: string
55823         description: Alternative name of vserver
55824       prov-status:
55825         type: string
55826         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55827       vserver-selflink:
55828         type: string
55829         description: URL to endpoint where AAI can get more details
55830       in-maint:
55831         type: boolean
55832         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.
55833       is-closed-loop-disabled:
55834         type: boolean
55835         description: Used to indicate whether closed loop function is enabled on this node
55836       resource-version:
55837         type: string
55838         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55839       volumes:
55840         type: array
55841         items:
55842           $ref: "#/getDefinitions/volume"
55843       relationship-list:
55844         type: array
55845         items:
55846           $ref: "#/getDefinitions/relationship"
55847       l-interfaces:
55848         type: array
55849         items:
55850           $ref: "#/getDefinitions/l-interface"
55851   vservers:
55852     description: |
55853       Collection of virtual Servers, aka virtual machines or VMs.
55854     properties:
55855       vserver:
55856         type: array
55857         items:
55858           $ref: "#/getDefinitions/vserver"
55859   zone:
55860     description: |
55861       A zone is a grouping of assets in a location homing to the same connections into the CBB
55862       ###### Related Nodes
55863       - TO complex( zone LocatedIn complex, MANY2ONE)
55864       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
55865       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
55866       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
55867
55868     required:
55869     - zone-id
55870     - zone-name
55871     - design-type
55872     - zone-context
55873     properties:
55874       zone-id:
55875         type: string
55876         description: Code assigned by AIC to the zone
55877       zone-name:
55878         type: string
55879         description: English name associated with the zone
55880       design-type:
55881         type: string
55882         description: Design of zone [Medium/Large?]
55883       zone-context:
55884         type: string
55885         description: Context of zone [production/test]
55886       status:
55887         type: string
55888         description: Status of a zone.
55889       resource-version:
55890         type: string
55891         description: Concurrency value
55892       relationship-list:
55893         type: array
55894         items:
55895           $ref: "#/getDefinitions/relationship"
55896   zones:
55897     description: |
55898       Collection of zones
55899     properties:
55900       zone:
55901         type: array
55902         items:
55903           $ref: "#/getDefinitions/zone"