contains-other-v no longer implies delete-other-v
[aai/aai-common.git] / aai-schema / src / main / resources / aai_swagger_yaml / aai_swagger_v11.yaml
1 #
2 # ============LICENSE_START=======================================================
3 # org.onap.aai
4 # ================================================================================
5 # Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 # ================================================================================
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
10 #
11 #    http://www.apache.org/licenses/LICENSE-2.0
12 #
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
18 # ============LICENSE_END=========================================================
19 #
20 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
21 #
22
23 swagger: "2.0"
24 info:
25   description: |
26     Copyright © 2017 AT&T Intellectual Property. All rights reserved.
27
28     Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
29
30     You may obtain a copy of the License at
31
32     (https://creativecommons.org/licenses/by/4.0/)
33
34     Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" 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.
35
36     ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.
37
38     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.
39   version: "v11"
40   title: Active and Available Inventory REST API
41   license:
42     name: Apache 2.0
43     url: http://www.apache.org/licenses/LICENSE-2.0.html
44   contact:
45     name:
46     url:
47     email:
48 host:
49 basePath: /aai/v11
50 schemes:
51   - https
52 paths:
53   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
54     put:
55       tags:
56         - CloudInfrastructure
57       summary: see node definition for valid relationships
58       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
59       consumes:
60         - application/json
61         - application/xml
62       produces:
63         - application/json
64         - application/xml
65       responses:
66         "default":
67           description: Response codes found in [response codes](https://wiki.onap.org/).
68       parameters:
69         - name: physical-location-id
70           in: path
71           description: Unique identifier for physical location, e.g., CLLI
72           required: true
73           type: string
74         - name: target-pe
75           in: path
76           description: The Target provider edge router
77           required: true
78           type: string
79         - name: availability-zone-name
80           in: path
81           description: Name of the availability zone
82           required: true
83           type: string
84         - name: body
85           in: body
86           description: relationship object that needs to be created or updated
87           required: true
88           schema:
89             $ref: "#/definitions/relationship"
90     delete:
91       tags:
92         - CloudInfrastructure
93       summary: delete an existing relationship
94       description: delete an existing relationship
95       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
96       consumes:
97         - application/json
98         - application/xml
99       produces:
100         - application/json
101         - application/xml
102       responses:
103         "default":
104           description: Response codes found in [response codes](https://wiki.onap.org/).
105       parameters:
106         - name: physical-location-id
107           in: path
108           description: Unique identifier for physical location, e.g., CLLI
109           required: true
110           type: string
111         - name: target-pe
112           in: path
113           description: The Target provider edge router
114           required: true
115           type: string
116         - name: availability-zone-name
117           in: path
118           description: Name of the availability zone
119           required: true
120           type: string
121   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
122     get:
123       tags:
124         - CloudInfrastructure
125       summary: returns ctag-pool
126       description: returns ctag-pool
127       operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
128       produces:
129         - application/json
130         - application/xml
131       responses:
132         "200":
133           description: successful operation
134           schema:
135               $ref: "#/definitions/ctag-pool"
136         "default":
137           description: Response codes found in [response codes](https://wiki.onap.org/).
138       parameters:
139         - name: physical-location-id
140           in: path
141           description: Unique identifier for physical location, e.g., CLLI
142           required: true
143           type: string
144         - name: target-pe
145           in: path
146           description: The Target provider edge router
147           required: true
148           type: string
149         - name: availability-zone-name
150           in: path
151           description: Name of the availability zone
152           required: true
153           type: string
154         - name: data-center-code
155           in: query
156           description: Data center code which can be an alternate way to identify a complex
157           required: false
158           type: string
159         - name: complex-name
160           in: query
161           description: Gamma complex name for LCP instance.
162           required: false
163           type: string
164         - name: identity-url
165           in: query
166           description: URL of the keystone identity service
167           required: false
168           type: string
169     put:
170       tags:
171         - CloudInfrastructure
172       summary: create or update an existing ctag-pool
173       description: create or update an existing ctag-pool
174       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
175       consumes:
176         - application/json
177         - application/xml
178       produces:
179         - application/json
180         - application/xml
181       responses:
182         "default":
183           description: Response codes found in [response codes](https://wiki.onap.org/).
184       parameters:
185         - name: physical-location-id
186           in: path
187           description: Unique identifier for physical location, e.g., CLLI
188           required: true
189           type: string
190         - name: target-pe
191           in: path
192           description: The Target provider edge router
193           required: true
194           type: string
195         - name: availability-zone-name
196           in: path
197           description: Name of the availability zone
198           required: true
199           type: string
200         - name: body
201           in: body
202           description: ctag-pool object that needs to be created or updated
203           required: true
204           schema:
205             $ref: "#/definitions/ctag-pool"
206     delete:
207       tags:
208         - CloudInfrastructure
209       summary: delete an existing ctag-pool
210       description: delete an existing ctag-pool
211       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
212       consumes:
213         - application/json
214         - application/xml
215       produces:
216         - application/json
217         - application/xml
218       responses:
219         "default":
220           description: Response codes found in [response codes](https://wiki.onap.org/).
221       parameters:
222         - name: physical-location-id
223           in: path
224           description: Unique identifier for physical location, e.g., CLLI
225           required: true
226           type: string
227         - name: target-pe
228           in: path
229           description: The Target provider edge router
230           required: true
231           type: string
232         - name: availability-zone-name
233           in: path
234           description: Name of the availability zone
235           required: true
236           type: string
237         - name: resource-version
238           in: query
239           description: resource-version for concurrency
240           required: true
241           type: string
242   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
243     get:
244       tags:
245         - CloudInfrastructure
246       summary: returns ctag-pools
247       description: returns ctag-pools
248       operationId: getCloudInfrastructureComplexesComplexCtagPools
249       produces:
250         - application/json
251         - application/xml
252       responses:
253         "200":
254           description: successful operation
255           schema:
256               $ref: "#/definitions/ctag-pools"
257         "default":
258           description: Response codes found in [response codes](https://wiki.onap.org/).
259       parameters:
260         - name: physical-location-id
261           in: path
262           description: Unique identifier for physical location, e.g., CLLI
263           required: true
264           type: string
265         - name: data-center-code
266           in: query
267           description: Data center code which can be an alternate way to identify a complex
268           required: false
269           type: string
270         - name: complex-name
271           in: query
272           description: Gamma complex name for LCP instance.
273           required: false
274           type: string
275         - name: identity-url
276           in: query
277           description: URL of the keystone identity service
278           required: false
279           type: string
280   /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
281     put:
282       tags:
283         - CloudInfrastructure
284       summary: see node definition for valid relationships
285       operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
286       consumes:
287         - application/json
288         - application/xml
289       produces:
290         - application/json
291         - application/xml
292       responses:
293         "default":
294           description: Response codes found in [response codes](https://wiki.onap.org/).
295       parameters:
296         - name: physical-location-id
297           in: path
298           description: Unique identifier for physical location, e.g., CLLI
299           required: true
300           type: string
301         - name: body
302           in: body
303           description: relationship object that needs to be created or updated
304           required: true
305           schema:
306             $ref: "#/definitions/relationship"
307     delete:
308       tags:
309         - CloudInfrastructure
310       summary: delete an existing relationship
311       description: delete an existing relationship
312       operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
313       consumes:
314         - application/json
315         - application/xml
316       produces:
317         - application/json
318         - application/xml
319       responses:
320         "default":
321           description: Response codes found in [response codes](https://wiki.onap.org/).
322       parameters:
323         - name: physical-location-id
324           in: path
325           description: Unique identifier for physical location, e.g., CLLI
326           required: true
327           type: string
328   /cloud-infrastructure/complexes/complex/{physical-location-id}:
329     get:
330       tags:
331         - CloudInfrastructure
332       summary: returns complex
333       description: returns complex
334       operationId: getCloudInfrastructureComplexesComplex
335       produces:
336         - application/json
337         - application/xml
338       responses:
339         "200":
340           description: successful operation
341           schema:
342               $ref: "#/definitions/complex"
343         "default":
344           description: Response codes found in [response codes](https://wiki.onap.org/).
345       parameters:
346         - name: physical-location-id
347           in: path
348           description: Unique identifier for physical location, e.g., CLLI
349           required: true
350           type: string
351         - name: data-center-code
352           in: query
353           description: Data center code which can be an alternate way to identify a complex
354           required: false
355           type: string
356         - name: complex-name
357           in: query
358           description: Gamma complex name for LCP instance.
359           required: false
360           type: string
361         - name: identity-url
362           in: query
363           description: URL of the keystone identity service
364           required: false
365           type: string
366     put:
367       tags:
368         - CloudInfrastructure
369       summary: create or update an existing complex
370       description: create or update an existing complex
371       operationId: createOrUpdateCloudInfrastructureComplexesComplex
372       consumes:
373         - application/json
374         - application/xml
375       produces:
376         - application/json
377         - application/xml
378       responses:
379         "default":
380           description: Response codes found in [response codes](https://wiki.onap.org/).
381       parameters:
382         - name: physical-location-id
383           in: path
384           description: Unique identifier for physical location, e.g., CLLI
385           required: true
386           type: string
387         - name: body
388           in: body
389           description: complex object that needs to be created or updated
390           required: true
391           schema:
392             $ref: "#/definitions/complex"
393     delete:
394       tags:
395         - CloudInfrastructure
396       summary: delete an existing complex
397       description: delete an existing complex
398       operationId: deleteCloudInfrastructureComplexesComplex
399       consumes:
400         - application/json
401         - application/xml
402       produces:
403         - application/json
404         - application/xml
405       responses:
406         "default":
407           description: Response codes found in [response codes](https://wiki.onap.org/).
408       parameters:
409         - name: physical-location-id
410           in: path
411           description: Unique identifier for physical location, e.g., CLLI
412           required: true
413           type: string
414         - name: resource-version
415           in: query
416           description: resource-version for concurrency
417           required: true
418           type: string
419   /cloud-infrastructure/complexes:
420     get:
421       tags:
422         - CloudInfrastructure
423       summary: returns complexes
424       description: returns complexes
425       operationId: getCloudInfrastructureComplexes
426       produces:
427         - application/json
428         - application/xml
429       responses:
430         "200":
431           description: successful operation
432           schema:
433               $ref: "#/definitions/complexes"
434         "default":
435           description: Response codes found in [response codes](https://wiki.onap.org/).
436   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
437     put:
438       tags:
439         - CloudInfrastructure
440       summary: see node definition for valid relationships
441       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
442       consumes:
443         - application/json
444         - application/xml
445       produces:
446         - application/json
447         - application/xml
448       responses:
449         "default":
450           description: Response codes found in [response codes](https://wiki.onap.org/).
451       parameters:
452         - name: cloud-owner
453           in: path
454           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
455           required: true
456           type: string
457         - name: cloud-region-id
458           in: path
459           description: Identifier used by the vendor for the region. Second part of composite key
460           required: true
461           type: string
462         - name: volume-group-id
463           in: path
464           description: Unique ID of volume-group.
465           required: true
466           type: string
467         - name: body
468           in: body
469           description: relationship object that needs to be created or updated
470           required: true
471           schema:
472             $ref: "#/definitions/relationship"
473     delete:
474       tags:
475         - CloudInfrastructure
476       summary: delete an existing relationship
477       description: delete an existing relationship
478       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
479       consumes:
480         - application/json
481         - application/xml
482       produces:
483         - application/json
484         - application/xml
485       responses:
486         "default":
487           description: Response codes found in [response codes](https://wiki.onap.org/).
488       parameters:
489         - name: cloud-owner
490           in: path
491           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
492           required: true
493           type: string
494         - name: cloud-region-id
495           in: path
496           description: Identifier used by the vendor for the region. Second part of composite key
497           required: true
498           type: string
499         - name: volume-group-id
500           in: path
501           description: Unique ID of volume-group.
502           required: true
503           type: string
504   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
505     get:
506       tags:
507         - CloudInfrastructure
508       summary: returns volume-group
509       description: returns volume-group
510       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
511       produces:
512         - application/json
513         - application/xml
514       responses:
515         "200":
516           description: successful operation
517           schema:
518               $ref: "#/definitions/volume-group"
519         "default":
520           description: Response codes found in [response codes](https://wiki.onap.org/).
521       parameters:
522         - name: cloud-owner
523           in: path
524           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
525           required: true
526           type: string
527         - name: cloud-region-id
528           in: path
529           description: Identifier used by the vendor for the region. Second part of composite key
530           required: true
531           type: string
532         - name: volume-group-id
533           in: path
534           description: Unique ID of volume-group.
535           required: true
536           type: string
537         - name: cloud-type
538           in: query
539           description: Type of the cloud (e.g., openstack)
540           required: false
541           type: string
542         - name: owner-defined-type
543           in: query
544           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
545           required: false
546           type: string
547         - name: volume-group-name
548           in: query
549           description: Name of the volume group.
550           required: false
551           type: string
552         - name: heat-stack-id
553           in: query
554           description: Heat stack id corresponding to this volume-group
555           required: false
556           type: string
557         - name: vnf-type
558           in: query
559           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.
560           required: false
561           type: string
562     put:
563       tags:
564         - CloudInfrastructure
565       summary: create or update an existing volume-group
566       description: create or update an existing volume-group
567       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
568       consumes:
569         - application/json
570         - application/xml
571       produces:
572         - application/json
573         - application/xml
574       responses:
575         "default":
576           description: Response codes found in [response codes](https://wiki.onap.org/).
577       parameters:
578         - name: cloud-owner
579           in: path
580           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
581           required: true
582           type: string
583         - name: cloud-region-id
584           in: path
585           description: Identifier used by the vendor for the region. Second part of composite key
586           required: true
587           type: string
588         - name: volume-group-id
589           in: path
590           description: Unique ID of volume-group.
591           required: true
592           type: string
593         - name: body
594           in: body
595           description: volume-group object that needs to be created or updated
596           required: true
597           schema:
598             $ref: "#/definitions/volume-group"
599     delete:
600       tags:
601         - CloudInfrastructure
602       summary: delete an existing volume-group
603       description: delete an existing volume-group
604       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
605       consumes:
606         - application/json
607         - application/xml
608       produces:
609         - application/json
610         - application/xml
611       responses:
612         "default":
613           description: Response codes found in [response codes](https://wiki.onap.org/).
614       parameters:
615         - name: cloud-owner
616           in: path
617           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
618           required: true
619           type: string
620         - name: cloud-region-id
621           in: path
622           description: Identifier used by the vendor for the region. Second part of composite key
623           required: true
624           type: string
625         - name: volume-group-id
626           in: path
627           description: Unique ID of volume-group.
628           required: true
629           type: string
630         - name: resource-version
631           in: query
632           description: resource-version for concurrency
633           required: true
634           type: string
635   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
636     get:
637       tags:
638         - CloudInfrastructure
639       summary: returns volume-groups
640       description: returns volume-groups
641       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
642       produces:
643         - application/json
644         - application/xml
645       responses:
646         "200":
647           description: successful operation
648           schema:
649               $ref: "#/definitions/volume-groups"
650         "default":
651           description: Response codes found in [response codes](https://wiki.onap.org/).
652       parameters:
653         - name: cloud-owner
654           in: path
655           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
656           required: true
657           type: string
658         - name: cloud-region-id
659           in: path
660           description: Identifier used by the vendor for the region. Second part of composite key
661           required: true
662           type: string
663         - name: cloud-type
664           in: query
665           description: Type of the cloud (e.g., openstack)
666           required: false
667           type: string
668         - name: owner-defined-type
669           in: query
670           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
671           required: false
672           type: string
673   /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:
674     put:
675       tags:
676         - CloudInfrastructure
677       summary: see node definition for valid relationships
678       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
679       consumes:
680         - application/json
681         - application/xml
682       produces:
683         - application/json
684         - application/xml
685       responses:
686         "default":
687           description: Response codes found in [response codes](https://wiki.onap.org/).
688       parameters:
689         - name: cloud-owner
690           in: path
691           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
692           required: true
693           type: string
694         - name: cloud-region-id
695           in: path
696           description: Identifier used by the vendor for the region. Second part of composite key
697           required: true
698           type: string
699         - name: tenant-id
700           in: path
701           description: Unique id relative to the cloud-region.
702           required: true
703           type: string
704         - name: vserver-id
705           in: path
706           description: Unique identifier for this vserver relative to its tenant
707           required: true
708           type: string
709         - name: volume-id
710           in: path
711           description: Unique ID of block storage volume relative to the vserver.
712           required: true
713           type: string
714         - name: body
715           in: body
716           description: relationship object that needs to be created or updated
717           required: true
718           schema:
719             $ref: "#/definitions/relationship"
720     delete:
721       tags:
722         - CloudInfrastructure
723       summary: delete an existing relationship
724       description: delete an existing relationship
725       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
726       consumes:
727         - application/json
728         - application/xml
729       produces:
730         - application/json
731         - application/xml
732       responses:
733         "default":
734           description: Response codes found in [response codes](https://wiki.onap.org/).
735       parameters:
736         - name: cloud-owner
737           in: path
738           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
739           required: true
740           type: string
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         - name: tenant-id
747           in: path
748           description: Unique id relative to the cloud-region.
749           required: true
750           type: string
751         - name: vserver-id
752           in: path
753           description: Unique identifier for this vserver relative to its tenant
754           required: true
755           type: string
756         - name: volume-id
757           in: path
758           description: Unique ID of block storage volume relative to the vserver.
759           required: true
760           type: string
761   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
762     get:
763       tags:
764         - CloudInfrastructure
765       summary: returns volume
766       description: returns volume
767       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
768       produces:
769         - application/json
770         - application/xml
771       responses:
772         "200":
773           description: successful operation
774           schema:
775               $ref: "#/definitions/volume"
776         "default":
777           description: Response codes found in [response codes](https://wiki.onap.org/).
778       parameters:
779         - name: cloud-owner
780           in: path
781           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
782           required: true
783           type: string
784         - name: cloud-region-id
785           in: path
786           description: Identifier used by the vendor for the region. Second part of composite key
787           required: true
788           type: string
789         - name: tenant-id
790           in: path
791           description: Unique id relative to the cloud-region.
792           required: true
793           type: string
794         - name: vserver-id
795           in: path
796           description: Unique identifier for this vserver relative to its tenant
797           required: true
798           type: string
799         - name: volume-id
800           in: path
801           description: Unique ID of block storage volume relative to the vserver.
802           required: true
803           type: string
804         - name: cloud-type
805           in: query
806           description: Type of the cloud (e.g., openstack)
807           required: false
808           type: string
809         - name: owner-defined-type
810           in: query
811           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
812           required: false
813           type: string
814         - name: tenant-name
815           in: query
816           description: Readable name of tenant
817           required: false
818           type: string
819         - name: tenant-context
820           in: query
821           description: This field will store the tenant context.
822           required: false
823           type: string
824         - name: vserver-name
825           in: query
826           description: Name of vserver
827           required: false
828           type: string
829         - name: vserver-name2
830           in: query
831           description: Alternative name of vserver
832           required: false
833           type: string
834         - name: prov-status
835           in: query
836           description: Trigger for operational monitoring of this resource by Service Assurance systems.
837           required: false
838           type: string
839         - name: in-maint
840           in: query
841           required: false
842           type: boolean
843         - name: is-closed-loop-disabled
844           in: query
845           required: false
846           type: boolean
847     put:
848       tags:
849         - CloudInfrastructure
850       summary: create or update an existing volume
851       description: create or update an existing volume
852       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
853       consumes:
854         - application/json
855         - application/xml
856       produces:
857         - application/json
858         - application/xml
859       responses:
860         "default":
861           description: Response codes found in [response codes](https://wiki.onap.org/).
862       parameters:
863         - name: cloud-owner
864           in: path
865           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
866           required: true
867           type: string
868         - name: cloud-region-id
869           in: path
870           description: Identifier used by the vendor for the region. Second part of composite key
871           required: true
872           type: string
873         - name: tenant-id
874           in: path
875           description: Unique id relative to the cloud-region.
876           required: true
877           type: string
878         - name: vserver-id
879           in: path
880           description: Unique identifier for this vserver relative to its tenant
881           required: true
882           type: string
883         - name: volume-id
884           in: path
885           description: Unique ID of block storage volume relative to the vserver.
886           required: true
887           type: string
888         - name: body
889           in: body
890           description: volume object that needs to be created or updated
891           required: true
892           schema:
893             $ref: "#/definitions/volume"
894     delete:
895       tags:
896         - CloudInfrastructure
897       summary: delete an existing volume
898       description: delete an existing volume
899       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
900       consumes:
901         - application/json
902         - application/xml
903       produces:
904         - application/json
905         - application/xml
906       responses:
907         "default":
908           description: Response codes found in [response codes](https://wiki.onap.org/).
909       parameters:
910         - name: cloud-owner
911           in: path
912           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
913           required: true
914           type: string
915         - name: cloud-region-id
916           in: path
917           description: Identifier used by the vendor for the region. Second part of composite key
918           required: true
919           type: string
920         - name: tenant-id
921           in: path
922           description: Unique id relative to the cloud-region.
923           required: true
924           type: string
925         - name: vserver-id
926           in: path
927           description: Unique identifier for this vserver relative to its tenant
928           required: true
929           type: string
930         - name: volume-id
931           in: path
932           description: Unique ID of block storage volume relative to the vserver.
933           required: true
934           type: string
935         - name: resource-version
936           in: query
937           description: resource-version for concurrency
938           required: true
939           type: string
940   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
941     get:
942       tags:
943         - CloudInfrastructure
944       summary: returns volumes
945       description: returns volumes
946       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
947       produces:
948         - application/json
949         - application/xml
950       responses:
951         "200":
952           description: successful operation
953           schema:
954               $ref: "#/definitions/volumes"
955         "default":
956           description: Response codes found in [response codes](https://wiki.onap.org/).
957       parameters:
958         - name: cloud-owner
959           in: path
960           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
961           required: true
962           type: string
963         - name: cloud-region-id
964           in: path
965           description: Identifier used by the vendor for the region. Second part of composite key
966           required: true
967           type: string
968         - name: tenant-id
969           in: path
970           description: Unique id relative to the cloud-region.
971           required: true
972           type: string
973         - name: vserver-id
974           in: path
975           description: Unique identifier for this vserver relative to its tenant
976           required: true
977           type: string
978         - name: cloud-type
979           in: query
980           description: Type of the cloud (e.g., openstack)
981           required: false
982           type: string
983         - name: owner-defined-type
984           in: query
985           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
986           required: false
987           type: string
988         - name: tenant-name
989           in: query
990           description: Readable name of tenant
991           required: false
992           type: string
993         - name: tenant-context
994           in: query
995           description: This field will store the tenant context.
996           required: false
997           type: string
998         - name: vserver-name
999           in: query
1000           description: Name of vserver
1001           required: false
1002           type: string
1003         - name: vserver-name2
1004           in: query
1005           description: Alternative name of vserver
1006           required: false
1007           type: string
1008         - name: prov-status
1009           in: query
1010           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1011           required: false
1012           type: string
1013         - name: in-maint
1014           in: query
1015           required: false
1016           type: boolean
1017         - name: is-closed-loop-disabled
1018           in: query
1019           required: false
1020           type: boolean
1021   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1022     put:
1023       tags:
1024         - CloudInfrastructure
1025       summary: see node definition for valid relationships
1026       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1027       consumes:
1028         - application/json
1029         - application/xml
1030       produces:
1031         - application/json
1032         - application/xml
1033       responses:
1034         "default":
1035           description: Response codes found in [response codes](https://wiki.onap.org/).
1036       parameters:
1037         - name: cloud-owner
1038           in: path
1039           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1040           required: true
1041           type: string
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         - name: tenant-id
1048           in: path
1049           description: Unique id relative to the cloud-region.
1050           required: true
1051           type: string
1052         - name: vserver-id
1053           in: path
1054           description: Unique identifier for this vserver relative to its tenant
1055           required: true
1056           type: string
1057         - name: body
1058           in: body
1059           description: relationship object that needs to be created or updated
1060           required: true
1061           schema:
1062             $ref: "#/definitions/relationship"
1063     delete:
1064       tags:
1065         - CloudInfrastructure
1066       summary: delete an existing relationship
1067       description: delete an existing relationship
1068       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1069       consumes:
1070         - application/json
1071         - application/xml
1072       produces:
1073         - application/json
1074         - application/xml
1075       responses:
1076         "default":
1077           description: Response codes found in [response codes](https://wiki.onap.org/).
1078       parameters:
1079         - name: cloud-owner
1080           in: path
1081           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1082           required: true
1083           type: string
1084         - name: cloud-region-id
1085           in: path
1086           description: Identifier used by the vendor for the region. Second part of composite key
1087           required: true
1088           type: string
1089         - name: tenant-id
1090           in: path
1091           description: Unique id relative to the cloud-region.
1092           required: true
1093           type: string
1094         - name: vserver-id
1095           in: path
1096           description: Unique identifier for this vserver relative to its tenant
1097           required: true
1098           type: string
1099   /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:
1100     put:
1101       tags:
1102         - CloudInfrastructure
1103       summary: see node definition for valid relationships
1104       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1105       consumes:
1106         - application/json
1107         - application/xml
1108       produces:
1109         - application/json
1110         - application/xml
1111       responses:
1112         "default":
1113           description: Response codes found in [response codes](https://wiki.onap.org/).
1114       parameters:
1115         - name: cloud-owner
1116           in: path
1117           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1118           required: true
1119           type: string
1120         - name: cloud-region-id
1121           in: path
1122           description: Identifier used by the vendor for the region. Second part of composite key
1123           required: true
1124           type: string
1125         - name: tenant-id
1126           in: path
1127           description: Unique id relative to the cloud-region.
1128           required: true
1129           type: string
1130         - name: vserver-id
1131           in: path
1132           description: Unique identifier for this vserver relative to its tenant
1133           required: true
1134           type: string
1135         - name: interface-name
1136           in: path
1137           description: Name given to the interface
1138           required: true
1139           type: string
1140         - name: vlan-interface
1141           in: path
1142           description: String that identifies the interface
1143           required: true
1144           type: string
1145         - name: body
1146           in: body
1147           description: relationship object that needs to be created or updated
1148           required: true
1149           schema:
1150             $ref: "#/definitions/relationship"
1151     delete:
1152       tags:
1153         - CloudInfrastructure
1154       summary: delete an existing relationship
1155       description: delete an existing relationship
1156       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1157       consumes:
1158         - application/json
1159         - application/xml
1160       produces:
1161         - application/json
1162         - application/xml
1163       responses:
1164         "default":
1165           description: Response codes found in [response codes](https://wiki.onap.org/).
1166       parameters:
1167         - name: cloud-owner
1168           in: path
1169           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1170           required: true
1171           type: string
1172         - name: cloud-region-id
1173           in: path
1174           description: Identifier used by the vendor for the region. Second part of composite key
1175           required: true
1176           type: string
1177         - name: tenant-id
1178           in: path
1179           description: Unique id relative to the cloud-region.
1180           required: true
1181           type: string
1182         - name: vserver-id
1183           in: path
1184           description: Unique identifier for this vserver relative to its tenant
1185           required: true
1186           type: string
1187         - name: interface-name
1188           in: path
1189           description: Name given to the interface
1190           required: true
1191           type: string
1192         - name: vlan-interface
1193           in: path
1194           description: String that identifies the interface
1195           required: true
1196           type: string
1197   /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:
1198     put:
1199       tags:
1200         - CloudInfrastructure
1201       summary: see node definition for valid relationships
1202       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1203       consumes:
1204         - application/json
1205         - application/xml
1206       produces:
1207         - application/json
1208         - application/xml
1209       responses:
1210         "default":
1211           description: Response codes found in [response codes](https://wiki.onap.org/).
1212       parameters:
1213         - name: cloud-owner
1214           in: path
1215           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1216           required: true
1217           type: string
1218         - name: cloud-region-id
1219           in: path
1220           description: Identifier used by the vendor for the region. Second part of composite key
1221           required: true
1222           type: string
1223         - name: tenant-id
1224           in: path
1225           description: Unique id relative to the cloud-region.
1226           required: true
1227           type: string
1228         - name: vserver-id
1229           in: path
1230           description: Unique identifier for this vserver relative to its tenant
1231           required: true
1232           type: string
1233         - name: interface-name
1234           in: path
1235           description: Name given to the interface
1236           required: true
1237           type: string
1238         - name: vlan-interface
1239           in: path
1240           description: String that identifies the interface
1241           required: true
1242           type: string
1243         - name: l3-interface-ipv4-address
1244           in: path
1245           description: IP address
1246           required: true
1247           type: string
1248         - name: body
1249           in: body
1250           description: relationship object that needs to be created or updated
1251           required: true
1252           schema:
1253             $ref: "#/definitions/relationship"
1254     delete:
1255       tags:
1256         - CloudInfrastructure
1257       summary: delete an existing relationship
1258       description: delete an existing relationship
1259       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1260       consumes:
1261         - application/json
1262         - application/xml
1263       produces:
1264         - application/json
1265         - application/xml
1266       responses:
1267         "default":
1268           description: Response codes found in [response codes](https://wiki.onap.org/).
1269       parameters:
1270         - name: cloud-owner
1271           in: path
1272           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1273           required: true
1274           type: string
1275         - name: cloud-region-id
1276           in: path
1277           description: Identifier used by the vendor for the region. Second part of composite key
1278           required: true
1279           type: string
1280         - name: tenant-id
1281           in: path
1282           description: Unique id relative to the cloud-region.
1283           required: true
1284           type: string
1285         - name: vserver-id
1286           in: path
1287           description: Unique identifier for this vserver relative to its tenant
1288           required: true
1289           type: string
1290         - name: interface-name
1291           in: path
1292           description: Name given to the interface
1293           required: true
1294           type: string
1295         - name: vlan-interface
1296           in: path
1297           description: String that identifies the interface
1298           required: true
1299           type: string
1300         - name: l3-interface-ipv4-address
1301           in: path
1302           description: IP address
1303           required: true
1304           type: string
1305   /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}:
1306     get:
1307       tags:
1308         - CloudInfrastructure
1309       summary: returns l3-interface-ipv4-address-list
1310       description: returns l3-interface-ipv4-address-list
1311       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1312       produces:
1313         - application/json
1314         - application/xml
1315       responses:
1316         "200":
1317           description: successful operation
1318           schema:
1319               $ref: "#/definitions/l3-interface-ipv4-address-list"
1320         "default":
1321           description: Response codes found in [response codes](https://wiki.onap.org/).
1322       parameters:
1323         - name: cloud-owner
1324           in: path
1325           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1326           required: true
1327           type: string
1328         - name: cloud-region-id
1329           in: path
1330           description: Identifier used by the vendor for the region. Second part of composite key
1331           required: true
1332           type: string
1333         - name: tenant-id
1334           in: path
1335           description: Unique id relative to the cloud-region.
1336           required: true
1337           type: string
1338         - name: vserver-id
1339           in: path
1340           description: Unique identifier for this vserver relative to its tenant
1341           required: true
1342           type: string
1343         - name: interface-name
1344           in: path
1345           description: Name given to the interface
1346           required: true
1347           type: string
1348         - name: vlan-interface
1349           in: path
1350           description: String that identifies the interface
1351           required: true
1352           type: string
1353         - name: l3-interface-ipv4-address
1354           in: path
1355           description: IP address
1356           required: true
1357           type: string
1358         - name: cloud-type
1359           in: query
1360           description: Type of the cloud (e.g., openstack)
1361           required: false
1362           type: string
1363         - name: owner-defined-type
1364           in: query
1365           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1366           required: false
1367           type: string
1368         - name: tenant-name
1369           in: query
1370           description: Readable name of tenant
1371           required: false
1372           type: string
1373         - name: tenant-context
1374           in: query
1375           description: This field will store the tenant context.
1376           required: false
1377           type: string
1378         - name: vserver-name
1379           in: query
1380           description: Name of vserver
1381           required: false
1382           type: string
1383         - name: vserver-name2
1384           in: query
1385           description: Alternative name of vserver
1386           required: false
1387           type: string
1388         - name: prov-status
1389           in: query
1390           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1391           required: false
1392           type: string
1393         - name: in-maint
1394           in: query
1395           required: false
1396           type: boolean
1397         - name: is-closed-loop-disabled
1398           in: query
1399           required: false
1400           type: boolean
1401         - name: interface-id
1402           in: query
1403           description: ID of interface
1404           required: false
1405           type: string
1406         - name: macaddr
1407           in: query
1408           description: MAC address for the interface
1409           required: false
1410           type: string
1411         - name: network-name
1412           in: query
1413           description: Name of the network
1414           required: false
1415           type: string
1416         - name: vlan-id-inner
1417           in: query
1418           description: Inner VLAN tag
1419           required: false
1420           type: integer
1421           format: int64
1422         - name: vpn-key
1423           in: query
1424           description: This indicates the customers VPN ID associated with this vlan
1425           required: false
1426           type: string
1427         - name: vlan-id-inner
1428           in: query
1429           description: Inner VLAN tag
1430           required: false
1431           type: integer
1432           format: int64
1433         - name: neutron-network-id
1434           in: query
1435           description: Neutron network id of the interface that address belongs to
1436           required: false
1437           type: string
1438         - name: neutron-subnet-id
1439           in: query
1440           description: Neutron id of subnet that address belongs to
1441           required: false
1442           type: string
1443     put:
1444       tags:
1445         - CloudInfrastructure
1446       summary: create or update an existing l3-interface-ipv4-address-list
1447       description: create or update an existing l3-interface-ipv4-address-list
1448       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1449       consumes:
1450         - application/json
1451         - application/xml
1452       produces:
1453         - application/json
1454         - application/xml
1455       responses:
1456         "default":
1457           description: Response codes found in [response codes](https://wiki.onap.org/).
1458       parameters:
1459         - name: cloud-owner
1460           in: path
1461           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1462           required: true
1463           type: string
1464         - name: cloud-region-id
1465           in: path
1466           description: Identifier used by the vendor for the region. Second part of composite key
1467           required: true
1468           type: string
1469         - name: tenant-id
1470           in: path
1471           description: Unique id relative to the cloud-region.
1472           required: true
1473           type: string
1474         - name: vserver-id
1475           in: path
1476           description: Unique identifier for this vserver relative to its tenant
1477           required: true
1478           type: string
1479         - name: interface-name
1480           in: path
1481           description: Name given to the interface
1482           required: true
1483           type: string
1484         - name: vlan-interface
1485           in: path
1486           description: String that identifies the interface
1487           required: true
1488           type: string
1489         - name: l3-interface-ipv4-address
1490           in: path
1491           description: IP address
1492           required: true
1493           type: string
1494         - name: body
1495           in: body
1496           description: l3-interface-ipv4-address-list object that needs to be created or updated
1497           required: true
1498           schema:
1499             $ref: "#/definitions/l3-interface-ipv4-address-list"
1500     delete:
1501       tags:
1502         - CloudInfrastructure
1503       summary: delete an existing l3-interface-ipv4-address-list
1504       description: delete an existing l3-interface-ipv4-address-list
1505       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1506       consumes:
1507         - application/json
1508         - application/xml
1509       produces:
1510         - application/json
1511         - application/xml
1512       responses:
1513         "default":
1514           description: Response codes found in [response codes](https://wiki.onap.org/).
1515       parameters:
1516         - name: cloud-owner
1517           in: path
1518           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1519           required: true
1520           type: string
1521         - name: cloud-region-id
1522           in: path
1523           description: Identifier used by the vendor for the region. Second part of composite key
1524           required: true
1525           type: string
1526         - name: tenant-id
1527           in: path
1528           description: Unique id relative to the cloud-region.
1529           required: true
1530           type: string
1531         - name: vserver-id
1532           in: path
1533           description: Unique identifier for this vserver relative to its tenant
1534           required: true
1535           type: string
1536         - name: interface-name
1537           in: path
1538           description: Name given to the interface
1539           required: true
1540           type: string
1541         - name: vlan-interface
1542           in: path
1543           description: String that identifies the interface
1544           required: true
1545           type: string
1546         - name: l3-interface-ipv4-address
1547           in: path
1548           description: IP address
1549           required: true
1550           type: string
1551         - name: resource-version
1552           in: query
1553           description: resource-version for concurrency
1554           required: true
1555           type: string
1556   /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:
1557     put:
1558       tags:
1559         - CloudInfrastructure
1560       summary: see node definition for valid relationships
1561       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1562       consumes:
1563         - application/json
1564         - application/xml
1565       produces:
1566         - application/json
1567         - application/xml
1568       responses:
1569         "default":
1570           description: Response codes found in [response codes](https://wiki.onap.org/).
1571       parameters:
1572         - name: cloud-owner
1573           in: path
1574           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1575           required: true
1576           type: string
1577         - name: cloud-region-id
1578           in: path
1579           description: Identifier used by the vendor for the region. Second part of composite key
1580           required: true
1581           type: string
1582         - name: tenant-id
1583           in: path
1584           description: Unique id relative to the cloud-region.
1585           required: true
1586           type: string
1587         - name: vserver-id
1588           in: path
1589           description: Unique identifier for this vserver relative to its tenant
1590           required: true
1591           type: string
1592         - name: interface-name
1593           in: path
1594           description: Name given to the interface
1595           required: true
1596           type: string
1597         - name: vlan-interface
1598           in: path
1599           description: String that identifies the interface
1600           required: true
1601           type: string
1602         - name: l3-interface-ipv6-address
1603           in: path
1604           description: IP address
1605           required: true
1606           type: string
1607         - name: body
1608           in: body
1609           description: relationship object that needs to be created or updated
1610           required: true
1611           schema:
1612             $ref: "#/definitions/relationship"
1613     delete:
1614       tags:
1615         - CloudInfrastructure
1616       summary: delete an existing relationship
1617       description: delete an existing relationship
1618       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1619       consumes:
1620         - application/json
1621         - application/xml
1622       produces:
1623         - application/json
1624         - application/xml
1625       responses:
1626         "default":
1627           description: Response codes found in [response codes](https://wiki.onap.org/).
1628       parameters:
1629         - name: cloud-owner
1630           in: path
1631           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1632           required: true
1633           type: string
1634         - name: cloud-region-id
1635           in: path
1636           description: Identifier used by the vendor for the region. Second part of composite key
1637           required: true
1638           type: string
1639         - name: tenant-id
1640           in: path
1641           description: Unique id relative to the cloud-region.
1642           required: true
1643           type: string
1644         - name: vserver-id
1645           in: path
1646           description: Unique identifier for this vserver relative to its tenant
1647           required: true
1648           type: string
1649         - name: interface-name
1650           in: path
1651           description: Name given to the interface
1652           required: true
1653           type: string
1654         - name: vlan-interface
1655           in: path
1656           description: String that identifies the interface
1657           required: true
1658           type: string
1659         - name: l3-interface-ipv6-address
1660           in: path
1661           description: IP address
1662           required: true
1663           type: string
1664   /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}:
1665     get:
1666       tags:
1667         - CloudInfrastructure
1668       summary: returns l3-interface-ipv6-address-list
1669       description: returns l3-interface-ipv6-address-list
1670       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1671       produces:
1672         - application/json
1673         - application/xml
1674       responses:
1675         "200":
1676           description: successful operation
1677           schema:
1678               $ref: "#/definitions/l3-interface-ipv6-address-list"
1679         "default":
1680           description: Response codes found in [response codes](https://wiki.onap.org/).
1681       parameters:
1682         - name: cloud-owner
1683           in: path
1684           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1685           required: true
1686           type: string
1687         - name: cloud-region-id
1688           in: path
1689           description: Identifier used by the vendor for the region. Second part of composite key
1690           required: true
1691           type: string
1692         - name: tenant-id
1693           in: path
1694           description: Unique id relative to the cloud-region.
1695           required: true
1696           type: string
1697         - name: vserver-id
1698           in: path
1699           description: Unique identifier for this vserver relative to its tenant
1700           required: true
1701           type: string
1702         - name: interface-name
1703           in: path
1704           description: Name given to the interface
1705           required: true
1706           type: string
1707         - name: vlan-interface
1708           in: path
1709           description: String that identifies the interface
1710           required: true
1711           type: string
1712         - name: l3-interface-ipv6-address
1713           in: path
1714           description: IP address
1715           required: true
1716           type: string
1717         - name: cloud-type
1718           in: query
1719           description: Type of the cloud (e.g., openstack)
1720           required: false
1721           type: string
1722         - name: owner-defined-type
1723           in: query
1724           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1725           required: false
1726           type: string
1727         - name: tenant-name
1728           in: query
1729           description: Readable name of tenant
1730           required: false
1731           type: string
1732         - name: tenant-context
1733           in: query
1734           description: This field will store the tenant context.
1735           required: false
1736           type: string
1737         - name: vserver-name
1738           in: query
1739           description: Name of vserver
1740           required: false
1741           type: string
1742         - name: vserver-name2
1743           in: query
1744           description: Alternative name of vserver
1745           required: false
1746           type: string
1747         - name: prov-status
1748           in: query
1749           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1750           required: false
1751           type: string
1752         - name: in-maint
1753           in: query
1754           required: false
1755           type: boolean
1756         - name: is-closed-loop-disabled
1757           in: query
1758           required: false
1759           type: boolean
1760         - name: interface-id
1761           in: query
1762           description: ID of interface
1763           required: false
1764           type: string
1765         - name: macaddr
1766           in: query
1767           description: MAC address for the interface
1768           required: false
1769           type: string
1770         - name: network-name
1771           in: query
1772           description: Name of the network
1773           required: false
1774           type: string
1775         - name: vlan-id-inner
1776           in: query
1777           description: Inner VLAN tag
1778           required: false
1779           type: integer
1780           format: int64
1781         - name: vpn-key
1782           in: query
1783           description: This indicates the customers VPN ID associated with this vlan
1784           required: false
1785           type: string
1786         - name: vlan-id-inner
1787           in: query
1788           description: Inner VLAN tag
1789           required: false
1790           type: integer
1791           format: int64
1792         - name: neutron-network-id
1793           in: query
1794           description: Neutron network id of the interface that address belongs to
1795           required: false
1796           type: string
1797         - name: neutron-subnet-id
1798           in: query
1799           description: Neutron id of subnet that address belongs to
1800           required: false
1801           type: string
1802     put:
1803       tags:
1804         - CloudInfrastructure
1805       summary: create or update an existing l3-interface-ipv6-address-list
1806       description: create or update an existing l3-interface-ipv6-address-list
1807       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1808       consumes:
1809         - application/json
1810         - application/xml
1811       produces:
1812         - application/json
1813         - application/xml
1814       responses:
1815         "default":
1816           description: Response codes found in [response codes](https://wiki.onap.org/).
1817       parameters:
1818         - name: cloud-owner
1819           in: path
1820           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1821           required: true
1822           type: string
1823         - name: cloud-region-id
1824           in: path
1825           description: Identifier used by the vendor for the region. Second part of composite key
1826           required: true
1827           type: string
1828         - name: tenant-id
1829           in: path
1830           description: Unique id relative to the cloud-region.
1831           required: true
1832           type: string
1833         - name: vserver-id
1834           in: path
1835           description: Unique identifier for this vserver relative to its tenant
1836           required: true
1837           type: string
1838         - name: interface-name
1839           in: path
1840           description: Name given to the interface
1841           required: true
1842           type: string
1843         - name: vlan-interface
1844           in: path
1845           description: String that identifies the interface
1846           required: true
1847           type: string
1848         - name: l3-interface-ipv6-address
1849           in: path
1850           description: IP address
1851           required: true
1852           type: string
1853         - name: body
1854           in: body
1855           description: l3-interface-ipv6-address-list object that needs to be created or updated
1856           required: true
1857           schema:
1858             $ref: "#/definitions/l3-interface-ipv6-address-list"
1859     delete:
1860       tags:
1861         - CloudInfrastructure
1862       summary: delete an existing l3-interface-ipv6-address-list
1863       description: delete an existing l3-interface-ipv6-address-list
1864       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1865       consumes:
1866         - application/json
1867         - application/xml
1868       produces:
1869         - application/json
1870         - application/xml
1871       responses:
1872         "default":
1873           description: Response codes found in [response codes](https://wiki.onap.org/).
1874       parameters:
1875         - name: cloud-owner
1876           in: path
1877           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1878           required: true
1879           type: string
1880         - name: cloud-region-id
1881           in: path
1882           description: Identifier used by the vendor for the region. Second part of composite key
1883           required: true
1884           type: string
1885         - name: tenant-id
1886           in: path
1887           description: Unique id relative to the cloud-region.
1888           required: true
1889           type: string
1890         - name: vserver-id
1891           in: path
1892           description: Unique identifier for this vserver relative to its tenant
1893           required: true
1894           type: string
1895         - name: interface-name
1896           in: path
1897           description: Name given to the interface
1898           required: true
1899           type: string
1900         - name: vlan-interface
1901           in: path
1902           description: String that identifies the interface
1903           required: true
1904           type: string
1905         - name: l3-interface-ipv6-address
1906           in: path
1907           description: IP address
1908           required: true
1909           type: string
1910         - name: resource-version
1911           in: query
1912           description: resource-version for concurrency
1913           required: true
1914           type: string
1915   /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}:
1916     get:
1917       tags:
1918         - CloudInfrastructure
1919       summary: returns vlan
1920       description: returns vlan
1921       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
1922       produces:
1923         - application/json
1924         - application/xml
1925       responses:
1926         "200":
1927           description: successful operation
1928           schema:
1929               $ref: "#/definitions/vlan"
1930         "default":
1931           description: Response codes found in [response codes](https://wiki.onap.org/).
1932       parameters:
1933         - name: cloud-owner
1934           in: path
1935           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1936           required: true
1937           type: string
1938         - name: cloud-region-id
1939           in: path
1940           description: Identifier used by the vendor for the region. Second part of composite key
1941           required: true
1942           type: string
1943         - name: tenant-id
1944           in: path
1945           description: Unique id relative to the cloud-region.
1946           required: true
1947           type: string
1948         - name: vserver-id
1949           in: path
1950           description: Unique identifier for this vserver relative to its tenant
1951           required: true
1952           type: string
1953         - name: interface-name
1954           in: path
1955           description: Name given to the interface
1956           required: true
1957           type: string
1958         - name: vlan-interface
1959           in: path
1960           description: String that identifies the interface
1961           required: true
1962           type: string
1963         - name: cloud-type
1964           in: query
1965           description: Type of the cloud (e.g., openstack)
1966           required: false
1967           type: string
1968         - name: owner-defined-type
1969           in: query
1970           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1971           required: false
1972           type: string
1973         - name: tenant-name
1974           in: query
1975           description: Readable name of tenant
1976           required: false
1977           type: string
1978         - name: tenant-context
1979           in: query
1980           description: This field will store the tenant context.
1981           required: false
1982           type: string
1983         - name: vserver-name
1984           in: query
1985           description: Name of vserver
1986           required: false
1987           type: string
1988         - name: vserver-name2
1989           in: query
1990           description: Alternative name of vserver
1991           required: false
1992           type: string
1993         - name: prov-status
1994           in: query
1995           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1996           required: false
1997           type: string
1998         - name: in-maint
1999           in: query
2000           required: false
2001           type: boolean
2002         - name: is-closed-loop-disabled
2003           in: query
2004           required: false
2005           type: boolean
2006         - name: interface-id
2007           in: query
2008           description: ID of interface
2009           required: false
2010           type: string
2011         - name: macaddr
2012           in: query
2013           description: MAC address for the interface
2014           required: false
2015           type: string
2016         - name: network-name
2017           in: query
2018           description: Name of the network
2019           required: false
2020           type: string
2021         - name: vlan-id-inner
2022           in: query
2023           description: Inner VLAN tag
2024           required: false
2025           type: integer
2026           format: int64
2027         - name: vpn-key
2028           in: query
2029           description: This indicates the customers VPN ID associated with this vlan
2030           required: false
2031           type: string
2032     put:
2033       tags:
2034         - CloudInfrastructure
2035       summary: create or update an existing vlan
2036       description: create or update an existing vlan
2037       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2038       consumes:
2039         - application/json
2040         - application/xml
2041       produces:
2042         - application/json
2043         - application/xml
2044       responses:
2045         "default":
2046           description: Response codes found in [response codes](https://wiki.onap.org/).
2047       parameters:
2048         - name: cloud-owner
2049           in: path
2050           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2051           required: true
2052           type: string
2053         - name: cloud-region-id
2054           in: path
2055           description: Identifier used by the vendor for the region. Second part of composite key
2056           required: true
2057           type: string
2058         - name: tenant-id
2059           in: path
2060           description: Unique id relative to the cloud-region.
2061           required: true
2062           type: string
2063         - name: vserver-id
2064           in: path
2065           description: Unique identifier for this vserver relative to its tenant
2066           required: true
2067           type: string
2068         - name: interface-name
2069           in: path
2070           description: Name given to the interface
2071           required: true
2072           type: string
2073         - name: vlan-interface
2074           in: path
2075           description: String that identifies the interface
2076           required: true
2077           type: string
2078         - name: body
2079           in: body
2080           description: vlan object that needs to be created or updated
2081           required: true
2082           schema:
2083             $ref: "#/definitions/vlan"
2084     delete:
2085       tags:
2086         - CloudInfrastructure
2087       summary: delete an existing vlan
2088       description: delete an existing vlan
2089       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2090       consumes:
2091         - application/json
2092         - application/xml
2093       produces:
2094         - application/json
2095         - application/xml
2096       responses:
2097         "default":
2098           description: Response codes found in [response codes](https://wiki.onap.org/).
2099       parameters:
2100         - name: cloud-owner
2101           in: path
2102           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2103           required: true
2104           type: string
2105         - name: cloud-region-id
2106           in: path
2107           description: Identifier used by the vendor for the region. Second part of composite key
2108           required: true
2109           type: string
2110         - name: tenant-id
2111           in: path
2112           description: Unique id relative to the cloud-region.
2113           required: true
2114           type: string
2115         - name: vserver-id
2116           in: path
2117           description: Unique identifier for this vserver relative to its tenant
2118           required: true
2119           type: string
2120         - name: interface-name
2121           in: path
2122           description: Name given to the interface
2123           required: true
2124           type: string
2125         - name: vlan-interface
2126           in: path
2127           description: String that identifies the interface
2128           required: true
2129           type: string
2130         - name: resource-version
2131           in: query
2132           description: resource-version for concurrency
2133           required: true
2134           type: string
2135   /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:
2136     get:
2137       tags:
2138         - CloudInfrastructure
2139       summary: returns vlans
2140       description: returns vlans
2141       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2142       produces:
2143         - application/json
2144         - application/xml
2145       responses:
2146         "200":
2147           description: successful operation
2148           schema:
2149               $ref: "#/definitions/vlans"
2150         "default":
2151           description: Response codes found in [response codes](https://wiki.onap.org/).
2152       parameters:
2153         - name: cloud-owner
2154           in: path
2155           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2156           required: true
2157           type: string
2158         - name: cloud-region-id
2159           in: path
2160           description: Identifier used by the vendor for the region. Second part of composite key
2161           required: true
2162           type: string
2163         - name: tenant-id
2164           in: path
2165           description: Unique id relative to the cloud-region.
2166           required: true
2167           type: string
2168         - name: vserver-id
2169           in: path
2170           description: Unique identifier for this vserver relative to its tenant
2171           required: true
2172           type: string
2173         - name: interface-name
2174           in: path
2175           description: Name given to the interface
2176           required: true
2177           type: string
2178         - name: cloud-type
2179           in: query
2180           description: Type of the cloud (e.g., openstack)
2181           required: false
2182           type: string
2183         - name: owner-defined-type
2184           in: query
2185           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2186           required: false
2187           type: string
2188         - name: tenant-name
2189           in: query
2190           description: Readable name of tenant
2191           required: false
2192           type: string
2193         - name: tenant-context
2194           in: query
2195           description: This field will store the tenant context.
2196           required: false
2197           type: string
2198         - name: vserver-name
2199           in: query
2200           description: Name of vserver
2201           required: false
2202           type: string
2203         - name: vserver-name2
2204           in: query
2205           description: Alternative name of vserver
2206           required: false
2207           type: string
2208         - name: prov-status
2209           in: query
2210           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2211           required: false
2212           type: string
2213         - name: in-maint
2214           in: query
2215           required: false
2216           type: boolean
2217         - name: is-closed-loop-disabled
2218           in: query
2219           required: false
2220           type: boolean
2221         - name: interface-id
2222           in: query
2223           description: ID of interface
2224           required: false
2225           type: string
2226         - name: macaddr
2227           in: query
2228           description: MAC address for the interface
2229           required: false
2230           type: string
2231         - name: network-name
2232           in: query
2233           description: Name of the network
2234           required: false
2235           type: string
2236   /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:
2237     put:
2238       tags:
2239         - CloudInfrastructure
2240       summary: see node definition for valid relationships
2241       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2242       consumes:
2243         - application/json
2244         - application/xml
2245       produces:
2246         - application/json
2247         - application/xml
2248       responses:
2249         "default":
2250           description: Response codes found in [response codes](https://wiki.onap.org/).
2251       parameters:
2252         - name: cloud-owner
2253           in: path
2254           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2255           required: true
2256           type: string
2257         - name: cloud-region-id
2258           in: path
2259           description: Identifier used by the vendor for the region. Second part of composite key
2260           required: true
2261           type: string
2262         - name: tenant-id
2263           in: path
2264           description: Unique id relative to the cloud-region.
2265           required: true
2266           type: string
2267         - name: vserver-id
2268           in: path
2269           description: Unique identifier for this vserver relative to its tenant
2270           required: true
2271           type: string
2272         - name: interface-name
2273           in: path
2274           description: Name given to the interface
2275           required: true
2276           type: string
2277         - name: pci-id
2278           in: path
2279           description: PCI ID used to identify the sriov-vf
2280           required: true
2281           type: string
2282         - name: body
2283           in: body
2284           description: relationship object that needs to be created or updated
2285           required: true
2286           schema:
2287             $ref: "#/definitions/relationship"
2288     delete:
2289       tags:
2290         - CloudInfrastructure
2291       summary: delete an existing relationship
2292       description: delete an existing relationship
2293       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2294       consumes:
2295         - application/json
2296         - application/xml
2297       produces:
2298         - application/json
2299         - application/xml
2300       responses:
2301         "default":
2302           description: Response codes found in [response codes](https://wiki.onap.org/).
2303       parameters:
2304         - name: cloud-owner
2305           in: path
2306           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2307           required: true
2308           type: string
2309         - name: cloud-region-id
2310           in: path
2311           description: Identifier used by the vendor for the region. Second part of composite key
2312           required: true
2313           type: string
2314         - name: tenant-id
2315           in: path
2316           description: Unique id relative to the cloud-region.
2317           required: true
2318           type: string
2319         - name: vserver-id
2320           in: path
2321           description: Unique identifier for this vserver relative to its tenant
2322           required: true
2323           type: string
2324         - name: interface-name
2325           in: path
2326           description: Name given to the interface
2327           required: true
2328           type: string
2329         - name: pci-id
2330           in: path
2331           description: PCI ID used to identify the sriov-vf
2332           required: true
2333           type: string
2334   /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}:
2335     get:
2336       tags:
2337         - CloudInfrastructure
2338       summary: returns sriov-vf
2339       description: returns sriov-vf
2340       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2341       produces:
2342         - application/json
2343         - application/xml
2344       responses:
2345         "200":
2346           description: successful operation
2347           schema:
2348               $ref: "#/definitions/sriov-vf"
2349         "default":
2350           description: Response codes found in [response codes](https://wiki.onap.org/).
2351       parameters:
2352         - name: cloud-owner
2353           in: path
2354           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2355           required: true
2356           type: string
2357         - name: cloud-region-id
2358           in: path
2359           description: Identifier used by the vendor for the region. Second part of composite key
2360           required: true
2361           type: string
2362         - name: tenant-id
2363           in: path
2364           description: Unique id relative to the cloud-region.
2365           required: true
2366           type: string
2367         - name: vserver-id
2368           in: path
2369           description: Unique identifier for this vserver relative to its tenant
2370           required: true
2371           type: string
2372         - name: interface-name
2373           in: path
2374           description: Name given to the interface
2375           required: true
2376           type: string
2377         - name: pci-id
2378           in: path
2379           description: PCI ID used to identify the sriov-vf
2380           required: true
2381           type: string
2382         - name: cloud-type
2383           in: query
2384           description: Type of the cloud (e.g., openstack)
2385           required: false
2386           type: string
2387         - name: owner-defined-type
2388           in: query
2389           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2390           required: false
2391           type: string
2392         - name: tenant-name
2393           in: query
2394           description: Readable name of tenant
2395           required: false
2396           type: string
2397         - name: tenant-context
2398           in: query
2399           description: This field will store the tenant context.
2400           required: false
2401           type: string
2402         - name: vserver-name
2403           in: query
2404           description: Name of vserver
2405           required: false
2406           type: string
2407         - name: vserver-name2
2408           in: query
2409           description: Alternative name of vserver
2410           required: false
2411           type: string
2412         - name: prov-status
2413           in: query
2414           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2415           required: false
2416           type: string
2417         - name: in-maint
2418           in: query
2419           required: false
2420           type: boolean
2421         - name: is-closed-loop-disabled
2422           in: query
2423           required: false
2424           type: boolean
2425         - name: interface-id
2426           in: query
2427           description: ID of interface
2428           required: false
2429           type: string
2430         - name: macaddr
2431           in: query
2432           description: MAC address for the interface
2433           required: false
2434           type: string
2435         - name: network-name
2436           in: query
2437           description: Name of the network
2438           required: false
2439           type: string
2440         - name: vf-vlan-filter
2441           in: query
2442           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
2443           required: false
2444           type: string
2445         - name: vf-mac-filter
2446           in: query
2447           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
2448           required: false
2449           type: string
2450         - name: vf-vlan-strip
2451           in: query
2452           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
2453           required: false
2454           type: boolean
2455         - name: neutron-network-id
2456           in: query
2457           description: Neutron network id of the interface
2458           required: false
2459           type: string
2460     put:
2461       tags:
2462         - CloudInfrastructure
2463       summary: create or update an existing sriov-vf
2464       description: create or update an existing sriov-vf
2465       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2466       consumes:
2467         - application/json
2468         - application/xml
2469       produces:
2470         - application/json
2471         - application/xml
2472       responses:
2473         "default":
2474           description: Response codes found in [response codes](https://wiki.onap.org/).
2475       parameters:
2476         - name: cloud-owner
2477           in: path
2478           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2479           required: true
2480           type: string
2481         - name: cloud-region-id
2482           in: path
2483           description: Identifier used by the vendor for the region. Second part of composite key
2484           required: true
2485           type: string
2486         - name: tenant-id
2487           in: path
2488           description: Unique id relative to the cloud-region.
2489           required: true
2490           type: string
2491         - name: vserver-id
2492           in: path
2493           description: Unique identifier for this vserver relative to its tenant
2494           required: true
2495           type: string
2496         - name: interface-name
2497           in: path
2498           description: Name given to the interface
2499           required: true
2500           type: string
2501         - name: pci-id
2502           in: path
2503           description: PCI ID used to identify the sriov-vf
2504           required: true
2505           type: string
2506         - name: body
2507           in: body
2508           description: sriov-vf object that needs to be created or updated
2509           required: true
2510           schema:
2511             $ref: "#/definitions/sriov-vf"
2512     delete:
2513       tags:
2514         - CloudInfrastructure
2515       summary: delete an existing sriov-vf
2516       description: delete an existing sriov-vf
2517       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2518       consumes:
2519         - application/json
2520         - application/xml
2521       produces:
2522         - application/json
2523         - application/xml
2524       responses:
2525         "default":
2526           description: Response codes found in [response codes](https://wiki.onap.org/).
2527       parameters:
2528         - name: cloud-owner
2529           in: path
2530           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2531           required: true
2532           type: string
2533         - name: cloud-region-id
2534           in: path
2535           description: Identifier used by the vendor for the region. Second part of composite key
2536           required: true
2537           type: string
2538         - name: tenant-id
2539           in: path
2540           description: Unique id relative to the cloud-region.
2541           required: true
2542           type: string
2543         - name: vserver-id
2544           in: path
2545           description: Unique identifier for this vserver relative to its tenant
2546           required: true
2547           type: string
2548         - name: interface-name
2549           in: path
2550           description: Name given to the interface
2551           required: true
2552           type: string
2553         - name: pci-id
2554           in: path
2555           description: PCI ID used to identify the sriov-vf
2556           required: true
2557           type: string
2558         - name: resource-version
2559           in: query
2560           description: resource-version for concurrency
2561           required: true
2562           type: string
2563   /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:
2564     get:
2565       tags:
2566         - CloudInfrastructure
2567       summary: returns sriov-vfs
2568       description: returns sriov-vfs
2569       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
2570       produces:
2571         - application/json
2572         - application/xml
2573       responses:
2574         "200":
2575           description: successful operation
2576           schema:
2577               $ref: "#/definitions/sriov-vfs"
2578         "default":
2579           description: Response codes found in [response codes](https://wiki.onap.org/).
2580       parameters:
2581         - name: cloud-owner
2582           in: path
2583           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2584           required: true
2585           type: string
2586         - name: cloud-region-id
2587           in: path
2588           description: Identifier used by the vendor for the region. Second part of composite key
2589           required: true
2590           type: string
2591         - name: tenant-id
2592           in: path
2593           description: Unique id relative to the cloud-region.
2594           required: true
2595           type: string
2596         - name: vserver-id
2597           in: path
2598           description: Unique identifier for this vserver relative to its tenant
2599           required: true
2600           type: string
2601         - name: interface-name
2602           in: path
2603           description: Name given to the interface
2604           required: true
2605           type: string
2606         - name: cloud-type
2607           in: query
2608           description: Type of the cloud (e.g., openstack)
2609           required: false
2610           type: string
2611         - name: owner-defined-type
2612           in: query
2613           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2614           required: false
2615           type: string
2616         - name: tenant-name
2617           in: query
2618           description: Readable name of tenant
2619           required: false
2620           type: string
2621         - name: tenant-context
2622           in: query
2623           description: This field will store the tenant context.
2624           required: false
2625           type: string
2626         - name: vserver-name
2627           in: query
2628           description: Name of vserver
2629           required: false
2630           type: string
2631         - name: vserver-name2
2632           in: query
2633           description: Alternative name of vserver
2634           required: false
2635           type: string
2636         - name: prov-status
2637           in: query
2638           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2639           required: false
2640           type: string
2641         - name: in-maint
2642           in: query
2643           required: false
2644           type: boolean
2645         - name: is-closed-loop-disabled
2646           in: query
2647           required: false
2648           type: boolean
2649         - name: interface-id
2650           in: query
2651           description: ID of interface
2652           required: false
2653           type: string
2654         - name: macaddr
2655           in: query
2656           description: MAC address for the interface
2657           required: false
2658           type: string
2659         - name: network-name
2660           in: query
2661           description: Name of the network
2662           required: false
2663           type: string
2664   /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:
2665     put:
2666       tags:
2667         - CloudInfrastructure
2668       summary: see node definition for valid relationships
2669       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2670       consumes:
2671         - application/json
2672         - application/xml
2673       produces:
2674         - application/json
2675         - application/xml
2676       responses:
2677         "default":
2678           description: Response codes found in [response codes](https://wiki.onap.org/).
2679       parameters:
2680         - name: cloud-owner
2681           in: path
2682           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2683           required: true
2684           type: string
2685         - name: cloud-region-id
2686           in: path
2687           description: Identifier used by the vendor for the region. Second part of composite key
2688           required: true
2689           type: string
2690         - name: tenant-id
2691           in: path
2692           description: Unique id relative to the cloud-region.
2693           required: true
2694           type: string
2695         - name: vserver-id
2696           in: path
2697           description: Unique identifier for this vserver relative to its tenant
2698           required: true
2699           type: string
2700         - name: interface-name
2701           in: path
2702           description: Name given to the interface
2703           required: true
2704           type: string
2705         - name: body
2706           in: body
2707           description: relationship object that needs to be created or updated
2708           required: true
2709           schema:
2710             $ref: "#/definitions/relationship"
2711     delete:
2712       tags:
2713         - CloudInfrastructure
2714       summary: delete an existing relationship
2715       description: delete an existing relationship
2716       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2717       consumes:
2718         - application/json
2719         - application/xml
2720       produces:
2721         - application/json
2722         - application/xml
2723       responses:
2724         "default":
2725           description: Response codes found in [response codes](https://wiki.onap.org/).
2726       parameters:
2727         - name: cloud-owner
2728           in: path
2729           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2730           required: true
2731           type: string
2732         - name: cloud-region-id
2733           in: path
2734           description: Identifier used by the vendor for the region. Second part of composite key
2735           required: true
2736           type: string
2737         - name: tenant-id
2738           in: path
2739           description: Unique id relative to the cloud-region.
2740           required: true
2741           type: string
2742         - name: vserver-id
2743           in: path
2744           description: Unique identifier for this vserver relative to its tenant
2745           required: true
2746           type: string
2747         - name: interface-name
2748           in: path
2749           description: Name given to the interface
2750           required: true
2751           type: string
2752   /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:
2753     put:
2754       tags:
2755         - CloudInfrastructure
2756       summary: see node definition for valid relationships
2757       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
2758       consumes:
2759         - application/json
2760         - application/xml
2761       produces:
2762         - application/json
2763         - application/xml
2764       responses:
2765         "default":
2766           description: Response codes found in [response codes](https://wiki.onap.org/).
2767       parameters:
2768         - name: cloud-owner
2769           in: path
2770           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2771           required: true
2772           type: string
2773         - name: cloud-region-id
2774           in: path
2775           description: Identifier used by the vendor for the region. Second part of composite key
2776           required: true
2777           type: string
2778         - name: tenant-id
2779           in: path
2780           description: Unique id relative to the cloud-region.
2781           required: true
2782           type: string
2783         - name: vserver-id
2784           in: path
2785           description: Unique identifier for this vserver relative to its tenant
2786           required: true
2787           type: string
2788         - name: interface-name
2789           in: path
2790           description: Name given to the interface
2791           required: true
2792           type: string
2793         - name: l3-interface-ipv4-address
2794           in: path
2795           description: IP address
2796           required: true
2797           type: string
2798         - name: body
2799           in: body
2800           description: relationship object that needs to be created or updated
2801           required: true
2802           schema:
2803             $ref: "#/definitions/relationship"
2804     delete:
2805       tags:
2806         - CloudInfrastructure
2807       summary: delete an existing relationship
2808       description: delete an existing relationship
2809       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
2810       consumes:
2811         - application/json
2812         - application/xml
2813       produces:
2814         - application/json
2815         - application/xml
2816       responses:
2817         "default":
2818           description: Response codes found in [response codes](https://wiki.onap.org/).
2819       parameters:
2820         - name: cloud-owner
2821           in: path
2822           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2823           required: true
2824           type: string
2825         - name: cloud-region-id
2826           in: path
2827           description: Identifier used by the vendor for the region. Second part of composite key
2828           required: true
2829           type: string
2830         - name: tenant-id
2831           in: path
2832           description: Unique id relative to the cloud-region.
2833           required: true
2834           type: string
2835         - name: vserver-id
2836           in: path
2837           description: Unique identifier for this vserver relative to its tenant
2838           required: true
2839           type: string
2840         - name: interface-name
2841           in: path
2842           description: Name given to the interface
2843           required: true
2844           type: string
2845         - name: l3-interface-ipv4-address
2846           in: path
2847           description: IP address
2848           required: true
2849           type: string
2850   /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}:
2851     get:
2852       tags:
2853         - CloudInfrastructure
2854       summary: returns l3-interface-ipv4-address-list
2855       description: returns l3-interface-ipv4-address-list
2856       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
2857       produces:
2858         - application/json
2859         - application/xml
2860       responses:
2861         "200":
2862           description: successful operation
2863           schema:
2864               $ref: "#/definitions/l3-interface-ipv4-address-list"
2865         "default":
2866           description: Response codes found in [response codes](https://wiki.onap.org/).
2867       parameters:
2868         - name: cloud-owner
2869           in: path
2870           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2871           required: true
2872           type: string
2873         - name: cloud-region-id
2874           in: path
2875           description: Identifier used by the vendor for the region. Second part of composite key
2876           required: true
2877           type: string
2878         - name: tenant-id
2879           in: path
2880           description: Unique id relative to the cloud-region.
2881           required: true
2882           type: string
2883         - name: vserver-id
2884           in: path
2885           description: Unique identifier for this vserver relative to its tenant
2886           required: true
2887           type: string
2888         - name: interface-name
2889           in: path
2890           description: Name given to the interface
2891           required: true
2892           type: string
2893         - name: l3-interface-ipv4-address
2894           in: path
2895           description: IP address
2896           required: true
2897           type: string
2898         - name: cloud-type
2899           in: query
2900           description: Type of the cloud (e.g., openstack)
2901           required: false
2902           type: string