5 [Differences versus the previous schema version](apidocs/aai_swagger_v8.diff)
7 Copyright © 2017 AT&T Intellectual Property. All rights reserved.
9 Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
11 You may obtain a copy of the License at
13 (https://creativecommons.org/licenses/by/4.0/)
15 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.
17 ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.
19 This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
21 title: Active and Available Inventory REST API
24 url: http://www.apache.org/licenses/LICENSE-2.0.html
34 /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
38 summary: see node definition for valid relationships
39 operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
48 description: Response codes found in [response codes](https://wiki.onap.org/).
50 - name: physical-location-id
52 description: Unique identifier for physical location, e.g., CLLI
55 example: __PHYSICAL-LOCATION-ID__
58 description: The Target provider edge router
61 example: __TARGET-PE__
62 - name: availability-zone-name
64 description: Name of the availability zone
67 example: __AVAILABILITY-ZONE-NAME__
70 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
73 $ref: "#/definitions/relationship"
77 summary: delete an existing relationship
78 description: delete an existing relationship
79 operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
88 description: Response codes found in [response codes](https://wiki.onap.org/).
90 - name: physical-location-id
92 description: Unique identifier for physical location, e.g., CLLI
95 example: __PHYSICAL-LOCATION-ID__
98 description: The Target provider edge router
101 example: __TARGET-PE__
102 - name: availability-zone-name
104 description: Name of the availability zone
107 example: __AVAILABILITY-ZONE-NAME__
108 /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
111 - CloudInfrastructure
112 summary: returns ctag-pool
113 description: returns ctag-pool
114 operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
120 description: successful operation
122 $ref: "#/getDefinitions/ctag-pool"
124 description: Response codes found in [response codes](https://wiki.onap.org/).
126 - name: physical-location-id
128 description: Unique identifier for physical location, e.g., CLLI
131 example: __PHYSICAL-LOCATION-ID__
134 description: The Target provider edge router
137 example: __TARGET-PE__
138 - name: availability-zone-name
140 description: Name of the availability zone
143 example: __AVAILABILITY-ZONE-NAME__
146 - CloudInfrastructure
147 summary: create or update an existing ctag-pool
149 Create or update an existing ctag-pool.
151 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
152 operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
161 description: Response codes found in [response codes](https://wiki.onap.org/).
163 - name: physical-location-id
165 description: Unique identifier for physical location, e.g., CLLI
168 example: __PHYSICAL-LOCATION-ID__
171 description: The Target provider edge router
174 example: __TARGET-PE__
175 - name: availability-zone-name
177 description: Name of the availability zone
180 example: __AVAILABILITY-ZONE-NAME__
183 description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
186 $ref: "#/definitions/ctag-pool"
189 - CloudInfrastructure
190 summary: update an existing ctag-pool
192 Update an existing ctag-pool
194 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
195 The PUT operation will entirely replace an existing object.
196 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
198 Other differences between PUT and PATCH are:
200 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
201 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
202 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
203 operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
212 description: Response codes found in [response codes](https://wiki.onap.org/).
214 - name: physical-location-id
216 description: Unique identifier for physical location, e.g., CLLI
219 example: __PHYSICAL-LOCATION-ID__
222 description: The Target provider edge router
225 example: __TARGET-PE__
226 - name: availability-zone-name
228 description: Name of the availability zone
231 example: __AVAILABILITY-ZONE-NAME__
234 description: ctag-pool object that needs to be updated.
237 $ref: "#/patchDefinitions/ctag-pool"
240 - CloudInfrastructure
241 summary: delete an existing ctag-pool
242 description: delete an existing ctag-pool
243 operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
252 description: Response codes found in [response codes](https://wiki.onap.org/).
254 - name: physical-location-id
256 description: Unique identifier for physical location, e.g., CLLI
259 example: __PHYSICAL-LOCATION-ID__
262 description: The Target provider edge router
265 example: __TARGET-PE__
266 - name: availability-zone-name
268 description: Name of the availability zone
271 example: __AVAILABILITY-ZONE-NAME__
272 - name: resource-version
274 description: resource-version for concurrency
277 /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
280 - CloudInfrastructure
281 summary: returns ctag-pools
282 description: returns ctag-pools
283 operationId: getCloudInfrastructureComplexesComplexCtagPools
289 description: successful operation
291 $ref: "#/getDefinitions/ctag-pools"
293 description: Response codes found in [response codes](https://wiki.onap.org/).
295 - name: physical-location-id
297 description: Unique identifier for physical location, e.g., CLLI
300 example: __PHYSICAL-LOCATION-ID__
301 - name: availability-zone-name
306 /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
309 - CloudInfrastructure
310 summary: see node definition for valid relationships
311 operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
320 description: Response codes found in [response codes](https://wiki.onap.org/).
322 - name: physical-location-id
324 description: Unique identifier for physical location, e.g., CLLI
327 example: __PHYSICAL-LOCATION-ID__
330 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplex.json)
333 $ref: "#/definitions/relationship"
336 - CloudInfrastructure
337 summary: delete an existing relationship
338 description: delete an existing relationship
339 operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
348 description: Response codes found in [response codes](https://wiki.onap.org/).
350 - name: physical-location-id
352 description: Unique identifier for physical location, e.g., CLLI
355 example: __PHYSICAL-LOCATION-ID__
356 /cloud-infrastructure/complexes/complex/{physical-location-id}:
359 - CloudInfrastructure
360 summary: returns complex
361 description: returns complex
362 operationId: getCloudInfrastructureComplexesComplex
368 description: successful operation
370 $ref: "#/getDefinitions/complex"
372 description: Response codes found in [response codes](https://wiki.onap.org/).
374 - name: physical-location-id
376 description: Unique identifier for physical location, e.g., CLLI
379 example: __PHYSICAL-LOCATION-ID__
382 - CloudInfrastructure
383 summary: create or update an existing complex
385 Create or update an existing complex.
387 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
388 operationId: createOrUpdateCloudInfrastructureComplexesComplex
397 description: Response codes found in [response codes](https://wiki.onap.org/).
399 - name: physical-location-id
401 description: Unique identifier for physical location, e.g., CLLI
404 example: __PHYSICAL-LOCATION-ID__
407 description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplex.json)
410 $ref: "#/definitions/complex"
413 - CloudInfrastructure
414 summary: update an existing complex
416 Update an existing complex
418 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
419 The PUT operation will entirely replace an existing object.
420 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
422 Other differences between PUT and PATCH are:
424 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
425 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
426 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
427 operationId: UpdateCloudInfrastructureComplexesComplex
436 description: Response codes found in [response codes](https://wiki.onap.org/).
438 - name: physical-location-id
440 description: Unique identifier for physical location, e.g., CLLI
443 example: __PHYSICAL-LOCATION-ID__
446 description: complex object that needs to be updated.
449 $ref: "#/patchDefinitions/complex"
452 - CloudInfrastructure
453 summary: delete an existing complex
454 description: delete an existing complex
455 operationId: deleteCloudInfrastructureComplexesComplex
464 description: Response codes found in [response codes](https://wiki.onap.org/).
466 - name: physical-location-id
468 description: Unique identifier for physical location, e.g., CLLI
471 example: __PHYSICAL-LOCATION-ID__
472 - name: resource-version
474 description: resource-version for concurrency
477 /cloud-infrastructure/complexes:
480 - CloudInfrastructure
481 summary: returns complexes
482 description: returns complexes
483 operationId: getCloudInfrastructureComplexes
489 description: successful operation
491 $ref: "#/getDefinitions/complexes"
493 description: Response codes found in [response codes](https://wiki.onap.org/).
495 - name: physical-location-id
500 - name: data-center-code
515 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
518 - CloudInfrastructure
519 summary: see node definition for valid relationships
520 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
529 description: Response codes found in [response codes](https://wiki.onap.org/).
533 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
536 example: __CLOUD-OWNER__
537 - name: cloud-region-id
539 description: Identifier used by the vendor for the region. Second part of composite key
542 example: __CLOUD-REGION-ID__
543 - name: volume-group-id
545 description: Unique ID of volume-group.
548 example: __VOLUME-GROUP-ID__
551 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
554 $ref: "#/definitions/relationship"
557 - CloudInfrastructure
558 summary: delete an existing relationship
559 description: delete an existing relationship
560 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
569 description: Response codes found in [response codes](https://wiki.onap.org/).
573 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
576 example: __CLOUD-OWNER__
577 - name: cloud-region-id
579 description: Identifier used by the vendor for the region. Second part of composite key
582 example: __CLOUD-REGION-ID__
583 - name: volume-group-id
585 description: Unique ID of volume-group.
588 example: __VOLUME-GROUP-ID__
589 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
592 - CloudInfrastructure
593 summary: returns volume-group
594 description: returns volume-group
595 operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
601 description: successful operation
603 $ref: "#/getDefinitions/volume-group"
605 description: Response codes found in [response codes](https://wiki.onap.org/).
609 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
612 example: __CLOUD-OWNER__
613 - name: cloud-region-id
615 description: Identifier used by the vendor for the region. Second part of composite key
618 example: __CLOUD-REGION-ID__
619 - name: volume-group-id
621 description: Unique ID of volume-group.
624 example: __VOLUME-GROUP-ID__
627 - CloudInfrastructure
628 summary: create or update an existing volume-group
630 Create or update an existing volume-group.
632 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
633 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
642 description: Response codes found in [response codes](https://wiki.onap.org/).
646 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
649 example: __CLOUD-OWNER__
650 - name: cloud-region-id
652 description: Identifier used by the vendor for the region. Second part of composite key
655 example: __CLOUD-REGION-ID__
656 - name: volume-group-id
658 description: Unique ID of volume-group.
661 example: __VOLUME-GROUP-ID__
664 description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
667 $ref: "#/definitions/volume-group"
670 - CloudInfrastructure
671 summary: update an existing volume-group
673 Update an existing volume-group
675 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
676 The PUT operation will entirely replace an existing object.
677 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
679 Other differences between PUT and PATCH are:
681 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
682 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
683 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
684 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
693 description: Response codes found in [response codes](https://wiki.onap.org/).
697 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
700 example: __CLOUD-OWNER__
701 - name: cloud-region-id
703 description: Identifier used by the vendor for the region. Second part of composite key
706 example: __CLOUD-REGION-ID__
707 - name: volume-group-id
709 description: Unique ID of volume-group.
712 example: __VOLUME-GROUP-ID__
715 description: volume-group object that needs to be updated.
718 $ref: "#/patchDefinitions/volume-group"
721 - CloudInfrastructure
722 summary: delete an existing volume-group
723 description: delete an existing volume-group
724 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
733 description: Response codes found in [response codes](https://wiki.onap.org/).
737 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
740 example: __CLOUD-OWNER__
741 - name: cloud-region-id
743 description: Identifier used by the vendor for the region. Second part of composite key
746 example: __CLOUD-REGION-ID__
747 - name: volume-group-id
749 description: Unique ID of volume-group.
752 example: __VOLUME-GROUP-ID__
753 - name: resource-version
755 description: resource-version for concurrency
758 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
761 - CloudInfrastructure
762 summary: returns volume-groups
763 description: returns volume-groups
764 operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
770 description: successful operation
772 $ref: "#/getDefinitions/volume-groups"
774 description: Response codes found in [response codes](https://wiki.onap.org/).
778 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
781 example: __CLOUD-OWNER__
782 - name: cloud-region-id
784 description: Identifier used by the vendor for the region. Second part of composite key
787 example: __CLOUD-REGION-ID__
788 - name: volume-group-id
793 - name: volume-group-name
798 - name: heat-stack-id
808 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship:
811 - CloudInfrastructure
812 summary: see node definition for valid relationships
813 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
822 description: Response codes found in [response codes](https://wiki.onap.org/).
826 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
829 example: __CLOUD-OWNER__
830 - name: cloud-region-id
832 description: Identifier used by the vendor for the region. Second part of composite key
835 example: __CLOUD-REGION-ID__
838 description: Unique id relative to the cloud-region.
841 example: __TENANT-ID__
844 description: Unique identifier for this vserver relative to its tenant
847 example: __VSERVER-ID__
850 description: Unique ID of block storage volume relative to the vserver.
853 example: __VOLUME-ID__
856 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
859 $ref: "#/definitions/relationship"
862 - CloudInfrastructure
863 summary: delete an existing relationship
864 description: delete an existing relationship
865 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
874 description: Response codes found in [response codes](https://wiki.onap.org/).
878 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
881 example: __CLOUD-OWNER__
882 - name: cloud-region-id
884 description: Identifier used by the vendor for the region. Second part of composite key
887 example: __CLOUD-REGION-ID__
890 description: Unique id relative to the cloud-region.
893 example: __TENANT-ID__
896 description: Unique identifier for this vserver relative to its tenant
899 example: __VSERVER-ID__
902 description: Unique ID of block storage volume relative to the vserver.
905 example: __VOLUME-ID__
906 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
909 - CloudInfrastructure
910 summary: returns volume
911 description: returns volume
912 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
918 description: successful operation
920 $ref: "#/getDefinitions/volume"
922 description: Response codes found in [response codes](https://wiki.onap.org/).
926 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
929 example: __CLOUD-OWNER__
930 - name: cloud-region-id
932 description: Identifier used by the vendor for the region. Second part of composite key
935 example: __CLOUD-REGION-ID__
938 description: Unique id relative to the cloud-region.
941 example: __TENANT-ID__
944 description: Unique identifier for this vserver relative to its tenant
947 example: __VSERVER-ID__
950 description: Unique ID of block storage volume relative to the vserver.
953 example: __VOLUME-ID__
956 - CloudInfrastructure
957 summary: create or update an existing volume
959 Create or update an existing volume.
961 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
962 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
971 description: Response codes found in [response codes](https://wiki.onap.org/).
975 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
978 example: __CLOUD-OWNER__
979 - name: cloud-region-id
981 description: Identifier used by the vendor for the region. Second part of composite key
984 example: __CLOUD-REGION-ID__
987 description: Unique id relative to the cloud-region.
990 example: __TENANT-ID__
993 description: Unique identifier for this vserver relative to its tenant
996 example: __VSERVER-ID__
999 description: Unique ID of block storage volume relative to the vserver.
1002 example: __VOLUME-ID__
1005 description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1008 $ref: "#/definitions/volume"
1011 - CloudInfrastructure
1012 summary: update an existing volume
1014 Update an existing volume
1016 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1017 The PUT operation will entirely replace an existing object.
1018 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
1020 Other differences between PUT and PATCH are:
1022 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
1023 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1024 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1025 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1034 description: Response codes found in [response codes](https://wiki.onap.org/).
1038 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1041 example: __CLOUD-OWNER__
1042 - name: cloud-region-id
1044 description: Identifier used by the vendor for the region. Second part of composite key
1047 example: __CLOUD-REGION-ID__
1050 description: Unique id relative to the cloud-region.
1053 example: __TENANT-ID__
1056 description: Unique identifier for this vserver relative to its tenant
1059 example: __VSERVER-ID__
1062 description: Unique ID of block storage volume relative to the vserver.
1065 example: __VOLUME-ID__
1068 description: volume object that needs to be updated.
1071 $ref: "#/patchDefinitions/volume"
1074 - CloudInfrastructure
1075 summary: delete an existing volume
1076 description: delete an existing volume
1077 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1086 description: Response codes found in [response codes](https://wiki.onap.org/).
1090 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1093 example: __CLOUD-OWNER__
1094 - name: cloud-region-id
1096 description: Identifier used by the vendor for the region. Second part of composite key
1099 example: __CLOUD-REGION-ID__
1102 description: Unique id relative to the cloud-region.
1105 example: __TENANT-ID__
1108 description: Unique identifier for this vserver relative to its tenant
1111 example: __VSERVER-ID__
1114 description: Unique ID of block storage volume relative to the vserver.
1117 example: __VOLUME-ID__
1118 - name: resource-version
1120 description: resource-version for concurrency
1123 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1126 - CloudInfrastructure
1127 summary: returns volumes
1128 description: returns volumes
1129 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1135 description: successful operation
1137 $ref: "#/getDefinitions/volumes"
1139 description: Response codes found in [response codes](https://wiki.onap.org/).
1143 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1146 example: __CLOUD-OWNER__
1147 - name: cloud-region-id
1149 description: Identifier used by the vendor for the region. Second part of composite key
1152 example: __CLOUD-REGION-ID__
1155 description: Unique id relative to the cloud-region.
1158 example: __TENANT-ID__
1161 description: Unique identifier for this vserver relative to its tenant
1164 example: __VSERVER-ID__
1170 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1173 - CloudInfrastructure
1174 summary: see node definition for valid relationships
1175 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1184 description: Response codes found in [response codes](https://wiki.onap.org/).
1188 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1191 example: __CLOUD-OWNER__
1192 - name: cloud-region-id
1194 description: Identifier used by the vendor for the region. Second part of composite key
1197 example: __CLOUD-REGION-ID__
1200 description: Unique id relative to the cloud-region.
1203 example: __TENANT-ID__
1206 description: Unique identifier for this vserver relative to its tenant
1209 example: __VSERVER-ID__
1212 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1215 $ref: "#/definitions/relationship"
1218 - CloudInfrastructure
1219 summary: delete an existing relationship
1220 description: delete an existing relationship
1221 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1230 description: Response codes found in [response codes](https://wiki.onap.org/).
1234 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1237 example: __CLOUD-OWNER__
1238 - name: cloud-region-id
1240 description: Identifier used by the vendor for the region. Second part of composite key
1243 example: __CLOUD-REGION-ID__
1246 description: Unique id relative to the cloud-region.
1249 example: __TENANT-ID__
1252 description: Unique identifier for this vserver relative to its tenant
1255 example: __VSERVER-ID__
1256 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
1259 - CloudInfrastructure
1260 summary: see node definition for valid relationships
1261 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1270 description: Response codes found in [response codes](https://wiki.onap.org/).
1274 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1277 example: __CLOUD-OWNER__
1278 - name: cloud-region-id
1280 description: Identifier used by the vendor for the region. Second part of composite key
1283 example: __CLOUD-REGION-ID__
1286 description: Unique id relative to the cloud-region.
1289 example: __TENANT-ID__
1292 description: Unique identifier for this vserver relative to its tenant
1295 example: __VSERVER-ID__
1296 - name: interface-name
1298 description: Name given to the interface
1301 example: __INTERFACE-NAME__
1302 - name: vlan-interface
1304 description: String that identifies the interface
1307 example: __VLAN-INTERFACE__
1310 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1313 $ref: "#/definitions/relationship"
1316 - CloudInfrastructure
1317 summary: delete an existing relationship
1318 description: delete an existing relationship
1319 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1328 description: Response codes found in [response codes](https://wiki.onap.org/).
1332 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1335 example: __CLOUD-OWNER__
1336 - name: cloud-region-id
1338 description: Identifier used by the vendor for the region. Second part of composite key
1341 example: __CLOUD-REGION-ID__
1344 description: Unique id relative to the cloud-region.
1347 example: __TENANT-ID__
1350 description: Unique identifier for this vserver relative to its tenant
1353 example: __VSERVER-ID__
1354 - name: interface-name
1356 description: Name given to the interface
1359 example: __INTERFACE-NAME__
1360 - name: vlan-interface
1362 description: String that identifies the interface
1365 example: __VLAN-INTERFACE__
1366 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
1369 - CloudInfrastructure
1370 summary: see node definition for valid relationships
1371 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1380 description: Response codes found in [response codes](https://wiki.onap.org/).
1384 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1387 example: __CLOUD-OWNER__
1388 - name: cloud-region-id
1390 description: Identifier used by the vendor for the region. Second part of composite key
1393 example: __CLOUD-REGION-ID__
1396 description: Unique id relative to the cloud-region.
1399 example: __TENANT-ID__
1402 description: Unique identifier for this vserver relative to its tenant
1405 example: __VSERVER-ID__
1406 - name: interface-name
1408 description: Name given to the interface
1411 example: __INTERFACE-NAME__
1412 - name: vlan-interface
1414 description: String that identifies the interface
1417 example: __VLAN-INTERFACE__
1418 - name: l3-interface-ipv4-address
1420 description: IP address
1423 example: __L3-INTERFACE-IPV4-ADDRESS__
1426 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1429 $ref: "#/definitions/relationship"
1432 - CloudInfrastructure
1433 summary: delete an existing relationship
1434 description: delete an existing relationship
1435 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1444 description: Response codes found in [response codes](https://wiki.onap.org/).
1448 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1451 example: __CLOUD-OWNER__
1452 - name: cloud-region-id
1454 description: Identifier used by the vendor for the region. Second part of composite key
1457 example: __CLOUD-REGION-ID__
1460 description: Unique id relative to the cloud-region.
1463 example: __TENANT-ID__
1466 description: Unique identifier for this vserver relative to its tenant
1469 example: __VSERVER-ID__
1470 - name: interface-name
1472 description: Name given to the interface
1475 example: __INTERFACE-NAME__
1476 - name: vlan-interface
1478 description: String that identifies the interface
1481 example: __VLAN-INTERFACE__
1482 - name: l3-interface-ipv4-address
1484 description: IP address
1487 example: __L3-INTERFACE-IPV4-ADDRESS__
1488 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
1491 - CloudInfrastructure
1492 summary: returns l3-interface-ipv4-address-list
1493 description: returns l3-interface-ipv4-address-list
1494 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1500 description: successful operation
1502 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1504 description: Response codes found in [response codes](https://wiki.onap.org/).
1508 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1511 example: __CLOUD-OWNER__
1512 - name: cloud-region-id
1514 description: Identifier used by the vendor for the region. Second part of composite key
1517 example: __CLOUD-REGION-ID__
1520 description: Unique id relative to the cloud-region.
1523 example: __TENANT-ID__
1526 description: Unique identifier for this vserver relative to its tenant
1529 example: __VSERVER-ID__
1530 - name: interface-name
1532 description: Name given to the interface
1535 example: __INTERFACE-NAME__
1536 - name: vlan-interface
1538 description: String that identifies the interface
1541 example: __VLAN-INTERFACE__
1542 - name: l3-interface-ipv4-address
1544 description: IP address
1547 example: __L3-INTERFACE-IPV4-ADDRESS__
1550 - CloudInfrastructure
1551 summary: create or update an existing l3-interface-ipv4-address-list
1553 Create or update an existing l3-interface-ipv4-address-list.
1555 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
1556 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1565 description: Response codes found in [response codes](https://wiki.onap.org/).
1569 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1572 example: __CLOUD-OWNER__
1573 - name: cloud-region-id
1575 description: Identifier used by the vendor for the region. Second part of composite key
1578 example: __CLOUD-REGION-ID__
1581 description: Unique id relative to the cloud-region.
1584 example: __TENANT-ID__
1587 description: Unique identifier for this vserver relative to its tenant
1590 example: __VSERVER-ID__
1591 - name: interface-name
1593 description: Name given to the interface
1596 example: __INTERFACE-NAME__
1597 - name: vlan-interface
1599 description: String that identifies the interface
1602 example: __VLAN-INTERFACE__
1603 - name: l3-interface-ipv4-address
1605 description: IP address
1608 example: __L3-INTERFACE-IPV4-ADDRESS__
1611 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1614 $ref: "#/definitions/l3-interface-ipv4-address-list"
1617 - CloudInfrastructure
1618 summary: update an existing l3-interface-ipv4-address-list
1620 Update an existing l3-interface-ipv4-address-list
1622 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1623 The PUT operation will entirely replace an existing object.
1624 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
1626 Other differences between PUT and PATCH are:
1628 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
1629 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1630 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1631 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1640 description: Response codes found in [response codes](https://wiki.onap.org/).
1644 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1647 example: __CLOUD-OWNER__
1648 - name: cloud-region-id
1650 description: Identifier used by the vendor for the region. Second part of composite key
1653 example: __CLOUD-REGION-ID__
1656 description: Unique id relative to the cloud-region.
1659 example: __TENANT-ID__
1662 description: Unique identifier for this vserver relative to its tenant
1665 example: __VSERVER-ID__
1666 - name: interface-name
1668 description: Name given to the interface
1671 example: __INTERFACE-NAME__
1672 - name: vlan-interface
1674 description: String that identifies the interface
1677 example: __VLAN-INTERFACE__
1678 - name: l3-interface-ipv4-address
1680 description: IP address
1683 example: __L3-INTERFACE-IPV4-ADDRESS__
1686 description: l3-interface-ipv4-address-list object that needs to be updated.
1689 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1692 - CloudInfrastructure
1693 summary: delete an existing l3-interface-ipv4-address-list
1694 description: delete an existing l3-interface-ipv4-address-list
1695 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1704 description: Response codes found in [response codes](https://wiki.onap.org/).
1708 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1711 example: __CLOUD-OWNER__
1712 - name: cloud-region-id
1714 description: Identifier used by the vendor for the region. Second part of composite key
1717 example: __CLOUD-REGION-ID__
1720 description: Unique id relative to the cloud-region.
1723 example: __TENANT-ID__
1726 description: Unique identifier for this vserver relative to its tenant
1729 example: __VSERVER-ID__
1730 - name: interface-name
1732 description: Name given to the interface
1735 example: __INTERFACE-NAME__
1736 - name: vlan-interface
1738 description: String that identifies the interface
1741 example: __VLAN-INTERFACE__
1742 - name: l3-interface-ipv4-address
1744 description: IP address
1747 example: __L3-INTERFACE-IPV4-ADDRESS__
1748 - name: resource-version
1750 description: resource-version for concurrency
1753 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
1756 - CloudInfrastructure
1757 summary: see node definition for valid relationships
1758 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1767 description: Response codes found in [response codes](https://wiki.onap.org/).
1771 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1774 example: __CLOUD-OWNER__
1775 - name: cloud-region-id
1777 description: Identifier used by the vendor for the region. Second part of composite key
1780 example: __CLOUD-REGION-ID__
1783 description: Unique id relative to the cloud-region.
1786 example: __TENANT-ID__
1789 description: Unique identifier for this vserver relative to its tenant
1792 example: __VSERVER-ID__
1793 - name: interface-name
1795 description: Name given to the interface
1798 example: __INTERFACE-NAME__
1799 - name: vlan-interface
1801 description: String that identifies the interface
1804 example: __VLAN-INTERFACE__
1805 - name: l3-interface-ipv6-address
1807 description: IP address
1810 example: __L3-INTERFACE-IPV6-ADDRESS__
1813 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
1816 $ref: "#/definitions/relationship"
1819 - CloudInfrastructure
1820 summary: delete an existing relationship
1821 description: delete an existing relationship
1822 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1831 description: Response codes found in [response codes](https://wiki.onap.org/).
1835 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1838 example: __CLOUD-OWNER__
1839 - name: cloud-region-id
1841 description: Identifier used by the vendor for the region. Second part of composite key
1844 example: __CLOUD-REGION-ID__
1847 description: Unique id relative to the cloud-region.
1850 example: __TENANT-ID__
1853 description: Unique identifier for this vserver relative to its tenant
1856 example: __VSERVER-ID__
1857 - name: interface-name
1859 description: Name given to the interface
1862 example: __INTERFACE-NAME__
1863 - name: vlan-interface
1865 description: String that identifies the interface
1868 example: __VLAN-INTERFACE__
1869 - name: l3-interface-ipv6-address
1871 description: IP address
1874 example: __L3-INTERFACE-IPV6-ADDRESS__
1875 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
1878 - CloudInfrastructure
1879 summary: returns l3-interface-ipv6-address-list
1880 description: returns l3-interface-ipv6-address-list
1881 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1887 description: successful operation
1889 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
1891 description: Response codes found in [response codes](https://wiki.onap.org/).
1895 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1898 example: __CLOUD-OWNER__
1899 - name: cloud-region-id
1901 description: Identifier used by the vendor for the region. Second part of composite key
1904 example: __CLOUD-REGION-ID__
1907 description: Unique id relative to the cloud-region.
1910 example: __TENANT-ID__
1913 description: Unique identifier for this vserver relative to its tenant
1916 example: __VSERVER-ID__
1917 - name: interface-name
1919 description: Name given to the interface
1922 example: __INTERFACE-NAME__
1923 - name: vlan-interface
1925 description: String that identifies the interface
1928 example: __VLAN-INTERFACE__
1929 - name: l3-interface-ipv6-address
1931 description: IP address
1934 example: __L3-INTERFACE-IPV6-ADDRESS__
1937 - CloudInfrastructure
1938 summary: create or update an existing l3-interface-ipv6-address-list
1940 Create or update an existing l3-interface-ipv6-address-list.
1942 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
1943 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1952 description: Response codes found in [response codes](https://wiki.onap.org/).
1956 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1959 example: __CLOUD-OWNER__
1960 - name: cloud-region-id
1962 description: Identifier used by the vendor for the region. Second part of composite key
1965 example: __CLOUD-REGION-ID__
1968 description: Unique id relative to the cloud-region.
1971 example: __TENANT-ID__
1974 description: Unique identifier for this vserver relative to its tenant
1977 example: __VSERVER-ID__
1978 - name: interface-name
1980 description: Name given to the interface
1983 example: __INTERFACE-NAME__
1984 - name: vlan-interface
1986 description: String that identifies the interface
1989 example: __VLAN-INTERFACE__
1990 - name: l3-interface-ipv6-address
1992 description: IP address
1995 example: __L3-INTERFACE-IPV6-ADDRESS__
1998 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2001 $ref: "#/definitions/l3-interface-ipv6-address-list"
2004 - CloudInfrastructure
2005 summary: update an existing l3-interface-ipv6-address-list
2007 Update an existing l3-interface-ipv6-address-list
2009 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2010 The PUT operation will entirely replace an existing object.
2011 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
2013 Other differences between PUT and PATCH are:
2015 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
2016 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2017 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2018 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2027 description: Response codes found in [response codes](https://wiki.onap.org/).
2031 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2034 example: __CLOUD-OWNER__
2035 - name: cloud-region-id
2037 description: Identifier used by the vendor for the region. Second part of composite key
2040 example: __CLOUD-REGION-ID__
2043 description: Unique id relative to the cloud-region.
2046 example: __TENANT-ID__
2049 description: Unique identifier for this vserver relative to its tenant
2052 example: __VSERVER-ID__
2053 - name: interface-name
2055 description: Name given to the interface
2058 example: __INTERFACE-NAME__
2059 - name: vlan-interface
2061 description: String that identifies the interface
2064 example: __VLAN-INTERFACE__
2065 - name: l3-interface-ipv6-address
2067 description: IP address
2070 example: __L3-INTERFACE-IPV6-ADDRESS__
2073 description: l3-interface-ipv6-address-list object that needs to be updated.
2076 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2079 - CloudInfrastructure
2080 summary: delete an existing l3-interface-ipv6-address-list
2081 description: delete an existing l3-interface-ipv6-address-list
2082 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2091 description: Response codes found in [response codes](https://wiki.onap.org/).
2095 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2098 example: __CLOUD-OWNER__
2099 - name: cloud-region-id
2101 description: Identifier used by the vendor for the region. Second part of composite key
2104 example: __CLOUD-REGION-ID__
2107 description: Unique id relative to the cloud-region.
2110 example: __TENANT-ID__
2113 description: Unique identifier for this vserver relative to its tenant
2116 example: __VSERVER-ID__
2117 - name: interface-name
2119 description: Name given to the interface
2122 example: __INTERFACE-NAME__
2123 - name: vlan-interface
2125 description: String that identifies the interface
2128 example: __VLAN-INTERFACE__
2129 - name: l3-interface-ipv6-address
2131 description: IP address
2134 example: __L3-INTERFACE-IPV6-ADDRESS__
2135 - name: resource-version
2137 description: resource-version for concurrency
2140 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
2143 - CloudInfrastructure
2144 summary: returns vlan
2145 description: returns vlan
2146 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2152 description: successful operation
2154 $ref: "#/getDefinitions/vlan"
2156 description: Response codes found in [response codes](https://wiki.onap.org/).
2160 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2163 example: __CLOUD-OWNER__
2164 - name: cloud-region-id
2166 description: Identifier used by the vendor for the region. Second part of composite key
2169 example: __CLOUD-REGION-ID__
2172 description: Unique id relative to the cloud-region.
2175 example: __TENANT-ID__
2178 description: Unique identifier for this vserver relative to its tenant
2181 example: __VSERVER-ID__
2182 - name: interface-name
2184 description: Name given to the interface
2187 example: __INTERFACE-NAME__
2188 - name: vlan-interface
2190 description: String that identifies the interface
2193 example: __VLAN-INTERFACE__
2196 - CloudInfrastructure
2197 summary: create or update an existing vlan
2199 Create or update an existing vlan.
2201 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
2202 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2211 description: Response codes found in [response codes](https://wiki.onap.org/).
2215 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2218 example: __CLOUD-OWNER__
2219 - name: cloud-region-id
2221 description: Identifier used by the vendor for the region. Second part of composite key
2224 example: __CLOUD-REGION-ID__
2227 description: Unique id relative to the cloud-region.
2230 example: __TENANT-ID__
2233 description: Unique identifier for this vserver relative to its tenant
2236 example: __VSERVER-ID__
2237 - name: interface-name
2239 description: Name given to the interface
2242 example: __INTERFACE-NAME__
2243 - name: vlan-interface
2245 description: String that identifies the interface
2248 example: __VLAN-INTERFACE__
2251 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2254 $ref: "#/definitions/vlan"
2257 - CloudInfrastructure
2258 summary: update an existing vlan
2260 Update an existing vlan
2262 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2263 The PUT operation will entirely replace an existing object.
2264 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
2266 Other differences between PUT and PATCH are:
2268 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
2269 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2270 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2271 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2280 description: Response codes found in [response codes](https://wiki.onap.org/).
2284 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2287 example: __CLOUD-OWNER__
2288 - name: cloud-region-id
2290 description: Identifier used by the vendor for the region. Second part of composite key
2293 example: __CLOUD-REGION-ID__
2296 description: Unique id relative to the cloud-region.
2299 example: __TENANT-ID__
2302 description: Unique identifier for this vserver relative to its tenant
2305 example: __VSERVER-ID__
2306 - name: interface-name
2308 description: Name given to the interface
2311 example: __INTERFACE-NAME__
2312 - name: vlan-interface
2314 description: String that identifies the interface
2317 example: __VLAN-INTERFACE__
2320 description: vlan object that needs to be updated.
2323 $ref: "#/patchDefinitions/vlan"
2326 - CloudInfrastructure
2327 summary: delete an existing vlan
2328 description: delete an existing vlan
2329 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2338 description: Response codes found in [response codes](https://wiki.onap.org/).
2342 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2345 example: __CLOUD-OWNER__
2346 - name: cloud-region-id
2348 description: Identifier used by the vendor for the region. Second part of composite key
2351 example: __CLOUD-REGION-ID__
2354 description: Unique id relative to the cloud-region.
2357 example: __TENANT-ID__
2360 description: Unique identifier for this vserver relative to its tenant
2363 example: __VSERVER-ID__
2364 - name: interface-name
2366 description: Name given to the interface
2369 example: __INTERFACE-NAME__
2370 - name: vlan-interface
2372 description: String that identifies the interface
2375 example: __VLAN-INTERFACE__
2376 - name: resource-version
2378 description: resource-version for concurrency
2381 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans:
2384 - CloudInfrastructure
2385 summary: returns vlans
2386 description: returns vlans
2387 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2393 description: successful operation
2395 $ref: "#/getDefinitions/vlans"
2397 description: Response codes found in [response codes](https://wiki.onap.org/).
2401 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2404 example: __CLOUD-OWNER__
2405 - name: cloud-region-id
2407 description: Identifier used by the vendor for the region. Second part of composite key
2410 example: __CLOUD-REGION-ID__
2413 description: Unique id relative to the cloud-region.
2416 example: __TENANT-ID__
2419 description: Unique identifier for this vserver relative to its tenant
2422 example: __VSERVER-ID__
2423 - name: interface-name
2425 description: Name given to the interface
2428 example: __INTERFACE-NAME__
2429 - name: vlan-interface
2434 - name: vlan-id-inner
2445 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
2448 - CloudInfrastructure
2449 summary: see node definition for valid relationships
2450 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2459 description: Response codes found in [response codes](https://wiki.onap.org/).
2463 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2466 example: __CLOUD-OWNER__
2467 - name: cloud-region-id
2469 description: Identifier used by the vendor for the region. Second part of composite key
2472 example: __CLOUD-REGION-ID__
2475 description: Unique id relative to the cloud-region.
2478 example: __TENANT-ID__
2481 description: Unique identifier for this vserver relative to its tenant
2484 example: __VSERVER-ID__
2485 - name: interface-name
2487 description: Name given to the interface
2490 example: __INTERFACE-NAME__
2493 description: PCI ID used to identify the sriov-vf
2499 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2502 $ref: "#/definitions/relationship"
2505 - CloudInfrastructure
2506 summary: delete an existing relationship
2507 description: delete an existing relationship
2508 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2517 description: Response codes found in [response codes](https://wiki.onap.org/).
2521 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2524 example: __CLOUD-OWNER__
2525 - name: cloud-region-id
2527 description: Identifier used by the vendor for the region. Second part of composite key
2530 example: __CLOUD-REGION-ID__
2533 description: Unique id relative to the cloud-region.
2536 example: __TENANT-ID__
2539 description: Unique identifier for this vserver relative to its tenant
2542 example: __VSERVER-ID__
2543 - name: interface-name
2545 description: Name given to the interface
2548 example: __INTERFACE-NAME__
2551 description: PCI ID used to identify the sriov-vf
2555 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
2558 - CloudInfrastructure
2559 summary: returns sriov-vf
2560 description: returns sriov-vf
2561 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2567 description: successful operation
2569 $ref: "#/getDefinitions/sriov-vf"
2571 description: Response codes found in [response codes](https://wiki.onap.org/).
2575 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2578 example: __CLOUD-OWNER__
2579 - name: cloud-region-id
2581 description: Identifier used by the vendor for the region. Second part of composite key
2584 example: __CLOUD-REGION-ID__
2587 description: Unique id relative to the cloud-region.
2590 example: __TENANT-ID__
2593 description: Unique identifier for this vserver relative to its tenant
2596 example: __VSERVER-ID__
2597 - name: interface-name
2599 description: Name given to the interface
2602 example: __INTERFACE-NAME__
2605 description: PCI ID used to identify the sriov-vf
2611 - CloudInfrastructure
2612 summary: create or update an existing sriov-vf
2614 Create or update an existing sriov-vf.
2616 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
2617 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2626 description: Response codes found in [response codes](https://wiki.onap.org/).
2630 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2633 example: __CLOUD-OWNER__
2634 - name: cloud-region-id
2636 description: Identifier used by the vendor for the region. Second part of composite key
2639 example: __CLOUD-REGION-ID__
2642 description: Unique id relative to the cloud-region.
2645 example: __TENANT-ID__
2648 description: Unique identifier for this vserver relative to its tenant
2651 example: __VSERVER-ID__
2652 - name: interface-name
2654 description: Name given to the interface
2657 example: __INTERFACE-NAME__
2660 description: PCI ID used to identify the sriov-vf
2666 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2669 $ref: "#/definitions/sriov-vf"
2672 - CloudInfrastructure
2673 summary: update an existing sriov-vf
2675 Update an existing sriov-vf
2677 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2678 The PUT operation will entirely replace an existing object.
2679 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
2681 Other differences between PUT and PATCH are:
2683 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
2684 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2685 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2686 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2695 description: Response codes found in [response codes](https://wiki.onap.org/).
2699 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2702 example: __CLOUD-OWNER__
2703 - name: cloud-region-id
2705 description: Identifier used by the vendor for the region. Second part of composite key
2708 example: __CLOUD-REGION-ID__
2711 description: Unique id relative to the cloud-region.
2714 example: __TENANT-ID__
2717 description: Unique identifier for this vserver relative to its tenant
2720 example: __VSERVER-ID__
2721 - name: interface-name
2723 description: Name given to the interface
2726 example: __INTERFACE-NAME__
2729 description: PCI ID used to identify the sriov-vf
2735 description: sriov-vf object that needs to be updated.
2738 $ref: "#/patchDefinitions/sriov-vf"
2741 - CloudInfrastructure
2742 summary: delete an existing sriov-vf
2743 description: delete an existing sriov-vf
2744 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2753 description: Response codes found in [response codes](https://wiki.onap.org/).
2757 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2760 example: __CLOUD-OWNER__
2761 - name: cloud-region-id
2763 description: Identifier used by the vendor for the region. Second part of composite key
2766 example: __CLOUD-REGION-ID__
2769 description: Unique id relative to the cloud-region.
2772 example: __TENANT-ID__
2775 description: Unique identifier for this vserver relative to its tenant
2778 example: __VSERVER-ID__
2779 - name: interface-name
2781 description: Name given to the interface
2784 example: __INTERFACE-NAME__
2787 description: PCI ID used to identify the sriov-vf
2791 - name: resource-version
2793 description: resource-version for concurrency
2796 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
2799 - CloudInfrastructure
2800 summary: returns sriov-vfs
2801 description: returns sriov-vfs
2802 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
2808 description: successful operation
2810 $ref: "#/getDefinitions/sriov-vfs"
2812 description: Response codes found in [response codes](https://wiki.onap.org/).
2816 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2819 example: __CLOUD-OWNER__
2820 - name: cloud-region-id
2822 description: Identifier used by the vendor for the region. Second part of composite key
2825 example: __CLOUD-REGION-ID__
2828 description: Unique id relative to the cloud-region.
2831 example: __TENANT-ID__
2834 description: Unique identifier for this vserver relative to its tenant
2837 example: __VSERVER-ID__
2838 - name: interface-name
2840 description: Name given to the interface
2843 example: __INTERFACE-NAME__
2849 - name: vf-vlan-filter
2854 - name: vf-mac-filter
2859 - name: vf-vlan-strip
2864 - name: neutron-network-id
2869 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
2872 - CloudInfrastructure
2873 summary: see node definition for valid relationships
2874 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2883 description: Response codes found in [response codes](https://wiki.onap.org/).
2887 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2890 example: __CLOUD-OWNER__
2891 - name: cloud-region-id
2893 description: Identifier used by the vendor for the region. Second part of composite key
2896 example: __CLOUD-REGION-ID__
2899 description: Unique id relative to the cloud-region.
2902 example: __TENANT-ID__
2905 description: Unique identifier for this vserver relative to its tenant
2908 example: __VSERVER-ID__
2909 - name: interface-name
2911 description: Name given to the interface
2914 example: __INTERFACE-NAME__
2917 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
2920 $ref: "#/definitions/relationship"
2923 - CloudInfrastructure
2924 summary: delete an existing relationship
2925 description: delete an existing relationship
2926 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2935 description: Response codes found in [response codes](https://wiki.onap.org/).
2939 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2942 example: __CLOUD-OWNER__
2943 - name: cloud-region-id
2945 description: Identifier used by the vendor for the region. Second part of composite key
2948 example: __CLOUD-REGION-ID__
2951 description: Unique id relative to the cloud-region.
2954 example: __TENANT-ID__
2957 description: Unique identifier for this vserver relative to its tenant
2960 example: __VSERVER-ID__
2961 - name: interface-name
2963 description: Name given to the interface
2966 example: __INTERFACE-NAME__
2967 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
2970 - CloudInfrastructure
2971 summary: see node definition for valid relationships
2972 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
2981 description: Response codes found in [response codes](https://wiki.onap.org/).
2985 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2988 example: __CLOUD-OWNER__
2989 - name: cloud-region-id
2991 description: Identifier used by the vendor for the region. Second part of composite key
2994 example: __CLOUD-REGION-ID__
2997 description: Unique id relative to the cloud-region.
3000 example: __TENANT-ID__
3003 description: Unique identifier for this vserver relative to its tenant
3006 example: __VSERVER-ID__
3007 - name: interface-name
3009 description: Name given to the interface
3012 example: __INTERFACE-NAME__
3013 - name: l3-interface-ipv4-address
3015 description: IP address
3018 example: __L3-INTERFACE-IPV4-ADDRESS__
3021 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3024 $ref: "#/definitions/relationship"
3027 - CloudInfrastructure
3028 summary: delete an existing relationship
3029 description: delete an existing relationship
3030 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3039 description: Response codes found in [response codes](https://wiki.onap.org/).
3043 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3046 example: __CLOUD-OWNER__
3047 - name: cloud-region-id
3049 description: Identifier used by the vendor for the region. Second part of composite key
3052 example: __CLOUD-REGION-ID__
3055 description: Unique id relative to the cloud-region.
3058 example: __TENANT-ID__
3061 description: Unique identifier for this vserver relative to its tenant
3064 example: __VSERVER-ID__
3065 - name: interface-name
3067 description: Name given to the interface
3070 example: __INTERFACE-NAME__
3071 - name: l3-interface-ipv4-address
3073 description: IP address
3076 example: __L3-INTERFACE-IPV4-ADDRESS__
3077 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
3080 - CloudInfrastructure
3081 summary: returns l3-interface-ipv4-address-list
3082 description: returns l3-interface-ipv4-address-list
3083 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3089 description: successful operation
3091 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3093 description: Response codes found in [response codes](https://wiki.onap.org/).
3097 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3100 example: __CLOUD-OWNER__
3101 - name: cloud-region-id
3103 description: Identifier used by the vendor for the region. Second part of composite key
3106 example: __CLOUD-REGION-ID__
3109 description: Unique id relative to the cloud-region.
3112 example: __TENANT-ID__
3115 description: Unique identifier for this vserver relative to its tenant
3118 example: __VSERVER-ID__
3119 - name: interface-name
3121 description: Name given to the interface
3124 example: __INTERFACE-NAME__
3125 - name: l3-interface-ipv4-address
3127 description: IP address
3130 example: __L3-INTERFACE-IPV4-ADDRESS__
3133 - CloudInfrastructure
3134 summary: create or update an existing l3-interface-ipv4-address-list
3136 Create or update an existing l3-interface-ipv4-address-list.
3138 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
3139 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3148 description: Response codes found in [response codes](https://wiki.onap.org/).
3152 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3155 example: __CLOUD-OWNER__
3156 - name: cloud-region-id
3158 description: Identifier used by the vendor for the region. Second part of composite key
3161 example: __CLOUD-REGION-ID__
3164 description: Unique id relative to the cloud-region.
3167 example: __TENANT-ID__
3170 description: Unique identifier for this vserver relative to its tenant
3173 example: __VSERVER-ID__
3174 - name: interface-name
3176 description: Name given to the interface
3179 example: __INTERFACE-NAME__
3180 - name: l3-interface-ipv4-address
3182 description: IP address
3185 example: __L3-INTERFACE-IPV4-ADDRESS__
3188 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3191 $ref: "#/definitions/l3-interface-ipv4-address-list"
3194 - CloudInfrastructure
3195 summary: update an existing l3-interface-ipv4-address-list
3197 Update an existing l3-interface-ipv4-address-list
3199 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3200 The PUT operation will entirely replace an existing object.
3201 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
3203 Other differences between PUT and PATCH are:
3205 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
3206 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3207 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3208 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3217 description: Response codes found in [response codes](https://wiki.onap.org/).
3221 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3224 example: __CLOUD-OWNER__
3225 - name: cloud-region-id
3227 description: Identifier used by the vendor for the region. Second part of composite key
3230 example: __CLOUD-REGION-ID__
3233 description: Unique id relative to the cloud-region.
3236 example: __TENANT-ID__
3239 description: Unique identifier for this vserver relative to its tenant
3242 example: __VSERVER-ID__
3243 - name: interface-name
3245 description: Name given to the interface
3248 example: __INTERFACE-NAME__
3249 - name: l3-interface-ipv4-address
3251 description: IP address
3254 example: __L3-INTERFACE-IPV4-ADDRESS__
3257 description: l3-interface-ipv4-address-list object that needs to be updated.
3260 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3263 - CloudInfrastructure
3264 summary: delete an existing l3-interface-ipv4-address-list
3265 description: delete an existing l3-interface-ipv4-address-list
3266 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3275 description: Response codes found in [response codes](https://wiki.onap.org/).
3279 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3282 example: __CLOUD-OWNER__
3283 - name: cloud-region-id
3285 description: Identifier used by the vendor for the region. Second part of composite key
3288 example: __CLOUD-REGION-ID__
3291 description: Unique id relative to the cloud-region.
3294 example: __TENANT-ID__
3297 description: Unique identifier for this vserver relative to its tenant
3300 example: __VSERVER-ID__
3301 - name: interface-name
3303 description: Name given to the interface
3306 example: __INTERFACE-NAME__
3307 - name: l3-interface-ipv4-address
3309 description: IP address
3312 example: __L3-INTERFACE-IPV4-ADDRESS__
3313 - name: resource-version
3315 description: resource-version for concurrency
3318 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
3321 - CloudInfrastructure
3322 summary: see node definition for valid relationships
3323 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3332 description: Response codes found in [response codes](https://wiki.onap.org/).
3336 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3339 example: __CLOUD-OWNER__
3340 - name: cloud-region-id
3342 description: Identifier used by the vendor for the region. Second part of composite key
3345 example: __CLOUD-REGION-ID__
3348 description: Unique id relative to the cloud-region.
3351 example: __TENANT-ID__
3354 description: Unique identifier for this vserver relative to its tenant
3357 example: __VSERVER-ID__
3358 - name: interface-name
3360 description: Name given to the interface
3363 example: __INTERFACE-NAME__
3364 - name: l3-interface-ipv6-address
3366 description: IP address
3369 example: __L3-INTERFACE-IPV6-ADDRESS__
3372 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3375 $ref: "#/definitions/relationship"
3378 - CloudInfrastructure
3379 summary: delete an existing relationship
3380 description: delete an existing relationship
3381 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3390 description: Response codes found in [response codes](https://wiki.onap.org/).
3394 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3397 example: __CLOUD-OWNER__
3398 - name: cloud-region-id
3400 description: Identifier used by the vendor for the region. Second part of composite key
3403 example: __CLOUD-REGION-ID__
3406 description: Unique id relative to the cloud-region.
3409 example: __TENANT-ID__
3412 description: Unique identifier for this vserver relative to its tenant
3415 example: __VSERVER-ID__
3416 - name: interface-name
3418 description: Name given to the interface
3421 example: __INTERFACE-NAME__
3422 - name: l3-interface-ipv6-address
3424 description: IP address
3427 example: __L3-INTERFACE-IPV6-ADDRESS__
3428 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
3431 - CloudInfrastructure
3432 summary: returns l3-interface-ipv6-address-list
3433 description: returns l3-interface-ipv6-address-list
3434 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3440 description: successful operation
3442 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
3444 description: Response codes found in [response codes](https://wiki.onap.org/).
3448 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3451 example: __CLOUD-OWNER__
3452 - name: cloud-region-id
3454 description: Identifier used by the vendor for the region. Second part of composite key
3457 example: __CLOUD-REGION-ID__
3460 description: Unique id relative to the cloud-region.
3463 example: __TENANT-ID__
3466 description: Unique identifier for this vserver relative to its tenant
3469 example: __VSERVER-ID__
3470 - name: interface-name
3472 description: Name given to the interface
3475 example: __INTERFACE-NAME__
3476 - name: l3-interface-ipv6-address
3478 description: IP address
3481 example: __L3-INTERFACE-IPV6-ADDRESS__
3484 - CloudInfrastructure
3485 summary: create or update an existing l3-interface-ipv6-address-list
3487 Create or update an existing l3-interface-ipv6-address-list.
3489 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
3490 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3499 description: Response codes found in [response codes](https://wiki.onap.org/).
3503 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3506 example: __CLOUD-OWNER__
3507 - name: cloud-region-id
3509 description: Identifier used by the vendor for the region. Second part of composite key
3512 example: __CLOUD-REGION-ID__
3515 description: Unique id relative to the cloud-region.
3518 example: __TENANT-ID__
3521 description: Unique identifier for this vserver relative to its tenant
3524 example: __VSERVER-ID__
3525 - name: interface-name
3527 description: Name given to the interface
3530 example: __INTERFACE-NAME__
3531 - name: l3-interface-ipv6-address
3533 description: IP address
3536 example: __L3-INTERFACE-IPV6-ADDRESS__
3539 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3542 $ref: "#/definitions/l3-interface-ipv6-address-list"
3545 - CloudInfrastructure
3546 summary: update an existing l3-interface-ipv6-address-list
3548 Update an existing l3-interface-ipv6-address-list
3550 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3551 The PUT operation will entirely replace an existing object.
3552 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
3554 Other differences between PUT and PATCH are:
3556 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
3557 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3558 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3559 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3568 description: Response codes found in [response codes](https://wiki.onap.org/).
3572 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3575 example: __CLOUD-OWNER__
3576 - name: cloud-region-id
3578 description: Identifier used by the vendor for the region. Second part of composite key
3581 example: __CLOUD-REGION-ID__
3584 description: Unique id relative to the cloud-region.
3587 example: __TENANT-ID__
3590 description: Unique identifier for this vserver relative to its tenant
3593 example: __VSERVER-ID__
3594 - name: interface-name
3596 description: Name given to the interface
3599 example: __INTERFACE-NAME__
3600 - name: l3-interface-ipv6-address
3602 description: IP address
3605 example: __L3-INTERFACE-IPV6-ADDRESS__
3608 description: l3-interface-ipv6-address-list object that needs to be updated.
3611 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
3614 - CloudInfrastructure
3615 summary: delete an existing l3-interface-ipv6-address-list
3616 description: delete an existing l3-interface-ipv6-address-list
3617 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3626 description: Response codes found in [response codes](https://wiki.onap.org/).
3630 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3633 example: __CLOUD-OWNER__
3634 - name: cloud-region-id
3636 description: Identifier used by the vendor for the region. Second part of composite key
3639 example: __CLOUD-REGION-ID__
3642 description: Unique id relative to the cloud-region.
3645 example: __TENANT-ID__
3648 description: Unique identifier for this vserver relative to its tenant
3651 example: __VSERVER-ID__
3652 - name: interface-name
3654 description: Name given to the interface
3657 example: __INTERFACE-NAME__
3658 - name: l3-interface-ipv6-address
3660 description: IP address
3663 example: __L3-INTERFACE-IPV6-ADDRESS__
3664 - name: resource-version
3666 description: resource-version for concurrency
3669 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}:
3672 - CloudInfrastructure
3673 summary: returns l-interface
3674 description: returns l-interface
3675 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3681 description: successful operation
3683 $ref: "#/getDefinitions/l-interface"
3685 description: Response codes found in [response codes](https://wiki.onap.org/).
3689 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3692 example: __CLOUD-OWNER__
3693 - name: cloud-region-id
3695 description: Identifier used by the vendor for the region. Second part of composite key
3698 example: __CLOUD-REGION-ID__
3701 description: Unique id relative to the cloud-region.
3704 example: __TENANT-ID__
3707 description: Unique identifier for this vserver relative to its tenant
3710 example: __VSERVER-ID__
3711 - name: interface-name
3713 description: Name given to the interface
3716 example: __INTERFACE-NAME__
3719 - CloudInfrastructure
3720 summary: create or update an existing l-interface
3722 Create or update an existing l-interface.
3724 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
3725 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3734 description: Response codes found in [response codes](https://wiki.onap.org/).
3738 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3741 example: __CLOUD-OWNER__
3742 - name: cloud-region-id
3744 description: Identifier used by the vendor for the region. Second part of composite key
3747 example: __CLOUD-REGION-ID__
3750 description: Unique id relative to the cloud-region.
3753 example: __TENANT-ID__
3756 description: Unique identifier for this vserver relative to its tenant
3759 example: __VSERVER-ID__
3760 - name: interface-name
3762 description: Name given to the interface
3765 example: __INTERFACE-NAME__
3768 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3771 $ref: "#/definitions/l-interface"
3774 - CloudInfrastructure
3775 summary: update an existing l-interface
3777 Update an existing l-interface
3779 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3780 The PUT operation will entirely replace an existing object.
3781 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
3783 Other differences between PUT and PATCH are:
3785 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
3786 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3787 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3788 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3797 description: Response codes found in [response codes](https://wiki.onap.org/).
3801 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3804 example: __CLOUD-OWNER__
3805 - name: cloud-region-id
3807 description: Identifier used by the vendor for the region. Second part of composite key
3810 example: __CLOUD-REGION-ID__
3813 description: Unique id relative to the cloud-region.
3816 example: __TENANT-ID__
3819 description: Unique identifier for this vserver relative to its tenant
3822 example: __VSERVER-ID__
3823 - name: interface-name
3825 description: Name given to the interface
3828 example: __INTERFACE-NAME__
3831 description: l-interface object that needs to be updated.
3834 $ref: "#/patchDefinitions/l-interface"
3837 - CloudInfrastructure
3838 summary: delete an existing l-interface
3839 description: delete an existing l-interface
3840 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3849 description: Response codes found in [response codes](https://wiki.onap.org/).
3853 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3856 example: __CLOUD-OWNER__
3857 - name: cloud-region-id
3859 description: Identifier used by the vendor for the region. Second part of composite key
3862 example: __CLOUD-REGION-ID__
3865 description: Unique id relative to the cloud-region.
3868 example: __TENANT-ID__
3871 description: Unique identifier for this vserver relative to its tenant
3874 example: __VSERVER-ID__
3875 - name: interface-name
3877 description: Name given to the interface
3880 example: __INTERFACE-NAME__
3881 - name: resource-version
3883 description: resource-version for concurrency
3886 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
3889 - CloudInfrastructure
3890 summary: returns l-interfaces
3891 description: returns l-interfaces
3892 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
3898 description: successful operation
3900 $ref: "#/getDefinitions/l-interfaces"
3902 description: Response codes found in [response codes](https://wiki.onap.org/).
3906 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3909 example: __CLOUD-OWNER__
3910 - name: cloud-region-id
3912 description: Identifier used by the vendor for the region. Second part of composite key
3915 example: __CLOUD-REGION-ID__
3918 description: Unique id relative to the cloud-region.
3921 example: __TENANT-ID__
3924 description: Unique identifier for this vserver relative to its tenant
3927 example: __VSERVER-ID__
3928 - name: interface-name
3933 - name: interface-id
3943 - name: network-name
3948 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
3951 - CloudInfrastructure
3952 summary: returns vserver
3953 description: returns vserver
3954 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
3960 description: successful operation
3962 $ref: "#/getDefinitions/vserver"
3964 description: Response codes found in [response codes](https://wiki.onap.org/).
3968 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3971 example: __CLOUD-OWNER__
3972 - name: cloud-region-id
3974 description: Identifier used by the vendor for the region. Second part of composite key
3977 example: __CLOUD-REGION-ID__
3980 description: Unique id relative to the cloud-region.
3983 example: __TENANT-ID__
3986 description: Unique identifier for this vserver relative to its tenant
3989 example: __VSERVER-ID__
3992 - CloudInfrastructure
3993 summary: create or update an existing vserver
3995 Create or update an existing vserver.
3997 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
3998 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4007 description: Response codes found in [response codes](https://wiki.onap.org/).
4011 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4014 example: __CLOUD-OWNER__
4015 - name: cloud-region-id
4017 description: Identifier used by the vendor for the region. Second part of composite key
4020 example: __CLOUD-REGION-ID__
4023 description: Unique id relative to the cloud-region.
4026 example: __TENANT-ID__
4029 description: Unique identifier for this vserver relative to its tenant
4032 example: __VSERVER-ID__
4035 description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4038 $ref: "#/definitions/vserver"
4041 - CloudInfrastructure
4042 summary: update an existing vserver
4044 Update an existing vserver
4046 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4047 The PUT operation will entirely replace an existing object.
4048 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4050 Other differences between PUT and PATCH are:
4052 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4053 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4054 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4055 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4064 description: Response codes found in [response codes](https://wiki.onap.org/).
4068 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4071 example: __CLOUD-OWNER__
4072 - name: cloud-region-id
4074 description: Identifier used by the vendor for the region. Second part of composite key
4077 example: __CLOUD-REGION-ID__
4080 description: Unique id relative to the cloud-region.
4083 example: __TENANT-ID__
4086 description: Unique identifier for this vserver relative to its tenant
4089 example: __VSERVER-ID__
4092 description: vserver object that needs to be updated.
4095 $ref: "#/patchDefinitions/vserver"
4098 - CloudInfrastructure
4099 summary: delete an existing vserver
4100 description: delete an existing vserver
4101 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4110 description: Response codes found in [response codes](https://wiki.onap.org/).
4114 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4117 example: __CLOUD-OWNER__
4118 - name: cloud-region-id
4120 description: Identifier used by the vendor for the region. Second part of composite key
4123 example: __CLOUD-REGION-ID__
4126 description: Unique id relative to the cloud-region.
4129 example: __TENANT-ID__
4132 description: Unique identifier for this vserver relative to its tenant
4135 example: __VSERVER-ID__
4136 - name: resource-version
4138 description: resource-version for concurrency
4141 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4144 - CloudInfrastructure
4145 summary: returns vservers
4146 description: returns vservers
4147 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4153 description: successful operation
4155 $ref: "#/getDefinitions/vservers"
4157 description: Response codes found in [response codes](https://wiki.onap.org/).
4161 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4164 example: __CLOUD-OWNER__
4165 - name: cloud-region-id
4167 description: Identifier used by the vendor for the region. Second part of composite key
4170 example: __CLOUD-REGION-ID__
4173 description: Unique id relative to the cloud-region.
4176 example: __TENANT-ID__
4182 - name: vserver-name
4187 - name: vserver-name2
4202 - name: is-closed-loop-disabled
4207 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4210 - CloudInfrastructure
4211 summary: see node definition for valid relationships
4212 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4221 description: Response codes found in [response codes](https://wiki.onap.org/).
4225 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4228 example: __CLOUD-OWNER__
4229 - name: cloud-region-id
4231 description: Identifier used by the vendor for the region. Second part of composite key
4234 example: __CLOUD-REGION-ID__
4237 description: Unique id relative to the cloud-region.
4240 example: __TENANT-ID__
4243 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4246 $ref: "#/definitions/relationship"
4249 - CloudInfrastructure
4250 summary: delete an existing relationship
4251 description: delete an existing relationship
4252 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4261 description: Response codes found in [response codes](https://wiki.onap.org/).
4265 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4268 example: __CLOUD-OWNER__
4269 - name: cloud-region-id
4271 description: Identifier used by the vendor for the region. Second part of composite key
4274 example: __CLOUD-REGION-ID__
4277 description: Unique id relative to the cloud-region.
4280 example: __TENANT-ID__
4281 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
4284 - CloudInfrastructure
4285 summary: returns tenant
4286 description: returns tenant
4287 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4293 description: successful operation
4295 $ref: "#/getDefinitions/tenant"
4297 description: Response codes found in [response codes](https://wiki.onap.org/).
4301 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4304 example: __CLOUD-OWNER__
4305 - name: cloud-region-id
4307 description: Identifier used by the vendor for the region. Second part of composite key
4310 example: __CLOUD-REGION-ID__
4313 description: Unique id relative to the cloud-region.
4316 example: __TENANT-ID__
4319 - CloudInfrastructure
4320 summary: create or update an existing tenant
4322 Create or update an existing tenant.
4324 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4325 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4334 description: Response codes found in [response codes](https://wiki.onap.org/).
4338 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4341 example: __CLOUD-OWNER__
4342 - name: cloud-region-id
4344 description: Identifier used by the vendor for the region. Second part of composite key
4347 example: __CLOUD-REGION-ID__
4350 description: Unique id relative to the cloud-region.
4353 example: __TENANT-ID__
4356 description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4359 $ref: "#/definitions/tenant"
4362 - CloudInfrastructure
4363 summary: update an existing tenant
4365 Update an existing tenant
4367 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4368 The PUT operation will entirely replace an existing object.
4369 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4371 Other differences between PUT and PATCH are:
4373 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4374 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4375 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4376 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4385 description: Response codes found in [response codes](https://wiki.onap.org/).
4389 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4392 example: __CLOUD-OWNER__
4393 - name: cloud-region-id
4395 description: Identifier used by the vendor for the region. Second part of composite key
4398 example: __CLOUD-REGION-ID__
4401 description: Unique id relative to the cloud-region.
4404 example: __TENANT-ID__
4407 description: tenant object that needs to be updated.
4410 $ref: "#/patchDefinitions/tenant"
4413 - CloudInfrastructure
4414 summary: delete an existing tenant
4415 description: delete an existing tenant
4416 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4425 description: Response codes found in [response codes](https://wiki.onap.org/).
4429 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4432 example: __CLOUD-OWNER__
4433 - name: cloud-region-id
4435 description: Identifier used by the vendor for the region. Second part of composite key
4438 example: __CLOUD-REGION-ID__
4441 description: Unique id relative to the cloud-region.
4444 example: __TENANT-ID__
4445 - name: resource-version
4447 description: resource-version for concurrency
4450 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
4453 - CloudInfrastructure
4454 summary: returns tenants
4455 description: returns tenants
4456 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
4462 description: successful operation
4464 $ref: "#/getDefinitions/tenants"
4466 description: Response codes found in [response codes](https://wiki.onap.org/).
4470 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4473 example: __CLOUD-OWNER__
4474 - name: cloud-region-id
4476 description: Identifier used by the vendor for the region. Second part of composite key
4479 example: __CLOUD-REGION-ID__
4490 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
4493 - CloudInfrastructure
4494 summary: see node definition for valid relationships
4495 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4504 description: Response codes found in [response codes](https://wiki.onap.org/).
4508 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4511 example: __CLOUD-OWNER__
4512 - name: cloud-region-id
4514 description: Identifier used by the vendor for the region. Second part of composite key
4517 example: __CLOUD-REGION-ID__
4520 description: Flavor id, expected to be unique across cloud-region.
4523 example: __FLAVOR-ID__
4526 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4529 $ref: "#/definitions/relationship"
4532 - CloudInfrastructure
4533 summary: delete an existing relationship
4534 description: delete an existing relationship
4535 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4544 description: Response codes found in [response codes](https://wiki.onap.org/).
4548 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4551 example: __CLOUD-OWNER__
4552 - name: cloud-region-id
4554 description: Identifier used by the vendor for the region. Second part of composite key
4557 example: __CLOUD-REGION-ID__
4560 description: Flavor id, expected to be unique across cloud-region.
4563 example: __FLAVOR-ID__
4564 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
4567 - CloudInfrastructure
4568 summary: returns flavor
4569 description: returns flavor
4570 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4576 description: successful operation
4578 $ref: "#/getDefinitions/flavor"
4580 description: Response codes found in [response codes](https://wiki.onap.org/).
4584 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4587 example: __CLOUD-OWNER__
4588 - name: cloud-region-id
4590 description: Identifier used by the vendor for the region. Second part of composite key
4593 example: __CLOUD-REGION-ID__
4596 description: Flavor id, expected to be unique across cloud-region.
4599 example: __FLAVOR-ID__
4602 - CloudInfrastructure
4603 summary: create or update an existing flavor
4605 Create or update an existing flavor.
4607 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4608 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4617 description: Response codes found in [response codes](https://wiki.onap.org/).
4621 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4624 example: __CLOUD-OWNER__
4625 - name: cloud-region-id
4627 description: Identifier used by the vendor for the region. Second part of composite key
4630 example: __CLOUD-REGION-ID__
4633 description: Flavor id, expected to be unique across cloud-region.
4636 example: __FLAVOR-ID__
4639 description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4642 $ref: "#/definitions/flavor"
4645 - CloudInfrastructure
4646 summary: update an existing flavor
4648 Update an existing flavor
4650 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4651 The PUT operation will entirely replace an existing object.
4652 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4654 Other differences between PUT and PATCH are:
4656 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4657 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4658 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4659 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4668 description: Response codes found in [response codes](https://wiki.onap.org/).
4672 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4675 example: __CLOUD-OWNER__
4676 - name: cloud-region-id
4678 description: Identifier used by the vendor for the region. Second part of composite key
4681 example: __CLOUD-REGION-ID__
4684 description: Flavor id, expected to be unique across cloud-region.
4687 example: __FLAVOR-ID__
4690 description: flavor object that needs to be updated.
4693 $ref: "#/patchDefinitions/flavor"
4696 - CloudInfrastructure
4697 summary: delete an existing flavor
4698 description: delete an existing flavor
4699 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4708 description: Response codes found in [response codes](https://wiki.onap.org/).
4712 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4715 example: __CLOUD-OWNER__
4716 - name: cloud-region-id
4718 description: Identifier used by the vendor for the region. Second part of composite key
4721 example: __CLOUD-REGION-ID__
4724 description: Flavor id, expected to be unique across cloud-region.
4727 example: __FLAVOR-ID__
4728 - name: resource-version
4730 description: resource-version for concurrency
4733 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
4736 - CloudInfrastructure
4737 summary: returns flavors
4738 description: returns flavors
4739 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
4745 description: successful operation
4747 $ref: "#/getDefinitions/flavors"
4749 description: Response codes found in [response codes](https://wiki.onap.org/).
4753 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4756 example: __CLOUD-OWNER__
4757 - name: cloud-region-id
4759 description: Identifier used by the vendor for the region. Second part of composite key
4762 example: __CLOUD-REGION-ID__
4773 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
4776 - CloudInfrastructure
4777 summary: see node definition for valid relationships
4778 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4787 description: Response codes found in [response codes](https://wiki.onap.org/).
4791 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4794 example: __CLOUD-OWNER__
4795 - name: cloud-region-id
4797 description: Identifier used by the vendor for the region. Second part of composite key
4800 example: __CLOUD-REGION-ID__
4803 description: Group id, expected to be unique across cloud-region.
4806 example: __GROUP-ID__
4809 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4812 $ref: "#/definitions/relationship"
4815 - CloudInfrastructure
4816 summary: delete an existing relationship
4817 description: delete an existing relationship
4818 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4827 description: Response codes found in [response codes](https://wiki.onap.org/).
4831 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4834 example: __CLOUD-OWNER__
4835 - name: cloud-region-id
4837 description: Identifier used by the vendor for the region. Second part of composite key
4840 example: __CLOUD-REGION-ID__
4843 description: Group id, expected to be unique across cloud-region.
4846 example: __GROUP-ID__
4847 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
4850 - CloudInfrastructure
4851 summary: returns group-assignment
4852 description: returns group-assignment
4853 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4859 description: successful operation
4861 $ref: "#/getDefinitions/group-assignment"
4863 description: Response codes found in [response codes](https://wiki.onap.org/).
4867 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4870 example: __CLOUD-OWNER__
4871 - name: cloud-region-id
4873 description: Identifier used by the vendor for the region. Second part of composite key
4876 example: __CLOUD-REGION-ID__
4879 description: Group id, expected to be unique across cloud-region.
4882 example: __GROUP-ID__
4885 - CloudInfrastructure
4886 summary: create or update an existing group-assignment
4888 Create or update an existing group-assignment.
4890 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4891 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4900 description: Response codes found in [response codes](https://wiki.onap.org/).
4904 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4907 example: __CLOUD-OWNER__
4908 - name: cloud-region-id
4910 description: Identifier used by the vendor for the region. Second part of composite key
4913 example: __CLOUD-REGION-ID__
4916 description: Group id, expected to be unique across cloud-region.
4919 example: __GROUP-ID__
4922 description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4925 $ref: "#/definitions/group-assignment"
4928 - CloudInfrastructure
4929 summary: update an existing group-assignment
4931 Update an existing group-assignment
4933 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4934 The PUT operation will entirely replace an existing object.
4935 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4937 Other differences between PUT and PATCH are:
4939 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4940 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4941 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4942 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4951 description: Response codes found in [response codes](https://wiki.onap.org/).
4955 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4958 example: __CLOUD-OWNER__
4959 - name: cloud-region-id
4961 description: Identifier used by the vendor for the region. Second part of composite key
4964 example: __CLOUD-REGION-ID__
4967 description: Group id, expected to be unique across cloud-region.
4970 example: __GROUP-ID__
4973 description: group-assignment object that needs to be updated.
4976 $ref: "#/patchDefinitions/group-assignment"
4979 - CloudInfrastructure
4980 summary: delete an existing group-assignment
4981 description: delete an existing group-assignment
4982 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4991 description: Response codes found in [response codes](https://wiki.onap.org/).
4995 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4998 example: __CLOUD-OWNER__
4999 - name: cloud-region-id
5001 description: Identifier used by the vendor for the region. Second part of composite key
5004 example: __CLOUD-REGION-ID__
5007 description: Group id, expected to be unique across cloud-region.
5010 example: __GROUP-ID__
5011 - name: resource-version
5013 description: resource-version for concurrency
5016 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5019 - CloudInfrastructure
5020 summary: returns group-assignments
5021 description: returns group-assignments
5022 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5028 description: successful operation
5030 $ref: "#/getDefinitions/group-assignments"
5032 description: Response codes found in [response codes](https://wiki.onap.org/).
5036 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5039 example: __CLOUD-OWNER__
5040 - name: cloud-region-id
5042 description: Identifier used by the vendor for the region. Second part of composite key
5045 example: __CLOUD-REGION-ID__
5061 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5064 - CloudInfrastructure
5065 summary: see node definition for valid relationships
5066 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5075 description: Response codes found in [response codes](https://wiki.onap.org/).
5079 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5082 example: __CLOUD-OWNER__
5083 - name: cloud-region-id
5085 description: Identifier used by the vendor for the region. Second part of composite key
5088 example: __CLOUD-REGION-ID__
5091 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5094 example: __SNAPSHOT-ID__
5097 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5100 $ref: "#/definitions/relationship"
5103 - CloudInfrastructure
5104 summary: delete an existing relationship
5105 description: delete an existing relationship
5106 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5115 description: Response codes found in [response codes](https://wiki.onap.org/).
5119 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5122 example: __CLOUD-OWNER__
5123 - name: cloud-region-id
5125 description: Identifier used by the vendor for the region. Second part of composite key
5128 example: __CLOUD-REGION-ID__
5131 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5134 example: __SNAPSHOT-ID__
5135 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5138 - CloudInfrastructure
5139 summary: returns snapshot
5140 description: returns snapshot
5141 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5147 description: successful operation
5149 $ref: "#/getDefinitions/snapshot"
5151 description: Response codes found in [response codes](https://wiki.onap.org/).
5155 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5158 example: __CLOUD-OWNER__
5159 - name: cloud-region-id
5161 description: Identifier used by the vendor for the region. Second part of composite key
5164 example: __CLOUD-REGION-ID__
5167 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5170 example: __SNAPSHOT-ID__
5173 - CloudInfrastructure
5174 summary: create or update an existing snapshot
5176 Create or update an existing snapshot.
5178 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5179 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5188 description: Response codes found in [response codes](https://wiki.onap.org/).
5192 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5195 example: __CLOUD-OWNER__
5196 - name: cloud-region-id
5198 description: Identifier used by the vendor for the region. Second part of composite key
5201 example: __CLOUD-REGION-ID__
5204 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5207 example: __SNAPSHOT-ID__
5210 description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5213 $ref: "#/definitions/snapshot"
5216 - CloudInfrastructure
5217 summary: update an existing snapshot
5219 Update an existing snapshot
5221 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5222 The PUT operation will entirely replace an existing object.
5223 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5225 Other differences between PUT and PATCH are:
5227 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5228 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5229 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5230 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5239 description: Response codes found in [response codes](https://wiki.onap.org/).
5243 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5246 example: __CLOUD-OWNER__
5247 - name: cloud-region-id
5249 description: Identifier used by the vendor for the region. Second part of composite key
5252 example: __CLOUD-REGION-ID__
5255 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5258 example: __SNAPSHOT-ID__
5261 description: snapshot object that needs to be updated.
5264 $ref: "#/patchDefinitions/snapshot"
5267 - CloudInfrastructure
5268 summary: delete an existing snapshot
5269 description: delete an existing snapshot
5270 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5279 description: Response codes found in [response codes](https://wiki.onap.org/).
5283 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5286 example: __CLOUD-OWNER__
5287 - name: cloud-region-id
5289 description: Identifier used by the vendor for the region. Second part of composite key
5292 example: __CLOUD-REGION-ID__
5295 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5298 example: __SNAPSHOT-ID__
5299 - name: resource-version
5301 description: resource-version for concurrency
5304 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5307 - CloudInfrastructure
5308 summary: returns snapshots
5309 description: returns snapshots
5310 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5316 description: successful operation
5318 $ref: "#/getDefinitions/snapshots"
5320 description: Response codes found in [response codes](https://wiki.onap.org/).
5324 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5327 example: __CLOUD-OWNER__
5328 - name: cloud-region-id
5330 description: Identifier used by the vendor for the region. Second part of composite key
5333 example: __CLOUD-REGION-ID__
5339 - name: snapshot-name
5349 - name: application-vendor
5354 - name: application-version
5359 - name: prev-snapshot-id
5364 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
5367 - CloudInfrastructure
5368 summary: see node definition for valid relationships
5369 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5378 description: Response codes found in [response codes](https://wiki.onap.org/).
5382 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5385 example: __CLOUD-OWNER__
5386 - name: cloud-region-id
5388 description: Identifier used by the vendor for the region. Second part of composite key
5391 example: __CLOUD-REGION-ID__
5394 description: Image id, expected to be unique across cloud region
5397 example: __IMAGE-ID__
5400 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5403 $ref: "#/definitions/relationship"
5406 - CloudInfrastructure
5407 summary: delete an existing relationship
5408 description: delete an existing relationship
5409 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5418 description: Response codes found in [response codes](https://wiki.onap.org/).
5422 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5425 example: __CLOUD-OWNER__
5426 - name: cloud-region-id
5428 description: Identifier used by the vendor for the region. Second part of composite key
5431 example: __CLOUD-REGION-ID__
5434 description: Image id, expected to be unique across cloud region
5437 example: __IMAGE-ID__
5438 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
5441 - CloudInfrastructure
5442 summary: returns metadatum
5443 description: returns metadatum
5444 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5450 description: successful operation
5452 $ref: "#/getDefinitions/metadatum"
5454 description: Response codes found in [response codes](https://wiki.onap.org/).
5458 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5461 example: __CLOUD-OWNER__
5462 - name: cloud-region-id
5464 description: Identifier used by the vendor for the region. Second part of composite key
5467 example: __CLOUD-REGION-ID__
5470 description: Image id, expected to be unique across cloud region
5473 example: __IMAGE-ID__
5478 example: __METANAME__
5481 - CloudInfrastructure
5482 summary: create or update an existing metadatum
5484 Create or update an existing metadatum.
5486 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5487 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5496 description: Response codes found in [response codes](https://wiki.onap.org/).
5500 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5503 example: __CLOUD-OWNER__
5504 - name: cloud-region-id
5506 description: Identifier used by the vendor for the region. Second part of composite key
5509 example: __CLOUD-REGION-ID__
5512 description: Image id, expected to be unique across cloud region
5515 example: __IMAGE-ID__
5520 example: __METANAME__
5523 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
5526 $ref: "#/definitions/metadatum"
5529 - CloudInfrastructure
5530 summary: update an existing metadatum
5532 Update an existing metadatum
5534 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5535 The PUT operation will entirely replace an existing object.
5536 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5538 Other differences between PUT and PATCH are:
5540 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5541 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5542 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5543 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5552 description: Response codes found in [response codes](https://wiki.onap.org/).
5556 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5559 example: __CLOUD-OWNER__
5560 - name: cloud-region-id
5562 description: Identifier used by the vendor for the region. Second part of composite key
5565 example: __CLOUD-REGION-ID__
5568 description: Image id, expected to be unique across cloud region
5571 example: __IMAGE-ID__
5576 example: __METANAME__
5579 description: metadatum object that needs to be updated.
5582 $ref: "#/patchDefinitions/metadatum"
5585 - CloudInfrastructure
5586 summary: delete an existing metadatum
5587 description: delete an existing metadatum
5588 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5597 description: Response codes found in [response codes](https://wiki.onap.org/).
5601 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5604 example: __CLOUD-OWNER__
5605 - name: cloud-region-id
5607 description: Identifier used by the vendor for the region. Second part of composite key
5610 example: __CLOUD-REGION-ID__
5613 description: Image id, expected to be unique across cloud region
5616 example: __IMAGE-ID__
5621 example: __METANAME__
5622 - name: resource-version
5624 description: resource-version for concurrency
5627 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
5630 - CloudInfrastructure
5631 summary: returns metadata
5632 description: returns metadata
5633 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
5639 description: successful operation
5641 $ref: "#/getDefinitions/metadata"
5643 description: Response codes found in [response codes](https://wiki.onap.org/).
5647 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5650 example: __CLOUD-OWNER__
5651 - name: cloud-region-id
5653 description: Identifier used by the vendor for the region. Second part of composite key
5656 example: __CLOUD-REGION-ID__
5659 description: Image id, expected to be unique across cloud region
5662 example: __IMAGE-ID__
5668 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
5671 - CloudInfrastructure
5672 summary: returns image
5673 description: returns image
5674 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
5680 description: successful operation
5682 $ref: "#/getDefinitions/image"
5684 description: Response codes found in [response codes](https://wiki.onap.org/).
5688 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5691 example: __CLOUD-OWNER__
5692 - name: cloud-region-id
5694 description: Identifier used by the vendor for the region. Second part of composite key
5697 example: __CLOUD-REGION-ID__
5700 description: Image id, expected to be unique across cloud region
5703 example: __IMAGE-ID__
5706 - CloudInfrastructure
5707 summary: create or update an existing image
5709 Create or update an existing image.
5711 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5712 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5721 description: Response codes found in [response codes](https://wiki.onap.org/).
5725 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5728 example: __CLOUD-OWNER__
5729 - name: cloud-region-id
5731 description: Identifier used by the vendor for the region. Second part of composite key
5734 example: __CLOUD-REGION-ID__
5737 description: Image id, expected to be unique across cloud region
5740 example: __IMAGE-ID__
5743 description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5746 $ref: "#/definitions/image"
5749 - CloudInfrastructure
5750 summary: update an existing image
5752 Update an existing image
5754 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5755 The PUT operation will entirely replace an existing object.
5756 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5758 Other differences between PUT and PATCH are:
5760 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5761 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5762 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5763 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5772 description: Response codes found in [response codes](https://wiki.onap.org/).
5776 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5779 example: __CLOUD-OWNER__
5780 - name: cloud-region-id
5782 description: Identifier used by the vendor for the region. Second part of composite key
5785 example: __CLOUD-REGION-ID__
5788 description: Image id, expected to be unique across cloud region
5791 example: __IMAGE-ID__
5794 description: image object that needs to be updated.
5797 $ref: "#/patchDefinitions/image"
5800 - CloudInfrastructure
5801 summary: delete an existing image
5802 description: delete an existing image
5803 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
5812 description: Response codes found in [response codes](https://wiki.onap.org/).
5816 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5819 example: __CLOUD-OWNER__
5820 - name: cloud-region-id
5822 description: Identifier used by the vendor for the region. Second part of composite key
5825 example: __CLOUD-REGION-ID__
5828 description: Image id, expected to be unique across cloud region
5831 example: __IMAGE-ID__
5832 - name: resource-version
5834 description: resource-version for concurrency
5837 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
5840 - CloudInfrastructure
5841 summary: returns images
5842 description: returns images
5843 operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
5849 description: successful operation
5851 $ref: "#/getDefinitions/images"
5853 description: Response codes found in [response codes](https://wiki.onap.org/).
5857 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5860 example: __CLOUD-OWNER__
5861 - name: cloud-region-id
5863 description: Identifier used by the vendor for the region. Second part of composite key
5866 example: __CLOUD-REGION-ID__
5882 - name: application-vendor
5887 - name: application-version
5892 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
5895 - CloudInfrastructure
5896 summary: see node definition for valid relationships
5897 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5906 description: Response codes found in [response codes](https://wiki.onap.org/).
5910 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5913 example: __CLOUD-OWNER__
5914 - name: cloud-region-id
5916 description: Identifier used by the vendor for the region. Second part of composite key
5919 example: __CLOUD-REGION-ID__
5922 description: DVS switch name
5925 example: __SWITCH-NAME__
5928 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
5931 $ref: "#/definitions/relationship"
5934 - CloudInfrastructure
5935 summary: delete an existing relationship
5936 description: delete an existing relationship
5937 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5946 description: Response codes found in [response codes](https://wiki.onap.org/).
5950 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5953 example: __CLOUD-OWNER__
5954 - name: cloud-region-id
5956 description: Identifier used by the vendor for the region. Second part of composite key
5959 example: __CLOUD-REGION-ID__
5962 description: DVS switch name
5965 example: __SWITCH-NAME__
5966 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
5969 - CloudInfrastructure
5970 summary: returns dvs-switch
5971 description: returns dvs-switch
5972 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
5978 description: successful operation
5980 $ref: "#/getDefinitions/dvs-switch"
5982 description: Response codes found in [response codes](https://wiki.onap.org/).
5986 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5989 example: __CLOUD-OWNER__
5990 - name: cloud-region-id
5992 description: Identifier used by the vendor for the region. Second part of composite key
5995 example: __CLOUD-REGION-ID__
5998 description: DVS switch name
6001 example: __SWITCH-NAME__
6004 - CloudInfrastructure
6005 summary: create or update an existing dvs-switch
6007 Create or update an existing dvs-switch.
6009 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6010 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6019 description: Response codes found in [response codes](https://wiki.onap.org/).
6023 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6026 example: __CLOUD-OWNER__
6027 - name: cloud-region-id
6029 description: Identifier used by the vendor for the region. Second part of composite key
6032 example: __CLOUD-REGION-ID__
6035 description: DVS switch name
6038 example: __SWITCH-NAME__
6041 description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6044 $ref: "#/definitions/dvs-switch"
6047 - CloudInfrastructure
6048 summary: update an existing dvs-switch
6050 Update an existing dvs-switch
6052 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6053 The PUT operation will entirely replace an existing object.
6054 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6056 Other differences between PUT and PATCH are:
6058 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6059 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6060 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6061 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6070 description: Response codes found in [response codes](https://wiki.onap.org/).
6074 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6077 example: __CLOUD-OWNER__
6078 - name: cloud-region-id
6080 description: Identifier used by the vendor for the region. Second part of composite key
6083 example: __CLOUD-REGION-ID__
6086 description: DVS switch name
6089 example: __SWITCH-NAME__
6092 description: dvs-switch object that needs to be updated.
6095 $ref: "#/patchDefinitions/dvs-switch"
6098 - CloudInfrastructure
6099 summary: delete an existing dvs-switch
6100 description: delete an existing dvs-switch
6101 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6110 description: Response codes found in [response codes](https://wiki.onap.org/).
6114 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6117 example: __CLOUD-OWNER__
6118 - name: cloud-region-id
6120 description: Identifier used by the vendor for the region. Second part of composite key
6123 example: __CLOUD-REGION-ID__
6126 description: DVS switch name
6129 example: __SWITCH-NAME__
6130 - name: resource-version
6132 description: resource-version for concurrency
6135 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6138 - CloudInfrastructure
6139 summary: returns dvs-switches
6140 description: returns dvs-switches
6141 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6147 description: successful operation
6149 $ref: "#/getDefinitions/dvs-switches"
6151 description: Response codes found in [response codes](https://wiki.onap.org/).
6155 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6158 example: __CLOUD-OWNER__
6159 - name: cloud-region-id
6161 description: Identifier used by the vendor for the region. Second part of composite key
6164 example: __CLOUD-REGION-ID__
6175 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6178 - CloudInfrastructure
6179 summary: see node definition for valid relationships
6180 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6189 description: Response codes found in [response codes](https://wiki.onap.org/).
6193 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6196 example: __CLOUD-OWNER__
6197 - name: cloud-region-id
6199 description: Identifier used by the vendor for the region. Second part of composite key
6202 example: __CLOUD-REGION-ID__
6203 - name: network-uuid
6205 description: UUID of the network. Unique across a cloud-region
6208 example: __NETWORK-UUID__
6211 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6214 $ref: "#/definitions/relationship"
6217 - CloudInfrastructure
6218 summary: delete an existing relationship
6219 description: delete an existing relationship
6220 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6229 description: Response codes found in [response codes](https://wiki.onap.org/).
6233 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6236 example: __CLOUD-OWNER__
6237 - name: cloud-region-id
6239 description: Identifier used by the vendor for the region. Second part of composite key
6242 example: __CLOUD-REGION-ID__
6243 - name: network-uuid
6245 description: UUID of the network. Unique across a cloud-region
6248 example: __NETWORK-UUID__
6249 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6252 - CloudInfrastructure
6253 summary: returns oam-network
6254 description: returns oam-network
6255 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6261 description: successful operation
6263 $ref: "#/getDefinitions/oam-network"
6265 description: Response codes found in [response codes](https://wiki.onap.org/).
6269 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6272 example: __CLOUD-OWNER__
6273 - name: cloud-region-id
6275 description: Identifier used by the vendor for the region. Second part of composite key
6278 example: __CLOUD-REGION-ID__
6279 - name: network-uuid
6281 description: UUID of the network. Unique across a cloud-region
6284 example: __NETWORK-UUID__
6287 - CloudInfrastructure
6288 summary: create or update an existing oam-network
6290 Create or update an existing oam-network.
6292 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6293 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6302 description: Response codes found in [response codes](https://wiki.onap.org/).
6306 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6309 example: __CLOUD-OWNER__
6310 - name: cloud-region-id
6312 description: Identifier used by the vendor for the region. Second part of composite key
6315 example: __CLOUD-REGION-ID__
6316 - name: network-uuid
6318 description: UUID of the network. Unique across a cloud-region
6321 example: __NETWORK-UUID__
6324 description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6327 $ref: "#/definitions/oam-network"
6330 - CloudInfrastructure
6331 summary: update an existing oam-network
6333 Update an existing oam-network
6335 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6336 The PUT operation will entirely replace an existing object.
6337 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6339 Other differences between PUT and PATCH are:
6341 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6342 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6343 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6344 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6353 description: Response codes found in [response codes](https://wiki.onap.org/).
6357 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6360 example: __CLOUD-OWNER__
6361 - name: cloud-region-id
6363 description: Identifier used by the vendor for the region. Second part of composite key
6366 example: __CLOUD-REGION-ID__
6367 - name: network-uuid
6369 description: UUID of the network. Unique across a cloud-region
6372 example: __NETWORK-UUID__
6375 description: oam-network object that needs to be updated.
6378 $ref: "#/patchDefinitions/oam-network"
6381 - CloudInfrastructure
6382 summary: delete an existing oam-network
6383 description: delete an existing oam-network
6384 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6393 description: Response codes found in [response codes](https://wiki.onap.org/).
6397 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6400 example: __CLOUD-OWNER__
6401 - name: cloud-region-id
6403 description: Identifier used by the vendor for the region. Second part of composite key
6406 example: __CLOUD-REGION-ID__
6407 - name: network-uuid
6409 description: UUID of the network. Unique across a cloud-region
6412 example: __NETWORK-UUID__
6413 - name: resource-version
6415 description: resource-version for concurrency
6418 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
6421 - CloudInfrastructure
6422 summary: returns oam-networks
6423 description: returns oam-networks
6424 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
6430 description: successful operation
6432 $ref: "#/getDefinitions/oam-networks"
6434 description: Response codes found in [response codes](https://wiki.onap.org/).
6438 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6441 example: __CLOUD-OWNER__
6442 - name: cloud-region-id
6444 description: Identifier used by the vendor for the region. Second part of composite key
6447 example: __CLOUD-REGION-ID__
6448 - name: network-uuid
6453 - name: network-name
6464 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
6467 - CloudInfrastructure
6468 summary: see node definition for valid relationships
6469 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6478 description: Response codes found in [response codes](https://wiki.onap.org/).
6482 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6485 example: __CLOUD-OWNER__
6486 - name: cloud-region-id
6488 description: Identifier used by the vendor for the region. Second part of composite key
6491 example: __CLOUD-REGION-ID__
6492 - name: availability-zone-name
6494 description: Name of the availability zone. Unique across a cloud region
6497 example: __AVAILABILITY-ZONE-NAME__
6500 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6503 $ref: "#/definitions/relationship"
6506 - CloudInfrastructure
6507 summary: delete an existing relationship
6508 description: delete an existing relationship
6509 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6518 description: Response codes found in [response codes](https://wiki.onap.org/).
6522 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6525 example: __CLOUD-OWNER__
6526 - name: cloud-region-id
6528 description: Identifier used by the vendor for the region. Second part of composite key
6531 example: __CLOUD-REGION-ID__
6532 - name: availability-zone-name
6534 description: Name of the availability zone. Unique across a cloud region
6537 example: __AVAILABILITY-ZONE-NAME__
6538 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
6541 - CloudInfrastructure
6542 summary: returns availability-zone
6543 description: returns availability-zone
6544 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6550 description: successful operation
6552 $ref: "#/getDefinitions/availability-zone"
6554 description: Response codes found in [response codes](https://wiki.onap.org/).
6558 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6561 example: __CLOUD-OWNER__
6562 - name: cloud-region-id
6564 description: Identifier used by the vendor for the region. Second part of composite key
6567 example: __CLOUD-REGION-ID__
6568 - name: availability-zone-name
6570 description: Name of the availability zone. Unique across a cloud region
6573 example: __AVAILABILITY-ZONE-NAME__
6576 - CloudInfrastructure
6577 summary: create or update an existing availability-zone
6579 Create or update an existing availability-zone.
6581 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6582 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6591 description: Response codes found in [response codes](https://wiki.onap.org/).
6595 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6598 example: __CLOUD-OWNER__
6599 - name: cloud-region-id
6601 description: Identifier used by the vendor for the region. Second part of composite key
6604 example: __CLOUD-REGION-ID__
6605 - name: availability-zone-name
6607 description: Name of the availability zone. Unique across a cloud region
6610 example: __AVAILABILITY-ZONE-NAME__
6613 description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6616 $ref: "#/definitions/availability-zone"
6619 - CloudInfrastructure
6620 summary: update an existing availability-zone
6622 Update an existing availability-zone
6624 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6625 The PUT operation will entirely replace an existing object.
6626 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6628 Other differences between PUT and PATCH are:
6630 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6631 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6632 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6633 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6642 description: Response codes found in [response codes](https://wiki.onap.org/).
6646 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6649 example: __CLOUD-OWNER__
6650 - name: cloud-region-id
6652 description: Identifier used by the vendor for the region. Second part of composite key
6655 example: __CLOUD-REGION-ID__
6656 - name: availability-zone-name
6658 description: Name of the availability zone. Unique across a cloud region
6661 example: __AVAILABILITY-ZONE-NAME__
6664 description: availability-zone object that needs to be updated.
6667 $ref: "#/patchDefinitions/availability-zone"
6670 - CloudInfrastructure
6671 summary: delete an existing availability-zone
6672 description: delete an existing availability-zone
6673 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6682 description: Response codes found in [response codes](https://wiki.onap.org/).
6686 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6689 example: __CLOUD-OWNER__
6690 - name: cloud-region-id
6692 description: Identifier used by the vendor for the region. Second part of composite key
6695 example: __CLOUD-REGION-ID__
6696 - name: availability-zone-name
6698 description: Name of the availability zone. Unique across a cloud region
6701 example: __AVAILABILITY-ZONE-NAME__
6702 - name: resource-version
6704 description: resource-version for concurrency
6707 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
6710 - CloudInfrastructure
6711 summary: returns availability-zones
6712 description: returns availability-zones
6713 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
6719 description: successful operation
6721 $ref: "#/getDefinitions/availability-zones"
6723 description: Response codes found in [response codes](https://wiki.onap.org/).
6727 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6730 example: __CLOUD-OWNER__
6731 - name: cloud-region-id
6733 description: Identifier used by the vendor for the region. Second part of composite key
6736 example: __CLOUD-REGION-ID__
6737 - name: availability-zone-name
6742 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
6745 - CloudInfrastructure
6746 summary: see node definition for valid relationships
6747 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6756 description: Response codes found in [response codes](https://wiki.onap.org/).
6760 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6763 example: __CLOUD-OWNER__
6764 - name: cloud-region-id
6766 description: Identifier used by the vendor for the region. Second part of composite key
6769 example: __CLOUD-REGION-ID__
6772 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegion.json)
6775 $ref: "#/definitions/relationship"
6778 - CloudInfrastructure
6779 summary: delete an existing relationship
6780 description: delete an existing relationship
6781 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6790 description: Response codes found in [response codes](https://wiki.onap.org/).
6794 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6797 example: __CLOUD-OWNER__
6798 - name: cloud-region-id
6800 description: Identifier used by the vendor for the region. Second part of composite key
6803 example: __CLOUD-REGION-ID__
6804 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
6807 - CloudInfrastructure
6808 summary: returns cloud-region
6809 description: returns cloud-region
6810 operationId: getCloudInfrastructureCloudRegionsCloudRegion
6816 description: successful operation
6818 $ref: "#/getDefinitions/cloud-region"
6820 description: Response codes found in [response codes](https://wiki.onap.org/).
6824 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6827 example: __CLOUD-OWNER__
6828 - name: cloud-region-id
6830 description: Identifier used by the vendor for the region. Second part of composite key
6833 example: __CLOUD-REGION-ID__
6836 - CloudInfrastructure
6837 summary: create or update an existing cloud-region
6839 Create or update an existing cloud-region.
6841 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6842 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
6851 description: Response codes found in [response codes](https://wiki.onap.org/).
6855 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6858 example: __CLOUD-OWNER__
6859 - name: cloud-region-id
6861 description: Identifier used by the vendor for the region. Second part of composite key
6864 example: __CLOUD-REGION-ID__
6867 description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegion.json)
6870 $ref: "#/definitions/cloud-region"
6873 - CloudInfrastructure
6874 summary: update an existing cloud-region
6876 Update an existing cloud-region
6878 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6879 The PUT operation will entirely replace an existing object.
6880 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6882 Other differences between PUT and PATCH are:
6884 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6885 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6886 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6887 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
6896 description: Response codes found in [response codes](https://wiki.onap.org/).
6900 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6903 example: __CLOUD-OWNER__
6904 - name: cloud-region-id
6906 description: Identifier used by the vendor for the region. Second part of composite key
6909 example: __CLOUD-REGION-ID__
6912 description: cloud-region object that needs to be updated.
6915 $ref: "#/patchDefinitions/cloud-region"
6918 - CloudInfrastructure
6919 summary: delete an existing cloud-region
6920 description: delete an existing cloud-region
6921 operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
6930 description: Response codes found in [response codes](https://wiki.onap.org/).
6934 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6937 example: __CLOUD-OWNER__
6938 - name: cloud-region-id
6940 description: Identifier used by the vendor for the region. Second part of composite key
6943 example: __CLOUD-REGION-ID__
6944 - name: resource-version
6946 description: resource-version for concurrency
6949 /cloud-infrastructure/cloud-regions:
6952 - CloudInfrastructure
6953 summary: returns cloud-regions
6954 description: returns cloud-regions
6955 operationId: getCloudInfrastructureCloudRegions
6961 description: successful operation
6963 $ref: "#/getDefinitions/cloud-regions"
6965 description: Response codes found in [response codes](https://wiki.onap.org/).
6972 - name: cloud-region-id
6982 - name: owner-defined-type
6987 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
6990 - CloudInfrastructure
6991 summary: see node definition for valid relationships
6992 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7001 description: Response codes found in [response codes](https://wiki.onap.org/).
7003 - name: nm-profile-name
7005 description: Unique name of network profile.
7008 example: __NM-PROFILE-NAME__
7011 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7014 $ref: "#/definitions/relationship"
7017 - CloudInfrastructure
7018 summary: delete an existing relationship
7019 description: delete an existing relationship
7020 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7029 description: Response codes found in [response codes](https://wiki.onap.org/).
7031 - name: nm-profile-name
7033 description: Unique name of network profile.
7036 example: __NM-PROFILE-NAME__
7037 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7040 - CloudInfrastructure
7041 summary: returns network-profile
7042 description: returns network-profile
7043 operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7049 description: successful operation
7051 $ref: "#/getDefinitions/network-profile"
7053 description: Response codes found in [response codes](https://wiki.onap.org/).
7055 - name: nm-profile-name
7057 description: Unique name of network profile.
7060 example: __NM-PROFILE-NAME__
7063 - CloudInfrastructure
7064 summary: create or update an existing network-profile
7066 Create or update an existing network-profile.
7068 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7069 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
7078 description: Response codes found in [response codes](https://wiki.onap.org/).
7080 - name: nm-profile-name
7082 description: Unique name of network profile.
7085 example: __NM-PROFILE-NAME__
7088 description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7091 $ref: "#/definitions/network-profile"
7094 - CloudInfrastructure
7095 summary: update an existing network-profile
7097 Update an existing network-profile
7099 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7100 The PUT operation will entirely replace an existing object.
7101 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7103 Other differences between PUT and PATCH are:
7105 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7106 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7107 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7108 operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7117 description: Response codes found in [response codes](https://wiki.onap.org/).
7119 - name: nm-profile-name
7121 description: Unique name of network profile.
7124 example: __NM-PROFILE-NAME__
7127 description: network-profile object that needs to be updated.
7130 $ref: "#/patchDefinitions/network-profile"
7133 - CloudInfrastructure
7134 summary: delete an existing network-profile
7135 description: delete an existing network-profile
7136 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
7145 description: Response codes found in [response codes](https://wiki.onap.org/).
7147 - name: nm-profile-name
7149 description: Unique name of network profile.
7152 example: __NM-PROFILE-NAME__
7153 - name: resource-version
7155 description: resource-version for concurrency
7158 /cloud-infrastructure/network-profiles:
7161 - CloudInfrastructure
7162 summary: returns network-profiles
7163 description: returns network-profiles
7164 operationId: getCloudInfrastructureNetworkProfiles
7170 description: successful operation
7172 $ref: "#/getDefinitions/network-profiles"
7174 description: Response codes found in [response codes](https://wiki.onap.org/).
7176 - name: nm-profile-name
7181 /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
7184 - CloudInfrastructure
7185 summary: see node definition for valid relationships
7186 operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
7195 description: Response codes found in [response codes](https://wiki.onap.org/).
7199 description: Value from executing hostname on the compute node.
7202 example: __HOSTNAME__
7205 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)
7208 $ref: "#/definitions/relationship"
7211 - CloudInfrastructure
7212 summary: delete an existing relationship
7213 description: delete an existing relationship
7214 operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
7223 description: Response codes found in [response codes](https://wiki.onap.org/).
7227 description: Value from executing hostname on the compute node.
7230 example: __HOSTNAME__
7231 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
7234 - CloudInfrastructure
7235 summary: see node definition for valid relationships
7236 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7245 description: Response codes found in [response codes](https://wiki.onap.org/).
7249 description: Value from executing hostname on the compute node.
7252 example: __HOSTNAME__
7253 - name: interface-name
7255 description: Name that identifies the physical interface
7258 example: __INTERFACE-NAME__
7261 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
7264 $ref: "#/definitions/relationship"
7267 - CloudInfrastructure
7268 summary: delete an existing relationship
7269 description: delete an existing relationship
7270 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7279 description: Response codes found in [response codes](https://wiki.onap.org/).
7283 description: Value from executing hostname on the compute node.
7286 example: __HOSTNAME__
7287 - name: interface-name
7289 description: Name that identifies the physical interface
7292 example: __INTERFACE-NAME__
7293 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
7296 - CloudInfrastructure
7297 summary: see node definition for valid relationships
7298 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7307 description: Response codes found in [response codes](https://wiki.onap.org/).
7311 description: Value from executing hostname on the compute node.
7314 example: __HOSTNAME__
7315 - name: interface-name
7317 description: Name that identifies the physical interface
7320 example: __INTERFACE-NAME__
7321 - name: interface-name
7323 description: Name given to the interface
7326 example: __INTERFACE-NAME__
7327 - name: vlan-interface
7329 description: String that identifies the interface
7332 example: __VLAN-INTERFACE__
7335 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
7338 $ref: "#/definitions/relationship"
7341 - CloudInfrastructure
7342 summary: delete an existing relationship
7343 description: delete an existing relationship
7344 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7353 description: Response codes found in [response codes](https://wiki.onap.org/).
7357 description: Value from executing hostname on the compute node.
7360 example: __HOSTNAME__
7361 - name: interface-name
7363 description: Name that identifies the physical interface
7366 example: __INTERFACE-NAME__
7367 - name: interface-name
7369 description: Name given to the interface
7372 example: __INTERFACE-NAME__
7373 - name: vlan-interface
7375 description: String that identifies the interface
7378 example: __VLAN-INTERFACE__
7379 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
7382 - CloudInfrastructure
7383 summary: see node definition for valid relationships
7384 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7393 description: Response codes found in [response codes](https://wiki.onap.org/).
7397 description: Value from executing hostname on the compute node.
7400 example: __HOSTNAME__
7401 - name: interface-name
7403 description: Name that identifies the physical interface
7406 example: __INTERFACE-NAME__
7407 - name: interface-name
7409 description: Name given to the interface
7412 example: __INTERFACE-NAME__
7413 - name: vlan-interface
7415 description: String that identifies the interface
7418 example: __VLAN-INTERFACE__
7419 - name: l3-interface-ipv4-address
7421 description: IP address
7424 example: __L3-INTERFACE-IPV4-ADDRESS__
7427 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7430 $ref: "#/definitions/relationship"
7433 - CloudInfrastructure
7434 summary: delete an existing relationship
7435 description: delete an existing relationship
7436 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7445 description: Response codes found in [response codes](https://wiki.onap.org/).
7449 description: Value from executing hostname on the compute node.
7452 example: __HOSTNAME__
7453 - name: interface-name
7455 description: Name that identifies the physical interface
7458 example: __INTERFACE-NAME__
7459 - name: interface-name
7461 description: Name given to the interface
7464 example: __INTERFACE-NAME__
7465 - name: vlan-interface
7467 description: String that identifies the interface
7470 example: __VLAN-INTERFACE__
7471 - name: l3-interface-ipv4-address
7473 description: IP address
7476 example: __L3-INTERFACE-IPV4-ADDRESS__
7477 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
7480 - CloudInfrastructure
7481 summary: returns l3-interface-ipv4-address-list
7482 description: returns l3-interface-ipv4-address-list
7483 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7489 description: successful operation
7491 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
7493 description: Response codes found in [response codes](https://wiki.onap.org/).
7497 description: Value from executing hostname on the compute node.
7500 example: __HOSTNAME__
7501 - name: interface-name
7503 description: Name that identifies the physical interface
7506 example: __INTERFACE-NAME__
7507 - name: interface-name
7509 description: Name given to the interface
7512 example: __INTERFACE-NAME__
7513 - name: vlan-interface
7515 description: String that identifies the interface
7518 example: __VLAN-INTERFACE__
7519 - name: l3-interface-ipv4-address
7521 description: IP address
7524 example: __L3-INTERFACE-IPV4-ADDRESS__
7527 - CloudInfrastructure
7528 summary: create or update an existing l3-interface-ipv4-address-list
7530 Create or update an existing l3-interface-ipv4-address-list.
7532 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7533 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7542 description: Response codes found in [response codes](https://wiki.onap.org/).
7546 description: Value from executing hostname on the compute node.
7549 example: __HOSTNAME__
7550 - name: interface-name
7552 description: Name that identifies the physical interface
7555 example: __INTERFACE-NAME__
7556 - name: interface-name
7558 description: Name given to the interface
7561 example: __INTERFACE-NAME__
7562 - name: vlan-interface
7564 description: String that identifies the interface
7567 example: __VLAN-INTERFACE__
7568 - name: l3-interface-ipv4-address
7570 description: IP address
7573 example: __L3-INTERFACE-IPV4-ADDRESS__
7576 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7579 $ref: "#/definitions/l3-interface-ipv4-address-list"
7582 - CloudInfrastructure
7583 summary: update an existing l3-interface-ipv4-address-list
7585 Update an existing l3-interface-ipv4-address-list
7587 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7588 The PUT operation will entirely replace an existing object.
7589 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7591 Other differences between PUT and PATCH are:
7593 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7594 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7595 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7596 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7605 description: Response codes found in [response codes](https://wiki.onap.org/).
7609 description: Value from executing hostname on the compute node.
7612 example: __HOSTNAME__
7613 - name: interface-name
7615 description: Name that identifies the physical interface
7618 example: __INTERFACE-NAME__
7619 - name: interface-name
7621 description: Name given to the interface
7624 example: __INTERFACE-NAME__
7625 - name: vlan-interface
7627 description: String that identifies the interface
7630 example: __VLAN-INTERFACE__
7631 - name: l3-interface-ipv4-address
7633 description: IP address
7636 example: __L3-INTERFACE-IPV4-ADDRESS__
7639 description: l3-interface-ipv4-address-list object that needs to be updated.
7642 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
7645 - CloudInfrastructure
7646 summary: delete an existing l3-interface-ipv4-address-list
7647 description: delete an existing l3-interface-ipv4-address-list
7648 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7657 description: Response codes found in [response codes](https://wiki.onap.org/).
7661 description: Value from executing hostname on the compute node.
7664 example: __HOSTNAME__
7665 - name: interface-name
7667 description: Name that identifies the physical interface
7670 example: __INTERFACE-NAME__
7671 - name: interface-name
7673 description: Name given to the interface
7676 example: __INTERFACE-NAME__
7677 - name: vlan-interface
7679 description: String that identifies the interface
7682 example: __VLAN-INTERFACE__
7683 - name: l3-interface-ipv4-address
7685 description: IP address
7688 example: __L3-INTERFACE-IPV4-ADDRESS__
7689 - name: resource-version
7691 description: resource-version for concurrency
7694 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
7697 - CloudInfrastructure
7698 summary: see node definition for valid relationships
7699 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7708 description: Response codes found in [response codes](https://wiki.onap.org/).
7712 description: Value from executing hostname on the compute node.
7715 example: __HOSTNAME__
7716 - name: interface-name
7718 description: Name that identifies the physical interface
7721 example: __INTERFACE-NAME__
7722 - name: interface-name
7724 description: Name given to the interface
7727 example: __INTERFACE-NAME__
7728 - name: vlan-interface
7730 description: String that identifies the interface
7733 example: __VLAN-INTERFACE__
7734 - name: l3-interface-ipv6-address
7736 description: IP address
7739 example: __L3-INTERFACE-IPV6-ADDRESS__
7742 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7745 $ref: "#/definitions/relationship"
7748 - CloudInfrastructure
7749 summary: delete an existing relationship
7750 description: delete an existing relationship
7751 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7760 description: Response codes found in [response codes](https://wiki.onap.org/).
7764 description: Value from executing hostname on the compute node.
7767 example: __HOSTNAME__
7768 - name: interface-name
7770 description: Name that identifies the physical interface
7773 example: __INTERFACE-NAME__
7774 - name: interface-name
7776 description: Name given to the interface
7779 example: __INTERFACE-NAME__
7780 - name: vlan-interface
7782 description: String that identifies the interface
7785 example: __VLAN-INTERFACE__
7786 - name: l3-interface-ipv6-address
7788 description: IP address
7791 example: __L3-INTERFACE-IPV6-ADDRESS__
7792 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
7795 - CloudInfrastructure
7796 summary: returns l3-interface-ipv6-address-list
7797 description: returns l3-interface-ipv6-address-list
7798 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7804 description: successful operation
7806 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
7808 description: Response codes found in [response codes](https://wiki.onap.org/).
7812 description: Value from executing hostname on the compute node.
7815 example: __HOSTNAME__
7816 - name: interface-name
7818 description: Name that identifies the physical interface
7821 example: __INTERFACE-NAME__
7822 - name: interface-name
7824 description: Name given to the interface
7827 example: __INTERFACE-NAME__
7828 - name: vlan-interface
7830 description: String that identifies the interface
7833 example: __VLAN-INTERFACE__
7834 - name: l3-interface-ipv6-address
7836 description: IP address
7839 example: __L3-INTERFACE-IPV6-ADDRESS__
7842 - CloudInfrastructure
7843 summary: create or update an existing l3-interface-ipv6-address-list
7845 Create or update an existing l3-interface-ipv6-address-list.
7847 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7848 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7857 description: Response codes found in [response codes](https://wiki.onap.org/).
7861 description: Value from executing hostname on the compute node.
7864 example: __HOSTNAME__
7865 - name: interface-name
7867 description: Name that identifies the physical interface
7870 example: __INTERFACE-NAME__
7871 - name: interface-name
7873 description: Name given to the interface
7876 example: __INTERFACE-NAME__
7877 - name: vlan-interface
7879 description: String that identifies the interface
7882 example: __VLAN-INTERFACE__
7883 - name: l3-interface-ipv6-address
7885 description: IP address
7888 example: __L3-INTERFACE-IPV6-ADDRESS__
7891 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7894 $ref: "#/definitions/l3-interface-ipv6-address-list"
7897 - CloudInfrastructure
7898 summary: update an existing l3-interface-ipv6-address-list
7900 Update an existing l3-interface-ipv6-address-list
7902 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7903 The PUT operation will entirely replace an existing object.
7904 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7906 Other differences between PUT and PATCH are:
7908 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7909 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7910 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7911 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7920 description: Response codes found in [response codes](https://wiki.onap.org/).
7924 description: Value from executing hostname on the compute node.
7927 example: __HOSTNAME__
7928 - name: interface-name
7930 description: Name that identifies the physical interface
7933 example: __INTERFACE-NAME__
7934 - name: interface-name
7936 description: Name given to the interface
7939 example: __INTERFACE-NAME__
7940 - name: vlan-interface
7942 description: String that identifies the interface
7945 example: __VLAN-INTERFACE__
7946 - name: l3-interface-ipv6-address
7948 description: IP address
7951 example: __L3-INTERFACE-IPV6-ADDRESS__
7954 description: l3-interface-ipv6-address-list object that needs to be updated.
7957 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
7960 - CloudInfrastructure
7961 summary: delete an existing l3-interface-ipv6-address-list
7962 description: delete an existing l3-interface-ipv6-address-list
7963 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7972 description: Response codes found in [response codes](https://wiki.onap.org/).
7976 description: Value from executing hostname on the compute node.
7979 example: __HOSTNAME__
7980 - name: interface-name
7982 description: Name that identifies the physical interface
7985 example: __INTERFACE-NAME__
7986 - name: interface-name
7988 description: Name given to the interface
7991 example: __INTERFACE-NAME__
7992 - name: vlan-interface
7994 description: String that identifies the interface
7997 example: __VLAN-INTERFACE__
7998 - name: l3-interface-ipv6-address
8000 description: IP address
8003 example: __L3-INTERFACE-IPV6-ADDRESS__
8004 - name: resource-version
8006 description: resource-version for concurrency
8009 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8012 - CloudInfrastructure
8013 summary: returns vlan
8014 description: returns vlan
8015 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8021 description: successful operation
8023 $ref: "#/getDefinitions/vlan"
8025 description: Response codes found in [response codes](https://wiki.onap.org/).
8029 description: Value from executing hostname on the compute node.
8032 example: __HOSTNAME__
8033 - name: interface-name
8035 description: Name that identifies the physical interface
8038 example: __INTERFACE-NAME__
8039 - name: interface-name
8041 description: Name given to the interface
8044 example: __INTERFACE-NAME__
8045 - name: vlan-interface
8047 description: String that identifies the interface
8050 example: __VLAN-INTERFACE__
8053 - CloudInfrastructure
8054 summary: create or update an existing vlan
8056 Create or update an existing vlan.
8058 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8059 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8068 description: Response codes found in [response codes](https://wiki.onap.org/).
8072 description: Value from executing hostname on the compute node.
8075 example: __HOSTNAME__
8076 - name: interface-name
8078 description: Name that identifies the physical interface
8081 example: __INTERFACE-NAME__
8082 - name: interface-name
8084 description: Name given to the interface
8087 example: __INTERFACE-NAME__
8088 - name: vlan-interface
8090 description: String that identifies the interface
8093 example: __VLAN-INTERFACE__
8096 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8099 $ref: "#/definitions/vlan"
8102 - CloudInfrastructure
8103 summary: update an existing vlan
8105 Update an existing vlan
8107 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8108 The PUT operation will entirely replace an existing object.
8109 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8111 Other differences between PUT and PATCH are:
8113 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8114 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8115 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8116 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8125 description: Response codes found in [response codes](https://wiki.onap.org/).
8129 description: Value from executing hostname on the compute node.
8132 example: __HOSTNAME__
8133 - name: interface-name
8135 description: Name that identifies the physical interface
8138 example: __INTERFACE-NAME__
8139 - name: interface-name
8141 description: Name given to the interface
8144 example: __INTERFACE-NAME__
8145 - name: vlan-interface
8147 description: String that identifies the interface
8150 example: __VLAN-INTERFACE__
8153 description: vlan object that needs to be updated.
8156 $ref: "#/patchDefinitions/vlan"
8159 - CloudInfrastructure
8160 summary: delete an existing vlan
8161 description: delete an existing vlan
8162 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8171 description: Response codes found in [response codes](https://wiki.onap.org/).
8175 description: Value from executing hostname on the compute node.
8178 example: __HOSTNAME__
8179 - name: interface-name
8181 description: Name that identifies the physical interface
8184 example: __INTERFACE-NAME__
8185 - name: interface-name
8187 description: Name given to the interface
8190 example: __INTERFACE-NAME__
8191 - name: vlan-interface
8193 description: String that identifies the interface
8196 example: __VLAN-INTERFACE__
8197 - name: resource-version
8199 description: resource-version for concurrency
8202 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
8205 - CloudInfrastructure
8206 summary: returns vlans
8207 description: returns vlans
8208 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
8214 description: successful operation
8216 $ref: "#/getDefinitions/vlans"
8218 description: Response codes found in [response codes](https://wiki.onap.org/).
8222 description: Value from executing hostname on the compute node.
8225 example: __HOSTNAME__
8226 - name: interface-name
8228 description: Name that identifies the physical interface
8231 example: __INTERFACE-NAME__
8232 - name: interface-name
8234 description: Name given to the interface
8237 example: __INTERFACE-NAME__
8238 - name: vlan-interface
8243 - name: vlan-id-inner
8254 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
8257 - CloudInfrastructure
8258 summary: see node definition for valid relationships
8259 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8268 description: Response codes found in [response codes](https://wiki.onap.org/).
8272 description: Value from executing hostname on the compute node.
8275 example: __HOSTNAME__
8276 - name: interface-name
8278 description: Name that identifies the physical interface
8281 example: __INTERFACE-NAME__
8282 - name: interface-name
8284 description: Name given to the interface
8287 example: __INTERFACE-NAME__
8290 description: PCI ID used to identify the sriov-vf
8296 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8299 $ref: "#/definitions/relationship"
8302 - CloudInfrastructure
8303 summary: delete an existing relationship
8304 description: delete an existing relationship
8305 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8314 description: Response codes found in [response codes](https://wiki.onap.org/).
8318 description: Value from executing hostname on the compute node.
8321 example: __HOSTNAME__
8322 - name: interface-name
8324 description: Name that identifies the physical interface
8327 example: __INTERFACE-NAME__
8328 - name: interface-name
8330 description: Name given to the interface
8333 example: __INTERFACE-NAME__
8336 description: PCI ID used to identify the sriov-vf
8340 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
8343 - CloudInfrastructure
8344 summary: returns sriov-vf
8345 description: returns sriov-vf
8346 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8352 description: successful operation
8354 $ref: "#/getDefinitions/sriov-vf"
8356 description: Response codes found in [response codes](https://wiki.onap.org/).
8360 description: Value from executing hostname on the compute node.
8363 example: __HOSTNAME__
8364 - name: interface-name
8366 description: Name that identifies the physical interface
8369 example: __INTERFACE-NAME__
8370 - name: interface-name
8372 description: Name given to the interface
8375 example: __INTERFACE-NAME__
8378 description: PCI ID used to identify the sriov-vf
8384 - CloudInfrastructure
8385 summary: create or update an existing sriov-vf
8387 Create or update an existing sriov-vf.
8389 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8390 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8399 description: Response codes found in [response codes](https://wiki.onap.org/).
8403 description: Value from executing hostname on the compute node.
8406 example: __HOSTNAME__
8407 - name: interface-name
8409 description: Name that identifies the physical interface
8412 example: __INTERFACE-NAME__
8413 - name: interface-name
8415 description: Name given to the interface
8418 example: __INTERFACE-NAME__
8421 description: PCI ID used to identify the sriov-vf
8427 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8430 $ref: "#/definitions/sriov-vf"
8433 - CloudInfrastructure
8434 summary: update an existing sriov-vf
8436 Update an existing sriov-vf
8438 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8439 The PUT operation will entirely replace an existing object.
8440 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8442 Other differences between PUT and PATCH are:
8444 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8445 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8446 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8447 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8456 description: Response codes found in [response codes](https://wiki.onap.org/).
8460 description: Value from executing hostname on the compute node.
8463 example: __HOSTNAME__
8464 - name: interface-name
8466 description: Name that identifies the physical interface
8469 example: __INTERFACE-NAME__
8470 - name: interface-name
8472 description: Name given to the interface
8475 example: __INTERFACE-NAME__
8478 description: PCI ID used to identify the sriov-vf
8484 description: sriov-vf object that needs to be updated.
8487 $ref: "#/patchDefinitions/sriov-vf"
8490 - CloudInfrastructure
8491 summary: delete an existing sriov-vf
8492 description: delete an existing sriov-vf
8493 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8502 description: Response codes found in [response codes](https://wiki.onap.org/).
8506 description: Value from executing hostname on the compute node.
8509 example: __HOSTNAME__
8510 - name: interface-name
8512 description: Name that identifies the physical interface
8515 example: __INTERFACE-NAME__
8516 - name: interface-name
8518 description: Name given to the interface
8521 example: __INTERFACE-NAME__
8524 description: PCI ID used to identify the sriov-vf
8528 - name: resource-version
8530 description: resource-version for concurrency
8533 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
8536 - CloudInfrastructure
8537 summary: returns sriov-vfs
8538 description: returns sriov-vfs
8539 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
8545 description: successful operation
8547 $ref: "#/getDefinitions/sriov-vfs"
8549 description: Response codes found in [response codes](https://wiki.onap.org/).
8553 description: Value from executing hostname on the compute node.
8556 example: __HOSTNAME__
8557 - name: interface-name
8559 description: Name that identifies the physical interface
8562 example: __INTERFACE-NAME__
8563 - name: interface-name
8565 description: Name given to the interface
8568 example: __INTERFACE-NAME__
8574 - name: vf-vlan-filter
8579 - name: vf-mac-filter
8584 - name: vf-vlan-strip
8589 - name: neutron-network-id
8594 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
8597 - CloudInfrastructure
8598 summary: see node definition for valid relationships
8599 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8608 description: Response codes found in [response codes](https://wiki.onap.org/).
8612 description: Value from executing hostname on the compute node.
8615 example: __HOSTNAME__
8616 - name: interface-name
8618 description: Name that identifies the physical interface
8621 example: __INTERFACE-NAME__
8622 - name: interface-name
8624 description: Name given to the interface
8627 example: __INTERFACE-NAME__
8630 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
8633 $ref: "#/definitions/relationship"
8636 - CloudInfrastructure
8637 summary: delete an existing relationship
8638 description: delete an existing relationship
8639 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8648 description: Response codes found in [response codes](https://wiki.onap.org/).
8652 description: Value from executing hostname on the compute node.
8655 example: __HOSTNAME__
8656 - name: interface-name
8658 description: Name that identifies the physical interface
8661 example: __INTERFACE-NAME__
8662 - name: interface-name
8664 description: Name given to the interface
8667 example: __INTERFACE-NAME__
8668 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
8671 - CloudInfrastructure
8672 summary: see node definition for valid relationships
8673 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8682 description: Response codes found in [response codes](https://wiki.onap.org/).
8686 description: Value from executing hostname on the compute node.
8689 example: __HOSTNAME__
8690 - name: interface-name
8692 description: Name that identifies the physical interface
8695 example: __INTERFACE-NAME__
8696 - name: interface-name
8698 description: Name given to the interface
8701 example: __INTERFACE-NAME__
8702 - name: l3-interface-ipv4-address
8704 description: IP address
8707 example: __L3-INTERFACE-IPV4-ADDRESS__
8710 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8713 $ref: "#/definitions/relationship"
8716 - CloudInfrastructure
8717 summary: delete an existing relationship
8718 description: delete an existing relationship
8719 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8728 description: Response codes found in [response codes](https://wiki.onap.org/).
8732 description: Value from executing hostname on the compute node.
8735 example: __HOSTNAME__
8736 - name: interface-name
8738 description: Name that identifies the physical interface
8741 example: __INTERFACE-NAME__
8742 - name: interface-name
8744 description: Name given to the interface
8747 example: __INTERFACE-NAME__
8748 - name: l3-interface-ipv4-address
8750 description: IP address
8753 example: __L3-INTERFACE-IPV4-ADDRESS__
8754 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
8757 - CloudInfrastructure
8758 summary: returns l3-interface-ipv4-address-list
8759 description: returns l3-interface-ipv4-address-list
8760 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8766 description: successful operation
8768 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8770 description: Response codes found in [response codes](https://wiki.onap.org/).
8774 description: Value from executing hostname on the compute node.
8777 example: __HOSTNAME__
8778 - name: interface-name
8780 description: Name that identifies the physical interface
8783 example: __INTERFACE-NAME__
8784 - name: interface-name
8786 description: Name given to the interface
8789 example: __INTERFACE-NAME__
8790 - name: l3-interface-ipv4-address
8792 description: IP address
8795 example: __L3-INTERFACE-IPV4-ADDRESS__
8798 - CloudInfrastructure
8799 summary: create or update an existing l3-interface-ipv4-address-list
8801 Create or update an existing l3-interface-ipv4-address-list.
8803 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8804 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8813 description: Response codes found in [response codes](https://wiki.onap.org/).
8817 description: Value from executing hostname on the compute node.
8820 example: __HOSTNAME__
8821 - name: interface-name
8823 description: Name that identifies the physical interface
8826 example: __INTERFACE-NAME__
8827 - name: interface-name
8829 description: Name given to the interface
8832 example: __INTERFACE-NAME__
8833 - name: l3-interface-ipv4-address
8835 description: IP address
8838 example: __L3-INTERFACE-IPV4-ADDRESS__
8841 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8844 $ref: "#/definitions/l3-interface-ipv4-address-list"
8847 - CloudInfrastructure
8848 summary: update an existing l3-interface-ipv4-address-list
8850 Update an existing l3-interface-ipv4-address-list
8852 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8853 The PUT operation will entirely replace an existing object.
8854 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8856 Other differences between PUT and PATCH are:
8858 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8859 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8860 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8861 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8870 description: Response codes found in [response codes](https://wiki.onap.org/).
8874 description: Value from executing hostname on the compute node.
8877 example: __HOSTNAME__
8878 - name: interface-name
8880 description: Name that identifies the physical interface
8883 example: __INTERFACE-NAME__
8884 - name: interface-name
8886 description: Name given to the interface
8889 example: __INTERFACE-NAME__
8890 - name: l3-interface-ipv4-address
8892 description: IP address
8895 example: __L3-INTERFACE-IPV4-ADDRESS__
8898 description: l3-interface-ipv4-address-list object that needs to be updated.
8901 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8904 - CloudInfrastructure
8905 summary: delete an existing l3-interface-ipv4-address-list
8906 description: delete an existing l3-interface-ipv4-address-list
8907 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8916 description: Response codes found in [response codes](https://wiki.onap.org/).
8920 description: Value from executing hostname on the compute node.
8923 example: __HOSTNAME__
8924 - name: interface-name
8926 description: Name that identifies the physical interface
8929 example: __INTERFACE-NAME__
8930 - name: interface-name
8932 description: Name given to the interface
8935 example: __INTERFACE-NAME__
8936 - name: l3-interface-ipv4-address
8938 description: IP address
8941 example: __L3-INTERFACE-IPV4-ADDRESS__
8942 - name: resource-version
8944 description: resource-version for concurrency
8947 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
8950 - CloudInfrastructure
8951 summary: see node definition for valid relationships
8952 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
8961 description: Response codes found in [response codes](https://wiki.onap.org/).
8965 description: Value from executing hostname on the compute node.
8968 example: __HOSTNAME__
8969 - name: interface-name
8971 description: Name that identifies the physical interface
8974 example: __INTERFACE-NAME__
8975 - name: interface-name
8977 description: Name given to the interface
8980 example: __INTERFACE-NAME__
8981 - name: l3-interface-ipv6-address
8983 description: IP address
8986 example: __L3-INTERFACE-IPV6-ADDRESS__
8989 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
8992 $ref: "#/definitions/relationship"
8995 - CloudInfrastructure
8996 summary: delete an existing relationship
8997 description: delete an existing relationship
8998 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
9007 description: Response codes found in [response codes](https://wiki.onap.org/).
9011 description: Value from executing hostname on the compute node.
9014 example: __HOSTNAME__
9015 - name: interface-name
9017 description: Name that identifies the physical interface
9020 example: __INTERFACE-NAME__
9021 - name: interface-name
9023 description: Name given to the interface
9026 example: __INTERFACE-NAME__
9027 - name: l3-interface-ipv6-address
9029 description: IP address
9032 example: __L3-INTERFACE-IPV6-ADDRESS__
9033 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
9036 - CloudInfrastructure
9037 summary: returns l3-interface-ipv6-address-list
9038 description: returns l3-interface-ipv6-address-list
9039 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9045 description: successful operation
9047 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9049 description: Response codes found in [response codes](https://wiki.onap.org/).
9053 description: Value from executing hostname on the compute node.
9056 example: __HOSTNAME__
9057 - name: interface-name
9059 description: Name that identifies the physical interface
9062 example: __INTERFACE-NAME__
9063 - name: interface-name
9065 description: Name given to the interface
9068 example: __INTERFACE-NAME__
9069 - name: l3-interface-ipv6-address
9071 description: IP address
9074 example: __L3-INTERFACE-IPV6-ADDRESS__
9077 - CloudInfrastructure
9078 summary: create or update an existing l3-interface-ipv6-address-list
9080 Create or update an existing l3-interface-ipv6-address-list.
9082 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9083 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9092 description: Response codes found in [response codes](https://wiki.onap.org/).
9096 description: Value from executing hostname on the compute node.
9099 example: __HOSTNAME__
9100 - name: interface-name
9102 description: Name that identifies the physical interface
9105 example: __INTERFACE-NAME__
9106 - name: interface-name
9108 description: Name given to the interface
9111 example: __INTERFACE-NAME__
9112 - name: l3-interface-ipv6-address
9114 description: IP address
9117 example: __L3-INTERFACE-IPV6-ADDRESS__
9120 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
9123 $ref: "#/definitions/l3-interface-ipv6-address-list"
9126 - CloudInfrastructure
9127 summary: update an existing l3-interface-ipv6-address-list
9129 Update an existing l3-interface-ipv6-address-list
9131 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9132 The PUT operation will entirely replace an existing object.
9133 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9135 Other differences between PUT and PATCH are:
9137 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9138 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9139 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9140 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9149 description: Response codes found in [response codes](https://wiki.onap.org/).
9153 description: Value from executing hostname on the compute node.
9156 example: __HOSTNAME__
9157 - name: interface-name
9159 description: Name that identifies the physical interface
9162 example: __INTERFACE-NAME__
9163 - name: interface-name
9165 description: Name given to the interface
9168 example: __INTERFACE-NAME__
9169 - name: l3-interface-ipv6-address
9171 description: IP address
9174 example: __L3-INTERFACE-IPV6-ADDRESS__
9177 description: l3-interface-ipv6-address-list object that needs to be updated.
9180 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9183 - CloudInfrastructure
9184 summary: delete an existing l3-interface-ipv6-address-list
9185 description: delete an existing l3-interface-ipv6-address-list
9186 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9195 description: Response codes found in [response codes](https://wiki.onap.org/).
9199 description: Value from executing hostname on the compute node.
9202 example: __HOSTNAME__
9203 - name: interface-name
9205 description: Name that identifies the physical interface
9208 example: __INTERFACE-NAME__
9209 - name: interface-name
9211 description: Name given to the interface
9214 example: __INTERFACE-NAME__
9215 - name: l3-interface-ipv6-address
9217 description: IP address
9220 example: __L3-INTERFACE-IPV6-ADDRESS__
9221 - name: resource-version
9223 description: resource-version for concurrency
9226 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
9229 - CloudInfrastructure
9230 summary: returns l-interface
9231 description: returns l-interface
9232 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9238 description: successful operation
9240 $ref: "#/getDefinitions/l-interface"
9242 description: Response codes found in [response codes](https://wiki.onap.org/).
9246 description: Value from executing hostname on the compute node.
9249 example: __HOSTNAME__
9250 - name: interface-name
9252 description: Name that identifies the physical interface
9255 example: __INTERFACE-NAME__
9256 - name: interface-name
9258 description: Name given to the interface
9261 example: __INTERFACE-NAME__
9264 - CloudInfrastructure
9265 summary: create or update an existing l-interface
9267 Create or update an existing l-interface.
9269 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9270 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9279 description: Response codes found in [response codes](https://wiki.onap.org/).
9283 description: Value from executing hostname on the compute node.
9286 example: __HOSTNAME__
9287 - name: interface-name
9289 description: Name that identifies the physical interface
9292 example: __INTERFACE-NAME__
9293 - name: interface-name
9295 description: Name given to the interface
9298 example: __INTERFACE-NAME__
9301 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9304 $ref: "#/definitions/l-interface"
9307 - CloudInfrastructure
9308 summary: update an existing l-interface
9310 Update an existing l-interface
9312 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9313 The PUT operation will entirely replace an existing object.
9314 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9316 Other differences between PUT and PATCH are:
9318 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9319 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9320 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9321 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9330 description: Response codes found in [response codes](https://wiki.onap.org/).
9334 description: Value from executing hostname on the compute node.
9337 example: __HOSTNAME__
9338 - name: interface-name
9340 description: Name that identifies the physical interface
9343 example: __INTERFACE-NAME__
9344 - name: interface-name
9346 description: Name given to the interface
9349 example: __INTERFACE-NAME__
9352 description: l-interface object that needs to be updated.
9355 $ref: "#/patchDefinitions/l-interface"
9358 - CloudInfrastructure
9359 summary: delete an existing l-interface
9360 description: delete an existing l-interface
9361 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9370 description: Response codes found in [response codes](https://wiki.onap.org/).
9374 description: Value from executing hostname on the compute node.
9377 example: __HOSTNAME__
9378 - name: interface-name
9380 description: Name that identifies the physical interface
9383 example: __INTERFACE-NAME__
9384 - name: interface-name
9386 description: Name given to the interface
9389 example: __INTERFACE-NAME__
9390 - name: resource-version
9392 description: resource-version for concurrency
9395 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
9398 - CloudInfrastructure
9399 summary: returns l-interfaces
9400 description: returns l-interfaces
9401 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
9407 description: successful operation
9409 $ref: "#/getDefinitions/l-interfaces"
9411 description: Response codes found in [response codes](https://wiki.onap.org/).
9415 description: Value from executing hostname on the compute node.
9418 example: __HOSTNAME__
9419 - name: interface-name
9421 description: Name that identifies the physical interface
9424 example: __INTERFACE-NAME__
9425 - name: interface-name
9430 - name: interface-id
9440 - name: network-name
9445 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
9448 - CloudInfrastructure
9449 summary: returns p-interface
9450 description: returns p-interface
9451 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
9457 description: successful operation
9459 $ref: "#/getDefinitions/p-interface"
9461 description: Response codes found in [response codes](https://wiki.onap.org/).
9465 description: Value from executing hostname on the compute node.
9468 example: __HOSTNAME__
9469 - name: interface-name
9471 description: Name that identifies the physical interface
9474 example: __INTERFACE-NAME__
9477 - CloudInfrastructure
9478 summary: create or update an existing p-interface
9480 Create or update an existing p-interface.
9482 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9483 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9492 description: Response codes found in [response codes](https://wiki.onap.org/).
9496 description: Value from executing hostname on the compute node.
9499 example: __HOSTNAME__
9500 - name: interface-name
9502 description: Name that identifies the physical interface
9505 example: __INTERFACE-NAME__
9508 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9511 $ref: "#/definitions/p-interface"
9514 - CloudInfrastructure
9515 summary: update an existing p-interface
9517 Update an existing p-interface
9519 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9520 The PUT operation will entirely replace an existing object.
9521 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9523 Other differences between PUT and PATCH are:
9525 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9526 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9527 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9528 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9537 description: Response codes found in [response codes](https://wiki.onap.org/).
9541 description: Value from executing hostname on the compute node.
9544 example: __HOSTNAME__
9545 - name: interface-name
9547 description: Name that identifies the physical interface
9550 example: __INTERFACE-NAME__
9553 description: p-interface object that needs to be updated.
9556 $ref: "#/patchDefinitions/p-interface"
9559 - CloudInfrastructure
9560 summary: delete an existing p-interface
9561 description: delete an existing p-interface
9562 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
9571 description: Response codes found in [response codes](https://wiki.onap.org/).
9575 description: Value from executing hostname on the compute node.
9578 example: __HOSTNAME__
9579 - name: interface-name
9581 description: Name that identifies the physical interface
9584 example: __INTERFACE-NAME__
9585 - name: resource-version
9587 description: resource-version for concurrency
9590 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
9593 - CloudInfrastructure
9594 summary: returns p-interfaces
9595 description: returns p-interfaces
9596 operationId: getCloudInfrastructurePserversPserverPInterfaces
9602 description: successful operation
9604 $ref: "#/getDefinitions/p-interfaces"
9606 description: Response codes found in [response codes](https://wiki.onap.org/).
9610 description: Value from executing hostname on the compute node.
9613 example: __HOSTNAME__
9614 - name: interface-name
9619 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
9622 - CloudInfrastructure
9623 summary: see node definition for valid relationships
9624 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9633 description: Response codes found in [response codes](https://wiki.onap.org/).
9637 description: Value from executing hostname on the compute node.
9640 example: __HOSTNAME__
9641 - name: interface-name
9643 description: Name that identifies the link aggregate interface
9646 example: __INTERFACE-NAME__
9649 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
9652 $ref: "#/definitions/relationship"
9655 - CloudInfrastructure
9656 summary: delete an existing relationship
9657 description: delete an existing relationship
9658 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9667 description: Response codes found in [response codes](https://wiki.onap.org/).
9671 description: Value from executing hostname on the compute node.
9674 example: __HOSTNAME__
9675 - name: interface-name
9677 description: Name that identifies the link aggregate interface
9680 example: __INTERFACE-NAME__
9681 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9684 - CloudInfrastructure
9685 summary: see node definition for valid relationships
9686 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9695 description: Response codes found in [response codes](https://wiki.onap.org/).
9699 description: Value from executing hostname on the compute node.
9702 example: __HOSTNAME__
9703 - name: interface-name
9705 description: Name that identifies the link aggregate interface
9708 example: __INTERFACE-NAME__
9709 - name: interface-name
9711 description: Name given to the interface
9714 example: __INTERFACE-NAME__
9715 - name: vlan-interface
9717 description: String that identifies the interface
9720 example: __VLAN-INTERFACE__
9723 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
9726 $ref: "#/definitions/relationship"
9729 - CloudInfrastructure
9730 summary: delete an existing relationship
9731 description: delete an existing relationship
9732 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9741 description: Response codes found in [response codes](https://wiki.onap.org/).
9745 description: Value from executing hostname on the compute node.
9748 example: __HOSTNAME__
9749 - name: interface-name
9751 description: Name that identifies the link aggregate interface
9754 example: __INTERFACE-NAME__
9755 - name: interface-name
9757 description: Name given to the interface
9760 example: __INTERFACE-NAME__
9761 - name: vlan-interface
9763 description: String that identifies the interface
9766 example: __VLAN-INTERFACE__
9767 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9770 - CloudInfrastructure
9771 summary: see node definition for valid relationships
9772 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9781 description: Response codes found in [response codes](https://wiki.onap.org/).
9785 description: Value from executing hostname on the compute node.
9788 example: __HOSTNAME__
9789 - name: interface-name
9791 description: Name that identifies the link aggregate interface
9794 example: __INTERFACE-NAME__
9795 - name: interface-name
9797 description: Name given to the interface
9800 example: __INTERFACE-NAME__
9801 - name: vlan-interface
9803 description: String that identifies the interface
9806 example: __VLAN-INTERFACE__
9807 - name: l3-interface-ipv4-address
9809 description: IP address
9812 example: __L3-INTERFACE-IPV4-ADDRESS__
9815 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9818 $ref: "#/definitions/relationship"
9821 - CloudInfrastructure
9822 summary: delete an existing relationship
9823 description: delete an existing relationship
9824 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9833 description: Response codes found in [response codes](https://wiki.onap.org/).
9837 description: Value from executing hostname on the compute node.
9840 example: __HOSTNAME__
9841 - name: interface-name
9843 description: Name that identifies the link aggregate interface
9846 example: __INTERFACE-NAME__
9847 - name: interface-name
9849 description: Name given to the interface
9852 example: __INTERFACE-NAME__
9853 - name: vlan-interface
9855 description: String that identifies the interface
9858 example: __VLAN-INTERFACE__
9859 - name: l3-interface-ipv4-address
9861 description: IP address
9864 example: __L3-INTERFACE-IPV4-ADDRESS__
9865 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9868 - CloudInfrastructure
9869 summary: returns l3-interface-ipv4-address-list
9870 description: returns l3-interface-ipv4-address-list
9871 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9877 description: successful operation
9879 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9881 description: Response codes found in [response codes](https://wiki.onap.org/).
9885 description: Value from executing hostname on the compute node.
9888 example: __HOSTNAME__
9889 - name: interface-name
9891 description: Name that identifies the link aggregate interface
9894 example: __INTERFACE-NAME__
9895 - name: interface-name
9897 description: Name given to the interface
9900 example: __INTERFACE-NAME__
9901 - name: vlan-interface
9903 description: String that identifies the interface
9906 example: __VLAN-INTERFACE__
9907 - name: l3-interface-ipv4-address
9909 description: IP address
9912 example: __L3-INTERFACE-IPV4-ADDRESS__
9915 - CloudInfrastructure
9916 summary: create or update an existing l3-interface-ipv4-address-list
9918 Create or update an existing l3-interface-ipv4-address-list.
9920 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9921 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9930 description: Response codes found in [response codes](https://wiki.onap.org/).
9934 description: Value from executing hostname on the compute node.
9937 example: __HOSTNAME__
9938 - name: interface-name
9940 description: Name that identifies the link aggregate interface
9943 example: __INTERFACE-NAME__
9944 - name: interface-name
9946 description: Name given to the interface
9949 example: __INTERFACE-NAME__
9950 - name: vlan-interface
9952 description: String that identifies the interface
9955 example: __VLAN-INTERFACE__
9956 - name: l3-interface-ipv4-address
9958 description: IP address
9961 example: __L3-INTERFACE-IPV4-ADDRESS__
9964 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9967 $ref: "#/definitions/l3-interface-ipv4-address-list"
9970 - CloudInfrastructure
9971 summary: update an existing l3-interface-ipv4-address-list
9973 Update an existing l3-interface-ipv4-address-list
9975 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9976 The PUT operation will entirely replace an existing object.
9977 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9979 Other differences between PUT and PATCH are:
9981 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9982 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9983 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9984 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9993 description: Response codes found in [response codes](https://wiki.onap.org/).
9997 description: Value from executing hostname on the compute node.
10000 example: __HOSTNAME__
10001 - name: interface-name
10003 description: Name that identifies the link aggregate interface
10006 example: __INTERFACE-NAME__
10007 - name: interface-name
10009 description: Name given to the interface
10012 example: __INTERFACE-NAME__
10013 - name: vlan-interface
10015 description: String that identifies the interface
10018 example: __VLAN-INTERFACE__
10019 - name: l3-interface-ipv4-address
10021 description: IP address
10024 example: __L3-INTERFACE-IPV4-ADDRESS__
10027 description: l3-interface-ipv4-address-list object that needs to be updated.
10030 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10033 - CloudInfrastructure
10034 summary: delete an existing l3-interface-ipv4-address-list
10035 description: delete an existing l3-interface-ipv4-address-list
10036 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10045 description: Response codes found in [response codes](https://wiki.onap.org/).
10049 description: Value from executing hostname on the compute node.
10052 example: __HOSTNAME__
10053 - name: interface-name
10055 description: Name that identifies the link aggregate interface
10058 example: __INTERFACE-NAME__
10059 - name: interface-name
10061 description: Name given to the interface
10064 example: __INTERFACE-NAME__
10065 - name: vlan-interface
10067 description: String that identifies the interface
10070 example: __VLAN-INTERFACE__
10071 - name: l3-interface-ipv4-address
10073 description: IP address
10076 example: __L3-INTERFACE-IPV4-ADDRESS__
10077 - name: resource-version
10079 description: resource-version for concurrency
10082 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10085 - CloudInfrastructure
10086 summary: see node definition for valid relationships
10087 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10096 description: Response codes found in [response codes](https://wiki.onap.org/).
10100 description: Value from executing hostname on the compute node.
10103 example: __HOSTNAME__
10104 - name: interface-name
10106 description: Name that identifies the link aggregate interface
10109 example: __INTERFACE-NAME__
10110 - name: interface-name
10112 description: Name given to the interface
10115 example: __INTERFACE-NAME__
10116 - name: vlan-interface
10118 description: String that identifies the interface
10121 example: __VLAN-INTERFACE__
10122 - name: l3-interface-ipv6-address
10124 description: IP address
10127 example: __L3-INTERFACE-IPV6-ADDRESS__
10130 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10133 $ref: "#/definitions/relationship"
10136 - CloudInfrastructure
10137 summary: delete an existing relationship
10138 description: delete an existing relationship
10139 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10148 description: Response codes found in [response codes](https://wiki.onap.org/).
10152 description: Value from executing hostname on the compute node.
10155 example: __HOSTNAME__
10156 - name: interface-name
10158 description: Name that identifies the link aggregate interface
10161 example: __INTERFACE-NAME__
10162 - name: interface-name
10164 description: Name given to the interface
10167 example: __INTERFACE-NAME__
10168 - name: vlan-interface
10170 description: String that identifies the interface
10173 example: __VLAN-INTERFACE__
10174 - name: l3-interface-ipv6-address
10176 description: IP address
10179 example: __L3-INTERFACE-IPV6-ADDRESS__
10180 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10183 - CloudInfrastructure
10184 summary: returns l3-interface-ipv6-address-list
10185 description: returns l3-interface-ipv6-address-list
10186 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10192 description: successful operation
10194 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10196 description: Response codes found in [response codes](https://wiki.onap.org/).
10200 description: Value from executing hostname on the compute node.
10203 example: __HOSTNAME__
10204 - name: interface-name
10206 description: Name that identifies the link aggregate interface
10209 example: __INTERFACE-NAME__
10210 - name: interface-name
10212 description: Name given to the interface
10215 example: __INTERFACE-NAME__
10216 - name: vlan-interface
10218 description: String that identifies the interface
10221 example: __VLAN-INTERFACE__
10222 - name: l3-interface-ipv6-address
10224 description: IP address
10227 example: __L3-INTERFACE-IPV6-ADDRESS__
10230 - CloudInfrastructure
10231 summary: create or update an existing l3-interface-ipv6-address-list
10233 Create or update an existing l3-interface-ipv6-address-list.
10235 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10236 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10245 description: Response codes found in [response codes](https://wiki.onap.org/).
10249 description: Value from executing hostname on the compute node.
10252 example: __HOSTNAME__
10253 - name: interface-name
10255 description: Name that identifies the link aggregate interface
10258 example: __INTERFACE-NAME__
10259 - name: interface-name
10261 description: Name given to the interface
10264 example: __INTERFACE-NAME__
10265 - name: vlan-interface
10267 description: String that identifies the interface
10270 example: __VLAN-INTERFACE__
10271 - name: l3-interface-ipv6-address
10273 description: IP address
10276 example: __L3-INTERFACE-IPV6-ADDRESS__
10279 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10282 $ref: "#/definitions/l3-interface-ipv6-address-list"
10285 - CloudInfrastructure
10286 summary: update an existing l3-interface-ipv6-address-list
10288 Update an existing l3-interface-ipv6-address-list
10290 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10291 The PUT operation will entirely replace an existing object.
10292 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10294 Other differences between PUT and PATCH are:
10296 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10297 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10298 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10299 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10308 description: Response codes found in [response codes](https://wiki.onap.org/).
10312 description: Value from executing hostname on the compute node.
10315 example: __HOSTNAME__
10316 - name: interface-name
10318 description: Name that identifies the link aggregate interface
10321 example: __INTERFACE-NAME__
10322 - name: interface-name
10324 description: Name given to the interface
10327 example: __INTERFACE-NAME__
10328 - name: vlan-interface
10330 description: String that identifies the interface
10333 example: __VLAN-INTERFACE__
10334 - name: l3-interface-ipv6-address
10336 description: IP address
10339 example: __L3-INTERFACE-IPV6-ADDRESS__
10342 description: l3-interface-ipv6-address-list object that needs to be updated.
10345 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10348 - CloudInfrastructure
10349 summary: delete an existing l3-interface-ipv6-address-list
10350 description: delete an existing l3-interface-ipv6-address-list
10351 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10360 description: Response codes found in [response codes](https://wiki.onap.org/).
10364 description: Value from executing hostname on the compute node.
10367 example: __HOSTNAME__
10368 - name: interface-name
10370 description: Name that identifies the link aggregate interface
10373 example: __INTERFACE-NAME__
10374 - name: interface-name
10376 description: Name given to the interface
10379 example: __INTERFACE-NAME__
10380 - name: vlan-interface
10382 description: String that identifies the interface
10385 example: __VLAN-INTERFACE__
10386 - name: l3-interface-ipv6-address
10388 description: IP address
10391 example: __L3-INTERFACE-IPV6-ADDRESS__
10392 - name: resource-version
10394 description: resource-version for concurrency
10397 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10400 - CloudInfrastructure
10401 summary: returns vlan
10402 description: returns vlan
10403 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10409 description: successful operation
10411 $ref: "#/getDefinitions/vlan"
10413 description: Response codes found in [response codes](https://wiki.onap.org/).
10417 description: Value from executing hostname on the compute node.
10420 example: __HOSTNAME__
10421 - name: interface-name
10423 description: Name that identifies the link aggregate interface
10426 example: __INTERFACE-NAME__
10427 - name: interface-name
10429 description: Name given to the interface
10432 example: __INTERFACE-NAME__
10433 - name: vlan-interface
10435 description: String that identifies the interface
10438 example: __VLAN-INTERFACE__
10441 - CloudInfrastructure
10442 summary: create or update an existing vlan
10444 Create or update an existing vlan.
10446 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10447 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10456 description: Response codes found in [response codes](https://wiki.onap.org/).
10460 description: Value from executing hostname on the compute node.
10463 example: __HOSTNAME__
10464 - name: interface-name
10466 description: Name that identifies the link aggregate interface
10469 example: __INTERFACE-NAME__
10470 - name: interface-name
10472 description: Name given to the interface
10475 example: __INTERFACE-NAME__
10476 - name: vlan-interface
10478 description: String that identifies the interface
10481 example: __VLAN-INTERFACE__
10484 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10487 $ref: "#/definitions/vlan"
10490 - CloudInfrastructure
10491 summary: update an existing vlan
10493 Update an existing vlan
10495 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10496 The PUT operation will entirely replace an existing object.
10497 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10499 Other differences between PUT and PATCH are:
10501 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10502 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10503 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10504 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10513 description: Response codes found in [response codes](https://wiki.onap.org/).
10517 description: Value from executing hostname on the compute node.
10520 example: __HOSTNAME__
10521 - name: interface-name
10523 description: Name that identifies the link aggregate interface
10526 example: __INTERFACE-NAME__
10527 - name: interface-name
10529 description: Name given to the interface
10532 example: __INTERFACE-NAME__
10533 - name: vlan-interface
10535 description: String that identifies the interface
10538 example: __VLAN-INTERFACE__
10541 description: vlan object that needs to be updated.
10544 $ref: "#/patchDefinitions/vlan"
10547 - CloudInfrastructure
10548 summary: delete an existing vlan
10549 description: delete an existing vlan
10550 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10559 description: Response codes found in [response codes](https://wiki.onap.org/).
10563 description: Value from executing hostname on the compute node.
10566 example: __HOSTNAME__
10567 - name: interface-name
10569 description: Name that identifies the link aggregate interface
10572 example: __INTERFACE-NAME__
10573 - name: interface-name
10575 description: Name given to the interface
10578 example: __INTERFACE-NAME__
10579 - name: vlan-interface
10581 description: String that identifies the interface
10584 example: __VLAN-INTERFACE__
10585 - name: resource-version
10587 description: resource-version for concurrency
10590 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10593 - CloudInfrastructure
10594 summary: returns vlans
10595 description: returns vlans
10596 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
10602 description: successful operation
10604 $ref: "#/getDefinitions/vlans"
10606 description: Response codes found in [response codes](https://wiki.onap.org/).
10610 description: Value from executing hostname on the compute node.
10613 example: __HOSTNAME__
10614 - name: interface-name
10616 description: Name that identifies the link aggregate interface
10619 example: __INTERFACE-NAME__
10620 - name: interface-name
10622 description: Name given to the interface
10625 example: __INTERFACE-NAME__
10626 - name: vlan-interface
10631 - name: vlan-id-inner
10642 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
10645 - CloudInfrastructure
10646 summary: see node definition for valid relationships
10647 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10656 description: Response codes found in [response codes](https://wiki.onap.org/).
10660 description: Value from executing hostname on the compute node.
10663 example: __HOSTNAME__
10664 - name: interface-name
10666 description: Name that identifies the link aggregate interface
10669 example: __INTERFACE-NAME__
10670 - name: interface-name
10672 description: Name given to the interface
10675 example: __INTERFACE-NAME__
10678 description: PCI ID used to identify the sriov-vf
10681 example: __PCI-ID__
10684 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10687 $ref: "#/definitions/relationship"
10690 - CloudInfrastructure
10691 summary: delete an existing relationship
10692 description: delete an existing relationship
10693 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10702 description: Response codes found in [response codes](https://wiki.onap.org/).
10706 description: Value from executing hostname on the compute node.
10709 example: __HOSTNAME__
10710 - name: interface-name
10712 description: Name that identifies the link aggregate interface
10715 example: __INTERFACE-NAME__
10716 - name: interface-name
10718 description: Name given to the interface
10721 example: __INTERFACE-NAME__
10724 description: PCI ID used to identify the sriov-vf
10727 example: __PCI-ID__
10728 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10731 - CloudInfrastructure
10732 summary: returns sriov-vf
10733 description: returns sriov-vf
10734 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10740 description: successful operation
10742 $ref: "#/getDefinitions/sriov-vf"
10744 description: Response codes found in [response codes](https://wiki.onap.org/).
10748 description: Value from executing hostname on the compute node.
10751 example: __HOSTNAME__
10752 - name: interface-name
10754 description: Name that identifies the link aggregate interface
10757 example: __INTERFACE-NAME__
10758 - name: interface-name
10760 description: Name given to the interface
10763 example: __INTERFACE-NAME__
10766 description: PCI ID used to identify the sriov-vf
10769 example: __PCI-ID__
10772 - CloudInfrastructure
10773 summary: create or update an existing sriov-vf
10775 Create or update an existing sriov-vf.
10777 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10778 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10787 description: Response codes found in [response codes](https://wiki.onap.org/).
10791 description: Value from executing hostname on the compute node.
10794 example: __HOSTNAME__
10795 - name: interface-name
10797 description: Name that identifies the link aggregate interface
10800 example: __INTERFACE-NAME__
10801 - name: interface-name
10803 description: Name given to the interface
10806 example: __INTERFACE-NAME__
10809 description: PCI ID used to identify the sriov-vf
10812 example: __PCI-ID__
10815 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10818 $ref: "#/definitions/sriov-vf"
10821 - CloudInfrastructure
10822 summary: update an existing sriov-vf
10824 Update an existing sriov-vf
10826 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10827 The PUT operation will entirely replace an existing object.
10828 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10830 Other differences between PUT and PATCH are:
10832 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10833 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10834 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10835 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10844 description: Response codes found in [response codes](https://wiki.onap.org/).
10848 description: Value from executing hostname on the compute node.
10851 example: __HOSTNAME__
10852 - name: interface-name
10854 description: Name that identifies the link aggregate interface
10857 example: __INTERFACE-NAME__
10858 - name: interface-name
10860 description: Name given to the interface
10863 example: __INTERFACE-NAME__
10866 description: PCI ID used to identify the sriov-vf
10869 example: __PCI-ID__
10872 description: sriov-vf object that needs to be updated.
10875 $ref: "#/patchDefinitions/sriov-vf"
10878 - CloudInfrastructure
10879 summary: delete an existing sriov-vf
10880 description: delete an existing sriov-vf
10881 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10890 description: Response codes found in [response codes](https://wiki.onap.org/).
10894 description: Value from executing hostname on the compute node.
10897 example: __HOSTNAME__
10898 - name: interface-name
10900 description: Name that identifies the link aggregate interface
10903 example: __INTERFACE-NAME__
10904 - name: interface-name
10906 description: Name given to the interface
10909 example: __INTERFACE-NAME__
10912 description: PCI ID used to identify the sriov-vf
10915 example: __PCI-ID__
10916 - name: resource-version
10918 description: resource-version for concurrency
10921 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10924 - CloudInfrastructure
10925 summary: returns sriov-vfs
10926 description: returns sriov-vfs
10927 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
10933 description: successful operation
10935 $ref: "#/getDefinitions/sriov-vfs"
10937 description: Response codes found in [response codes](https://wiki.onap.org/).
10941 description: Value from executing hostname on the compute node.
10944 example: __HOSTNAME__
10945 - name: interface-name
10947 description: Name that identifies the link aggregate interface
10950 example: __INTERFACE-NAME__
10951 - name: interface-name
10953 description: Name given to the interface
10956 example: __INTERFACE-NAME__
10962 - name: vf-vlan-filter
10967 - name: vf-mac-filter
10972 - name: vf-vlan-strip
10977 - name: neutron-network-id
10982 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10985 - CloudInfrastructure
10986 summary: see node definition for valid relationships
10987 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
10996 description: Response codes found in [response codes](https://wiki.onap.org/).
11000 description: Value from executing hostname on the compute node.
11003 example: __HOSTNAME__
11004 - name: interface-name
11006 description: Name that identifies the link aggregate interface
11009 example: __INTERFACE-NAME__
11010 - name: interface-name
11012 description: Name given to the interface
11015 example: __INTERFACE-NAME__
11018 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11021 $ref: "#/definitions/relationship"
11024 - CloudInfrastructure
11025 summary: delete an existing relationship
11026 description: delete an existing relationship
11027 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
11036 description: Response codes found in [response codes](https://wiki.onap.org/).
11040 description: Value from executing hostname on the compute node.
11043 example: __HOSTNAME__
11044 - name: interface-name
11046 description: Name that identifies the link aggregate interface
11049 example: __INTERFACE-NAME__
11050 - name: interface-name
11052 description: Name given to the interface
11055 example: __INTERFACE-NAME__
11056 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
11059 - CloudInfrastructure
11060 summary: see node definition for valid relationships
11061 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11070 description: Response codes found in [response codes](https://wiki.onap.org/).
11074 description: Value from executing hostname on the compute node.
11077 example: __HOSTNAME__
11078 - name: interface-name
11080 description: Name that identifies the link aggregate interface
11083 example: __INTERFACE-NAME__
11084 - name: interface-name
11086 description: Name given to the interface
11089 example: __INTERFACE-NAME__
11090 - name: l3-interface-ipv4-address
11092 description: IP address
11095 example: __L3-INTERFACE-IPV4-ADDRESS__
11098 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11101 $ref: "#/definitions/relationship"
11104 - CloudInfrastructure
11105 summary: delete an existing relationship
11106 description: delete an existing relationship
11107 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11116 description: Response codes found in [response codes](https://wiki.onap.org/).
11120 description: Value from executing hostname on the compute node.
11123 example: __HOSTNAME__
11124 - name: interface-name
11126 description: Name that identifies the link aggregate interface
11129 example: __INTERFACE-NAME__
11130 - name: interface-name
11132 description: Name given to the interface
11135 example: __INTERFACE-NAME__
11136 - name: l3-interface-ipv4-address
11138 description: IP address
11141 example: __L3-INTERFACE-IPV4-ADDRESS__
11142 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11145 - CloudInfrastructure
11146 summary: returns l3-interface-ipv4-address-list
11147 description: returns l3-interface-ipv4-address-list
11148 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11154 description: successful operation
11156 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11158 description: Response codes found in [response codes](https://wiki.onap.org/).
11162 description: Value from executing hostname on the compute node.
11165 example: __HOSTNAME__
11166 - name: interface-name
11168 description: Name that identifies the link aggregate interface
11171 example: __INTERFACE-NAME__
11172 - name: interface-name
11174 description: Name given to the interface
11177 example: __INTERFACE-NAME__
11178 - name: l3-interface-ipv4-address
11180 description: IP address
11183 example: __L3-INTERFACE-IPV4-ADDRESS__
11186 - CloudInfrastructure
11187 summary: create or update an existing l3-interface-ipv4-address-list
11189 Create or update an existing l3-interface-ipv4-address-list.
11191 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11192 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11201 description: Response codes found in [response codes](https://wiki.onap.org/).
11205 description: Value from executing hostname on the compute node.
11208 example: __HOSTNAME__
11209 - name: interface-name
11211 description: Name that identifies the link aggregate interface
11214 example: __INTERFACE-NAME__
11215 - name: interface-name
11217 description: Name given to the interface
11220 example: __INTERFACE-NAME__
11221 - name: l3-interface-ipv4-address
11223 description: IP address
11226 example: __L3-INTERFACE-IPV4-ADDRESS__
11229 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11232 $ref: "#/definitions/l3-interface-ipv4-address-list"
11235 - CloudInfrastructure
11236 summary: update an existing l3-interface-ipv4-address-list
11238 Update an existing l3-interface-ipv4-address-list
11240 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11241 The PUT operation will entirely replace an existing object.
11242 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11244 Other differences between PUT and PATCH are:
11246 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11247 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11248 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11249 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11258 description: Response codes found in [response codes](https://wiki.onap.org/).
11262 description: Value from executing hostname on the compute node.
11265 example: __HOSTNAME__
11266 - name: interface-name
11268 description: Name that identifies the link aggregate interface
11271 example: __INTERFACE-NAME__
11272 - name: interface-name
11274 description: Name given to the interface
11277 example: __INTERFACE-NAME__
11278 - name: l3-interface-ipv4-address
11280 description: IP address
11283 example: __L3-INTERFACE-IPV4-ADDRESS__
11286 description: l3-interface-ipv4-address-list object that needs to be updated.
11289 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11292 - CloudInfrastructure
11293 summary: delete an existing l3-interface-ipv4-address-list
11294 description: delete an existing l3-interface-ipv4-address-list
11295 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11304 description: Response codes found in [response codes](https://wiki.onap.org/).
11308 description: Value from executing hostname on the compute node.
11311 example: __HOSTNAME__
11312 - name: interface-name
11314 description: Name that identifies the link aggregate interface
11317 example: __INTERFACE-NAME__
11318 - name: interface-name
11320 description: Name given to the interface
11323 example: __INTERFACE-NAME__
11324 - name: l3-interface-ipv4-address
11326 description: IP address
11329 example: __L3-INTERFACE-IPV4-ADDRESS__
11330 - name: resource-version
11332 description: resource-version for concurrency
11335 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11338 - CloudInfrastructure
11339 summary: see node definition for valid relationships
11340 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11349 description: Response codes found in [response codes](https://wiki.onap.org/).
11353 description: Value from executing hostname on the compute node.
11356 example: __HOSTNAME__
11357 - name: interface-name
11359 description: Name that identifies the link aggregate interface
11362 example: __INTERFACE-NAME__
11363 - name: interface-name
11365 description: Name given to the interface
11368 example: __INTERFACE-NAME__
11369 - name: l3-interface-ipv6-address
11371 description: IP address
11374 example: __L3-INTERFACE-IPV6-ADDRESS__
11377 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11380 $ref: "#/definitions/relationship"
11383 - CloudInfrastructure
11384 summary: delete an existing relationship
11385 description: delete an existing relationship
11386 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11395 description: Response codes found in [response codes](https://wiki.onap.org/).
11399 description: Value from executing hostname on the compute node.
11402 example: __HOSTNAME__
11403 - name: interface-name
11405 description: Name that identifies the link aggregate interface
11408 example: __INTERFACE-NAME__
11409 - name: interface-name
11411 description: Name given to the interface
11414 example: __INTERFACE-NAME__
11415 - name: l3-interface-ipv6-address
11417 description: IP address
11420 example: __L3-INTERFACE-IPV6-ADDRESS__
11421 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11424 - CloudInfrastructure
11425 summary: returns l3-interface-ipv6-address-list
11426 description: returns l3-interface-ipv6-address-list
11427 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11433 description: successful operation
11435 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11437 description: Response codes found in [response codes](https://wiki.onap.org/).
11441 description: Value from executing hostname on the compute node.
11444 example: __HOSTNAME__
11445 - name: interface-name
11447 description: Name that identifies the link aggregate interface
11450 example: __INTERFACE-NAME__
11451 - name: interface-name
11453 description: Name given to the interface
11456 example: __INTERFACE-NAME__
11457 - name: l3-interface-ipv6-address
11459 description: IP address
11462 example: __L3-INTERFACE-IPV6-ADDRESS__
11465 - CloudInfrastructure
11466 summary: create or update an existing l3-interface-ipv6-address-list
11468 Create or update an existing l3-interface-ipv6-address-list.
11470 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11471 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11480 description: Response codes found in [response codes](https://wiki.onap.org/).
11484 description: Value from executing hostname on the compute node.
11487 example: __HOSTNAME__
11488 - name: interface-name
11490 description: Name that identifies the link aggregate interface
11493 example: __INTERFACE-NAME__
11494 - name: interface-name
11496 description: Name given to the interface
11499 example: __INTERFACE-NAME__
11500 - name: l3-interface-ipv6-address
11502 description: IP address
11505 example: __L3-INTERFACE-IPV6-ADDRESS__
11508 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11511 $ref: "#/definitions/l3-interface-ipv6-address-list"
11514 - CloudInfrastructure
11515 summary: update an existing l3-interface-ipv6-address-list
11517 Update an existing l3-interface-ipv6-address-list
11519 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11520 The PUT operation will entirely replace an existing object.
11521 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11523 Other differences between PUT and PATCH are:
11525 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11526 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11527 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11528 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11537 description: Response codes found in [response codes](https://wiki.onap.org/).
11541 description: Value from executing hostname on the compute node.
11544 example: __HOSTNAME__
11545 - name: interface-name
11547 description: Name that identifies the link aggregate interface
11550 example: __INTERFACE-NAME__
11551 - name: interface-name
11553 description: Name given to the interface
11556 example: __INTERFACE-NAME__
11557 - name: l3-interface-ipv6-address
11559 description: IP address
11562 example: __L3-INTERFACE-IPV6-ADDRESS__
11565 description: l3-interface-ipv6-address-list object that needs to be updated.
11568 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11571 - CloudInfrastructure
11572 summary: delete an existing l3-interface-ipv6-address-list
11573 description: delete an existing l3-interface-ipv6-address-list
11574 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11583 description: Response codes found in [response codes](https://wiki.onap.org/).
11587 description: Value from executing hostname on the compute node.
11590 example: __HOSTNAME__
11591 - name: interface-name
11593 description: Name that identifies the link aggregate interface
11596 example: __INTERFACE-NAME__
11597 - name: interface-name
11599 description: Name given to the interface
11602 example: __INTERFACE-NAME__
11603 - name: l3-interface-ipv6-address
11605 description: IP address
11608 example: __L3-INTERFACE-IPV6-ADDRESS__
11609 - name: resource-version
11611 description: resource-version for concurrency
11614 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11617 - CloudInfrastructure
11618 summary: returns l-interface
11619 description: returns l-interface
11620 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11626 description: successful operation
11628 $ref: "#/getDefinitions/l-interface"
11630 description: Response codes found in [response codes](https://wiki.onap.org/).
11634 description: Value from executing hostname on the compute node.
11637 example: __HOSTNAME__
11638 - name: interface-name
11640 description: Name that identifies the link aggregate interface
11643 example: __INTERFACE-NAME__
11644 - name: interface-name
11646 description: Name given to the interface
11649 example: __INTERFACE-NAME__
11652 - CloudInfrastructure
11653 summary: create or update an existing l-interface
11655 Create or update an existing l-interface.
11657 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11658 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11667 description: Response codes found in [response codes](https://wiki.onap.org/).
11671 description: Value from executing hostname on the compute node.
11674 example: __HOSTNAME__
11675 - name: interface-name
11677 description: Name that identifies the link aggregate interface
11680 example: __INTERFACE-NAME__
11681 - name: interface-name
11683 description: Name given to the interface
11686 example: __INTERFACE-NAME__
11689 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11692 $ref: "#/definitions/l-interface"
11695 - CloudInfrastructure
11696 summary: update an existing l-interface
11698 Update an existing l-interface
11700 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11701 The PUT operation will entirely replace an existing object.
11702 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11704 Other differences between PUT and PATCH are:
11706 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11707 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11708 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11709 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11718 description: Response codes found in [response codes](https://wiki.onap.org/).
11722 description: Value from executing hostname on the compute node.
11725 example: __HOSTNAME__
11726 - name: interface-name
11728 description: Name that identifies the link aggregate interface
11731 example: __INTERFACE-NAME__
11732 - name: interface-name
11734 description: Name given to the interface
11737 example: __INTERFACE-NAME__
11740 description: l-interface object that needs to be updated.
11743 $ref: "#/patchDefinitions/l-interface"
11746 - CloudInfrastructure
11747 summary: delete an existing l-interface
11748 description: delete an existing l-interface
11749 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11758 description: Response codes found in [response codes](https://wiki.onap.org/).
11762 description: Value from executing hostname on the compute node.
11765 example: __HOSTNAME__
11766 - name: interface-name
11768 description: Name that identifies the link aggregate interface
11771 example: __INTERFACE-NAME__
11772 - name: interface-name
11774 description: Name given to the interface
11777 example: __INTERFACE-NAME__
11778 - name: resource-version
11780 description: resource-version for concurrency
11783 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
11786 - CloudInfrastructure
11787 summary: returns l-interfaces
11788 description: returns l-interfaces
11789 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
11795 description: successful operation
11797 $ref: "#/getDefinitions/l-interfaces"
11799 description: Response codes found in [response codes](https://wiki.onap.org/).
11803 description: Value from executing hostname on the compute node.
11806 example: __HOSTNAME__
11807 - name: interface-name
11809 description: Name that identifies the link aggregate interface
11812 example: __INTERFACE-NAME__
11813 - name: interface-name
11818 - name: interface-id
11828 - name: network-name
11833 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
11836 - CloudInfrastructure
11837 summary: returns lag-interface
11838 description: returns lag-interface
11839 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
11845 description: successful operation
11847 $ref: "#/getDefinitions/lag-interface"
11849 description: Response codes found in [response codes](https://wiki.onap.org/).
11853 description: Value from executing hostname on the compute node.
11856 example: __HOSTNAME__
11857 - name: interface-name
11859 description: Name that identifies the link aggregate interface
11862 example: __INTERFACE-NAME__
11865 - CloudInfrastructure
11866 summary: create or update an existing lag-interface
11868 Create or update an existing lag-interface.
11870 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11871 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11880 description: Response codes found in [response codes](https://wiki.onap.org/).
11884 description: Value from executing hostname on the compute node.
11887 example: __HOSTNAME__
11888 - name: interface-name
11890 description: Name that identifies the link aggregate interface
11893 example: __INTERFACE-NAME__
11896 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11899 $ref: "#/definitions/lag-interface"
11902 - CloudInfrastructure
11903 summary: update an existing lag-interface
11905 Update an existing lag-interface
11907 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11908 The PUT operation will entirely replace an existing object.
11909 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11911 Other differences between PUT and PATCH are:
11913 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11914 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11915 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11916 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11925 description: Response codes found in [response codes](https://wiki.onap.org/).
11929 description: Value from executing hostname on the compute node.
11932 example: __HOSTNAME__
11933 - name: interface-name
11935 description: Name that identifies the link aggregate interface
11938 example: __INTERFACE-NAME__
11941 description: lag-interface object that needs to be updated.
11944 $ref: "#/patchDefinitions/lag-interface"
11947 - CloudInfrastructure
11948 summary: delete an existing lag-interface
11949 description: delete an existing lag-interface
11950 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
11959 description: Response codes found in [response codes](https://wiki.onap.org/).
11963 description: Value from executing hostname on the compute node.
11966 example: __HOSTNAME__
11967 - name: interface-name
11969 description: Name that identifies the link aggregate interface
11972 example: __INTERFACE-NAME__
11973 - name: resource-version
11975 description: resource-version for concurrency
11978 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
11981 - CloudInfrastructure
11982 summary: returns lag-interfaces
11983 description: returns lag-interfaces
11984 operationId: getCloudInfrastructurePserversPserverLagInterfaces
11990 description: successful operation
11992 $ref: "#/getDefinitions/lag-interfaces"
11994 description: Response codes found in [response codes](https://wiki.onap.org/).
11998 description: Value from executing hostname on the compute node.
12001 example: __HOSTNAME__
12002 - name: interface-name
12007 /cloud-infrastructure/pservers/pserver/{hostname}:
12010 - CloudInfrastructure
12011 summary: returns pserver
12012 description: returns pserver
12013 operationId: getCloudInfrastructurePserversPserver
12019 description: successful operation
12021 $ref: "#/getDefinitions/pserver"
12023 description: Response codes found in [response codes](https://wiki.onap.org/).
12027 description: Value from executing hostname on the compute node.
12030 example: __HOSTNAME__
12033 - CloudInfrastructure
12034 summary: create or update an existing pserver
12036 Create or update an existing pserver.
12038 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12039 operationId: createOrUpdateCloudInfrastructurePserversPserver
12048 description: Response codes found in [response codes](https://wiki.onap.org/).
12052 description: Value from executing hostname on the compute node.
12055 example: __HOSTNAME__
12058 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)
12061 $ref: "#/definitions/pserver"
12064 - CloudInfrastructure
12065 summary: update an existing pserver
12067 Update an existing pserver
12069 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12070 The PUT operation will entirely replace an existing object.
12071 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12073 Other differences between PUT and PATCH are:
12075 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12076 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12077 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12078 operationId: UpdateCloudInfrastructurePserversPserver
12087 description: Response codes found in [response codes](https://wiki.onap.org/).
12091 description: Value from executing hostname on the compute node.
12094 example: __HOSTNAME__
12097 description: pserver object that needs to be updated.
12100 $ref: "#/patchDefinitions/pserver"
12103 - CloudInfrastructure
12104 summary: delete an existing pserver
12105 description: delete an existing pserver
12106 operationId: deleteCloudInfrastructurePserversPserver
12115 description: Response codes found in [response codes](https://wiki.onap.org/).
12119 description: Value from executing hostname on the compute node.
12122 example: __HOSTNAME__
12123 - name: resource-version
12125 description: resource-version for concurrency
12128 /cloud-infrastructure/pservers:
12131 - CloudInfrastructure
12132 summary: returns pservers
12133 description: returns pservers
12134 operationId: getCloudInfrastructurePservers
12140 description: successful operation
12142 $ref: "#/getDefinitions/pservers"
12144 description: Response codes found in [response codes](https://wiki.onap.org/).
12161 - name: pserver-name2
12166 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
12169 - CloudInfrastructure
12170 summary: see node definition for valid relationships
12171 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12180 description: Response codes found in [response codes](https://wiki.onap.org/).
12184 description: Unique ID of the vdc
12187 example: __VDC-ID__
12190 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12193 $ref: "#/definitions/relationship"
12196 - CloudInfrastructure
12197 summary: delete an existing relationship
12198 description: delete an existing relationship
12199 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12208 description: Response codes found in [response codes](https://wiki.onap.org/).
12212 description: Unique ID of the vdc
12215 example: __VDC-ID__
12216 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
12219 - CloudInfrastructure
12220 summary: returns virtual-data-center
12221 description: returns virtual-data-center
12222 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
12228 description: successful operation
12230 $ref: "#/getDefinitions/virtual-data-center"
12232 description: Response codes found in [response codes](https://wiki.onap.org/).
12236 description: Unique ID of the vdc
12239 example: __VDC-ID__
12242 - CloudInfrastructure
12243 summary: create or update an existing virtual-data-center
12245 Create or update an existing virtual-data-center.
12247 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12248 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12257 description: Response codes found in [response codes](https://wiki.onap.org/).
12261 description: Unique ID of the vdc
12264 example: __VDC-ID__
12267 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12270 $ref: "#/definitions/virtual-data-center"
12273 - CloudInfrastructure
12274 summary: update an existing virtual-data-center
12276 Update an existing virtual-data-center
12278 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12279 The PUT operation will entirely replace an existing object.
12280 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12282 Other differences between PUT and PATCH are:
12284 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12285 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12286 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12287 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12296 description: Response codes found in [response codes](https://wiki.onap.org/).
12300 description: Unique ID of the vdc
12303 example: __VDC-ID__
12306 description: virtual-data-center object that needs to be updated.
12309 $ref: "#/patchDefinitions/virtual-data-center"
12312 - CloudInfrastructure
12313 summary: delete an existing virtual-data-center
12314 description: delete an existing virtual-data-center
12315 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
12324 description: Response codes found in [response codes](https://wiki.onap.org/).
12328 description: Unique ID of the vdc
12331 example: __VDC-ID__
12332 - name: resource-version
12334 description: resource-version for concurrency
12337 /cloud-infrastructure/virtual-data-centers:
12340 - CloudInfrastructure
12341 summary: returns virtual-data-centers
12342 description: returns virtual-data-centers
12343 operationId: getCloudInfrastructureVirtualDataCenters
12349 description: successful operation
12351 $ref: "#/getDefinitions/virtual-data-centers"
12353 description: Response codes found in [response codes](https://wiki.onap.org/).
12365 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
12369 summary: see node definition for valid relationships
12370 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
12379 description: Response codes found in [response codes](https://wiki.onap.org/).
12381 - name: resource-instance-id
12383 description: Unique id of resource instance.
12386 example: __RESOURCE-INSTANCE-ID__
12389 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
12392 $ref: "#/definitions/relationship"
12396 summary: delete an existing relationship
12397 description: delete an existing relationship
12398 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
12407 description: Response codes found in [response codes](https://wiki.onap.org/).
12409 - name: resource-instance-id
12411 description: Unique id of resource instance.
12414 example: __RESOURCE-INSTANCE-ID__
12415 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
12419 summary: returns metadatum
12420 description: returns metadatum
12421 operationId: getBusinessConnectorsConnectorMetadataMetadatum
12427 description: successful operation
12429 $ref: "#/getDefinitions/metadatum"
12431 description: Response codes found in [response codes](https://wiki.onap.org/).
12433 - name: resource-instance-id
12435 description: Unique id of resource instance.
12438 example: __RESOURCE-INSTANCE-ID__
12443 example: __METANAME__
12447 summary: create or update an existing metadatum
12449 Create or update an existing metadatum.
12451 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12452 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
12461 description: Response codes found in [response codes](https://wiki.onap.org/).
12463 - name: resource-instance-id
12465 description: Unique id of resource instance.
12468 example: __RESOURCE-INSTANCE-ID__
12473 example: __METANAME__
12476 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnectorMetadataMetadatum.json)
12479 $ref: "#/definitions/metadatum"
12483 summary: update an existing metadatum
12485 Update an existing metadatum
12487 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12488 The PUT operation will entirely replace an existing object.
12489 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12491 Other differences between PUT and PATCH are:
12493 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12494 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12495 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12496 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
12505 description: Response codes found in [response codes](https://wiki.onap.org/).
12507 - name: resource-instance-id
12509 description: Unique id of resource instance.
12512 example: __RESOURCE-INSTANCE-ID__
12517 example: __METANAME__
12520 description: metadatum object that needs to be updated.
12523 $ref: "#/patchDefinitions/metadatum"
12527 summary: delete an existing metadatum
12528 description: delete an existing metadatum
12529 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
12538 description: Response codes found in [response codes](https://wiki.onap.org/).
12540 - name: resource-instance-id
12542 description: Unique id of resource instance.
12545 example: __RESOURCE-INSTANCE-ID__
12550 example: __METANAME__
12551 - name: resource-version
12553 description: resource-version for concurrency
12556 /business/connectors/connector/{resource-instance-id}/metadata:
12560 summary: returns metadata
12561 description: returns metadata
12562 operationId: getBusinessConnectorsConnectorMetadata
12568 description: successful operation
12570 $ref: "#/getDefinitions/metadata"
12572 description: Response codes found in [response codes](https://wiki.onap.org/).
12574 - name: resource-instance-id
12576 description: Unique id of resource instance.
12579 example: __RESOURCE-INSTANCE-ID__
12585 /business/connectors/connector/{resource-instance-id}:
12589 summary: returns connector
12590 description: returns connector
12591 operationId: getBusinessConnectorsConnector
12597 description: successful operation
12599 $ref: "#/getDefinitions/connector"
12601 description: Response codes found in [response codes](https://wiki.onap.org/).
12603 - name: resource-instance-id
12605 description: Unique id of resource instance.
12608 example: __RESOURCE-INSTANCE-ID__
12612 summary: create or update an existing connector
12614 Create or update an existing connector.
12616 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12617 operationId: createOrUpdateBusinessConnectorsConnector
12626 description: Response codes found in [response codes](https://wiki.onap.org/).
12628 - name: resource-instance-id
12630 description: Unique id of resource instance.
12633 example: __RESOURCE-INSTANCE-ID__
12636 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
12639 $ref: "#/definitions/connector"
12643 summary: update an existing connector
12645 Update an existing connector
12647 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12648 The PUT operation will entirely replace an existing object.
12649 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12651 Other differences between PUT and PATCH are:
12653 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12654 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12655 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12656 operationId: UpdateBusinessConnectorsConnector
12665 description: Response codes found in [response codes](https://wiki.onap.org/).
12667 - name: resource-instance-id
12669 description: Unique id of resource instance.
12672 example: __RESOURCE-INSTANCE-ID__
12675 description: connector object that needs to be updated.
12678 $ref: "#/patchDefinitions/connector"
12682 summary: delete an existing connector
12683 description: delete an existing connector
12684 operationId: deleteBusinessConnectorsConnector
12693 description: Response codes found in [response codes](https://wiki.onap.org/).
12695 - name: resource-instance-id
12697 description: Unique id of resource instance.
12700 example: __RESOURCE-INSTANCE-ID__
12701 - name: resource-version
12703 description: resource-version for concurrency
12706 /business/connectors:
12710 summary: returns connectors
12711 description: returns connectors
12712 operationId: getBusinessConnectors
12718 description: successful operation
12720 $ref: "#/getDefinitions/connectors"
12722 description: Response codes found in [response codes](https://wiki.onap.org/).
12724 - name: resource-instance-id
12729 - name: persona-model-id
12734 - name: persona-model-version
12739 - name: widget-model-id
12744 - name: widget-model-version
12749 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
12753 summary: see node definition for valid relationships
12754 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12763 description: Response codes found in [response codes](https://wiki.onap.org/).
12765 - name: global-customer-id
12767 description: Global customer id used across ECOMP to uniquely identify customer.
12770 example: __GLOBAL-CUSTOMER-ID__
12771 - name: service-type
12773 description: Value defined by orchestration to identify this service across ECOMP.
12776 example: __SERVICE-TYPE__
12777 - name: service-instance-id
12779 description: Uniquely identifies this instance of a service
12782 example: __SERVICE-INSTANCE-ID__
12785 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
12788 $ref: "#/definitions/relationship"
12792 summary: delete an existing relationship
12793 description: delete an existing relationship
12794 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12803 description: Response codes found in [response codes](https://wiki.onap.org/).
12805 - name: global-customer-id
12807 description: Global customer id used across ECOMP to uniquely identify customer.
12810 example: __GLOBAL-CUSTOMER-ID__
12811 - name: service-type
12813 description: Value defined by orchestration to identify this service across ECOMP.
12816 example: __SERVICE-TYPE__
12817 - name: service-instance-id
12819 description: Uniquely identifies this instance of a service
12822 example: __SERVICE-INSTANCE-ID__
12823 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
12827 summary: returns metadatum
12828 description: returns metadatum
12829 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12835 description: successful operation
12837 $ref: "#/getDefinitions/metadatum"
12839 description: Response codes found in [response codes](https://wiki.onap.org/).
12841 - name: global-customer-id
12843 description: Global customer id used across ECOMP to uniquely identify customer.
12846 example: __GLOBAL-CUSTOMER-ID__
12847 - name: service-type
12849 description: Value defined by orchestration to identify this service across ECOMP.
12852 example: __SERVICE-TYPE__
12853 - name: service-instance-id
12855 description: Uniquely identifies this instance of a service
12858 example: __SERVICE-INSTANCE-ID__
12863 example: __METANAME__
12867 summary: create or update an existing metadatum
12869 Create or update an existing metadatum.
12871 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12872 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12881 description: Response codes found in [response codes](https://wiki.onap.org/).
12883 - name: global-customer-id
12885 description: Global customer id used across ECOMP to uniquely identify customer.
12888 example: __GLOBAL-CUSTOMER-ID__
12889 - name: service-type
12891 description: Value defined by orchestration to identify this service across ECOMP.
12894 example: __SERVICE-TYPE__
12895 - name: service-instance-id
12897 description: Uniquely identifies this instance of a service
12900 example: __SERVICE-INSTANCE-ID__
12905 example: __METANAME__
12908 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
12911 $ref: "#/definitions/metadatum"
12915 summary: update an existing metadatum
12917 Update an existing metadatum
12919 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12920 The PUT operation will entirely replace an existing object.
12921 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12923 Other differences between PUT and PATCH are:
12925 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12926 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12927 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12928 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12937 description: Response codes found in [response codes](https://wiki.onap.org/).
12939 - name: global-customer-id
12941 description: Global customer id used across ECOMP to uniquely identify customer.
12944 example: __GLOBAL-CUSTOMER-ID__
12945 - name: service-type
12947 description: Value defined by orchestration to identify this service across ECOMP.
12950 example: __SERVICE-TYPE__
12951 - name: service-instance-id
12953 description: Uniquely identifies this instance of a service
12956 example: __SERVICE-INSTANCE-ID__
12961 example: __METANAME__
12964 description: metadatum object that needs to be updated.
12967 $ref: "#/patchDefinitions/metadatum"
12971 summary: delete an existing metadatum
12972 description: delete an existing metadatum
12973 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12982 description: Response codes found in [response codes](https://wiki.onap.org/).
12984 - name: global-customer-id
12986 description: Global customer id used across ECOMP to uniquely identify customer.
12989 example: __GLOBAL-CUSTOMER-ID__
12990 - name: service-type
12992 description: Value defined by orchestration to identify this service across ECOMP.
12995 example: __SERVICE-TYPE__
12996 - name: service-instance-id
12998 description: Uniquely identifies this instance of a service
13001 example: __SERVICE-INSTANCE-ID__
13006 example: __METANAME__
13007 - name: resource-version
13009 description: resource-version for concurrency
13012 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
13016 summary: returns metadata
13017 description: returns metadata
13018 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
13024 description: successful operation
13026 $ref: "#/getDefinitions/metadata"
13028 description: Response codes found in [response codes](https://wiki.onap.org/).
13030 - name: global-customer-id
13032 description: Global customer id used across ECOMP to uniquely identify customer.
13035 example: __GLOBAL-CUSTOMER-ID__
13036 - name: service-type
13038 description: Value defined by orchestration to identify this service across ECOMP.
13041 example: __SERVICE-TYPE__
13042 - name: service-instance-id
13044 description: Uniquely identifies this instance of a service
13047 example: __SERVICE-INSTANCE-ID__
13053 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
13057 summary: returns service-instance
13058 description: returns service-instance
13059 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13065 description: successful operation
13067 $ref: "#/getDefinitions/service-instance"
13069 description: Response codes found in [response codes](https://wiki.onap.org/).
13071 - name: global-customer-id
13073 description: Global customer id used across ECOMP to uniquely identify customer.
13076 example: __GLOBAL-CUSTOMER-ID__
13077 - name: service-type
13079 description: Value defined by orchestration to identify this service across ECOMP.
13082 example: __SERVICE-TYPE__
13083 - name: service-instance-id
13085 description: Uniquely identifies this instance of a service
13088 example: __SERVICE-INSTANCE-ID__
13092 summary: create or update an existing service-instance
13094 Create or update an existing service-instance.
13096 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13097 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13106 description: Response codes found in [response codes](https://wiki.onap.org/).
13108 - name: global-customer-id
13110 description: Global customer id used across ECOMP to uniquely identify customer.
13113 example: __GLOBAL-CUSTOMER-ID__
13114 - name: service-type
13116 description: Value defined by orchestration to identify this service across ECOMP.
13119 example: __SERVICE-TYPE__
13120 - name: service-instance-id
13122 description: Uniquely identifies this instance of a service
13125 example: __SERVICE-INSTANCE-ID__
13128 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
13131 $ref: "#/definitions/service-instance"
13135 summary: update an existing service-instance
13137 Update an existing service-instance
13139 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13140 The PUT operation will entirely replace an existing object.
13141 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13143 Other differences between PUT and PATCH are:
13145 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13146 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13147 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13148 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13157 description: Response codes found in [response codes](https://wiki.onap.org/).
13159 - name: global-customer-id
13161 description: Global customer id used across ECOMP to uniquely identify customer.
13164 example: __GLOBAL-CUSTOMER-ID__
13165 - name: service-type
13167 description: Value defined by orchestration to identify this service across ECOMP.
13170 example: __SERVICE-TYPE__
13171 - name: service-instance-id
13173 description: Uniquely identifies this instance of a service
13176 example: __SERVICE-INSTANCE-ID__
13179 description: service-instance object that needs to be updated.
13182 $ref: "#/patchDefinitions/service-instance"
13186 summary: delete an existing service-instance
13187 description: delete an existing service-instance
13188 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13197 description: Response codes found in [response codes](https://wiki.onap.org/).
13199 - name: global-customer-id
13201 description: Global customer id used across ECOMP to uniquely identify customer.
13204 example: __GLOBAL-CUSTOMER-ID__
13205 - name: service-type
13207 description: Value defined by orchestration to identify this service across ECOMP.
13210 example: __SERVICE-TYPE__
13211 - name: service-instance-id
13213 description: Uniquely identifies this instance of a service
13216 example: __SERVICE-INSTANCE-ID__
13217 - name: resource-version
13219 description: resource-version for concurrency
13222 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
13226 summary: returns service-instances
13227 description: returns service-instances
13228 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
13234 description: successful operation
13236 $ref: "#/getDefinitions/service-instances"
13238 description: Response codes found in [response codes](https://wiki.onap.org/).
13240 - name: global-customer-id
13242 description: Global customer id used across ECOMP to uniquely identify customer.
13245 example: __GLOBAL-CUSTOMER-ID__
13246 - name: service-type
13248 description: Value defined by orchestration to identify this service across ECOMP.
13251 example: __SERVICE-TYPE__
13252 - name: service-instance-id
13257 - name: service-instance-name
13262 - name: persona-model-id
13267 - name: persona-model-version
13272 - name: widget-model-id
13277 - name: widget-model-version
13282 - name: service-instance-location-id
13287 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
13291 summary: see node definition for valid relationships
13292 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
13301 description: Response codes found in [response codes](https://wiki.onap.org/).
13303 - name: global-customer-id
13305 description: Global customer id used across ECOMP to uniquely identify customer.
13308 example: __GLOBAL-CUSTOMER-ID__
13309 - name: service-type
13311 description: Value defined by orchestration to identify this service across ECOMP.
13314 example: __SERVICE-TYPE__
13317 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
13320 $ref: "#/definitions/relationship"
13324 summary: delete an existing relationship
13325 description: delete an existing relationship
13326 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
13335 description: Response codes found in [response codes](https://wiki.onap.org/).
13337 - name: global-customer-id
13339 description: Global customer id used across ECOMP to uniquely identify customer.
13342 example: __GLOBAL-CUSTOMER-ID__
13343 - name: service-type
13345 description: Value defined by orchestration to identify this service across ECOMP.
13348 example: __SERVICE-TYPE__
13349 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
13353 summary: returns service-subscription
13354 description: returns service-subscription
13355 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
13361 description: successful operation
13363 $ref: "#/getDefinitions/service-subscription"
13365 description: Response codes found in [response codes](https://wiki.onap.org/).
13367 - name: global-customer-id
13369 description: Global customer id used across ECOMP to uniquely identify customer.
13372 example: __GLOBAL-CUSTOMER-ID__
13373 - name: service-type
13375 description: Value defined by orchestration to identify this service across ECOMP.
13378 example: __SERVICE-TYPE__
13382 summary: create or update an existing service-subscription
13384 Create or update an existing service-subscription.
13386 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13387 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
13396 description: Response codes found in [response codes](https://wiki.onap.org/).
13398 - name: global-customer-id
13400 description: Global customer id used across ECOMP to uniquely identify customer.
13403 example: __GLOBAL-CUSTOMER-ID__
13404 - name: service-type
13406 description: Value defined by orchestration to identify this service across ECOMP.
13409 example: __SERVICE-TYPE__
13412 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
13415 $ref: "#/definitions/service-subscription"
13419 summary: update an existing service-subscription
13421 Update an existing service-subscription
13423 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13424 The PUT operation will entirely replace an existing object.
13425 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13427 Other differences between PUT and PATCH are:
13429 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13430 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13431 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13432 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
13441 description: Response codes found in [response codes](https://wiki.onap.org/).
13443 - name: global-customer-id
13445 description: Global customer id used across ECOMP to uniquely identify customer.
13448 example: __GLOBAL-CUSTOMER-ID__
13449 - name: service-type
13451 description: Value defined by orchestration to identify this service across ECOMP.
13454 example: __SERVICE-TYPE__
13457 description: service-subscription object that needs to be updated.
13460 $ref: "#/patchDefinitions/service-subscription"
13464 summary: delete an existing service-subscription
13465 description: delete an existing service-subscription
13466 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
13475 description: Response codes found in [response codes](https://wiki.onap.org/).
13477 - name: global-customer-id
13479 description: Global customer id used across ECOMP to uniquely identify customer.
13482 example: __GLOBAL-CUSTOMER-ID__
13483 - name: service-type
13485 description: Value defined by orchestration to identify this service across ECOMP.
13488 example: __SERVICE-TYPE__
13489 - name: resource-version
13491 description: resource-version for concurrency
13494 /business/customers/customer/{global-customer-id}/service-subscriptions:
13498 summary: returns service-subscriptions
13499 description: returns service-subscriptions
13500 operationId: getBusinessCustomersCustomerServiceSubscriptions
13506 description: successful operation
13508 $ref: "#/getDefinitions/service-subscriptions"
13510 description: Response codes found in [response codes](https://wiki.onap.org/).
13512 - name: global-customer-id
13514 description: Global customer id used across ECOMP to uniquely identify customer.
13517 example: __GLOBAL-CUSTOMER-ID__
13518 - name: service-type
13523 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
13527 summary: see node definition for valid relationships
13528 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
13537 description: Response codes found in [response codes](https://wiki.onap.org/).
13539 - name: global-customer-id
13541 description: Global customer id used across ECOMP to uniquely identify customer.
13544 example: __GLOBAL-CUSTOMER-ID__
13547 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
13550 $ref: "#/definitions/relationship"
13554 summary: delete an existing relationship
13555 description: delete an existing relationship
13556 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
13565 description: Response codes found in [response codes](https://wiki.onap.org/).
13567 - name: global-customer-id
13569 description: Global customer id used across ECOMP to uniquely identify customer.
13572 example: __GLOBAL-CUSTOMER-ID__
13573 /business/customers/customer/{global-customer-id}:
13577 summary: returns customer
13578 description: returns customer
13579 operationId: getBusinessCustomersCustomer
13585 description: successful operation
13587 $ref: "#/getDefinitions/customer"
13589 description: Response codes found in [response codes](https://wiki.onap.org/).
13591 - name: global-customer-id
13593 description: Global customer id used across ECOMP to uniquely identify customer.
13596 example: __GLOBAL-CUSTOMER-ID__
13600 summary: create or update an existing customer
13602 Create or update an existing customer.
13604 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13605 operationId: createOrUpdateBusinessCustomersCustomer
13614 description: Response codes found in [response codes](https://wiki.onap.org/).
13616 - name: global-customer-id
13618 description: Global customer id used across ECOMP to uniquely identify customer.
13621 example: __GLOBAL-CUSTOMER-ID__
13624 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
13627 $ref: "#/definitions/customer"
13631 summary: update an existing customer
13633 Update an existing customer
13635 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13636 The PUT operation will entirely replace an existing object.
13637 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13639 Other differences between PUT and PATCH are:
13641 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13642 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13643 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13644 operationId: UpdateBusinessCustomersCustomer
13653 description: Response codes found in [response codes](https://wiki.onap.org/).
13655 - name: global-customer-id
13657 description: Global customer id used across ECOMP to uniquely identify customer.
13660 example: __GLOBAL-CUSTOMER-ID__
13663 description: customer object that needs to be updated.
13666 $ref: "#/patchDefinitions/customer"
13670 summary: delete an existing customer
13671 description: delete an existing customer
13672 operationId: deleteBusinessCustomersCustomer
13681 description: Response codes found in [response codes](https://wiki.onap.org/).
13683 - name: global-customer-id
13685 description: Global customer id used across ECOMP to uniquely identify customer.
13688 example: __GLOBAL-CUSTOMER-ID__
13689 - name: resource-version
13691 description: resource-version for concurrency
13694 /business/customers:
13698 summary: returns customers
13699 description: returns customers
13700 operationId: getBusinessCustomers
13706 description: successful operation
13708 $ref: "#/getDefinitions/customers"
13710 description: Response codes found in [response codes](https://wiki.onap.org/).
13712 - name: global-customer-id
13717 - name: subscriber-name
13722 - name: subscriber-type
13727 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
13730 - ServiceDesignAndCreation
13731 summary: see node definition for valid relationships
13732 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
13741 description: Response codes found in [response codes](https://wiki.onap.org/).
13743 - name: vnf-image-uuid
13745 description: Unique ID of this asset
13748 example: __VNF-IMAGE-UUID__
13751 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
13754 $ref: "#/definitions/relationship"
13757 - ServiceDesignAndCreation
13758 summary: delete an existing relationship
13759 description: delete an existing relationship
13760 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
13769 description: Response codes found in [response codes](https://wiki.onap.org/).
13771 - name: vnf-image-uuid
13773 description: Unique ID of this asset
13776 example: __VNF-IMAGE-UUID__
13777 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
13780 - ServiceDesignAndCreation
13781 summary: returns vnf-image
13782 description: returns vnf-image
13783 operationId: getServiceDesignAndCreationVnfImagesVnfImage
13789 description: successful operation
13791 $ref: "#/getDefinitions/vnf-image"
13793 description: Response codes found in [response codes](https://wiki.onap.org/).
13795 - name: vnf-image-uuid
13797 description: Unique ID of this asset
13800 example: __VNF-IMAGE-UUID__
13803 - ServiceDesignAndCreation
13804 summary: create or update an existing vnf-image
13806 Create or update an existing vnf-image.
13808 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13809 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
13818 description: Response codes found in [response codes](https://wiki.onap.org/).
13820 - name: vnf-image-uuid
13822 description: Unique ID of this asset
13825 example: __VNF-IMAGE-UUID__
13828 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
13831 $ref: "#/definitions/vnf-image"
13834 - ServiceDesignAndCreation
13835 summary: update an existing vnf-image
13837 Update an existing vnf-image
13839 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13840 The PUT operation will entirely replace an existing object.
13841 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13843 Other differences between PUT and PATCH are:
13845 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13846 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13847 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13848 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
13857 description: Response codes found in [response codes](https://wiki.onap.org/).
13859 - name: vnf-image-uuid
13861 description: Unique ID of this asset
13864 example: __VNF-IMAGE-UUID__
13867 description: vnf-image object that needs to be updated.
13870 $ref: "#/patchDefinitions/vnf-image"
13873 - ServiceDesignAndCreation
13874 summary: delete an existing vnf-image
13875 description: delete an existing vnf-image
13876 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
13885 description: Response codes found in [response codes](https://wiki.onap.org/).
13887 - name: vnf-image-uuid
13889 description: Unique ID of this asset
13892 example: __VNF-IMAGE-UUID__
13893 - name: resource-version
13895 description: resource-version for concurrency
13898 /service-design-and-creation/vnf-images:
13901 - ServiceDesignAndCreation
13902 summary: returns vnf-images
13903 description: returns vnf-images
13904 operationId: getServiceDesignAndCreationVnfImages
13910 description: successful operation
13912 $ref: "#/getDefinitions/vnf-images"
13914 description: Response codes found in [response codes](https://wiki.onap.org/).
13916 - name: vnf-image-uuid
13921 - name: application
13926 - name: application-vendor
13931 - name: application-version
13936 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
13939 - ServiceDesignAndCreation
13940 summary: see node definition for valid relationships
13941 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
13950 description: Response codes found in [response codes](https://wiki.onap.org/).
13954 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
13957 example: __SERVICE-ID__
13960 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
13963 $ref: "#/definitions/relationship"
13966 - ServiceDesignAndCreation
13967 summary: delete an existing relationship
13968 description: delete an existing relationship
13969 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
13978 description: Response codes found in [response codes](https://wiki.onap.org/).
13982 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
13985 example: __SERVICE-ID__
13986 /service-design-and-creation/services/service/{service-id}:
13989 - ServiceDesignAndCreation
13990 summary: returns service
13991 description: returns service
13992 operationId: getServiceDesignAndCreationServicesService
13998 description: successful operation
14000 $ref: "#/getDefinitions/service"
14002 description: Response codes found in [response codes](https://wiki.onap.org/).
14006 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14009 example: __SERVICE-ID__
14012 - ServiceDesignAndCreation
14013 summary: create or update an existing service
14015 Create or update an existing service.
14017 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14018 operationId: createOrUpdateServiceDesignAndCreationServicesService
14027 description: Response codes found in [response codes](https://wiki.onap.org/).
14031 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14034 example: __SERVICE-ID__
14037 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
14040 $ref: "#/definitions/service"
14043 - ServiceDesignAndCreation
14044 summary: update an existing service
14046 Update an existing service
14048 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14049 The PUT operation will entirely replace an existing object.
14050 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14052 Other differences between PUT and PATCH are:
14054 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14055 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14056 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14057 operationId: UpdateServiceDesignAndCreationServicesService
14066 description: Response codes found in [response codes](https://wiki.onap.org/).
14070 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14073 example: __SERVICE-ID__
14076 description: service object that needs to be updated.
14079 $ref: "#/patchDefinitions/service"
14082 - ServiceDesignAndCreation
14083 summary: delete an existing service
14084 description: delete an existing service
14085 operationId: deleteServiceDesignAndCreationServicesService
14094 description: Response codes found in [response codes](https://wiki.onap.org/).
14098 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14101 example: __SERVICE-ID__
14102 - name: resource-version
14104 description: resource-version for concurrency
14107 /service-design-and-creation/services:
14110 - ServiceDesignAndCreation
14111 summary: returns services
14112 description: returns services
14113 operationId: getServiceDesignAndCreationServices
14119 description: successful operation
14121 $ref: "#/getDefinitions/services"
14123 description: Response codes found in [response codes](https://wiki.onap.org/).
14130 - name: service-description
14135 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
14138 - ServiceDesignAndCreation
14139 summary: see node definition for valid relationships
14140 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14149 description: Response codes found in [response codes](https://wiki.onap.org/).
14151 - name: service-type
14153 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14156 example: __SERVICE-TYPE__
14159 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
14162 example: __VNF-TYPE__
14165 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14168 $ref: "#/definitions/relationship"
14171 - ServiceDesignAndCreation
14172 summary: delete an existing relationship
14173 description: delete an existing relationship
14174 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14183 description: Response codes found in [response codes](https://wiki.onap.org/).
14185 - name: service-type
14187 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14190 example: __SERVICE-TYPE__
14193 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
14196 example: __VNF-TYPE__
14197 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
14200 - ServiceDesignAndCreation
14201 summary: returns service-capability
14202 description: returns service-capability
14203 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
14209 description: successful operation
14211 $ref: "#/getDefinitions/service-capability"
14213 description: Response codes found in [response codes](https://wiki.onap.org/).
14215 - name: service-type
14217 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14220 example: __SERVICE-TYPE__
14223 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
14226 example: __VNF-TYPE__
14229 - ServiceDesignAndCreation
14230 summary: create or update an existing service-capability
14232 Create or update an existing service-capability.
14234 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14235 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14244 description: Response codes found in [response codes](https://wiki.onap.org/).
14246 - name: service-type
14248 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14251 example: __SERVICE-TYPE__
14254 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
14257 example: __VNF-TYPE__
14260 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14263 $ref: "#/definitions/service-capability"
14266 - ServiceDesignAndCreation
14267 summary: update an existing service-capability
14269 Update an existing service-capability
14271 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14272 The PUT operation will entirely replace an existing object.
14273 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14275 Other differences between PUT and PATCH are:
14277 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14278 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14279 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14280 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14289 description: Response codes found in [response codes](https://wiki.onap.org/).
14291 - name: service-type
14293 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14296 example: __SERVICE-TYPE__
14299 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
14302 example: __VNF-TYPE__
14305 description: service-capability object that needs to be updated.
14308 $ref: "#/patchDefinitions/service-capability"
14311 - ServiceDesignAndCreation
14312 summary: delete an existing service-capability
14313 description: delete an existing service-capability
14314 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
14323 description: Response codes found in [response codes](https://wiki.onap.org/).
14325 - name: service-type
14327 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14330 example: __SERVICE-TYPE__
14333 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
14336 example: __VNF-TYPE__
14337 - name: resource-version
14339 description: resource-version for concurrency
14342 /service-design-and-creation/service-capabilities:
14345 - ServiceDesignAndCreation
14346 summary: returns service-capabilities
14347 description: returns service-capabilities
14348 operationId: getServiceDesignAndCreationServiceCapabilities
14354 description: successful operation
14356 $ref: "#/getDefinitions/service-capabilities"
14358 description: Response codes found in [response codes](https://wiki.onap.org/).
14360 - name: service-type
14370 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
14373 - ServiceDesignAndCreation
14374 summary: see node definition for valid relationships
14375 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
14384 description: Response codes found in [response codes](https://wiki.onap.org/).
14386 - name: model-name-version-id
14388 description: Unique identifier corresponding to one version of a model in ASDC
14391 example: __MODEL-NAME-VERSION-ID__
14392 - name: model-element-uuid
14396 example: __MODEL-ELEMENT-UUID__
14397 - name: model-constraint-uuid
14401 example: __MODEL-CONSTRAINT-UUID__
14402 - name: constrained-element-set-uuid
14406 example: __CONSTRAINED-ELEMENT-SET-UUID__
14407 - name: element-choice-set-uuid
14411 example: __ELEMENT-CHOICE-SET-UUID__
14414 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
14417 $ref: "#/definitions/relationship"
14420 - ServiceDesignAndCreation
14421 summary: delete an existing relationship
14422 description: delete an existing relationship
14423 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
14432 description: Response codes found in [response codes](https://wiki.onap.org/).
14434 - name: model-name-version-id
14436 description: Unique identifier corresponding to one version of a model in ASDC
14439 example: __MODEL-NAME-VERSION-ID__
14440 - name: model-element-uuid
14444 example: __MODEL-ELEMENT-UUID__
14445 - name: model-constraint-uuid
14449 example: __MODEL-CONSTRAINT-UUID__
14450 - name: constrained-element-set-uuid
14454 example: __CONSTRAINED-ELEMENT-SET-UUID__
14455 - name: element-choice-set-uuid
14459 example: __ELEMENT-CHOICE-SET-UUID__
14460 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
14463 - ServiceDesignAndCreation
14464 summary: returns element-choice-set
14465 description: returns element-choice-set
14466 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
14472 description: successful operation
14474 $ref: "#/getDefinitions/element-choice-set"
14476 description: Response codes found in [response codes](https://wiki.onap.org/).
14478 - name: model-name-version-id
14480 description: Unique identifier corresponding to one version of a model in ASDC
14483 example: __MODEL-NAME-VERSION-ID__
14484 - name: model-element-uuid
14488 example: __MODEL-ELEMENT-UUID__
14489 - name: model-constraint-uuid
14493 example: __MODEL-CONSTRAINT-UUID__
14494 - name: constrained-element-set-uuid
14498 example: __CONSTRAINED-ELEMENT-SET-UUID__
14499 - name: element-choice-set-uuid
14503 example: __ELEMENT-CHOICE-SET-UUID__
14506 - ServiceDesignAndCreation
14507 summary: create or update an existing element-choice-set
14509 Create or update an existing element-choice-set.
14511 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14512 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
14521 description: Response codes found in [response codes](https://wiki.onap.org/).
14523 - name: model-name-version-id
14525 description: Unique identifier corresponding to one version of a model in ASDC
14528 example: __MODEL-NAME-VERSION-ID__
14529 - name: model-element-uuid
14533 example: __MODEL-ELEMENT-UUID__
14534 - name: model-constraint-uuid
14538 example: __MODEL-CONSTRAINT-UUID__
14539 - name: constrained-element-set-uuid
14543 example: __CONSTRAINED-ELEMENT-SET-UUID__
14544 - name: element-choice-set-uuid
14548 example: __ELEMENT-CHOICE-SET-UUID__
14551 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
14554 $ref: "#/definitions/element-choice-set"
14557 - ServiceDesignAndCreation
14558 summary: update an existing element-choice-set
14560 Update an existing element-choice-set
14562 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14563 The PUT operation will entirely replace an existing object.
14564 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14566 Other differences between PUT and PATCH are:
14568 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14569 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14570 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14571 operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
14580 description: Response codes found in [response codes](https://wiki.onap.org/).
14582 - name: model-name-version-id
14584 description: Unique identifier corresponding to one version of a model in ASDC
14587 example: __MODEL-NAME-VERSION-ID__
14588 - name: model-element-uuid
14592 example: __MODEL-ELEMENT-UUID__
14593 - name: model-constraint-uuid
14597 example: __MODEL-CONSTRAINT-UUID__
14598 - name: constrained-element-set-uuid
14602 example: __CONSTRAINED-ELEMENT-SET-UUID__
14603 - name: element-choice-set-uuid
14607 example: __ELEMENT-CHOICE-SET-UUID__
14610 description: element-choice-set object that needs to be updated.
14613 $ref: "#/patchDefinitions/element-choice-set"
14616 - ServiceDesignAndCreation
14617 summary: delete an existing element-choice-set
14618 description: delete an existing element-choice-set
14619 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
14628 description: Response codes found in [response codes](https://wiki.onap.org/).
14630 - name: model-name-version-id
14632 description: Unique identifier corresponding to one version of a model in ASDC
14635 example: __MODEL-NAME-VERSION-ID__
14636 - name: model-element-uuid
14640 example: __MODEL-ELEMENT-UUID__
14641 - name: model-constraint-uuid
14645 example: __MODEL-CONSTRAINT-UUID__
14646 - name: constrained-element-set-uuid
14650 example: __CONSTRAINED-ELEMENT-SET-UUID__
14651 - name: element-choice-set-uuid
14655 example: __ELEMENT-CHOICE-SET-UUID__
14656 - name: resource-version
14658 description: resource-version for concurrency
14661 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
14664 - ServiceDesignAndCreation
14665 summary: returns element-choice-sets
14666 description: returns element-choice-sets
14667 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
14673 description: successful operation
14675 $ref: "#/getDefinitions/element-choice-sets"
14677 description: Response codes found in [response codes](https://wiki.onap.org/).
14679 - name: model-name-version-id
14681 description: Unique identifier corresponding to one version of a model in ASDC
14684 example: __MODEL-NAME-VERSION-ID__
14685 - name: model-element-uuid
14689 example: __MODEL-ELEMENT-UUID__
14690 - name: model-constraint-uuid
14694 example: __MODEL-CONSTRAINT-UUID__
14695 - name: constrained-element-set-uuid
14699 example: __CONSTRAINED-ELEMENT-SET-UUID__
14700 - name: element-choice-set-uuid
14705 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
14708 - ServiceDesignAndCreation
14709 summary: see node definition for valid relationships
14710 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
14719 description: Response codes found in [response codes](https://wiki.onap.org/).
14721 - name: model-name-version-id
14723 description: Unique identifier corresponding to one version of a model in ASDC
14726 example: __MODEL-NAME-VERSION-ID__
14727 - name: model-element-uuid
14731 example: __MODEL-ELEMENT-UUID__
14732 - name: model-constraint-uuid
14736 example: __MODEL-CONSTRAINT-UUID__
14737 - name: constrained-element-set-uuid
14741 example: __CONSTRAINED-ELEMENT-SET-UUID__
14744 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
14747 $ref: "#/definitions/relationship"
14750 - ServiceDesignAndCreation
14751 summary: delete an existing relationship
14752 description: delete an existing relationship
14753 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
14762 description: Response codes found in [response codes](https://wiki.onap.org/).
14764 - name: model-name-version-id
14766 description: Unique identifier corresponding to one version of a model in ASDC
14769 example: __MODEL-NAME-VERSION-ID__
14770 - name: model-element-uuid
14774 example: __MODEL-ELEMENT-UUID__
14775 - name: model-constraint-uuid
14779 example: __MODEL-CONSTRAINT-UUID__
14780 - name: constrained-element-set-uuid
14784 example: __CONSTRAINED-ELEMENT-SET-UUID__
14785 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
14788 - ServiceDesignAndCreation
14789 summary: returns constrained-element-set
14790 description: returns constrained-element-set
14791 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
14797 description: successful operation
14799 $ref: "#/getDefinitions/constrained-element-set"
14801 description: Response codes found in [response codes](https://wiki.onap.org/).
14803 - name: model-name-version-id
14805 description: Unique identifier corresponding to one version of a model in ASDC
14808 example: __MODEL-NAME-VERSION-ID__
14809 - name: model-element-uuid
14813 example: __MODEL-ELEMENT-UUID__
14814 - name: model-constraint-uuid
14818 example: __MODEL-CONSTRAINT-UUID__
14819 - name: constrained-element-set-uuid
14823 example: __CONSTRAINED-ELEMENT-SET-UUID__
14826 - ServiceDesignAndCreation
14827 summary: create or update an existing constrained-element-set
14829 Create or update an existing constrained-element-set.
14831 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14832 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
14841 description: Response codes found in [response codes](https://wiki.onap.org/).
14843 - name: model-name-version-id
14845 description: Unique identifier corresponding to one version of a model in ASDC
14848 example: __MODEL-NAME-VERSION-ID__
14849 - name: model-element-uuid
14853 example: __MODEL-ELEMENT-UUID__
14854 - name: model-constraint-uuid
14858 example: __MODEL-CONSTRAINT-UUID__
14859 - name: constrained-element-set-uuid
14863 example: __CONSTRAINED-ELEMENT-SET-UUID__
14866 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
14869 $ref: "#/definitions/constrained-element-set"
14872 - ServiceDesignAndCreation
14873 summary: update an existing constrained-element-set
14875 Update an existing constrained-element-set
14877 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14878 The PUT operation will entirely replace an existing object.
14879 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14881 Other differences between PUT and PATCH are:
14883 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14884 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14885 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14886 operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
14895 description: Response codes found in [response codes](https://wiki.onap.org/).
14897 - name: model-name-version-id
14899 description: Unique identifier corresponding to one version of a model in ASDC
14902 example: __MODEL-NAME-VERSION-ID__
14903 - name: model-element-uuid
14907 example: __MODEL-ELEMENT-UUID__
14908 - name: model-constraint-uuid
14912 example: __MODEL-CONSTRAINT-UUID__
14913 - name: constrained-element-set-uuid
14917 example: __CONSTRAINED-ELEMENT-SET-UUID__
14920 description: constrained-element-set object that needs to be updated.
14923 $ref: "#/patchDefinitions/constrained-element-set"
14926 - ServiceDesignAndCreation
14927 summary: delete an existing constrained-element-set
14928 description: delete an existing constrained-element-set
14929 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
14938 description: Response codes found in [response codes](https://wiki.onap.org/).
14940 - name: model-name-version-id
14942 description: Unique identifier corresponding to one version of a model in ASDC
14945 example: __MODEL-NAME-VERSION-ID__
14946 - name: model-element-uuid
14950 example: __MODEL-ELEMENT-UUID__
14951 - name: model-constraint-uuid
14955 example: __MODEL-CONSTRAINT-UUID__
14956 - name: constrained-element-set-uuid
14960 example: __CONSTRAINED-ELEMENT-SET-UUID__
14961 - name: resource-version
14963 description: resource-version for concurrency
14966 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
14969 - ServiceDesignAndCreation
14970 summary: returns constrained-element-sets
14971 description: returns constrained-element-sets
14972 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
14978 description: successful operation
14980 $ref: "#/getDefinitions/constrained-element-sets"
14982 description: Response codes found in [response codes](https://wiki.onap.org/).
14984 - name: model-name-version-id
14986 description: Unique identifier corresponding to one version of a model in ASDC
14989 example: __MODEL-NAME-VERSION-ID__
14990 - name: model-element-uuid
14994 example: __MODEL-ELEMENT-UUID__
14995 - name: model-constraint-uuid
14999 example: __MODEL-CONSTRAINT-UUID__
15000 - name: constrained-element-set-uuid
15005 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
15008 - ServiceDesignAndCreation
15009 summary: returns model-constraint
15010 description: returns model-constraint
15011 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
15017 description: successful operation
15019 $ref: "#/getDefinitions/model-constraint"
15021 description: Response codes found in [response codes](https://wiki.onap.org/).
15023 - name: model-name-version-id
15025 description: Unique identifier corresponding to one version of a model in ASDC
15028 example: __MODEL-NAME-VERSION-ID__
15029 - name: model-element-uuid
15033 example: __MODEL-ELEMENT-UUID__
15034 - name: model-constraint-uuid
15038 example: __MODEL-CONSTRAINT-UUID__
15041 - ServiceDesignAndCreation
15042 summary: create or update an existing model-constraint
15044 Create or update an existing model-constraint.
15046 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15047 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
15056 description: Response codes found in [response codes](https://wiki.onap.org/).
15058 - name: model-name-version-id
15060 description: Unique identifier corresponding to one version of a model in ASDC
15063 example: __MODEL-NAME-VERSION-ID__
15064 - name: model-element-uuid
15068 example: __MODEL-ELEMENT-UUID__
15069 - name: model-constraint-uuid
15073 example: __MODEL-CONSTRAINT-UUID__
15076 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint.json)
15079 $ref: "#/definitions/model-constraint"
15082 - ServiceDesignAndCreation
15083 summary: update an existing model-constraint
15085 Update an existing model-constraint
15087 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15088 The PUT operation will entirely replace an existing object.
15089 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15091 Other differences between PUT and PATCH are:
15093 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15094 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15095 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15096 operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
15105 description: Response codes found in [response codes](https://wiki.onap.org/).
15107 - name: model-name-version-id
15109 description: Unique identifier corresponding to one version of a model in ASDC
15112 example: __MODEL-NAME-VERSION-ID__
15113 - name: model-element-uuid
15117 example: __MODEL-ELEMENT-UUID__
15118 - name: model-constraint-uuid
15122 example: __MODEL-CONSTRAINT-UUID__
15125 description: model-constraint object that needs to be updated.
15128 $ref: "#/patchDefinitions/model-constraint"
15131 - ServiceDesignAndCreation
15132 summary: delete an existing model-constraint
15133 description: delete an existing model-constraint
15134 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
15143 description: Response codes found in [response codes](https://wiki.onap.org/).
15145 - name: model-name-version-id
15147 description: Unique identifier corresponding to one version of a model in ASDC
15150 example: __MODEL-NAME-VERSION-ID__
15151 - name: model-element-uuid
15155 example: __MODEL-ELEMENT-UUID__
15156 - name: model-constraint-uuid
15160 example: __MODEL-CONSTRAINT-UUID__
15161 - name: resource-version
15163 description: resource-version for concurrency
15166 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
15169 - ServiceDesignAndCreation
15170 summary: returns model-constraints
15171 description: returns model-constraints
15172 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraints
15178 description: successful operation
15180 $ref: "#/getDefinitions/model-constraints"
15182 description: Response codes found in [response codes](https://wiki.onap.org/).
15184 - name: model-name-version-id
15186 description: Unique identifier corresponding to one version of a model in ASDC
15189 example: __MODEL-NAME-VERSION-ID__
15190 - name: model-element-uuid
15194 example: __MODEL-ELEMENT-UUID__
15195 - name: model-constraint-uuid
15200 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
15203 - ServiceDesignAndCreation
15204 summary: see node definition for valid relationships
15205 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementRelationshipListRelationship
15214 description: Response codes found in [response codes](https://wiki.onap.org/).
15216 - name: model-name-version-id
15218 description: Unique identifier corresponding to one version of a model in ASDC
15221 example: __MODEL-NAME-VERSION-ID__
15222 - name: model-element-uuid
15226 example: __MODEL-ELEMENT-UUID__
15229 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
15232 $ref: "#/definitions/relationship"
15235 - ServiceDesignAndCreation
15236 summary: delete an existing relationship
15237 description: delete an existing relationship
15238 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementRelationshipListRelationship
15247 description: Response codes found in [response codes](https://wiki.onap.org/).
15249 - name: model-name-version-id
15251 description: Unique identifier corresponding to one version of a model in ASDC
15254 example: __MODEL-NAME-VERSION-ID__
15255 - name: model-element-uuid
15259 example: __MODEL-ELEMENT-UUID__
15260 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}:
15263 - ServiceDesignAndCreation
15264 summary: returns model-element
15265 description: returns model-element
15266 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElement
15272 description: successful operation
15274 $ref: "#/getDefinitions/model-element"
15276 description: Response codes found in [response codes](https://wiki.onap.org/).
15278 - name: model-name-version-id
15280 description: Unique identifier corresponding to one version of a model in ASDC
15283 example: __MODEL-NAME-VERSION-ID__
15284 - name: model-element-uuid
15288 example: __MODEL-ELEMENT-UUID__
15291 - ServiceDesignAndCreation
15292 summary: create or update an existing model-element
15294 Create or update an existing model-element.
15296 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15297 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElement
15306 description: Response codes found in [response codes](https://wiki.onap.org/).
15308 - name: model-name-version-id
15310 description: Unique identifier corresponding to one version of a model in ASDC
15313 example: __MODEL-NAME-VERSION-ID__
15314 - name: model-element-uuid
15318 example: __MODEL-ELEMENT-UUID__
15321 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
15324 $ref: "#/definitions/model-element"
15327 - ServiceDesignAndCreation
15328 summary: update an existing model-element
15330 Update an existing model-element
15332 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15333 The PUT operation will entirely replace an existing object.
15334 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15336 Other differences between PUT and PATCH are:
15338 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15339 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15340 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15341 operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElement
15350 description: Response codes found in [response codes](https://wiki.onap.org/).
15352 - name: model-name-version-id
15354 description: Unique identifier corresponding to one version of a model in ASDC
15357 example: __MODEL-NAME-VERSION-ID__
15358 - name: model-element-uuid
15362 example: __MODEL-ELEMENT-UUID__
15365 description: model-element object that needs to be updated.
15368 $ref: "#/patchDefinitions/model-element"
15371 - ServiceDesignAndCreation
15372 summary: delete an existing model-element
15373 description: delete an existing model-element
15374 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElement
15383 description: Response codes found in [response codes](https://wiki.onap.org/).
15385 - name: model-name-version-id
15387 description: Unique identifier corresponding to one version of a model in ASDC
15390 example: __MODEL-NAME-VERSION-ID__
15391 - name: model-element-uuid
15395 example: __MODEL-ELEMENT-UUID__
15396 - name: resource-version
15398 description: resource-version for concurrency
15401 /service-design-and-creation/models/model/{model-name-version-id}/model-elements:
15404 - ServiceDesignAndCreation
15405 summary: returns model-elements
15406 description: returns model-elements
15407 operationId: getServiceDesignAndCreationModelsModelModelElements
15413 description: successful operation
15415 $ref: "#/getDefinitions/model-elements"
15417 description: Response codes found in [response codes](https://wiki.onap.org/).
15419 - name: model-name-version-id
15421 description: Unique identifier corresponding to one version of a model in ASDC
15424 example: __MODEL-NAME-VERSION-ID__
15425 - name: model-element-uuid
15430 /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}:
15433 - ServiceDesignAndCreation
15434 summary: returns metadatum
15435 description: returns metadatum
15436 operationId: getServiceDesignAndCreationModelsModelMetadataMetadatum
15442 description: successful operation
15444 $ref: "#/getDefinitions/metadatum"
15446 description: Response codes found in [response codes](https://wiki.onap.org/).
15448 - name: model-name-version-id
15450 description: Unique identifier corresponding to one version of a model in ASDC
15453 example: __MODEL-NAME-VERSION-ID__
15458 example: __METANAME__
15461 - ServiceDesignAndCreation
15462 summary: create or update an existing metadatum
15464 Create or update an existing metadatum.
15466 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15467 operationId: createOrUpdateServiceDesignAndCreationModelsModelMetadataMetadatum
15476 description: Response codes found in [response codes](https://wiki.onap.org/).
15478 - name: model-name-version-id
15480 description: Unique identifier corresponding to one version of a model in ASDC
15483 example: __MODEL-NAME-VERSION-ID__
15488 example: __METANAME__
15491 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelMetadataMetadatum.json)
15494 $ref: "#/definitions/metadatum"
15497 - ServiceDesignAndCreation
15498 summary: update an existing metadatum
15500 Update an existing metadatum
15502 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15503 The PUT operation will entirely replace an existing object.
15504 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15506 Other differences between PUT and PATCH are:
15508 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15509 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15510 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15511 operationId: UpdateServiceDesignAndCreationModelsModelMetadataMetadatum
15520 description: Response codes found in [response codes](https://wiki.onap.org/).
15522 - name: model-name-version-id
15524 description: Unique identifier corresponding to one version of a model in ASDC
15527 example: __MODEL-NAME-VERSION-ID__
15532 example: __METANAME__
15535 description: metadatum object that needs to be updated.
15538 $ref: "#/patchDefinitions/metadatum"
15541 - ServiceDesignAndCreation
15542 summary: delete an existing metadatum
15543 description: delete an existing metadatum
15544 operationId: deleteServiceDesignAndCreationModelsModelMetadataMetadatum
15553 description: Response codes found in [response codes](https://wiki.onap.org/).
15555 - name: model-name-version-id
15557 description: Unique identifier corresponding to one version of a model in ASDC
15560 example: __MODEL-NAME-VERSION-ID__
15565 example: __METANAME__
15566 - name: resource-version
15568 description: resource-version for concurrency
15571 /service-design-and-creation/models/model/{model-name-version-id}/metadata:
15574 - ServiceDesignAndCreation
15575 summary: returns metadata
15576 description: returns metadata
15577 operationId: getServiceDesignAndCreationModelsModelMetadata
15583 description: successful operation
15585 $ref: "#/getDefinitions/metadata"
15587 description: Response codes found in [response codes](https://wiki.onap.org/).
15589 - name: model-name-version-id
15591 description: Unique identifier corresponding to one version of a model in ASDC
15594 example: __MODEL-NAME-VERSION-ID__
15600 /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship:
15603 - ServiceDesignAndCreation
15604 summary: see node definition for valid relationships
15605 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
15614 description: Response codes found in [response codes](https://wiki.onap.org/).
15616 - name: model-name-version-id
15618 description: Unique identifier corresponding to one version of a model in ASDC
15621 example: __MODEL-NAME-VERSION-ID__
15624 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
15627 $ref: "#/definitions/relationship"
15630 - ServiceDesignAndCreation
15631 summary: delete an existing relationship
15632 description: delete an existing relationship
15633 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
15642 description: Response codes found in [response codes](https://wiki.onap.org/).
15644 - name: model-name-version-id
15646 description: Unique identifier corresponding to one version of a model in ASDC
15649 example: __MODEL-NAME-VERSION-ID__
15650 /service-design-and-creation/models/model/{model-name-version-id}:
15653 - ServiceDesignAndCreation
15654 summary: returns model
15655 description: returns model
15656 operationId: getServiceDesignAndCreationModelsModel
15662 description: successful operation
15664 $ref: "#/getDefinitions/model"
15666 description: Response codes found in [response codes](https://wiki.onap.org/).
15668 - name: model-name-version-id
15670 description: Unique identifier corresponding to one version of a model in ASDC
15673 example: __MODEL-NAME-VERSION-ID__
15676 - ServiceDesignAndCreation
15677 summary: create or update an existing model
15679 Create or update an existing model.
15681 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15682 operationId: createOrUpdateServiceDesignAndCreationModelsModel
15691 description: Response codes found in [response codes](https://wiki.onap.org/).
15693 - name: model-name-version-id
15695 description: Unique identifier corresponding to one version of a model in ASDC
15698 example: __MODEL-NAME-VERSION-ID__
15701 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
15704 $ref: "#/definitions/model"
15707 - ServiceDesignAndCreation
15708 summary: update an existing model
15710 Update an existing model
15712 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15713 The PUT operation will entirely replace an existing object.
15714 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15716 Other differences between PUT and PATCH are:
15718 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15719 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15720 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15721 operationId: UpdateServiceDesignAndCreationModelsModel
15730 description: Response codes found in [response codes](https://wiki.onap.org/).
15732 - name: model-name-version-id
15734 description: Unique identifier corresponding to one version of a model in ASDC
15737 example: __MODEL-NAME-VERSION-ID__
15740 description: model object that needs to be updated.
15743 $ref: "#/patchDefinitions/model"
15746 - ServiceDesignAndCreation
15747 summary: delete an existing model
15748 description: delete an existing model
15749 operationId: deleteServiceDesignAndCreationModelsModel
15758 description: Response codes found in [response codes](https://wiki.onap.org/).
15760 - name: model-name-version-id
15762 description: Unique identifier corresponding to one version of a model in ASDC
15765 example: __MODEL-NAME-VERSION-ID__
15766 - name: resource-version
15768 description: resource-version for concurrency
15771 /service-design-and-creation/models:
15774 - ServiceDesignAndCreation
15775 summary: returns models
15776 description: returns models
15777 operationId: getServiceDesignAndCreationModels
15783 description: successful operation
15785 $ref: "#/getDefinitions/models"
15787 description: Response codes found in [response codes](https://wiki.onap.org/).
15789 - name: model-name-version-id
15809 - name: model-version
15814 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship:
15817 - ServiceDesignAndCreation
15818 summary: see node definition for valid relationships
15819 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
15828 description: Response codes found in [response codes](https://wiki.onap.org/).
15830 - name: named-query-uuid
15834 example: __NAMED-QUERY-UUID__
15835 - name: named-query-element-uuid
15839 example: __NAMED-QUERY-ELEMENT-UUID__
15840 - name: related-lookup-uuid
15844 example: __RELATED-LOOKUP-UUID__
15847 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
15850 $ref: "#/definitions/relationship"
15853 - ServiceDesignAndCreation
15854 summary: delete an existing relationship
15855 description: delete an existing relationship
15856 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
15865 description: Response codes found in [response codes](https://wiki.onap.org/).
15867 - name: named-query-uuid
15871 example: __NAMED-QUERY-UUID__
15872 - name: named-query-element-uuid
15876 example: __NAMED-QUERY-ELEMENT-UUID__
15877 - name: related-lookup-uuid
15881 example: __RELATED-LOOKUP-UUID__
15882 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}:
15885 - ServiceDesignAndCreation
15886 summary: returns related-lookup
15887 description: returns related-lookup
15888 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
15894 description: successful operation
15896 $ref: "#/getDefinitions/related-lookup"
15898 description: Response codes found in [response codes](https://wiki.onap.org/).
15900 - name: named-query-uuid
15904 example: __NAMED-QUERY-UUID__
15905 - name: named-query-element-uuid
15909 example: __NAMED-QUERY-ELEMENT-UUID__
15910 - name: related-lookup-uuid
15914 example: __RELATED-LOOKUP-UUID__
15917 - ServiceDesignAndCreation
15918 summary: create or update an existing related-lookup
15920 Create or update an existing related-lookup.
15922 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15923 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
15932 description: Response codes found in [response codes](https://wiki.onap.org/).
15934 - name: named-query-uuid
15938 example: __NAMED-QUERY-UUID__
15939 - name: named-query-element-uuid
15943 example: __NAMED-QUERY-ELEMENT-UUID__
15944 - name: related-lookup-uuid
15948 example: __RELATED-LOOKUP-UUID__
15951 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
15954 $ref: "#/definitions/related-lookup"
15957 - ServiceDesignAndCreation
15958 summary: update an existing related-lookup
15960 Update an existing related-lookup
15962 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15963 The PUT operation will entirely replace an existing object.
15964 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15966 Other differences between PUT and PATCH are:
15968 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15969 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15970 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15971 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
15980 description: Response codes found in [response codes](https://wiki.onap.org/).
15982 - name: named-query-uuid
15986 example: __NAMED-QUERY-UUID__
15987 - name: named-query-element-uuid
15991 example: __NAMED-QUERY-ELEMENT-UUID__
15992 - name: related-lookup-uuid
15996 example: __RELATED-LOOKUP-UUID__
15999 description: related-lookup object that needs to be updated.
16002 $ref: "#/patchDefinitions/related-lookup"
16005 - ServiceDesignAndCreation
16006 summary: delete an existing related-lookup
16007 description: delete an existing related-lookup
16008 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
16017 description: Response codes found in [response codes](https://wiki.onap.org/).
16019 - name: named-query-uuid
16023 example: __NAMED-QUERY-UUID__
16024 - name: named-query-element-uuid
16028 example: __NAMED-QUERY-ELEMENT-UUID__
16029 - name: related-lookup-uuid
16033 example: __RELATED-LOOKUP-UUID__
16034 - name: resource-version
16036 description: resource-version for concurrency
16039 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
16042 - ServiceDesignAndCreation
16043 summary: returns related-lookups
16044 description: returns related-lookups
16045 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
16051 description: successful operation
16053 $ref: "#/getDefinitions/related-lookups"
16055 description: Response codes found in [response codes](https://wiki.onap.org/).
16057 - name: named-query-uuid
16061 example: __NAMED-QUERY-UUID__
16062 - name: named-query-element-uuid
16066 example: __NAMED-QUERY-ELEMENT-UUID__
16067 - name: related-lookup-uuid
16072 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}:
16075 - ServiceDesignAndCreation
16076 summary: returns property-constraint
16077 description: returns property-constraint
16078 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
16084 description: successful operation
16086 $ref: "#/getDefinitions/property-constraint"
16088 description: Response codes found in [response codes](https://wiki.onap.org/).
16090 - name: named-query-uuid
16094 example: __NAMED-QUERY-UUID__
16095 - name: named-query-element-uuid
16099 example: __NAMED-QUERY-ELEMENT-UUID__
16100 - name: property-constraint-uuid
16104 example: __PROPERTY-CONSTRAINT-UUID__
16107 - ServiceDesignAndCreation
16108 summary: create or update an existing property-constraint
16110 Create or update an existing property-constraint.
16112 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16113 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
16122 description: Response codes found in [response codes](https://wiki.onap.org/).
16124 - name: named-query-uuid
16128 example: __NAMED-QUERY-UUID__
16129 - name: named-query-element-uuid
16133 example: __NAMED-QUERY-ELEMENT-UUID__
16134 - name: property-constraint-uuid
16138 example: __PROPERTY-CONSTRAINT-UUID__
16141 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
16144 $ref: "#/definitions/property-constraint"
16147 - ServiceDesignAndCreation
16148 summary: update an existing property-constraint
16150 Update an existing property-constraint
16152 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16153 The PUT operation will entirely replace an existing object.
16154 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16156 Other differences between PUT and PATCH are:
16158 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16159 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16160 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16161 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
16170 description: Response codes found in [response codes](https://wiki.onap.org/).
16172 - name: named-query-uuid
16176 example: __NAMED-QUERY-UUID__
16177 - name: named-query-element-uuid
16181 example: __NAMED-QUERY-ELEMENT-UUID__
16182 - name: property-constraint-uuid
16186 example: __PROPERTY-CONSTRAINT-UUID__
16189 description: property-constraint object that needs to be updated.
16192 $ref: "#/patchDefinitions/property-constraint"
16195 - ServiceDesignAndCreation
16196 summary: delete an existing property-constraint
16197 description: delete an existing property-constraint
16198 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
16207 description: Response codes found in [response codes](https://wiki.onap.org/).
16209 - name: named-query-uuid
16213 example: __NAMED-QUERY-UUID__
16214 - name: named-query-element-uuid
16218 example: __NAMED-QUERY-ELEMENT-UUID__
16219 - name: property-constraint-uuid
16223 example: __PROPERTY-CONSTRAINT-UUID__
16224 - name: resource-version
16226 description: resource-version for concurrency
16229 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
16232 - ServiceDesignAndCreation
16233 summary: returns property-constraints
16234 description: returns property-constraints
16235 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
16241 description: successful operation
16243 $ref: "#/getDefinitions/property-constraints"
16245 description: Response codes found in [response codes](https://wiki.onap.org/).
16247 - name: named-query-uuid
16251 example: __NAMED-QUERY-UUID__
16252 - name: named-query-element-uuid
16256 example: __NAMED-QUERY-ELEMENT-UUID__
16257 - name: property-constraint-uuid
16262 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
16265 - ServiceDesignAndCreation
16266 summary: see node definition for valid relationships
16267 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
16276 description: Response codes found in [response codes](https://wiki.onap.org/).
16278 - name: named-query-uuid
16282 example: __NAMED-QUERY-UUID__
16283 - name: named-query-element-uuid
16287 example: __NAMED-QUERY-ELEMENT-UUID__
16290 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
16293 $ref: "#/definitions/relationship"
16296 - ServiceDesignAndCreation
16297 summary: delete an existing relationship
16298 description: delete an existing relationship
16299 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
16308 description: Response codes found in [response codes](https://wiki.onap.org/).
16310 - name: named-query-uuid
16314 example: __NAMED-QUERY-UUID__
16315 - name: named-query-element-uuid
16319 example: __NAMED-QUERY-ELEMENT-UUID__
16320 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
16323 - ServiceDesignAndCreation
16324 summary: returns named-query-element
16325 description: returns named-query-element
16326 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
16332 description: successful operation
16334 $ref: "#/getDefinitions/named-query-element"
16336 description: Response codes found in [response codes](https://wiki.onap.org/).
16338 - name: named-query-uuid
16342 example: __NAMED-QUERY-UUID__
16343 - name: named-query-element-uuid
16347 example: __NAMED-QUERY-ELEMENT-UUID__
16350 - ServiceDesignAndCreation
16351 summary: create or update an existing named-query-element
16353 Create or update an existing named-query-element.
16355 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16356 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
16365 description: Response codes found in [response codes](https://wiki.onap.org/).
16367 - name: named-query-uuid
16371 example: __NAMED-QUERY-UUID__
16372 - name: named-query-element-uuid
16376 example: __NAMED-QUERY-ELEMENT-UUID__
16379 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
16382 $ref: "#/definitions/named-query-element"
16385 - ServiceDesignAndCreation
16386 summary: update an existing named-query-element
16388 Update an existing named-query-element
16390 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16391 The PUT operation will entirely replace an existing object.
16392 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16394 Other differences between PUT and PATCH are:
16396 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16397 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16398 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16399 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
16408 description: Response codes found in [response codes](https://wiki.onap.org/).
16410 - name: named-query-uuid
16414 example: __NAMED-QUERY-UUID__
16415 - name: named-query-element-uuid
16419 example: __NAMED-QUERY-ELEMENT-UUID__
16422 description: named-query-element object that needs to be updated.
16425 $ref: "#/patchDefinitions/named-query-element"
16428 - ServiceDesignAndCreation
16429 summary: delete an existing named-query-element
16430 description: delete an existing named-query-element
16431 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
16440 description: Response codes found in [response codes](https://wiki.onap.org/).
16442 - name: named-query-uuid
16446 example: __NAMED-QUERY-UUID__
16447 - name: named-query-element-uuid
16451 example: __NAMED-QUERY-ELEMENT-UUID__
16452 - name: resource-version
16454 description: resource-version for concurrency
16457 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
16460 - ServiceDesignAndCreation
16461 summary: returns named-query-elements
16462 description: returns named-query-elements
16463 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
16469 description: successful operation
16471 $ref: "#/getDefinitions/named-query-elements"
16473 description: Response codes found in [response codes](https://wiki.onap.org/).
16475 - name: named-query-uuid
16479 example: __NAMED-QUERY-UUID__
16480 - name: named-query-element-uuid
16485 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
16488 - ServiceDesignAndCreation
16489 summary: see node definition for valid relationships
16490 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
16499 description: Response codes found in [response codes](https://wiki.onap.org/).
16501 - name: named-query-uuid
16505 example: __NAMED-QUERY-UUID__
16508 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
16511 $ref: "#/definitions/relationship"
16514 - ServiceDesignAndCreation
16515 summary: delete an existing relationship
16516 description: delete an existing relationship
16517 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
16526 description: Response codes found in [response codes](https://wiki.onap.org/).
16528 - name: named-query-uuid
16532 example: __NAMED-QUERY-UUID__
16533 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
16536 - ServiceDesignAndCreation
16537 summary: returns named-query
16538 description: returns named-query
16539 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
16545 description: successful operation
16547 $ref: "#/getDefinitions/named-query"
16549 description: Response codes found in [response codes](https://wiki.onap.org/).
16551 - name: named-query-uuid
16555 example: __NAMED-QUERY-UUID__
16558 - ServiceDesignAndCreation
16559 summary: create or update an existing named-query
16561 Create or update an existing named-query.
16563 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16564 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
16573 description: Response codes found in [response codes](https://wiki.onap.org/).
16575 - name: named-query-uuid
16579 example: __NAMED-QUERY-UUID__
16582 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
16585 $ref: "#/definitions/named-query"
16588 - ServiceDesignAndCreation
16589 summary: update an existing named-query
16591 Update an existing named-query
16593 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16594 The PUT operation will entirely replace an existing object.
16595 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16597 Other differences between PUT and PATCH are:
16599 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16600 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16601 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16602 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
16611 description: Response codes found in [response codes](https://wiki.onap.org/).
16613 - name: named-query-uuid
16617 example: __NAMED-QUERY-UUID__
16620 description: named-query object that needs to be updated.
16623 $ref: "#/patchDefinitions/named-query"
16626 - ServiceDesignAndCreation
16627 summary: delete an existing named-query
16628 description: delete an existing named-query
16629 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
16638 description: Response codes found in [response codes](https://wiki.onap.org/).
16640 - name: named-query-uuid
16644 example: __NAMED-QUERY-UUID__
16645 - name: resource-version
16647 description: resource-version for concurrency
16650 /service-design-and-creation/named-queries:
16653 - ServiceDesignAndCreation
16654 summary: returns named-queries
16655 description: returns named-queries
16656 operationId: getServiceDesignAndCreationNamedQueries
16662 description: successful operation
16664 $ref: "#/getDefinitions/named-queries"
16666 description: Response codes found in [response codes](https://wiki.onap.org/).
16668 - name: named-query-uuid
16673 - name: named-query-name
16678 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
16682 summary: see node definition for valid relationships
16683 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
16692 description: Response codes found in [response codes](https://wiki.onap.org/).
16696 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16699 example: __LINK-NAME__
16702 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
16705 $ref: "#/definitions/relationship"
16709 summary: delete an existing relationship
16710 description: delete an existing relationship
16711 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
16720 description: Response codes found in [response codes](https://wiki.onap.org/).
16724 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16727 example: __LINK-NAME__
16728 /network/logical-links/logical-link/{link-name}:
16732 summary: returns logical-link
16733 description: returns logical-link
16734 operationId: getNetworkLogicalLinksLogicalLink
16740 description: successful operation
16742 $ref: "#/getDefinitions/logical-link"
16744 description: Response codes found in [response codes](https://wiki.onap.org/).
16748 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16751 example: __LINK-NAME__
16755 summary: create or update an existing logical-link
16757 Create or update an existing logical-link.
16759 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16760 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
16769 description: Response codes found in [response codes](https://wiki.onap.org/).
16773 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16776 example: __LINK-NAME__
16779 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
16782 $ref: "#/definitions/logical-link"
16786 summary: update an existing logical-link
16788 Update an existing logical-link
16790 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16791 The PUT operation will entirely replace an existing object.
16792 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16794 Other differences between PUT and PATCH are:
16796 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16797 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16798 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16799 operationId: UpdateNetworkLogicalLinksLogicalLink
16808 description: Response codes found in [response codes](https://wiki.onap.org/).
16812 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16815 example: __LINK-NAME__
16818 description: logical-link object that needs to be updated.
16821 $ref: "#/patchDefinitions/logical-link"
16825 summary: delete an existing logical-link
16826 description: delete an existing logical-link
16827 operationId: deleteNetworkLogicalLinksLogicalLink
16836 description: Response codes found in [response codes](https://wiki.onap.org/).
16840 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
16843 example: __LINK-NAME__
16844 - name: resource-version
16846 description: resource-version for concurrency
16849 /network/logical-links:
16853 summary: returns logical-links
16854 description: returns logical-links
16855 operationId: getNetworkLogicalLinks
16861 description: successful operation
16863 $ref: "#/getDefinitions/logical-links"
16865 description: Response codes found in [response codes](https://wiki.onap.org/).
16872 - name: persona-model-id
16877 - name: persona-model-version
16882 - name: widget-model-id
16887 - name: widget-model-version
16897 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship:
16901 summary: see node definition for valid relationships
16902 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
16911 description: Response codes found in [response codes](https://wiki.onap.org/).
16913 - name: site-pair-set-id
16915 description: Unique id of site pair set.
16918 example: __SITE-PAIR-SET-ID__
16919 - name: routing-instance-id
16921 description: Unique id of routing instance
16924 example: __ROUTING-INSTANCE-ID__
16925 - name: site-pair-id
16927 description: unique identifier of probe
16930 example: __SITE-PAIR-ID__
16933 description: unique identifier of probe
16939 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
16942 $ref: "#/definitions/relationship"
16946 summary: delete an existing relationship
16947 description: delete an existing relationship
16948 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
16957 description: Response codes found in [response codes](https://wiki.onap.org/).
16959 - name: site-pair-set-id
16961 description: Unique id of site pair set.
16964 example: __SITE-PAIR-SET-ID__
16965 - name: routing-instance-id
16967 description: Unique id of routing instance
16970 example: __ROUTING-INSTANCE-ID__
16971 - name: site-pair-id
16973 description: unique identifier of probe
16976 example: __SITE-PAIR-ID__
16979 description: unique identifier of probe
16983 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}:
16987 summary: returns class-of-service
16988 description: returns class-of-service
16989 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
16995 description: successful operation
16997 $ref: "#/getDefinitions/class-of-service"
16999 description: Response codes found in [response codes](https://wiki.onap.org/).
17001 - name: site-pair-set-id
17003 description: Unique id of site pair set.
17006 example: __SITE-PAIR-SET-ID__
17007 - name: routing-instance-id
17009 description: Unique id of routing instance
17012 example: __ROUTING-INSTANCE-ID__
17013 - name: site-pair-id
17015 description: unique identifier of probe
17018 example: __SITE-PAIR-ID__
17021 description: unique identifier of probe
17028 summary: create or update an existing class-of-service
17030 Create or update an existing class-of-service.
17032 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17033 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
17042 description: Response codes found in [response codes](https://wiki.onap.org/).
17044 - name: site-pair-set-id
17046 description: Unique id of site pair set.
17049 example: __SITE-PAIR-SET-ID__
17050 - name: routing-instance-id
17052 description: Unique id of routing instance
17055 example: __ROUTING-INSTANCE-ID__
17056 - name: site-pair-id
17058 description: unique identifier of probe
17061 example: __SITE-PAIR-ID__
17064 description: unique identifier of probe
17070 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
17073 $ref: "#/definitions/class-of-service"
17077 summary: update an existing class-of-service
17079 Update an existing class-of-service
17081 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17082 The PUT operation will entirely replace an existing object.
17083 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17085 Other differences between PUT and PATCH are:
17087 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17088 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17089 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17090 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
17099 description: Response codes found in [response codes](https://wiki.onap.org/).
17101 - name: site-pair-set-id
17103 description: Unique id of site pair set.
17106 example: __SITE-PAIR-SET-ID__
17107 - name: routing-instance-id
17109 description: Unique id of routing instance
17112 example: __ROUTING-INSTANCE-ID__
17113 - name: site-pair-id
17115 description: unique identifier of probe
17118 example: __SITE-PAIR-ID__
17121 description: unique identifier of probe
17127 description: class-of-service object that needs to be updated.
17130 $ref: "#/patchDefinitions/class-of-service"
17134 summary: delete an existing class-of-service
17135 description: delete an existing class-of-service
17136 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
17145 description: Response codes found in [response codes](https://wiki.onap.org/).
17147 - name: site-pair-set-id
17149 description: Unique id of site pair set.
17152 example: __SITE-PAIR-SET-ID__
17153 - name: routing-instance-id
17155 description: Unique id of routing instance
17158 example: __ROUTING-INSTANCE-ID__
17159 - name: site-pair-id
17161 description: unique identifier of probe
17164 example: __SITE-PAIR-ID__
17167 description: unique identifier of probe
17171 - name: resource-version
17173 description: resource-version for concurrency
17176 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service:
17180 summary: returns classes-of-service
17181 description: returns classes-of-service
17182 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
17188 description: successful operation
17190 $ref: "#/getDefinitions/classes-of-service"
17192 description: Response codes found in [response codes](https://wiki.onap.org/).
17194 - name: site-pair-set-id
17196 description: Unique id of site pair set.
17199 example: __SITE-PAIR-SET-ID__
17200 - name: routing-instance-id
17202 description: Unique id of routing instance
17205 example: __ROUTING-INSTANCE-ID__
17206 - name: site-pair-id
17208 description: unique identifier of probe
17211 example: __SITE-PAIR-ID__
17217 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship:
17221 summary: see node definition for valid relationships
17222 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
17231 description: Response codes found in [response codes](https://wiki.onap.org/).
17233 - name: site-pair-set-id
17235 description: Unique id of site pair set.
17238 example: __SITE-PAIR-SET-ID__
17239 - name: routing-instance-id
17241 description: Unique id of routing instance
17244 example: __ROUTING-INSTANCE-ID__
17245 - name: site-pair-id
17247 description: unique identifier of probe
17250 example: __SITE-PAIR-ID__
17253 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
17256 $ref: "#/definitions/relationship"
17260 summary: delete an existing relationship
17261 description: delete an existing relationship
17262 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
17271 description: Response codes found in [response codes](https://wiki.onap.org/).
17273 - name: site-pair-set-id
17275 description: Unique id of site pair set.
17278 example: __SITE-PAIR-SET-ID__
17279 - name: routing-instance-id
17281 description: Unique id of routing instance
17284 example: __ROUTING-INSTANCE-ID__
17285 - name: site-pair-id
17287 description: unique identifier of probe
17290 example: __SITE-PAIR-ID__
17291 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}:
17295 summary: returns site-pair
17296 description: returns site-pair
17297 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
17303 description: successful operation
17305 $ref: "#/getDefinitions/site-pair"
17307 description: Response codes found in [response codes](https://wiki.onap.org/).
17309 - name: site-pair-set-id
17311 description: Unique id of site pair set.
17314 example: __SITE-PAIR-SET-ID__
17315 - name: routing-instance-id
17317 description: Unique id of routing instance
17320 example: __ROUTING-INSTANCE-ID__
17321 - name: site-pair-id
17323 description: unique identifier of probe
17326 example: __SITE-PAIR-ID__
17330 summary: create or update an existing site-pair
17332 Create or update an existing site-pair.
17334 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17335 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
17344 description: Response codes found in [response codes](https://wiki.onap.org/).
17346 - name: site-pair-set-id
17348 description: Unique id of site pair set.
17351 example: __SITE-PAIR-SET-ID__
17352 - name: routing-instance-id
17354 description: Unique id of routing instance
17357 example: __ROUTING-INSTANCE-ID__
17358 - name: site-pair-id
17360 description: unique identifier of probe
17363 example: __SITE-PAIR-ID__
17366 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
17369 $ref: "#/definitions/site-pair"
17373 summary: update an existing site-pair
17375 Update an existing site-pair
17377 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17378 The PUT operation will entirely replace an existing object.
17379 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17381 Other differences between PUT and PATCH are:
17383 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17384 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17385 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17386 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
17395 description: Response codes found in [response codes](https://wiki.onap.org/).
17397 - name: site-pair-set-id
17399 description: Unique id of site pair set.
17402 example: __SITE-PAIR-SET-ID__
17403 - name: routing-instance-id
17405 description: Unique id of routing instance
17408 example: __ROUTING-INSTANCE-ID__
17409 - name: site-pair-id
17411 description: unique identifier of probe
17414 example: __SITE-PAIR-ID__
17417 description: site-pair object that needs to be updated.
17420 $ref: "#/patchDefinitions/site-pair"
17424 summary: delete an existing site-pair
17425 description: delete an existing site-pair
17426 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
17435 description: Response codes found in [response codes](https://wiki.onap.org/).
17437 - name: site-pair-set-id
17439 description: Unique id of site pair set.
17442 example: __SITE-PAIR-SET-ID__
17443 - name: routing-instance-id
17445 description: Unique id of routing instance
17448 example: __ROUTING-INSTANCE-ID__
17449 - name: site-pair-id
17451 description: unique identifier of probe
17454 example: __SITE-PAIR-ID__
17455 - name: resource-version
17457 description: resource-version for concurrency
17460 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
17464 summary: returns site-pairs
17465 description: returns site-pairs
17466 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
17472 description: successful operation
17474 $ref: "#/getDefinitions/site-pairs"
17476 description: Response codes found in [response codes](https://wiki.onap.org/).
17478 - name: site-pair-set-id
17480 description: Unique id of site pair set.
17483 example: __SITE-PAIR-SET-ID__
17484 - name: routing-instance-id
17486 description: Unique id of routing instance
17489 example: __ROUTING-INSTANCE-ID__
17490 - name: site-pair-id
17495 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
17499 summary: see node definition for valid relationships
17500 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
17509 description: Response codes found in [response codes](https://wiki.onap.org/).
17511 - name: site-pair-set-id
17513 description: Unique id of site pair set.
17516 example: __SITE-PAIR-SET-ID__
17517 - name: routing-instance-id
17519 description: Unique id of routing instance
17522 example: __ROUTING-INSTANCE-ID__
17525 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
17528 $ref: "#/definitions/relationship"
17532 summary: delete an existing relationship
17533 description: delete an existing relationship
17534 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
17543 description: Response codes found in [response codes](https://wiki.onap.org/).
17545 - name: site-pair-set-id
17547 description: Unique id of site pair set.
17550 example: __SITE-PAIR-SET-ID__
17551 - name: routing-instance-id
17553 description: Unique id of routing instance
17556 example: __ROUTING-INSTANCE-ID__
17557 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
17561 summary: returns routing-instance
17562 description: returns routing-instance
17563 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
17569 description: successful operation
17571 $ref: "#/getDefinitions/routing-instance"
17573 description: Response codes found in [response codes](https://wiki.onap.org/).
17575 - name: site-pair-set-id
17577 description: Unique id of site pair set.
17580 example: __SITE-PAIR-SET-ID__
17581 - name: routing-instance-id
17583 description: Unique id of routing instance
17586 example: __ROUTING-INSTANCE-ID__
17590 summary: create or update an existing routing-instance
17592 Create or update an existing routing-instance.
17594 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17595 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
17604 description: Response codes found in [response codes](https://wiki.onap.org/).
17606 - name: site-pair-set-id
17608 description: Unique id of site pair set.
17611 example: __SITE-PAIR-SET-ID__
17612 - name: routing-instance-id
17614 description: Unique id of routing instance
17617 example: __ROUTING-INSTANCE-ID__
17620 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
17623 $ref: "#/definitions/routing-instance"
17627 summary: update an existing routing-instance
17629 Update an existing routing-instance
17631 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17632 The PUT operation will entirely replace an existing object.
17633 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17635 Other differences between PUT and PATCH are:
17637 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17638 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17639 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17640 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
17649 description: Response codes found in [response codes](https://wiki.onap.org/).
17651 - name: site-pair-set-id
17653 description: Unique id of site pair set.
17656 example: __SITE-PAIR-SET-ID__
17657 - name: routing-instance-id
17659 description: Unique id of routing instance
17662 example: __ROUTING-INSTANCE-ID__
17665 description: routing-instance object that needs to be updated.
17668 $ref: "#/patchDefinitions/routing-instance"
17672 summary: delete an existing routing-instance
17673 description: delete an existing routing-instance
17674 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
17683 description: Response codes found in [response codes](https://wiki.onap.org/).
17685 - name: site-pair-set-id
17687 description: Unique id of site pair set.
17690 example: __SITE-PAIR-SET-ID__
17691 - name: routing-instance-id
17693 description: Unique id of routing instance
17696 example: __ROUTING-INSTANCE-ID__
17697 - name: resource-version
17699 description: resource-version for concurrency
17702 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
17706 summary: returns routing-instances
17707 description: returns routing-instances
17708 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
17714 description: successful operation
17716 $ref: "#/getDefinitions/routing-instances"
17718 description: Response codes found in [response codes](https://wiki.onap.org/).
17720 - name: site-pair-set-id
17722 description: Unique id of site pair set.
17725 example: __SITE-PAIR-SET-ID__
17726 - name: routing-instance-id
17731 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
17735 summary: see node definition for valid relationships
17736 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
17745 description: Response codes found in [response codes](https://wiki.onap.org/).
17747 - name: site-pair-set-id
17749 description: Unique id of site pair set.
17752 example: __SITE-PAIR-SET-ID__
17755 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
17758 $ref: "#/definitions/relationship"
17762 summary: delete an existing relationship
17763 description: delete an existing relationship
17764 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
17773 description: Response codes found in [response codes](https://wiki.onap.org/).
17775 - name: site-pair-set-id
17777 description: Unique id of site pair set.
17780 example: __SITE-PAIR-SET-ID__
17781 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
17785 summary: returns site-pair-set
17786 description: returns site-pair-set
17787 operationId: getNetworkSitePairSetsSitePairSet
17793 description: successful operation
17795 $ref: "#/getDefinitions/site-pair-set"
17797 description: Response codes found in [response codes](https://wiki.onap.org/).
17799 - name: site-pair-set-id
17801 description: Unique id of site pair set.
17804 example: __SITE-PAIR-SET-ID__
17808 summary: create or update an existing site-pair-set
17810 Create or update an existing site-pair-set.
17812 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17813 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
17822 description: Response codes found in [response codes](https://wiki.onap.org/).
17824 - name: site-pair-set-id
17826 description: Unique id of site pair set.
17829 example: __SITE-PAIR-SET-ID__
17832 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
17835 $ref: "#/definitions/site-pair-set"
17839 summary: update an existing site-pair-set
17841 Update an existing site-pair-set
17843 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17844 The PUT operation will entirely replace an existing object.
17845 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17847 Other differences between PUT and PATCH are:
17849 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17850 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17851 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17852 operationId: UpdateNetworkSitePairSetsSitePairSet
17861 description: Response codes found in [response codes](https://wiki.onap.org/).
17863 - name: site-pair-set-id
17865 description: Unique id of site pair set.
17868 example: __SITE-PAIR-SET-ID__
17871 description: site-pair-set object that needs to be updated.
17874 $ref: "#/patchDefinitions/site-pair-set"
17878 summary: delete an existing site-pair-set
17879 description: delete an existing site-pair-set
17880 operationId: deleteNetworkSitePairSetsSitePairSet
17889 description: Response codes found in [response codes](https://wiki.onap.org/).
17891 - name: site-pair-set-id
17893 description: Unique id of site pair set.
17896 example: __SITE-PAIR-SET-ID__
17897 - name: resource-version
17899 description: resource-version for concurrency
17902 /network/site-pair-sets:
17906 summary: returns site-pair-sets
17907 description: returns site-pair-sets
17908 operationId: getNetworkSitePairSets
17914 description: successful operation
17916 $ref: "#/getDefinitions/site-pair-sets"
17918 description: Response codes found in [response codes](https://wiki.onap.org/).
17920 - name: site-pair-set-id
17925 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
17929 summary: see node definition for valid relationships
17930 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
17939 description: Response codes found in [response codes](https://wiki.onap.org/).
17943 description: VPN ID, globally unique within A&AI
17946 example: __VPN-ID__
17949 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
17952 $ref: "#/definitions/relationship"
17956 summary: delete an existing relationship
17957 description: delete an existing relationship
17958 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
17967 description: Response codes found in [response codes](https://wiki.onap.org/).
17971 description: VPN ID, globally unique within A&AI
17974 example: __VPN-ID__
17975 /network/vpn-bindings/vpn-binding/{vpn-id}:
17979 summary: returns vpn-binding
17980 description: returns vpn-binding
17981 operationId: getNetworkVpnBindingsVpnBinding
17987 description: successful operation
17989 $ref: "#/getDefinitions/vpn-binding"
17991 description: Response codes found in [response codes](https://wiki.onap.org/).
17995 description: VPN ID, globally unique within A&AI
17998 example: __VPN-ID__
18002 summary: create or update an existing vpn-binding
18004 Create or update an existing vpn-binding.
18006 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18007 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
18016 description: Response codes found in [response codes](https://wiki.onap.org/).
18020 description: VPN ID, globally unique within A&AI
18023 example: __VPN-ID__
18026 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
18029 $ref: "#/definitions/vpn-binding"
18033 summary: update an existing vpn-binding
18035 Update an existing vpn-binding
18037 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18038 The PUT operation will entirely replace an existing object.
18039 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18041 Other differences between PUT and PATCH are:
18043 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18044 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18045 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18046 operationId: UpdateNetworkVpnBindingsVpnBinding
18055 description: Response codes found in [response codes](https://wiki.onap.org/).
18059 description: VPN ID, globally unique within A&AI
18062 example: __VPN-ID__
18065 description: vpn-binding object that needs to be updated.
18068 $ref: "#/patchDefinitions/vpn-binding"
18072 summary: delete an existing vpn-binding
18073 description: delete an existing vpn-binding
18074 operationId: deleteNetworkVpnBindingsVpnBinding
18083 description: Response codes found in [response codes](https://wiki.onap.org/).
18087 description: VPN ID, globally unique within A&AI
18090 example: __VPN-ID__
18091 - name: resource-version
18093 description: resource-version for concurrency
18096 /network/vpn-bindings:
18100 summary: returns vpn-bindings
18101 description: returns vpn-bindings
18102 operationId: getNetworkVpnBindings
18108 description: successful operation
18110 $ref: "#/getDefinitions/vpn-bindings"
18112 description: Response codes found in [response codes](https://wiki.onap.org/).
18124 - name: global-route-target
18129 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
18133 summary: see node definition for valid relationships
18134 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
18143 description: Response codes found in [response codes](https://wiki.onap.org/).
18145 - name: equipment-name
18149 example: __EQUIPMENT-NAME__
18152 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
18155 $ref: "#/definitions/relationship"
18159 summary: delete an existing relationship
18160 description: delete an existing relationship
18161 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
18170 description: Response codes found in [response codes](https://wiki.onap.org/).
18172 - name: equipment-name
18176 example: __EQUIPMENT-NAME__
18177 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
18181 summary: see node definition for valid relationships
18182 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
18191 description: Response codes found in [response codes](https://wiki.onap.org/).
18193 - name: equipment-name
18197 example: __EQUIPMENT-NAME__
18198 - name: interface-name
18200 description: Name that identifies the physical interface
18203 example: __INTERFACE-NAME__
18206 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
18209 $ref: "#/definitions/relationship"
18213 summary: delete an existing relationship
18214 description: delete an existing relationship
18215 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
18224 description: Response codes found in [response codes](https://wiki.onap.org/).
18226 - name: equipment-name
18230 example: __EQUIPMENT-NAME__
18231 - name: interface-name
18233 description: Name that identifies the physical interface
18236 example: __INTERFACE-NAME__
18237 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
18241 summary: see node definition for valid relationships
18242 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
18251 description: Response codes found in [response codes](https://wiki.onap.org/).
18253 - name: equipment-name
18257 example: __EQUIPMENT-NAME__
18258 - name: interface-name
18260 description: Name that identifies the physical interface
18263 example: __INTERFACE-NAME__
18264 - name: interface-name
18266 description: Name given to the interface
18269 example: __INTERFACE-NAME__
18270 - name: vlan-interface
18272 description: String that identifies the interface
18275 example: __VLAN-INTERFACE__
18278 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
18281 $ref: "#/definitions/relationship"
18285 summary: delete an existing relationship
18286 description: delete an existing relationship
18287 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
18296 description: Response codes found in [response codes](https://wiki.onap.org/).
18298 - name: equipment-name
18302 example: __EQUIPMENT-NAME__
18303 - name: interface-name
18305 description: Name that identifies the physical interface
18308 example: __INTERFACE-NAME__
18309 - name: interface-name
18311 description: Name given to the interface
18314 example: __INTERFACE-NAME__
18315 - name: vlan-interface
18317 description: String that identifies the interface
18320 example: __VLAN-INTERFACE__
18321 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
18325 summary: see node definition for valid relationships
18326 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
18335 description: Response codes found in [response codes](https://wiki.onap.org/).
18337 - name: equipment-name
18341 example: __EQUIPMENT-NAME__
18342 - name: interface-name
18344 description: Name that identifies the physical interface
18347 example: __INTERFACE-NAME__
18348 - name: interface-name
18350 description: Name given to the interface
18353 example: __INTERFACE-NAME__
18354 - name: vlan-interface
18356 description: String that identifies the interface
18359 example: __VLAN-INTERFACE__
18360 - name: l3-interface-ipv4-address
18362 description: IP address
18365 example: __L3-INTERFACE-IPV4-ADDRESS__
18368 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
18371 $ref: "#/definitions/relationship"
18375 summary: delete an existing relationship
18376 description: delete an existing relationship
18377 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
18386 description: Response codes found in [response codes](https://wiki.onap.org/).
18388 - name: equipment-name
18392 example: __EQUIPMENT-NAME__
18393 - name: interface-name
18395 description: Name that identifies the physical interface
18398 example: __INTERFACE-NAME__
18399 - name: interface-name
18401 description: Name given to the interface
18404 example: __INTERFACE-NAME__
18405 - name: vlan-interface
18407 description: String that identifies the interface
18410 example: __VLAN-INTERFACE__
18411 - name: l3-interface-ipv4-address
18413 description: IP address
18416 example: __L3-INTERFACE-IPV4-ADDRESS__
18417 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
18421 summary: returns l3-interface-ipv4-address-list
18422 description: returns l3-interface-ipv4-address-list
18423 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
18429 description: successful operation
18431 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
18433 description: Response codes found in [response codes](https://wiki.onap.org/).
18435 - name: equipment-name
18439 example: __EQUIPMENT-NAME__
18440 - name: interface-name
18442 description: Name that identifies the physical interface
18445 example: __INTERFACE-NAME__
18446 - name: interface-name
18448 description: Name given to the interface
18451 example: __INTERFACE-NAME__
18452 - name: vlan-interface
18454 description: String that identifies the interface
18457 example: __VLAN-INTERFACE__
18458 - name: l3-interface-ipv4-address
18460 description: IP address
18463 example: __L3-INTERFACE-IPV4-ADDRESS__
18467 summary: create or update an existing l3-interface-ipv4-address-list
18469 Create or update an existing l3-interface-ipv4-address-list.
18471 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18472 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
18481 description: Response codes found in [response codes](https://wiki.onap.org/).
18483 - name: equipment-name
18487 example: __EQUIPMENT-NAME__
18488 - name: interface-name
18490 description: Name that identifies the physical interface
18493 example: __INTERFACE-NAME__
18494 - name: interface-name
18496 description: Name given to the interface
18499 example: __INTERFACE-NAME__
18500 - name: vlan-interface
18502 description: String that identifies the interface
18505 example: __VLAN-INTERFACE__
18506 - name: l3-interface-ipv4-address
18508 description: IP address
18511 example: __L3-INTERFACE-IPV4-ADDRESS__
18514 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
18517 $ref: "#/definitions/l3-interface-ipv4-address-list"
18521 summary: update an existing l3-interface-ipv4-address-list
18523 Update an existing l3-interface-ipv4-address-list
18525 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18526 The PUT operation will entirely replace an existing object.
18527 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18529 Other differences between PUT and PATCH are:
18531 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18532 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18533 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18534 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
18543 description: Response codes found in [response codes](https://wiki.onap.org/).
18545 - name: equipment-name
18549 example: __EQUIPMENT-NAME__
18550 - name: interface-name
18552 description: Name that identifies the physical interface
18555 example: __INTERFACE-NAME__
18556 - name: interface-name
18558 description: Name given to the interface
18561 example: __INTERFACE-NAME__
18562 - name: vlan-interface
18564 description: String that identifies the interface
18567 example: __VLAN-INTERFACE__
18568 - name: l3-interface-ipv4-address
18570 description: IP address
18573 example: __L3-INTERFACE-IPV4-ADDRESS__
18576 description: l3-interface-ipv4-address-list object that needs to be updated.
18579 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
18583 summary: delete an existing l3-interface-ipv4-address-list
18584 description: delete an existing l3-interface-ipv4-address-list
18585 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
18594 description: Response codes found in [response codes](https://wiki.onap.org/).
18596 - name: equipment-name
18600 example: __EQUIPMENT-NAME__
18601 - name: interface-name
18603 description: Name that identifies the physical interface
18606 example: __INTERFACE-NAME__
18607 - name: interface-name
18609 description: Name given to the interface
18612 example: __INTERFACE-NAME__
18613 - name: vlan-interface
18615 description: String that identifies the interface
18618 example: __VLAN-INTERFACE__
18619 - name: l3-interface-ipv4-address
18621 description: IP address
18624 example: __L3-INTERFACE-IPV4-ADDRESS__
18625 - name: resource-version
18627 description: resource-version for concurrency
18630 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
18634 summary: see node definition for valid relationships
18635 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
18644 description: Response codes found in [response codes](https://wiki.onap.org/).
18646 - name: equipment-name
18650 example: __EQUIPMENT-NAME__
18651 - name: interface-name
18653 description: Name that identifies the physical interface
18656 example: __INTERFACE-NAME__
18657 - name: interface-name
18659 description: Name given to the interface
18662 example: __INTERFACE-NAME__
18663 - name: vlan-interface
18665 description: String that identifies the interface
18668 example: __VLAN-INTERFACE__
18669 - name: l3-interface-ipv6-address
18671 description: IP address
18674 example: __L3-INTERFACE-IPV6-ADDRESS__
18677 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
18680 $ref: "#/definitions/relationship"
18684 summary: delete an existing relationship
18685 description: delete an existing relationship
18686 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
18695 description: Response codes found in [response codes](https://wiki.onap.org/).
18697 - name: equipment-name
18701 example: __EQUIPMENT-NAME__
18702 - name: interface-name
18704 description: Name that identifies the physical interface
18707 example: __INTERFACE-NAME__
18708 - name: interface-name
18710 description: Name given to the interface
18713 example: __INTERFACE-NAME__
18714 - name: vlan-interface
18716 description: String that identifies the interface
18719 example: __VLAN-INTERFACE__
18720 - name: l3-interface-ipv6-address
18722 description: IP address
18725 example: __L3-INTERFACE-IPV6-ADDRESS__
18726 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
18730 summary: returns l3-interface-ipv6-address-list
18731 description: returns l3-interface-ipv6-address-list
18732 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
18738 description: successful operation
18740 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
18742 description: Response codes found in [response codes](https://wiki.onap.org/).
18744 - name: equipment-name
18748 example: __EQUIPMENT-NAME__
18749 - name: interface-name
18751 description: Name that identifies the physical interface
18754 example: __INTERFACE-NAME__
18755 - name: interface-name
18757 description: Name given to the interface
18760 example: __INTERFACE-NAME__
18761 - name: vlan-interface
18763 description: String that identifies the interface
18766 example: __VLAN-INTERFACE__
18767 - name: l3-interface-ipv6-address
18769 description: IP address
18772 example: __L3-INTERFACE-IPV6-ADDRESS__
18776 summary: create or update an existing l3-interface-ipv6-address-list
18778 Create or update an existing l3-interface-ipv6-address-list.
18780 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18781 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
18790 description: Response codes found in [response codes](https://wiki.onap.org/).
18792 - name: equipment-name
18796 example: __EQUIPMENT-NAME__
18797 - name: interface-name
18799 description: Name that identifies the physical interface
18802 example: __INTERFACE-NAME__
18803 - name: interface-name
18805 description: Name given to the interface
18808 example: __INTERFACE-NAME__
18809 - name: vlan-interface
18811 description: String that identifies the interface
18814 example: __VLAN-INTERFACE__
18815 - name: l3-interface-ipv6-address
18817 description: IP address
18820 example: __L3-INTERFACE-IPV6-ADDRESS__
18823 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
18826 $ref: "#/definitions/l3-interface-ipv6-address-list"
18830 summary: update an existing l3-interface-ipv6-address-list
18832 Update an existing l3-interface-ipv6-address-list
18834 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18835 The PUT operation will entirely replace an existing object.
18836 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18838 Other differences between PUT and PATCH are:
18840 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18841 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18842 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18843 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
18852 description: Response codes found in [response codes](https://wiki.onap.org/).
18854 - name: equipment-name
18858 example: __EQUIPMENT-NAME__
18859 - name: interface-name
18861 description: Name that identifies the physical interface
18864 example: __INTERFACE-NAME__
18865 - name: interface-name
18867 description: Name given to the interface
18870 example: __INTERFACE-NAME__
18871 - name: vlan-interface
18873 description: String that identifies the interface
18876 example: __VLAN-INTERFACE__
18877 - name: l3-interface-ipv6-address
18879 description: IP address
18882 example: __L3-INTERFACE-IPV6-ADDRESS__
18885 description: l3-interface-ipv6-address-list object that needs to be updated.
18888 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
18892 summary: delete an existing l3-interface-ipv6-address-list
18893 description: delete an existing l3-interface-ipv6-address-list
18894 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
18903 description: Response codes found in [response codes](https://wiki.onap.org/).
18905 - name: equipment-name
18909 example: __EQUIPMENT-NAME__
18910 - name: interface-name
18912 description: Name that identifies the physical interface
18915 example: __INTERFACE-NAME__
18916 - name: interface-name
18918 description: Name given to the interface
18921 example: __INTERFACE-NAME__
18922 - name: vlan-interface
18924 description: String that identifies the interface
18927 example: __VLAN-INTERFACE__
18928 - name: l3-interface-ipv6-address
18930 description: IP address
18933 example: __L3-INTERFACE-IPV6-ADDRESS__
18934 - name: resource-version
18936 description: resource-version for concurrency
18939 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
18943 summary: returns vlan
18944 description: returns vlan
18945 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
18951 description: successful operation
18953 $ref: "#/getDefinitions/vlan"
18955 description: Response codes found in [response codes](https://wiki.onap.org/).
18957 - name: equipment-name
18961 example: __EQUIPMENT-NAME__
18962 - name: interface-name
18964 description: Name that identifies the physical interface
18967 example: __INTERFACE-NAME__
18968 - name: interface-name
18970 description: Name given to the interface
18973 example: __INTERFACE-NAME__
18974 - name: vlan-interface
18976 description: String that identifies the interface
18979 example: __VLAN-INTERFACE__
18983 summary: create or update an existing vlan
18985 Create or update an existing vlan.
18987 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18988 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
18997 description: Response codes found in [response codes](https://wiki.onap.org/).
18999 - name: equipment-name
19003 example: __EQUIPMENT-NAME__
19004 - name: interface-name
19006 description: Name that identifies the physical interface
19009 example: __INTERFACE-NAME__
19010 - name: interface-name
19012 description: Name given to the interface
19015 example: __INTERFACE-NAME__
19016 - name: vlan-interface
19018 description: String that identifies the interface
19021 example: __VLAN-INTERFACE__
19024 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
19027 $ref: "#/definitions/vlan"
19031 summary: update an existing vlan
19033 Update an existing vlan
19035 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19036 The PUT operation will entirely replace an existing object.
19037 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19039 Other differences between PUT and PATCH are:
19041 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19042 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19043 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19044 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
19053 description: Response codes found in [response codes](https://wiki.onap.org/).
19055 - name: equipment-name
19059 example: __EQUIPMENT-NAME__
19060 - name: interface-name
19062 description: Name that identifies the physical interface
19065 example: __INTERFACE-NAME__
19066 - name: interface-name
19068 description: Name given to the interface
19071 example: __INTERFACE-NAME__
19072 - name: vlan-interface
19074 description: String that identifies the interface
19077 example: __VLAN-INTERFACE__
19080 description: vlan object that needs to be updated.
19083 $ref: "#/patchDefinitions/vlan"
19087 summary: delete an existing vlan
19088 description: delete an existing vlan
19089 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
19098 description: Response codes found in [response codes](https://wiki.onap.org/).
19100 - name: equipment-name
19104 example: __EQUIPMENT-NAME__
19105 - name: interface-name
19107 description: Name that identifies the physical interface
19110 example: __INTERFACE-NAME__
19111 - name: interface-name
19113 description: Name given to the interface
19116 example: __INTERFACE-NAME__
19117 - name: vlan-interface
19119 description: String that identifies the interface
19122 example: __VLAN-INTERFACE__
19123 - name: resource-version
19125 description: resource-version for concurrency
19128 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
19132 summary: returns vlans
19133 description: returns vlans
19134 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
19140 description: successful operation
19142 $ref: "#/getDefinitions/vlans"
19144 description: Response codes found in [response codes](https://wiki.onap.org/).
19146 - name: equipment-name
19150 example: __EQUIPMENT-NAME__
19151 - name: interface-name
19153 description: Name that identifies the physical interface
19156 example: __INTERFACE-NAME__
19157 - name: interface-name
19159 description: Name given to the interface
19162 example: __INTERFACE-NAME__
19163 - name: vlan-interface
19168 - name: vlan-id-inner
19179 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
19183 summary: see node definition for valid relationships
19184 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
19193 description: Response codes found in [response codes](https://wiki.onap.org/).
19195 - name: equipment-name
19199 example: __EQUIPMENT-NAME__
19200 - name: interface-name
19202 description: Name that identifies the physical interface
19205 example: __INTERFACE-NAME__
19206 - name: interface-name
19208 description: Name given to the interface
19211 example: __INTERFACE-NAME__
19214 description: PCI ID used to identify the sriov-vf
19217 example: __PCI-ID__
19220 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
19223 $ref: "#/definitions/relationship"
19227 summary: delete an existing relationship
19228 description: delete an existing relationship
19229 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
19238 description: Response codes found in [response codes](https://wiki.onap.org/).
19240 - name: equipment-name
19244 example: __EQUIPMENT-NAME__
19245 - name: interface-name
19247 description: Name that identifies the physical interface
19250 example: __INTERFACE-NAME__
19251 - name: interface-name
19253 description: Name given to the interface
19256 example: __INTERFACE-NAME__
19259 description: PCI ID used to identify the sriov-vf
19262 example: __PCI-ID__
19263 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
19267 summary: returns sriov-vf
19268 description: returns sriov-vf
19269 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
19275 description: successful operation
19277 $ref: "#/getDefinitions/sriov-vf"
19279 description: Response codes found in [response codes](https://wiki.onap.org/).
19281 - name: equipment-name
19285 example: __EQUIPMENT-NAME__
19286 - name: interface-name
19288 description: Name that identifies the physical interface
19291 example: __INTERFACE-NAME__
19292 - name: interface-name
19294 description: Name given to the interface
19297 example: __INTERFACE-NAME__
19300 description: PCI ID used to identify the sriov-vf
19303 example: __PCI-ID__
19307 summary: create or update an existing sriov-vf
19309 Create or update an existing sriov-vf.
19311 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19312 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
19321 description: Response codes found in [response codes](https://wiki.onap.org/).
19323 - name: equipment-name
19327 example: __EQUIPMENT-NAME__
19328 - name: interface-name
19330 description: Name that identifies the physical interface
19333 example: __INTERFACE-NAME__
19334 - name: interface-name
19336 description: Name given to the interface
19339 example: __INTERFACE-NAME__
19342 description: PCI ID used to identify the sriov-vf
19345 example: __PCI-ID__
19348 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
19351 $ref: "#/definitions/sriov-vf"
19355 summary: update an existing sriov-vf
19357 Update an existing sriov-vf
19359 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19360 The PUT operation will entirely replace an existing object.
19361 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19363 Other differences between PUT and PATCH are:
19365 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19366 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19367 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19368 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
19377 description: Response codes found in [response codes](https://wiki.onap.org/).
19379 - name: equipment-name
19383 example: __EQUIPMENT-NAME__
19384 - name: interface-name
19386 description: Name that identifies the physical interface
19389 example: __INTERFACE-NAME__
19390 - name: interface-name
19392 description: Name given to the interface
19395 example: __INTERFACE-NAME__
19398 description: PCI ID used to identify the sriov-vf
19401 example: __PCI-ID__
19404 description: sriov-vf object that needs to be updated.
19407 $ref: "#/patchDefinitions/sriov-vf"
19411 summary: delete an existing sriov-vf
19412 description: delete an existing sriov-vf
19413 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
19422 description: Response codes found in [response codes](https://wiki.onap.org/).
19424 - name: equipment-name
19428 example: __EQUIPMENT-NAME__
19429 - name: interface-name
19431 description: Name that identifies the physical interface
19434 example: __INTERFACE-NAME__
19435 - name: interface-name
19437 description: Name given to the interface
19440 example: __INTERFACE-NAME__
19443 description: PCI ID used to identify the sriov-vf
19446 example: __PCI-ID__
19447 - name: resource-version
19449 description: resource-version for concurrency
19452 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
19456 summary: returns sriov-vfs
19457 description: returns sriov-vfs
19458 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
19464 description: successful operation
19466 $ref: "#/getDefinitions/sriov-vfs"
19468 description: Response codes found in [response codes](https://wiki.onap.org/).
19470 - name: equipment-name
19474 example: __EQUIPMENT-NAME__
19475 - name: interface-name
19477 description: Name that identifies the physical interface
19480 example: __INTERFACE-NAME__
19481 - name: interface-name
19483 description: Name given to the interface
19486 example: __INTERFACE-NAME__
19492 - name: vf-vlan-filter
19497 - name: vf-mac-filter
19502 - name: vf-vlan-strip
19507 - name: neutron-network-id
19512 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
19516 summary: see node definition for valid relationships
19517 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
19526 description: Response codes found in [response codes](https://wiki.onap.org/).
19528 - name: equipment-name
19532 example: __EQUIPMENT-NAME__
19533 - name: interface-name
19535 description: Name that identifies the physical interface
19538 example: __INTERFACE-NAME__
19539 - name: interface-name
19541 description: Name given to the interface
19544 example: __INTERFACE-NAME__
19547 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
19550 $ref: "#/definitions/relationship"
19554 summary: delete an existing relationship
19555 description: delete an existing relationship
19556 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
19565 description: Response codes found in [response codes](https://wiki.onap.org/).
19567 - name: equipment-name
19571 example: __EQUIPMENT-NAME__
19572 - name: interface-name
19574 description: Name that identifies the physical interface
19577 example: __INTERFACE-NAME__
19578 - name: interface-name
19580 description: Name given to the interface
19583 example: __INTERFACE-NAME__
19584 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
19588 summary: see node definition for valid relationships
19589 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
19598 description: Response codes found in [response codes](https://wiki.onap.org/).
19600 - name: equipment-name
19604 example: __EQUIPMENT-NAME__
19605 - name: interface-name
19607 description: Name that identifies the physical interface
19610 example: __INTERFACE-NAME__
19611 - name: interface-name
19613 description: Name given to the interface
19616 example: __INTERFACE-NAME__
19617 - name: l3-interface-ipv4-address
19619 description: IP address
19622 example: __L3-INTERFACE-IPV4-ADDRESS__
19625 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
19628 $ref: "#/definitions/relationship"
19632 summary: delete an existing relationship
19633 description: delete an existing relationship
19634 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
19643 description: Response codes found in [response codes](https://wiki.onap.org/).
19645 - name: equipment-name
19649 example: __EQUIPMENT-NAME__
19650 - name: interface-name
19652 description: Name that identifies the physical interface
19655 example: __INTERFACE-NAME__
19656 - name: interface-name
19658 description: Name given to the interface
19661 example: __INTERFACE-NAME__
19662 - name: l3-interface-ipv4-address
19664 description: IP address
19667 example: __L3-INTERFACE-IPV4-ADDRESS__
19668 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
19672 summary: returns l3-interface-ipv4-address-list
19673 description: returns l3-interface-ipv4-address-list
19674 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
19680 description: successful operation
19682 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
19684 description: Response codes found in [response codes](https://wiki.onap.org/).
19686 - name: equipment-name
19690 example: __EQUIPMENT-NAME__
19691 - name: interface-name
19693 description: Name that identifies the physical interface
19696 example: __INTERFACE-NAME__
19697 - name: interface-name
19699 description: Name given to the interface
19702 example: __INTERFACE-NAME__
19703 - name: l3-interface-ipv4-address
19705 description: IP address
19708 example: __L3-INTERFACE-IPV4-ADDRESS__
19712 summary: create or update an existing l3-interface-ipv4-address-list
19714 Create or update an existing l3-interface-ipv4-address-list.
19716 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19717 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
19726 description: Response codes found in [response codes](https://wiki.onap.org/).
19728 - name: equipment-name
19732 example: __EQUIPMENT-NAME__
19733 - name: interface-name
19735 description: Name that identifies the physical interface
19738 example: __INTERFACE-NAME__
19739 - name: interface-name
19741 description: Name given to the interface
19744 example: __INTERFACE-NAME__
19745 - name: l3-interface-ipv4-address
19747 description: IP address
19750 example: __L3-INTERFACE-IPV4-ADDRESS__
19753 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
19756 $ref: "#/definitions/l3-interface-ipv4-address-list"
19760 summary: update an existing l3-interface-ipv4-address-list
19762 Update an existing l3-interface-ipv4-address-list
19764 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19765 The PUT operation will entirely replace an existing object.
19766 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19768 Other differences between PUT and PATCH are:
19770 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19771 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19772 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19773 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
19782 description: Response codes found in [response codes](https://wiki.onap.org/).
19784 - name: equipment-name
19788 example: __EQUIPMENT-NAME__
19789 - name: interface-name
19791 description: Name that identifies the physical interface
19794 example: __INTERFACE-NAME__
19795 - name: interface-name
19797 description: Name given to the interface
19800 example: __INTERFACE-NAME__
19801 - name: l3-interface-ipv4-address
19803 description: IP address
19806 example: __L3-INTERFACE-IPV4-ADDRESS__
19809 description: l3-interface-ipv4-address-list object that needs to be updated.
19812 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
19816 summary: delete an existing l3-interface-ipv4-address-list
19817 description: delete an existing l3-interface-ipv4-address-list
19818 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
19827 description: Response codes found in [response codes](https://wiki.onap.org/).
19829 - name: equipment-name
19833 example: __EQUIPMENT-NAME__
19834 - name: interface-name
19836 description: Name that identifies the physical interface
19839 example: __INTERFACE-NAME__
19840 - name: interface-name
19842 description: Name given to the interface
19845 example: __INTERFACE-NAME__
19846 - name: l3-interface-ipv4-address
19848 description: IP address
19851 example: __L3-INTERFACE-IPV4-ADDRESS__
19852 - name: resource-version
19854 description: resource-version for concurrency
19857 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
19861 summary: see node definition for valid relationships
19862 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
19871 description: Response codes found in [response codes](https://wiki.onap.org/).
19873 - name: equipment-name
19877 example: __EQUIPMENT-NAME__
19878 - name: interface-name
19880 description: Name that identifies the physical interface
19883 example: __INTERFACE-NAME__
19884 - name: interface-name
19886 description: Name given to the interface
19889 example: __INTERFACE-NAME__
19890 - name: l3-interface-ipv6-address
19892 description: IP address
19895 example: __L3-INTERFACE-IPV6-ADDRESS__
19898 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
19901 $ref: "#/definitions/relationship"
19905 summary: delete an existing relationship
19906 description: delete an existing relationship
19907 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
19916 description: Response codes found in [response codes](https://wiki.onap.org/).
19918 - name: equipment-name
19922 example: __EQUIPMENT-NAME__
19923 - name: interface-name
19925 description: Name that identifies the physical interface
19928 example: __INTERFACE-NAME__
19929 - name: interface-name
19931 description: Name given to the interface
19934 example: __INTERFACE-NAME__
19935 - name: l3-interface-ipv6-address
19937 description: IP address
19940 example: __L3-INTERFACE-IPV6-ADDRESS__
19941 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
19945 summary: returns l3-interface-ipv6-address-list
19946 description: returns l3-interface-ipv6-address-list
19947 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
19953 description: successful operation
19955 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
19957 description: Response codes found in [response codes](https://wiki.onap.org/).
19959 - name: equipment-name
19963 example: __EQUIPMENT-NAME__
19964 - name: interface-name
19966 description: Name that identifies the physical interface
19969 example: __INTERFACE-NAME__
19970 - name: interface-name
19972 description: Name given to the interface
19975 example: __INTERFACE-NAME__
19976 - name: l3-interface-ipv6-address
19978 description: IP address
19981 example: __L3-INTERFACE-IPV6-ADDRESS__
19985 summary: create or update an existing l3-interface-ipv6-address-list
19987 Create or update an existing l3-interface-ipv6-address-list.
19989 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19990 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
19999 description: Response codes found in [response codes](https://wiki.onap.org/).
20001 - name: equipment-name
20005 example: __EQUIPMENT-NAME__
20006 - name: interface-name
20008 description: Name that identifies the physical interface
20011 example: __INTERFACE-NAME__
20012 - name: interface-name
20014 description: Name given to the interface
20017 example: __INTERFACE-NAME__
20018 - name: l3-interface-ipv6-address
20020 description: IP address
20023 example: __L3-INTERFACE-IPV6-ADDRESS__
20026 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
20029 $ref: "#/definitions/l3-interface-ipv6-address-list"
20033 summary: update an existing l3-interface-ipv6-address-list
20035 Update an existing l3-interface-ipv6-address-list
20037 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20038 The PUT operation will entirely replace an existing object.
20039 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20041 Other differences between PUT and PATCH are:
20043 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20044 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20045 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20046 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
20055 description: Response codes found in [response codes](https://wiki.onap.org/).
20057 - name: equipment-name
20061 example: __EQUIPMENT-NAME__
20062 - name: interface-name
20064 description: Name that identifies the physical interface
20067 example: __INTERFACE-NAME__
20068 - name: interface-name
20070 description: Name given to the interface
20073 example: __INTERFACE-NAME__
20074 - name: l3-interface-ipv6-address
20076 description: IP address
20079 example: __L3-INTERFACE-IPV6-ADDRESS__
20082 description: l3-interface-ipv6-address-list object that needs to be updated.
20085 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
20089 summary: delete an existing l3-interface-ipv6-address-list
20090 description: delete an existing l3-interface-ipv6-address-list
20091 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
20100 description: Response codes found in [response codes](https://wiki.onap.org/).
20102 - name: equipment-name
20106 example: __EQUIPMENT-NAME__
20107 - name: interface-name
20109 description: Name that identifies the physical interface
20112 example: __INTERFACE-NAME__
20113 - name: interface-name
20115 description: Name given to the interface
20118 example: __INTERFACE-NAME__
20119 - name: l3-interface-ipv6-address
20121 description: IP address
20124 example: __L3-INTERFACE-IPV6-ADDRESS__
20125 - name: resource-version
20127 description: resource-version for concurrency
20130 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
20134 summary: returns l-interface
20135 description: returns l-interface
20136 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
20142 description: successful operation
20144 $ref: "#/getDefinitions/l-interface"
20146 description: Response codes found in [response codes](https://wiki.onap.org/).
20148 - name: equipment-name
20152 example: __EQUIPMENT-NAME__
20153 - name: interface-name
20155 description: Name that identifies the physical interface
20158 example: __INTERFACE-NAME__
20159 - name: interface-name
20161 description: Name given to the interface
20164 example: __INTERFACE-NAME__
20168 summary: create or update an existing l-interface
20170 Create or update an existing l-interface.
20172 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20173 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
20182 description: Response codes found in [response codes](https://wiki.onap.org/).
20184 - name: equipment-name
20188 example: __EQUIPMENT-NAME__
20189 - name: interface-name
20191 description: Name that identifies the physical interface
20194 example: __INTERFACE-NAME__
20195 - name: interface-name
20197 description: Name given to the interface
20200 example: __INTERFACE-NAME__
20203 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
20206 $ref: "#/definitions/l-interface"
20210 summary: update an existing l-interface
20212 Update an existing l-interface
20214 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20215 The PUT operation will entirely replace an existing object.
20216 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20218 Other differences between PUT and PATCH are:
20220 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20221 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20222 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20223 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
20232 description: Response codes found in [response codes](https://wiki.onap.org/).
20234 - name: equipment-name
20238 example: __EQUIPMENT-NAME__
20239 - name: interface-name
20241 description: Name that identifies the physical interface
20244 example: __INTERFACE-NAME__
20245 - name: interface-name
20247 description: Name given to the interface
20250 example: __INTERFACE-NAME__
20253 description: l-interface object that needs to be updated.
20256 $ref: "#/patchDefinitions/l-interface"
20260 summary: delete an existing l-interface
20261 description: delete an existing l-interface
20262 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
20271 description: Response codes found in [response codes](https://wiki.onap.org/).
20273 - name: equipment-name
20277 example: __EQUIPMENT-NAME__
20278 - name: interface-name
20280 description: Name that identifies the physical interface
20283 example: __INTERFACE-NAME__
20284 - name: interface-name
20286 description: Name given to the interface
20289 example: __INTERFACE-NAME__
20290 - name: resource-version
20292 description: resource-version for concurrency
20295 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
20299 summary: returns l-interfaces
20300 description: returns l-interfaces
20301 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
20307 description: successful operation
20309 $ref: "#/getDefinitions/l-interfaces"
20311 description: Response codes found in [response codes](https://wiki.onap.org/).
20313 - name: equipment-name
20317 example: __EQUIPMENT-NAME__
20318 - name: interface-name
20320 description: Name that identifies the physical interface
20323 example: __INTERFACE-NAME__
20324 - name: interface-name
20329 - name: interface-id
20339 - name: network-name
20344 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
20348 summary: returns p-interface
20349 description: returns p-interface
20350 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
20356 description: successful operation
20358 $ref: "#/getDefinitions/p-interface"
20360 description: Response codes found in [response codes](https://wiki.onap.org/).
20362 - name: equipment-name
20366 example: __EQUIPMENT-NAME__
20367 - name: interface-name
20369 description: Name that identifies the physical interface
20372 example: __INTERFACE-NAME__
20376 summary: create or update an existing p-interface
20378 Create or update an existing p-interface.
20380 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20381 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
20390 description: Response codes found in [response codes](https://wiki.onap.org/).
20392 - name: equipment-name
20396 example: __EQUIPMENT-NAME__
20397 - name: interface-name
20399 description: Name that identifies the physical interface
20402 example: __INTERFACE-NAME__
20405 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
20408 $ref: "#/definitions/p-interface"
20412 summary: update an existing p-interface
20414 Update an existing p-interface
20416 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20417 The PUT operation will entirely replace an existing object.
20418 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20420 Other differences between PUT and PATCH are:
20422 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20423 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20424 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20425 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
20434 description: Response codes found in [response codes](https://wiki.onap.org/).
20436 - name: equipment-name
20440 example: __EQUIPMENT-NAME__
20441 - name: interface-name
20443 description: Name that identifies the physical interface
20446 example: __INTERFACE-NAME__
20449 description: p-interface object that needs to be updated.
20452 $ref: "#/patchDefinitions/p-interface"
20456 summary: delete an existing p-interface
20457 description: delete an existing p-interface
20458 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
20467 description: Response codes found in [response codes](https://wiki.onap.org/).
20469 - name: equipment-name
20473 example: __EQUIPMENT-NAME__
20474 - name: interface-name
20476 description: Name that identifies the physical interface
20479 example: __INTERFACE-NAME__
20480 - name: resource-version
20482 description: resource-version for concurrency
20485 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
20489 summary: returns p-interfaces
20490 description: returns p-interfaces
20491 operationId: getNetworkVplsPesVplsPePInterfaces
20497 description: successful operation
20499 $ref: "#/getDefinitions/p-interfaces"
20501 description: Response codes found in [response codes](https://wiki.onap.org/).
20503 - name: equipment-name
20507 example: __EQUIPMENT-NAME__
20508 - name: interface-name
20513 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
20517 summary: see node definition for valid relationships
20518 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
20527 description: Response codes found in [response codes](https://wiki.onap.org/).
20529 - name: equipment-name
20533 example: __EQUIPMENT-NAME__
20534 - name: interface-name
20536 description: Name that identifies the link aggregate interface
20539 example: __INTERFACE-NAME__
20542 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
20545 $ref: "#/definitions/relationship"
20549 summary: delete an existing relationship
20550 description: delete an existing relationship
20551 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
20560 description: Response codes found in [response codes](https://wiki.onap.org/).
20562 - name: equipment-name
20566 example: __EQUIPMENT-NAME__
20567 - name: interface-name
20569 description: Name that identifies the link aggregate interface
20572 example: __INTERFACE-NAME__
20573 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
20577 summary: see node definition for valid relationships
20578 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
20587 description: Response codes found in [response codes](https://wiki.onap.org/).
20589 - name: equipment-name
20593 example: __EQUIPMENT-NAME__
20594 - name: interface-name
20596 description: Name that identifies the link aggregate interface
20599 example: __INTERFACE-NAME__
20600 - name: interface-name
20602 description: Name given to the interface
20605 example: __INTERFACE-NAME__
20606 - name: vlan-interface
20608 description: String that identifies the interface
20611 example: __VLAN-INTERFACE__
20614 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
20617 $ref: "#/definitions/relationship"
20621 summary: delete an existing relationship
20622 description: delete an existing relationship
20623 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
20632 description: Response codes found in [response codes](https://wiki.onap.org/).
20634 - name: equipment-name
20638 example: __EQUIPMENT-NAME__
20639 - name: interface-name
20641 description: Name that identifies the link aggregate interface
20644 example: __INTERFACE-NAME__
20645 - name: interface-name
20647 description: Name given to the interface
20650 example: __INTERFACE-NAME__
20651 - name: vlan-interface
20653 description: String that identifies the interface
20656 example: __VLAN-INTERFACE__
20657 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
20661 summary: see node definition for valid relationships
20662 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
20671 description: Response codes found in [response codes](https://wiki.onap.org/).
20673 - name: equipment-name
20677 example: __EQUIPMENT-NAME__
20678 - name: interface-name
20680 description: Name that identifies the link aggregate interface
20683 example: __INTERFACE-NAME__
20684 - name: interface-name
20686 description: Name given to the interface
20689 example: __INTERFACE-NAME__
20690 - name: vlan-interface
20692 description: String that identifies the interface
20695 example: __VLAN-INTERFACE__
20696 - name: l3-interface-ipv4-address
20698 description: IP address
20701 example: __L3-INTERFACE-IPV4-ADDRESS__
20704 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
20707 $ref: "#/definitions/relationship"
20711 summary: delete an existing relationship
20712 description: delete an existing relationship
20713 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
20722 description: Response codes found in [response codes](https://wiki.onap.org/).
20724 - name: equipment-name
20728 example: __EQUIPMENT-NAME__
20729 - name: interface-name
20731 description: Name that identifies the link aggregate interface
20734 example: __INTERFACE-NAME__
20735 - name: interface-name
20737 description: Name given to the interface
20740 example: __INTERFACE-NAME__
20741 - name: vlan-interface
20743 description: String that identifies the interface
20746 example: __VLAN-INTERFACE__
20747 - name: l3-interface-ipv4-address
20749 description: IP address
20752 example: __L3-INTERFACE-IPV4-ADDRESS__
20753 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
20757 summary: returns l3-interface-ipv4-address-list
20758 description: returns l3-interface-ipv4-address-list
20759 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20765 description: successful operation
20767 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
20769 description: Response codes found in [response codes](https://wiki.onap.org/).
20771 - name: equipment-name
20775 example: __EQUIPMENT-NAME__
20776 - name: interface-name
20778 description: Name that identifies the link aggregate interface
20781 example: __INTERFACE-NAME__
20782 - name: interface-name
20784 description: Name given to the interface
20787 example: __INTERFACE-NAME__
20788 - name: vlan-interface
20790 description: String that identifies the interface
20793 example: __VLAN-INTERFACE__
20794 - name: l3-interface-ipv4-address
20796 description: IP address
20799 example: __L3-INTERFACE-IPV4-ADDRESS__
20803 summary: create or update an existing l3-interface-ipv4-address-list
20805 Create or update an existing l3-interface-ipv4-address-list.
20807 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20808 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20817 description: Response codes found in [response codes](https://wiki.onap.org/).
20819 - name: equipment-name
20823 example: __EQUIPMENT-NAME__
20824 - name: interface-name
20826 description: Name that identifies the link aggregate interface
20829 example: __INTERFACE-NAME__
20830 - name: interface-name
20832 description: Name given to the interface
20835 example: __INTERFACE-NAME__
20836 - name: vlan-interface
20838 description: String that identifies the interface
20841 example: __VLAN-INTERFACE__
20842 - name: l3-interface-ipv4-address
20844 description: IP address
20847 example: __L3-INTERFACE-IPV4-ADDRESS__
20850 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
20853 $ref: "#/definitions/l3-interface-ipv4-address-list"
20857 summary: update an existing l3-interface-ipv4-address-list
20859 Update an existing l3-interface-ipv4-address-list
20861 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20862 The PUT operation will entirely replace an existing object.
20863 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20865 Other differences between PUT and PATCH are:
20867 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20868 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20869 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20870 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20879 description: Response codes found in [response codes](https://wiki.onap.org/).
20881 - name: equipment-name
20885 example: __EQUIPMENT-NAME__
20886 - name: interface-name
20888 description: Name that identifies the link aggregate interface
20891 example: __INTERFACE-NAME__
20892 - name: interface-name
20894 description: Name given to the interface
20897 example: __INTERFACE-NAME__
20898 - name: vlan-interface
20900 description: String that identifies the interface
20903 example: __VLAN-INTERFACE__
20904 - name: l3-interface-ipv4-address
20906 description: IP address
20909 example: __L3-INTERFACE-IPV4-ADDRESS__
20912 description: l3-interface-ipv4-address-list object that needs to be updated.
20915 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
20919 summary: delete an existing l3-interface-ipv4-address-list
20920 description: delete an existing l3-interface-ipv4-address-list
20921 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20930 description: Response codes found in [response codes](https://wiki.onap.org/).
20932 - name: equipment-name
20936 example: __EQUIPMENT-NAME__
20937 - name: interface-name
20939 description: Name that identifies the link aggregate interface
20942 example: __INTERFACE-NAME__
20943 - name: interface-name
20945 description: Name given to the interface
20948 example: __INTERFACE-NAME__
20949 - name: vlan-interface
20951 description: String that identifies the interface
20954 example: __VLAN-INTERFACE__
20955 - name: l3-interface-ipv4-address
20957 description: IP address
20960 example: __L3-INTERFACE-IPV4-ADDRESS__
20961 - name: resource-version
20963 description: resource-version for concurrency
20966 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
20970 summary: see node definition for valid relationships
20971 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20980 description: Response codes found in [response codes](https://wiki.onap.org/).
20982 - name: equipment-name
20986 example: __EQUIPMENT-NAME__
20987 - name: interface-name
20989 description: Name that identifies the link aggregate interface
20992 example: __INTERFACE-NAME__
20993 - name: interface-name
20995 description: Name given to the interface
20998 example: __INTERFACE-NAME__
20999 - name: vlan-interface
21001 description: String that identifies the interface
21004 example: __VLAN-INTERFACE__
21005 - name: l3-interface-ipv6-address
21007 description: IP address
21010 example: __L3-INTERFACE-IPV6-ADDRESS__
21013 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
21016 $ref: "#/definitions/relationship"
21020 summary: delete an existing relationship
21021 description: delete an existing relationship
21022 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
21031 description: Response codes found in [response codes](https://wiki.onap.org/).
21033 - name: equipment-name
21037 example: __EQUIPMENT-NAME__
21038 - name: interface-name
21040 description: Name that identifies the link aggregate interface
21043 example: __INTERFACE-NAME__
21044 - name: interface-name
21046 description: Name given to the interface
21049 example: __INTERFACE-NAME__
21050 - name: vlan-interface
21052 description: String that identifies the interface
21055 example: __VLAN-INTERFACE__
21056 - name: l3-interface-ipv6-address
21058 description: IP address
21061 example: __L3-INTERFACE-IPV6-ADDRESS__
21062 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
21066 summary: returns l3-interface-ipv6-address-list
21067 description: returns l3-interface-ipv6-address-list
21068 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
21074 description: successful operation
21076 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
21078 description: Response codes found in [response codes](https://wiki.onap.org/).
21080 - name: equipment-name
21084 example: __EQUIPMENT-NAME__
21085 - name: interface-name
21087 description: Name that identifies the link aggregate interface
21090 example: __INTERFACE-NAME__
21091 - name: interface-name
21093 description: Name given to the interface
21096 example: __INTERFACE-NAME__
21097 - name: vlan-interface
21099 description: String that identifies the interface
21102 example: __VLAN-INTERFACE__
21103 - name: l3-interface-ipv6-address
21105 description: IP address
21108 example: __L3-INTERFACE-IPV6-ADDRESS__
21112 summary: create or update an existing l3-interface-ipv6-address-list
21114 Create or update an existing l3-interface-ipv6-address-list.
21116 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21117 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
21126 description: Response codes found in [response codes](https://wiki.onap.org/).
21128 - name: equipment-name
21132 example: __EQUIPMENT-NAME__
21133 - name: interface-name
21135 description: Name that identifies the link aggregate interface
21138 example: __INTERFACE-NAME__
21139 - name: interface-name
21141 description: Name given to the interface
21144 example: __INTERFACE-NAME__
21145 - name: vlan-interface
21147 description: String that identifies the interface
21150 example: __VLAN-INTERFACE__
21151 - name: l3-interface-ipv6-address
21153 description: IP address
21156 example: __L3-INTERFACE-IPV6-ADDRESS__
21159 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
21162 $ref: "#/definitions/l3-interface-ipv6-address-list"
21166 summary: update an existing l3-interface-ipv6-address-list
21168 Update an existing l3-interface-ipv6-address-list
21170 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21171 The PUT operation will entirely replace an existing object.
21172 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21174 Other differences between PUT and PATCH are:
21176 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21177 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21178 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21179 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
21188 description: Response codes found in [response codes](https://wiki.onap.org/).
21190 - name: equipment-name
21194 example: __EQUIPMENT-NAME__
21195 - name: interface-name
21197 description: Name that identifies the link aggregate interface
21200 example: __INTERFACE-NAME__
21201 - name: interface-name
21203 description: Name given to the interface
21206 example: __INTERFACE-NAME__
21207 - name: vlan-interface
21209 description: String that identifies the interface
21212 example: __VLAN-INTERFACE__
21213 - name: l3-interface-ipv6-address
21215 description: IP address
21218 example: __L3-INTERFACE-IPV6-ADDRESS__
21221 description: l3-interface-ipv6-address-list object that needs to be updated.
21224 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
21228 summary: delete an existing l3-interface-ipv6-address-list
21229 description: delete an existing l3-interface-ipv6-address-list
21230 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
21239 description: Response codes found in [response codes](https://wiki.onap.org/).
21241 - name: equipment-name
21245 example: __EQUIPMENT-NAME__
21246 - name: interface-name
21248 description: Name that identifies the link aggregate interface
21251 example: __INTERFACE-NAME__
21252 - name: interface-name
21254 description: Name given to the interface
21257 example: __INTERFACE-NAME__
21258 - name: vlan-interface
21260 description: String that identifies the interface
21263 example: __VLAN-INTERFACE__
21264 - name: l3-interface-ipv6-address
21266 description: IP address
21269 example: __L3-INTERFACE-IPV6-ADDRESS__
21270 - name: resource-version
21272 description: resource-version for concurrency
21275 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
21279 summary: returns vlan
21280 description: returns vlan
21281 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
21287 description: successful operation
21289 $ref: "#/getDefinitions/vlan"
21291 description: Response codes found in [response codes](https://wiki.onap.org/).
21293 - name: equipment-name
21297 example: __EQUIPMENT-NAME__
21298 - name: interface-name
21300 description: Name that identifies the link aggregate interface
21303 example: __INTERFACE-NAME__
21304 - name: interface-name
21306 description: Name given to the interface
21309 example: __INTERFACE-NAME__
21310 - name: vlan-interface
21312 description: String that identifies the interface
21315 example: __VLAN-INTERFACE__
21319 summary: create or update an existing vlan
21321 Create or update an existing vlan.
21323 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21324 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
21333 description: Response codes found in [response codes](https://wiki.onap.org/).
21335 - name: equipment-name
21339 example: __EQUIPMENT-NAME__
21340 - name: interface-name
21342 description: Name that identifies the link aggregate interface
21345 example: __INTERFACE-NAME__
21346 - name: interface-name
21348 description: Name given to the interface
21351 example: __INTERFACE-NAME__
21352 - name: vlan-interface
21354 description: String that identifies the interface
21357 example: __VLAN-INTERFACE__
21360 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
21363 $ref: "#/definitions/vlan"
21367 summary: update an existing vlan
21369 Update an existing vlan
21371 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21372 The PUT operation will entirely replace an existing object.
21373 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21375 Other differences between PUT and PATCH are:
21377 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21378 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21379 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21380 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
21389 description: Response codes found in [response codes](https://wiki.onap.org/).
21391 - name: equipment-name
21395 example: __EQUIPMENT-NAME__
21396 - name: interface-name
21398 description: Name that identifies the link aggregate interface
21401 example: __INTERFACE-NAME__
21402 - name: interface-name
21404 description: Name given to the interface
21407 example: __INTERFACE-NAME__
21408 - name: vlan-interface
21410 description: String that identifies the interface
21413 example: __VLAN-INTERFACE__
21416 description: vlan object that needs to be updated.
21419 $ref: "#/patchDefinitions/vlan"
21423 summary: delete an existing vlan
21424 description: delete an existing vlan
21425 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
21434 description: Response codes found in [response codes](https://wiki.onap.org/).
21436 - name: equipment-name
21440 example: __EQUIPMENT-NAME__
21441 - name: interface-name
21443 description: Name that identifies the link aggregate interface
21446 example: __INTERFACE-NAME__
21447 - name: interface-name
21449 description: Name given to the interface
21452 example: __INTERFACE-NAME__
21453 - name: vlan-interface
21455 description: String that identifies the interface
21458 example: __VLAN-INTERFACE__
21459 - name: resource-version
21461 description: resource-version for concurrency
21464 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
21468 summary: returns vlans
21469 description: returns vlans
21470 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
21476 description: successful operation
21478 $ref: "#/getDefinitions/vlans"
21480 description: Response codes found in [response codes](https://wiki.onap.org/).
21482 - name: equipment-name
21486 example: __EQUIPMENT-NAME__
21487 - name: interface-name
21489 description: Name that identifies the link aggregate interface
21492 example: __INTERFACE-NAME__
21493 - name: interface-name
21495 description: Name given to the interface
21498 example: __INTERFACE-NAME__
21499 - name: vlan-interface
21504 - name: vlan-id-inner
21515 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
21519 summary: see node definition for valid relationships
21520 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
21529 description: Response codes found in [response codes](https://wiki.onap.org/).
21531 - name: equipment-name
21535 example: __EQUIPMENT-NAME__
21536 - name: interface-name
21538 description: Name that identifies the link aggregate interface
21541 example: __INTERFACE-NAME__
21542 - name: interface-name
21544 description: Name given to the interface
21547 example: __INTERFACE-NAME__
21550 description: PCI ID used to identify the sriov-vf
21553 example: __PCI-ID__
21556 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
21559 $ref: "#/definitions/relationship"
21563 summary: delete an existing relationship
21564 description: delete an existing relationship
21565 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
21574 description: Response codes found in [response codes](https://wiki.onap.org/).
21576 - name: equipment-name
21580 example: __EQUIPMENT-NAME__
21581 - name: interface-name
21583 description: Name that identifies the link aggregate interface
21586 example: __INTERFACE-NAME__
21587 - name: interface-name
21589 description: Name given to the interface
21592 example: __INTERFACE-NAME__
21595 description: PCI ID used to identify the sriov-vf
21598 example: __PCI-ID__
21599 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
21603 summary: returns sriov-vf
21604 description: returns sriov-vf
21605 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21611 description: successful operation
21613 $ref: "#/getDefinitions/sriov-vf"
21615 description: Response codes found in [response codes](https://wiki.onap.org/).
21617 - name: equipment-name
21621 example: __EQUIPMENT-NAME__
21622 - name: interface-name
21624 description: Name that identifies the link aggregate interface
21627 example: __INTERFACE-NAME__
21628 - name: interface-name
21630 description: Name given to the interface
21633 example: __INTERFACE-NAME__
21636 description: PCI ID used to identify the sriov-vf
21639 example: __PCI-ID__
21643 summary: create or update an existing sriov-vf
21645 Create or update an existing sriov-vf.
21647 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21648 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21657 description: Response codes found in [response codes](https://wiki.onap.org/).
21659 - name: equipment-name
21663 example: __EQUIPMENT-NAME__
21664 - name: interface-name
21666 description: Name that identifies the link aggregate interface
21669 example: __INTERFACE-NAME__
21670 - name: interface-name
21672 description: Name given to the interface
21675 example: __INTERFACE-NAME__
21678 description: PCI ID used to identify the sriov-vf
21681 example: __PCI-ID__
21684 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
21687 $ref: "#/definitions/sriov-vf"
21691 summary: update an existing sriov-vf
21693 Update an existing sriov-vf
21695 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21696 The PUT operation will entirely replace an existing object.
21697 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21699 Other differences between PUT and PATCH are:
21701 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21702 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21703 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21704 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21713 description: Response codes found in [response codes](https://wiki.onap.org/).
21715 - name: equipment-name
21719 example: __EQUIPMENT-NAME__
21720 - name: interface-name
21722 description: Name that identifies the link aggregate interface
21725 example: __INTERFACE-NAME__
21726 - name: interface-name
21728 description: Name given to the interface
21731 example: __INTERFACE-NAME__
21734 description: PCI ID used to identify the sriov-vf
21737 example: __PCI-ID__
21740 description: sriov-vf object that needs to be updated.
21743 $ref: "#/patchDefinitions/sriov-vf"
21747 summary: delete an existing sriov-vf
21748 description: delete an existing sriov-vf
21749 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21758 description: Response codes found in [response codes](https://wiki.onap.org/).
21760 - name: equipment-name
21764 example: __EQUIPMENT-NAME__
21765 - name: interface-name
21767 description: Name that identifies the link aggregate interface
21770 example: __INTERFACE-NAME__
21771 - name: interface-name
21773 description: Name given to the interface
21776 example: __INTERFACE-NAME__
21779 description: PCI ID used to identify the sriov-vf
21782 example: __PCI-ID__
21783 - name: resource-version
21785 description: resource-version for concurrency
21788 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
21792 summary: returns sriov-vfs
21793 description: returns sriov-vfs
21794 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
21800 description: successful operation
21802 $ref: "#/getDefinitions/sriov-vfs"
21804 description: Response codes found in [response codes](https://wiki.onap.org/).
21806 - name: equipment-name
21810 example: __EQUIPMENT-NAME__
21811 - name: interface-name
21813 description: Name that identifies the link aggregate interface
21816 example: __INTERFACE-NAME__
21817 - name: interface-name
21819 description: Name given to the interface
21822 example: __INTERFACE-NAME__
21828 - name: vf-vlan-filter
21833 - name: vf-mac-filter
21838 - name: vf-vlan-strip
21843 - name: neutron-network-id
21848 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
21852 summary: see node definition for valid relationships
21853 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
21862 description: Response codes found in [response codes](https://wiki.onap.org/).
21864 - name: equipment-name
21868 example: __EQUIPMENT-NAME__
21869 - name: interface-name
21871 description: Name that identifies the link aggregate interface
21874 example: __INTERFACE-NAME__
21875 - name: interface-name
21877 description: Name given to the interface
21880 example: __INTERFACE-NAME__
21883 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
21886 $ref: "#/definitions/relationship"
21890 summary: delete an existing relationship
21891 description: delete an existing relationship
21892 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
21901 description: Response codes found in [response codes](https://wiki.onap.org/).
21903 - name: equipment-name
21907 example: __EQUIPMENT-NAME__
21908 - name: interface-name
21910 description: Name that identifies the link aggregate interface
21913 example: __INTERFACE-NAME__
21914 - name: interface-name
21916 description: Name given to the interface
21919 example: __INTERFACE-NAME__
21920 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
21924 summary: see node definition for valid relationships
21925 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21934 description: Response codes found in [response codes](https://wiki.onap.org/).
21936 - name: equipment-name
21940 example: __EQUIPMENT-NAME__
21941 - name: interface-name
21943 description: Name that identifies the link aggregate interface
21946 example: __INTERFACE-NAME__
21947 - name: interface-name
21949 description: Name given to the interface
21952 example: __INTERFACE-NAME__
21953 - name: l3-interface-ipv4-address
21955 description: IP address
21958 example: __L3-INTERFACE-IPV4-ADDRESS__
21961 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21964 $ref: "#/definitions/relationship"
21968 summary: delete an existing relationship
21969 description: delete an existing relationship
21970 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21979 description: Response codes found in [response codes](https://wiki.onap.org/).
21981 - name: equipment-name
21985 example: __EQUIPMENT-NAME__
21986 - name: interface-name
21988 description: Name that identifies the link aggregate interface
21991 example: __INTERFACE-NAME__
21992 - name: interface-name
21994 description: Name given to the interface
21997 example: __INTERFACE-NAME__
21998 - name: l3-interface-ipv4-address
22000 description: IP address
22003 example: __L3-INTERFACE-IPV4-ADDRESS__
22004 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
22008 summary: returns l3-interface-ipv4-address-list
22009 description: returns l3-interface-ipv4-address-list
22010 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
22016 description: successful operation
22018 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
22020 description: Response codes found in [response codes](https://wiki.onap.org/).
22022 - name: equipment-name
22026 example: __EQUIPMENT-NAME__
22027 - name: interface-name
22029 description: Name that identifies the link aggregate interface
22032 example: __INTERFACE-NAME__
22033 - name: interface-name
22035 description: Name given to the interface
22038 example: __INTERFACE-NAME__
22039 - name: l3-interface-ipv4-address
22041 description: IP address
22044 example: __L3-INTERFACE-IPV4-ADDRESS__
22048 summary: create or update an existing l3-interface-ipv4-address-list
22050 Create or update an existing l3-interface-ipv4-address-list.
22052 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22053 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
22062 description: Response codes found in [response codes](https://wiki.onap.org/).
22064 - name: equipment-name
22068 example: __EQUIPMENT-NAME__
22069 - name: interface-name
22071 description: Name that identifies the link aggregate interface
22074 example: __INTERFACE-NAME__
22075 - name: interface-name
22077 description: Name given to the interface
22080 example: __INTERFACE-NAME__
22081 - name: l3-interface-ipv4-address
22083 description: IP address
22086 example: __L3-INTERFACE-IPV4-ADDRESS__
22089 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
22092 $ref: "#/definitions/l3-interface-ipv4-address-list"
22096 summary: update an existing l3-interface-ipv4-address-list
22098 Update an existing l3-interface-ipv4-address-list
22100 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22101 The PUT operation will entirely replace an existing object.
22102 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22104 Other differences between PUT and PATCH are:
22106 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22107 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22108 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22109 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
22118 description: Response codes found in [response codes](https://wiki.onap.org/).
22120 - name: equipment-name
22124 example: __EQUIPMENT-NAME__
22125 - name: interface-name
22127 description: Name that identifies the link aggregate interface
22130 example: __INTERFACE-NAME__
22131 - name: interface-name
22133 description: Name given to the interface
22136 example: __INTERFACE-NAME__
22137 - name: l3-interface-ipv4-address
22139 description: IP address
22142 example: __L3-INTERFACE-IPV4-ADDRESS__
22145 description: l3-interface-ipv4-address-list object that needs to be updated.
22148 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22152 summary: delete an existing l3-interface-ipv4-address-list
22153 description: delete an existing l3-interface-ipv4-address-list
22154 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
22163 description: Response codes found in [response codes](https://wiki.onap.org/).
22165 - name: equipment-name
22169 example: __EQUIPMENT-NAME__
22170 - name: interface-name
22172 description: Name that identifies the link aggregate interface
22175 example: __INTERFACE-NAME__
22176 - name: interface-name
22178 description: Name given to the interface
22181 example: __INTERFACE-NAME__
22182 - name: l3-interface-ipv4-address
22184 description: IP address
22187 example: __L3-INTERFACE-IPV4-ADDRESS__
22188 - name: resource-version
22190 description: resource-version for concurrency
22193 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
22197 summary: see node definition for valid relationships
22198 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
22207 description: Response codes found in [response codes](https://wiki.onap.org/).
22209 - name: equipment-name
22213 example: __EQUIPMENT-NAME__
22214 - name: interface-name
22216 description: Name that identifies the link aggregate interface
22219 example: __INTERFACE-NAME__
22220 - name: interface-name
22222 description: Name given to the interface
22225 example: __INTERFACE-NAME__
22226 - name: l3-interface-ipv6-address
22228 description: IP address
22231 example: __L3-INTERFACE-IPV6-ADDRESS__
22234 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
22237 $ref: "#/definitions/relationship"
22241 summary: delete an existing relationship
22242 description: delete an existing relationship
22243 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
22252 description: Response codes found in [response codes](https://wiki.onap.org/).
22254 - name: equipment-name
22258 example: __EQUIPMENT-NAME__
22259 - name: interface-name
22261 description: Name that identifies the link aggregate interface
22264 example: __INTERFACE-NAME__
22265 - name: interface-name
22267 description: Name given to the interface
22270 example: __INTERFACE-NAME__
22271 - name: l3-interface-ipv6-address
22273 description: IP address
22276 example: __L3-INTERFACE-IPV6-ADDRESS__
22277 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
22281 summary: returns l3-interface-ipv6-address-list
22282 description: returns l3-interface-ipv6-address-list
22283 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22289 description: successful operation
22291 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22293 description: Response codes found in [response codes](https://wiki.onap.org/).
22295 - name: equipment-name
22299 example: __EQUIPMENT-NAME__
22300 - name: interface-name
22302 description: Name that identifies the link aggregate interface
22305 example: __INTERFACE-NAME__
22306 - name: interface-name
22308 description: Name given to the interface
22311 example: __INTERFACE-NAME__
22312 - name: l3-interface-ipv6-address
22314 description: IP address
22317 example: __L3-INTERFACE-IPV6-ADDRESS__
22321 summary: create or update an existing l3-interface-ipv6-address-list
22323 Create or update an existing l3-interface-ipv6-address-list.
22325 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22326 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22335 description: Response codes found in [response codes](https://wiki.onap.org/).
22337 - name: equipment-name
22341 example: __EQUIPMENT-NAME__
22342 - name: interface-name
22344 description: Name that identifies the link aggregate interface
22347 example: __INTERFACE-NAME__
22348 - name: interface-name
22350 description: Name given to the interface
22353 example: __INTERFACE-NAME__
22354 - name: l3-interface-ipv6-address
22356 description: IP address
22359 example: __L3-INTERFACE-IPV6-ADDRESS__
22362 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
22365 $ref: "#/definitions/l3-interface-ipv6-address-list"
22369 summary: update an existing l3-interface-ipv6-address-list
22371 Update an existing l3-interface-ipv6-address-list
22373 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22374 The PUT operation will entirely replace an existing object.
22375 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22377 Other differences between PUT and PATCH are:
22379 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22380 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22381 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22382 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22391 description: Response codes found in [response codes](https://wiki.onap.org/).
22393 - name: equipment-name
22397 example: __EQUIPMENT-NAME__
22398 - name: interface-name
22400 description: Name that identifies the link aggregate interface
22403 example: __INTERFACE-NAME__
22404 - name: interface-name
22406 description: Name given to the interface
22409 example: __INTERFACE-NAME__
22410 - name: l3-interface-ipv6-address
22412 description: IP address
22415 example: __L3-INTERFACE-IPV6-ADDRESS__
22418 description: l3-interface-ipv6-address-list object that needs to be updated.
22421 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22425 summary: delete an existing l3-interface-ipv6-address-list
22426 description: delete an existing l3-interface-ipv6-address-list
22427 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22436 description: Response codes found in [response codes](https://wiki.onap.org/).
22438 - name: equipment-name
22442 example: __EQUIPMENT-NAME__
22443 - name: interface-name
22445 description: Name that identifies the link aggregate interface
22448 example: __INTERFACE-NAME__
22449 - name: interface-name
22451 description: Name given to the interface
22454 example: __INTERFACE-NAME__
22455 - name: l3-interface-ipv6-address
22457 description: IP address
22460 example: __L3-INTERFACE-IPV6-ADDRESS__
22461 - name: resource-version
22463 description: resource-version for concurrency
22466 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
22470 summary: returns l-interface
22471 description: returns l-interface
22472 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
22478 description: successful operation
22480 $ref: "#/getDefinitions/l-interface"
22482 description: Response codes found in [response codes](https://wiki.onap.org/).
22484 - name: equipment-name
22488 example: __EQUIPMENT-NAME__
22489 - name: interface-name
22491 description: Name that identifies the link aggregate interface
22494 example: __INTERFACE-NAME__
22495 - name: interface-name
22497 description: Name given to the interface
22500 example: __INTERFACE-NAME__
22504 summary: create or update an existing l-interface
22506 Create or update an existing l-interface.
22508 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22509 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
22518 description: Response codes found in [response codes](https://wiki.onap.org/).
22520 - name: equipment-name
22524 example: __EQUIPMENT-NAME__
22525 - name: interface-name
22527 description: Name that identifies the link aggregate interface
22530 example: __INTERFACE-NAME__
22531 - name: interface-name
22533 description: Name given to the interface
22536 example: __INTERFACE-NAME__
22539 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
22542 $ref: "#/definitions/l-interface"
22546 summary: update an existing l-interface
22548 Update an existing l-interface
22550 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22551 The PUT operation will entirely replace an existing object.
22552 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22554 Other differences between PUT and PATCH are:
22556 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22557 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22558 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22559 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
22568 description: Response codes found in [response codes](https://wiki.onap.org/).
22570 - name: equipment-name
22574 example: __EQUIPMENT-NAME__
22575 - name: interface-name
22577 description: Name that identifies the link aggregate interface
22580 example: __INTERFACE-NAME__
22581 - name: interface-name
22583 description: Name given to the interface
22586 example: __INTERFACE-NAME__
22589 description: l-interface object that needs to be updated.
22592 $ref: "#/patchDefinitions/l-interface"
22596 summary: delete an existing l-interface
22597 description: delete an existing l-interface
22598 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
22607 description: Response codes found in [response codes](https://wiki.onap.org/).
22609 - name: equipment-name
22613 example: __EQUIPMENT-NAME__
22614 - name: interface-name
22616 description: Name that identifies the link aggregate interface
22619 example: __INTERFACE-NAME__
22620 - name: interface-name
22622 description: Name given to the interface
22625 example: __INTERFACE-NAME__
22626 - name: resource-version
22628 description: resource-version for concurrency
22631 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
22635 summary: returns l-interfaces
22636 description: returns l-interfaces
22637 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
22643 description: successful operation
22645 $ref: "#/getDefinitions/l-interfaces"
22647 description: Response codes found in [response codes](https://wiki.onap.org/).
22649 - name: equipment-name
22653 example: __EQUIPMENT-NAME__
22654 - name: interface-name
22656 description: Name that identifies the link aggregate interface
22659 example: __INTERFACE-NAME__
22660 - name: interface-name
22665 - name: interface-id
22675 - name: network-name
22680 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
22684 summary: returns lag-interface
22685 description: returns lag-interface
22686 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
22692 description: successful operation
22694 $ref: "#/getDefinitions/lag-interface"
22696 description: Response codes found in [response codes](https://wiki.onap.org/).
22698 - name: equipment-name
22702 example: __EQUIPMENT-NAME__
22703 - name: interface-name
22705 description: Name that identifies the link aggregate interface
22708 example: __INTERFACE-NAME__
22712 summary: create or update an existing lag-interface
22714 Create or update an existing lag-interface.
22716 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22717 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
22726 description: Response codes found in [response codes](https://wiki.onap.org/).
22728 - name: equipment-name
22732 example: __EQUIPMENT-NAME__
22733 - name: interface-name
22735 description: Name that identifies the link aggregate interface
22738 example: __INTERFACE-NAME__
22741 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
22744 $ref: "#/definitions/lag-interface"
22748 summary: update an existing lag-interface
22750 Update an existing lag-interface
22752 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22753 The PUT operation will entirely replace an existing object.
22754 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22756 Other differences between PUT and PATCH are:
22758 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22759 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22760 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22761 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
22770 description: Response codes found in [response codes](https://wiki.onap.org/).
22772 - name: equipment-name
22776 example: __EQUIPMENT-NAME__
22777 - name: interface-name
22779 description: Name that identifies the link aggregate interface
22782 example: __INTERFACE-NAME__
22785 description: lag-interface object that needs to be updated.
22788 $ref: "#/patchDefinitions/lag-interface"
22792 summary: delete an existing lag-interface
22793 description: delete an existing lag-interface
22794 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
22803 description: Response codes found in [response codes](https://wiki.onap.org/).
22805 - name: equipment-name
22809 example: __EQUIPMENT-NAME__
22810 - name: interface-name
22812 description: Name that identifies the link aggregate interface
22815 example: __INTERFACE-NAME__
22816 - name: resource-version
22818 description: resource-version for concurrency
22821 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
22825 summary: returns lag-interfaces
22826 description: returns lag-interfaces
22827 operationId: getNetworkVplsPesVplsPeLagInterfaces
22833 description: successful operation
22835 $ref: "#/getDefinitions/lag-interfaces"
22837 description: Response codes found in [response codes](https://wiki.onap.org/).
22839 - name: equipment-name
22843 example: __EQUIPMENT-NAME__
22844 - name: interface-name
22849 /network/vpls-pes/vpls-pe/{equipment-name}:
22853 summary: returns vpls-pe
22854 description: returns vpls-pe
22855 operationId: getNetworkVplsPesVplsPe
22861 description: successful operation
22863 $ref: "#/getDefinitions/vpls-pe"
22865 description: Response codes found in [response codes](https://wiki.onap.org/).
22867 - name: equipment-name
22871 example: __EQUIPMENT-NAME__
22875 summary: create or update an existing vpls-pe
22877 Create or update an existing vpls-pe.
22879 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22880 operationId: createOrUpdateNetworkVplsPesVplsPe
22889 description: Response codes found in [response codes](https://wiki.onap.org/).
22891 - name: equipment-name
22895 example: __EQUIPMENT-NAME__
22898 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
22901 $ref: "#/definitions/vpls-pe"
22905 summary: update an existing vpls-pe
22907 Update an existing vpls-pe
22909 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22910 The PUT operation will entirely replace an existing object.
22911 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22913 Other differences between PUT and PATCH are:
22915 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22916 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22917 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22918 operationId: UpdateNetworkVplsPesVplsPe
22927 description: Response codes found in [response codes](https://wiki.onap.org/).
22929 - name: equipment-name
22933 example: __EQUIPMENT-NAME__
22936 description: vpls-pe object that needs to be updated.
22939 $ref: "#/patchDefinitions/vpls-pe"
22943 summary: delete an existing vpls-pe
22944 description: delete an existing vpls-pe
22945 operationId: deleteNetworkVplsPesVplsPe
22954 description: Response codes found in [response codes](https://wiki.onap.org/).
22956 - name: equipment-name
22960 example: __EQUIPMENT-NAME__
22961 - name: resource-version
22963 description: resource-version for concurrency
22970 summary: returns vpls-pes
22971 description: returns vpls-pes
22972 operationId: getNetworkVplsPes
22978 description: successful operation
22980 $ref: "#/getDefinitions/vpls-pes"
22982 description: Response codes found in [response codes](https://wiki.onap.org/).
22984 - name: equipment-name
22989 - name: prov-status
22994 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
22998 summary: see node definition for valid relationships
22999 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
23008 description: Response codes found in [response codes](https://wiki.onap.org/).
23010 - name: multicast-configuration-id
23012 description: Unique id of multicast configuration.
23015 example: __MULTICAST-CONFIGURATION-ID__
23018 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
23021 $ref: "#/definitions/relationship"
23025 summary: delete an existing relationship
23026 description: delete an existing relationship
23027 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
23036 description: Response codes found in [response codes](https://wiki.onap.org/).
23038 - name: multicast-configuration-id
23040 description: Unique id of multicast configuration.
23043 example: __MULTICAST-CONFIGURATION-ID__
23044 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
23048 summary: returns multicast-configuration
23049 description: returns multicast-configuration
23050 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
23056 description: successful operation
23058 $ref: "#/getDefinitions/multicast-configuration"
23060 description: Response codes found in [response codes](https://wiki.onap.org/).
23062 - name: multicast-configuration-id
23064 description: Unique id of multicast configuration.
23067 example: __MULTICAST-CONFIGURATION-ID__
23071 summary: create or update an existing multicast-configuration
23073 Create or update an existing multicast-configuration.
23075 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23076 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
23085 description: Response codes found in [response codes](https://wiki.onap.org/).
23087 - name: multicast-configuration-id
23089 description: Unique id of multicast configuration.
23092 example: __MULTICAST-CONFIGURATION-ID__
23095 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
23098 $ref: "#/definitions/multicast-configuration"
23102 summary: update an existing multicast-configuration
23104 Update an existing multicast-configuration
23106 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23107 The PUT operation will entirely replace an existing object.
23108 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23110 Other differences between PUT and PATCH are:
23112 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23113 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23114 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23115 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
23124 description: Response codes found in [response codes](https://wiki.onap.org/).
23126 - name: multicast-configuration-id
23128 description: Unique id of multicast configuration.
23131 example: __MULTICAST-CONFIGURATION-ID__
23134 description: multicast-configuration object that needs to be updated.
23137 $ref: "#/patchDefinitions/multicast-configuration"
23141 summary: delete an existing multicast-configuration
23142 description: delete an existing multicast-configuration
23143 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
23152 description: Response codes found in [response codes](https://wiki.onap.org/).
23154 - name: multicast-configuration-id
23156 description: Unique id of multicast configuration.
23159 example: __MULTICAST-CONFIGURATION-ID__
23160 - name: resource-version
23162 description: resource-version for concurrency
23165 /network/multicast-configurations:
23169 summary: returns multicast-configurations
23170 description: returns multicast-configurations
23171 operationId: getNetworkMulticastConfigurations
23177 description: successful operation
23179 $ref: "#/getDefinitions/multicast-configurations"
23181 description: Response codes found in [response codes](https://wiki.onap.org/).
23183 - name: multicast-configuration-id
23188 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
23192 summary: see node definition for valid relationships
23193 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
23202 description: Response codes found in [response codes](https://wiki.onap.org/).
23206 description: Unique id of VNF. This is unique across the graph.
23209 example: __VNF-ID__
23210 - name: interface-id
23212 description: Unique ID of the interface
23215 example: __INTERFACE-ID__
23218 description: See mis-na-virtualization-platform.yang
23222 example: __CVLAN-TAG__
23225 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
23228 $ref: "#/definitions/relationship"
23232 summary: delete an existing relationship
23233 description: delete an existing relationship
23234 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
23243 description: Response codes found in [response codes](https://wiki.onap.org/).
23247 description: Unique id of VNF. This is unique across the graph.
23250 example: __VNF-ID__
23251 - name: interface-id
23253 description: Unique ID of the interface
23256 example: __INTERFACE-ID__
23259 description: See mis-na-virtualization-platform.yang
23263 example: __CVLAN-TAG__
23264 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
23268 summary: returns cvlan-tag-entry
23269 description: returns cvlan-tag-entry
23270 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
23276 description: successful operation
23278 $ref: "#/getDefinitions/cvlan-tag-entry"
23280 description: Response codes found in [response codes](https://wiki.onap.org/).
23284 description: Unique id of VNF. This is unique across the graph.
23287 example: __VNF-ID__
23288 - name: interface-id
23290 description: Unique ID of the interface
23293 example: __INTERFACE-ID__
23296 description: See mis-na-virtualization-platform.yang
23300 example: __CVLAN-TAG__
23304 summary: create or update an existing cvlan-tag-entry
23306 Create or update an existing cvlan-tag-entry.
23308 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23309 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
23318 description: Response codes found in [response codes](https://wiki.onap.org/).
23322 description: Unique id of VNF. This is unique across the graph.
23325 example: __VNF-ID__
23326 - name: interface-id
23328 description: Unique ID of the interface
23331 example: __INTERFACE-ID__
23334 description: See mis-na-virtualization-platform.yang
23338 example: __CVLAN-TAG__
23341 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
23344 $ref: "#/definitions/cvlan-tag-entry"
23348 summary: update an existing cvlan-tag-entry
23350 Update an existing cvlan-tag-entry
23352 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23353 The PUT operation will entirely replace an existing object.
23354 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23356 Other differences between PUT and PATCH are:
23358 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23359 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23360 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23361 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
23370 description: Response codes found in [response codes](https://wiki.onap.org/).
23374 description: Unique id of VNF. This is unique across the graph.
23377 example: __VNF-ID__
23378 - name: interface-id
23380 description: Unique ID of the interface
23383 example: __INTERFACE-ID__
23386 description: See mis-na-virtualization-platform.yang
23390 example: __CVLAN-TAG__
23393 description: cvlan-tag-entry object that needs to be updated.
23396 $ref: "#/patchDefinitions/cvlan-tag-entry"
23400 summary: delete an existing cvlan-tag-entry
23401 description: delete an existing cvlan-tag-entry
23402 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
23411 description: Response codes found in [response codes](https://wiki.onap.org/).
23415 description: Unique id of VNF. This is unique across the graph.
23418 example: __VNF-ID__
23419 - name: interface-id
23421 description: Unique ID of the interface
23424 example: __INTERFACE-ID__
23427 description: See mis-na-virtualization-platform.yang
23431 example: __CVLAN-TAG__
23432 - name: resource-version
23434 description: resource-version for concurrency
23437 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
23441 summary: returns cvlan-tags
23442 description: returns cvlan-tags
23443 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
23449 description: successful operation
23451 $ref: "#/getDefinitions/cvlan-tags"
23453 description: Response codes found in [response codes](https://wiki.onap.org/).
23457 description: Unique id of VNF. This is unique across the graph.
23460 example: __VNF-ID__
23461 - name: interface-id
23463 description: Unique ID of the interface
23466 example: __INTERFACE-ID__
23473 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
23477 summary: see node definition for valid relationships
23478 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
23487 description: Response codes found in [response codes](https://wiki.onap.org/).
23491 description: Unique id of VNF. This is unique across the graph.
23494 example: __VNF-ID__
23495 - name: interface-id
23497 description: Unique ID of the interface
23500 example: __INTERFACE-ID__
23503 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
23506 $ref: "#/definitions/relationship"
23510 summary: delete an existing relationship
23511 description: delete an existing relationship
23512 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
23521 description: Response codes found in [response codes](https://wiki.onap.org/).
23525 description: Unique id of VNF. This is unique across the graph.
23528 example: __VNF-ID__
23529 - name: interface-id
23531 description: Unique ID of the interface
23534 example: __INTERFACE-ID__
23535 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
23539 summary: returns port-group
23540 description: returns port-group
23541 operationId: getNetworkVcesVcePortGroupsPortGroup
23547 description: successful operation
23549 $ref: "#/getDefinitions/port-group"
23551 description: Response codes found in [response codes](https://wiki.onap.org/).
23555 description: Unique id of VNF. This is unique across the graph.
23558 example: __VNF-ID__
23559 - name: interface-id
23561 description: Unique ID of the interface
23564 example: __INTERFACE-ID__
23568 summary: create or update an existing port-group
23570 Create or update an existing port-group.
23572 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23573 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
23582 description: Response codes found in [response codes](https://wiki.onap.org/).
23586 description: Unique id of VNF. This is unique across the graph.
23589 example: __VNF-ID__
23590 - name: interface-id
23592 description: Unique ID of the interface
23595 example: __INTERFACE-ID__
23598 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
23601 $ref: "#/definitions/port-group"
23605 summary: update an existing port-group
23607 Update an existing port-group
23609 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23610 The PUT operation will entirely replace an existing object.
23611 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23613 Other differences between PUT and PATCH are:
23615 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23616 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23617 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23618 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
23627 description: Response codes found in [response codes](https://wiki.onap.org/).
23631 description: Unique id of VNF. This is unique across the graph.
23634 example: __VNF-ID__
23635 - name: interface-id
23637 description: Unique ID of the interface
23640 example: __INTERFACE-ID__
23643 description: port-group object that needs to be updated.
23646 $ref: "#/patchDefinitions/port-group"
23650 summary: delete an existing port-group
23651 description: delete an existing port-group
23652 operationId: deleteNetworkVcesVcePortGroupsPortGroup
23661 description: Response codes found in [response codes](https://wiki.onap.org/).
23665 description: Unique id of VNF. This is unique across the graph.
23668 example: __VNF-ID__
23669 - name: interface-id
23671 description: Unique ID of the interface
23674 example: __INTERFACE-ID__
23675 - name: resource-version
23677 description: resource-version for concurrency
23680 /network/vces/vce/{vnf-id}/port-groups:
23684 summary: returns port-groups
23685 description: returns port-groups
23686 operationId: getNetworkVcesVcePortGroups
23692 description: successful operation
23694 $ref: "#/getDefinitions/port-groups"
23696 description: Response codes found in [response codes](https://wiki.onap.org/).
23700 description: Unique id of VNF. This is unique across the graph.
23703 example: __VNF-ID__
23704 - name: interface-id
23709 - name: port-group-id
23714 - name: switch-name
23719 - name: heat-stack-id
23724 /network/vces/vce/{vnf-id}/relationship-list/relationship:
23728 summary: see node definition for valid relationships
23729 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
23738 description: Response codes found in [response codes](https://wiki.onap.org/).
23742 description: Unique id of VNF. This is unique across the graph.
23745 example: __VNF-ID__
23748 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
23751 $ref: "#/definitions/relationship"
23755 summary: delete an existing relationship
23756 description: delete an existing relationship
23757 operationId: deleteNetworkVcesVceRelationshipListRelationship
23766 description: Response codes found in [response codes](https://wiki.onap.org/).
23770 description: Unique id of VNF. This is unique across the graph.
23773 example: __VNF-ID__
23774 /network/vces/vce/{vnf-id}:
23778 summary: returns vce
23779 description: returns vce
23780 operationId: getNetworkVcesVce
23786 description: successful operation
23788 $ref: "#/getDefinitions/vce"
23790 description: Response codes found in [response codes](https://wiki.onap.org/).
23794 description: Unique id of VNF. This is unique across the graph.
23797 example: __VNF-ID__
23801 summary: create or update an existing vce
23803 Create or update an existing vce.
23805 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23806 operationId: createOrUpdateNetworkVcesVce
23815 description: Response codes found in [response codes](https://wiki.onap.org/).
23819 description: Unique id of VNF. This is unique across the graph.
23822 example: __VNF-ID__
23825 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
23828 $ref: "#/definitions/vce"
23832 summary: update an existing vce
23834 Update an existing vce
23836 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23837 The PUT operation will entirely replace an existing object.
23838 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23840 Other differences between PUT and PATCH are:
23842 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23843 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23844 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23845 operationId: UpdateNetworkVcesVce
23854 description: Response codes found in [response codes](https://wiki.onap.org/).
23858 description: Unique id of VNF. This is unique across the graph.
23861 example: __VNF-ID__
23864 description: vce object that needs to be updated.
23867 $ref: "#/patchDefinitions/vce"
23871 summary: delete an existing vce
23872 description: delete an existing vce
23873 operationId: deleteNetworkVcesVce
23882 description: Response codes found in [response codes](https://wiki.onap.org/).
23886 description: Unique id of VNF. This is unique across the graph.
23889 example: __VNF-ID__
23890 - name: resource-version
23892 description: resource-version for concurrency
23899 summary: returns vces
23900 description: returns vces
23901 operationId: getNetworkVces
23907 description: successful operation
23909 $ref: "#/getDefinitions/vces"
23911 description: Response codes found in [response codes](https://wiki.onap.org/).
23938 - name: regional-resource-zone
23943 - name: prov-status
23948 - name: heat-stack-id
23958 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
23962 summary: see node definition for valid relationships
23963 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
23972 description: Response codes found in [response codes](https://wiki.onap.org/).
23976 description: Unique ID of vnfc.
23979 example: __VNFC-NAME__
23982 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
23985 $ref: "#/definitions/relationship"
23989 summary: delete an existing relationship
23990 description: delete an existing relationship
23991 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
24000 description: Response codes found in [response codes](https://wiki.onap.org/).
24004 description: Unique ID of vnfc.
24007 example: __VNFC-NAME__
24008 /network/vnfcs/vnfc/{vnfc-name}:
24012 summary: returns vnfc
24013 description: returns vnfc
24014 operationId: getNetworkVnfcsVnfc
24020 description: successful operation
24022 $ref: "#/getDefinitions/vnfc"
24024 description: Response codes found in [response codes](https://wiki.onap.org/).
24028 description: Unique ID of vnfc.
24031 example: __VNFC-NAME__
24035 summary: create or update an existing vnfc
24037 Create or update an existing vnfc.
24039 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24040 operationId: createOrUpdateNetworkVnfcsVnfc
24049 description: Response codes found in [response codes](https://wiki.onap.org/).
24053 description: Unique ID of vnfc.
24056 example: __VNFC-NAME__
24059 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
24062 $ref: "#/definitions/vnfc"
24066 summary: update an existing vnfc
24068 Update an existing vnfc
24070 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24071 The PUT operation will entirely replace an existing object.
24072 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24074 Other differences between PUT and PATCH are:
24076 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24077 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24078 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24079 operationId: UpdateNetworkVnfcsVnfc
24088 description: Response codes found in [response codes](https://wiki.onap.org/).
24092 description: Unique ID of vnfc.
24095 example: __VNFC-NAME__
24098 description: vnfc object that needs to be updated.
24101 $ref: "#/patchDefinitions/vnfc"
24105 summary: delete an existing vnfc
24106 description: delete an existing vnfc
24107 operationId: deleteNetworkVnfcsVnfc
24116 description: Response codes found in [response codes](https://wiki.onap.org/).
24120 description: Unique ID of vnfc.
24123 example: __VNFC-NAME__
24124 - name: resource-version
24126 description: resource-version for concurrency
24133 summary: returns vnfcs
24134 description: returns vnfcs
24135 operationId: getNetworkVnfcs
24141 description: successful operation
24143 $ref: "#/getDefinitions/vnfcs"
24145 description: Response codes found in [response codes](https://wiki.onap.org/).
24152 - name: vnfc-function-code
24162 - name: prov-status
24167 - name: ipaddress-v4-oam-vip
24177 - name: is-closed-loop-disabled
24182 - name: group-notation
24187 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
24191 summary: see node definition for valid relationships
24192 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
24201 description: Response codes found in [response codes](https://wiki.onap.org/).
24205 description: Network ID, should be uuid. Unique across A&AI.
24208 example: __NETWORK-ID__
24211 description: Subnet ID, should be UUID.
24214 example: __SUBNET-ID__
24217 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
24220 $ref: "#/definitions/relationship"
24224 summary: delete an existing relationship
24225 description: delete an existing relationship
24226 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
24235 description: Response codes found in [response codes](https://wiki.onap.org/).
24239 description: Network ID, should be uuid. Unique across A&AI.
24242 example: __NETWORK-ID__
24245 description: Subnet ID, should be UUID.
24248 example: __SUBNET-ID__
24249 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
24253 summary: returns subnet
24254 description: returns subnet
24255 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
24261 description: successful operation
24263 $ref: "#/getDefinitions/subnet"
24265 description: Response codes found in [response codes](https://wiki.onap.org/).
24269 description: Network ID, should be uuid. Unique across A&AI.
24272 example: __NETWORK-ID__
24275 description: Subnet ID, should be UUID.
24278 example: __SUBNET-ID__
24282 summary: create or update an existing subnet
24284 Create or update an existing subnet.
24286 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24287 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
24296 description: Response codes found in [response codes](https://wiki.onap.org/).
24300 description: Network ID, should be uuid. Unique across A&AI.
24303 example: __NETWORK-ID__
24306 description: Subnet ID, should be UUID.
24309 example: __SUBNET-ID__
24312 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
24315 $ref: "#/definitions/subnet"
24319 summary: update an existing subnet
24321 Update an existing subnet
24323 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24324 The PUT operation will entirely replace an existing object.
24325 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24327 Other differences between PUT and PATCH are:
24329 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24330 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24331 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24332 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
24341 description: Response codes found in [response codes](https://wiki.onap.org/).
24345 description: Network ID, should be uuid. Unique across A&AI.
24348 example: __NETWORK-ID__
24351 description: Subnet ID, should be UUID.
24354 example: __SUBNET-ID__
24357 description: subnet object that needs to be updated.
24360 $ref: "#/patchDefinitions/subnet"
24364 summary: delete an existing subnet
24365 description: delete an existing subnet
24366 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
24375 description: Response codes found in [response codes](https://wiki.onap.org/).
24379 description: Network ID, should be uuid. Unique across A&AI.
24382 example: __NETWORK-ID__
24385 description: Subnet ID, should be UUID.
24388 example: __SUBNET-ID__
24389 - name: resource-version
24391 description: resource-version for concurrency
24394 /network/l3-networks/l3-network/{network-id}/subnets:
24398 summary: returns subnets
24399 description: returns subnets
24400 operationId: getNetworkL3NetworksL3NetworkSubnets
24406 description: successful operation
24408 $ref: "#/getDefinitions/subnets"
24410 description: Response codes found in [response codes](https://wiki.onap.org/).
24414 description: Network ID, should be uuid. Unique across A&AI.
24417 example: __NETWORK-ID__
24423 - name: subnet-name
24428 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
24432 summary: see node definition for valid relationships
24433 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
24442 description: Response codes found in [response codes](https://wiki.onap.org/).
24446 description: Network ID, should be uuid. Unique across A&AI.
24449 example: __NETWORK-ID__
24450 - name: vlan-id-inner
24456 example: __VLAN-ID-INNER__
24459 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
24462 $ref: "#/definitions/relationship"
24466 summary: delete an existing relationship
24467 description: delete an existing relationship
24468 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
24477 description: Response codes found in [response codes](https://wiki.onap.org/).
24481 description: Network ID, should be uuid. Unique across A&AI.
24484 example: __NETWORK-ID__
24485 - name: vlan-id-inner
24491 example: __VLAN-ID-INNER__
24492 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
24496 summary: returns ctag-assignment
24497 description: returns ctag-assignment
24498 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
24504 description: successful operation
24506 $ref: "#/getDefinitions/ctag-assignment"
24508 description: Response codes found in [response codes](https://wiki.onap.org/).
24512 description: Network ID, should be uuid. Unique across A&AI.
24515 example: __NETWORK-ID__
24516 - name: vlan-id-inner
24522 example: __VLAN-ID-INNER__
24526 summary: create or update an existing ctag-assignment
24528 Create or update an existing ctag-assignment.
24530 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24531 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
24540 description: Response codes found in [response codes](https://wiki.onap.org/).
24544 description: Network ID, should be uuid. Unique across A&AI.
24547 example: __NETWORK-ID__
24548 - name: vlan-id-inner
24554 example: __VLAN-ID-INNER__
24557 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
24560 $ref: "#/definitions/ctag-assignment"
24564 summary: update an existing ctag-assignment
24566 Update an existing ctag-assignment
24568 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24569 The PUT operation will entirely replace an existing object.
24570 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24572 Other differences between PUT and PATCH are:
24574 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24575 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24576 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24577 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
24586 description: Response codes found in [response codes](https://wiki.onap.org/).
24590 description: Network ID, should be uuid. Unique across A&AI.
24593 example: __NETWORK-ID__
24594 - name: vlan-id-inner
24600 example: __VLAN-ID-INNER__
24603 description: ctag-assignment object that needs to be updated.
24606 $ref: "#/patchDefinitions/ctag-assignment"
24610 summary: delete an existing ctag-assignment
24611 description: delete an existing ctag-assignment
24612 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
24621 description: Response codes found in [response codes](https://wiki.onap.org/).
24625 description: Network ID, should be uuid. Unique across A&AI.
24628 example: __NETWORK-ID__
24629 - name: vlan-id-inner
24635 example: __VLAN-ID-INNER__
24636 - name: resource-version
24638 description: resource-version for concurrency
24641 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
24645 summary: returns ctag-assignments
24646 description: returns ctag-assignments
24647 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
24653 description: successful operation
24655 $ref: "#/getDefinitions/ctag-assignments"
24657 description: Response codes found in [response codes](https://wiki.onap.org/).
24661 description: Network ID, should be uuid. Unique across A&AI.
24664 example: __NETWORK-ID__
24665 - name: vlan-id-inner
24671 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
24675 summary: see node definition for valid relationships
24676 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
24685 description: Response codes found in [response codes](https://wiki.onap.org/).
24689 description: Network ID, should be uuid. Unique across A&AI.
24692 example: __NETWORK-ID__
24693 - name: segmentation-id
24695 description: Route Table Reference id, UUID assigned to this instance.
24698 example: __SEGMENTATION-ID__
24701 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
24704 $ref: "#/definitions/relationship"
24708 summary: delete an existing relationship
24709 description: delete an existing relationship
24710 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
24719 description: Response codes found in [response codes](https://wiki.onap.org/).
24723 description: Network ID, should be uuid. Unique across A&AI.
24726 example: __NETWORK-ID__
24727 - name: segmentation-id
24729 description: Route Table Reference id, UUID assigned to this instance.
24732 example: __SEGMENTATION-ID__
24733 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
24737 summary: returns segmentation-assignment
24738 description: returns segmentation-assignment
24739 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
24745 description: successful operation
24747 $ref: "#/getDefinitions/segmentation-assignment"
24749 description: Response codes found in [response codes](https://wiki.onap.org/).
24753 description: Network ID, should be uuid. Unique across A&AI.
24756 example: __NETWORK-ID__
24757 - name: segmentation-id
24759 description: Route Table Reference id, UUID assigned to this instance.
24762 example: __SEGMENTATION-ID__
24766 summary: create or update an existing segmentation-assignment
24768 Create or update an existing segmentation-assignment.
24770 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24771 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
24780 description: Response codes found in [response codes](https://wiki.onap.org/).
24784 description: Network ID, should be uuid. Unique across A&AI.
24787 example: __NETWORK-ID__
24788 - name: segmentation-id
24790 description: Route Table Reference id, UUID assigned to this instance.
24793 example: __SEGMENTATION-ID__
24796 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
24799 $ref: "#/definitions/segmentation-assignment"
24803 summary: update an existing segmentation-assignment
24805 Update an existing segmentation-assignment
24807 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24808 The PUT operation will entirely replace an existing object.
24809 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24811 Other differences between PUT and PATCH are:
24813 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24814 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24815 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24816 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
24825 description: Response codes found in [response codes](https://wiki.onap.org/).
24829 description: Network ID, should be uuid. Unique across A&AI.
24832 example: __NETWORK-ID__
24833 - name: segmentation-id
24835 description: Route Table Reference id, UUID assigned to this instance.
24838 example: __SEGMENTATION-ID__
24841 description: segmentation-assignment object that needs to be updated.
24844 $ref: "#/patchDefinitions/segmentation-assignment"
24848 summary: delete an existing segmentation-assignment
24849 description: delete an existing segmentation-assignment
24850 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
24859 description: Response codes found in [response codes](https://wiki.onap.org/).
24863 description: Network ID, should be uuid. Unique across A&AI.
24866 example: __NETWORK-ID__
24867 - name: segmentation-id
24869 description: Route Table Reference id, UUID assigned to this instance.
24872 example: __SEGMENTATION-ID__
24873 - name: resource-version
24875 description: resource-version for concurrency
24878 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
24882 summary: returns segmentation-assignments
24883 description: returns segmentation-assignments
24884 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
24890 description: successful operation
24892 $ref: "#/getDefinitions/segmentation-assignments"
24894 description: Response codes found in [response codes](https://wiki.onap.org/).
24898 description: Network ID, should be uuid. Unique across A&AI.
24901 example: __NETWORK-ID__
24902 - name: segmentation-id
24907 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
24911 summary: see node definition for valid relationships
24912 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
24921 description: Response codes found in [response codes](https://wiki.onap.org/).
24925 description: Network ID, should be uuid. Unique across A&AI.
24928 example: __NETWORK-ID__
24931 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
24934 $ref: "#/definitions/relationship"
24938 summary: delete an existing relationship
24939 description: delete an existing relationship
24940 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
24949 description: Response codes found in [response codes](https://wiki.onap.org/).
24953 description: Network ID, should be uuid. Unique across A&AI.
24956 example: __NETWORK-ID__
24957 /network/l3-networks/l3-network/{network-id}:
24961 summary: returns l3-network
24962 description: returns l3-network
24963 operationId: getNetworkL3NetworksL3Network
24969 description: successful operation
24971 $ref: "#/getDefinitions/l3-network"
24973 description: Response codes found in [response codes](https://wiki.onap.org/).
24977 description: Network ID, should be uuid. Unique across A&AI.
24980 example: __NETWORK-ID__
24984 summary: create or update an existing l3-network
24986 Create or update an existing l3-network.
24988 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24989 operationId: createOrUpdateNetworkL3NetworksL3Network
24998 description: Response codes found in [response codes](https://wiki.onap.org/).
25002 description: Network ID, should be uuid. Unique across A&AI.
25005 example: __NETWORK-ID__
25008 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
25011 $ref: "#/definitions/l3-network"
25015 summary: update an existing l3-network
25017 Update an existing l3-network
25019 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25020 The PUT operation will entirely replace an existing object.
25021 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25023 Other differences between PUT and PATCH are:
25025 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25026 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25027 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25028 operationId: UpdateNetworkL3NetworksL3Network
25037 description: Response codes found in [response codes](https://wiki.onap.org/).
25041 description: Network ID, should be uuid. Unique across A&AI.
25044 example: __NETWORK-ID__
25047 description: l3-network object that needs to be updated.
25050 $ref: "#/patchDefinitions/l3-network"
25054 summary: delete an existing l3-network
25055 description: delete an existing l3-network
25056 operationId: deleteNetworkL3NetworksL3Network
25065 description: Response codes found in [response codes](https://wiki.onap.org/).
25069 description: Network ID, should be uuid. Unique across A&AI.
25072 example: __NETWORK-ID__
25073 - name: resource-version
25075 description: resource-version for concurrency
25078 /network/l3-networks:
25082 summary: returns l3-networks
25083 description: returns l3-networks
25084 operationId: getNetworkL3Networks
25090 description: successful operation
25092 $ref: "#/getDefinitions/l3-networks"
25094 description: Response codes found in [response codes](https://wiki.onap.org/).
25101 - name: network-name
25111 - name: heat-stack-id
25116 - name: contrail-network-fqdn
25121 - name: persona-model-id
25126 - name: persona-model-version
25131 - name: widget-model-id
25136 - name: widget-model-version
25141 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
25145 summary: see node definition for valid relationships
25146 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
25155 description: Response codes found in [response codes](https://wiki.onap.org/).
25157 - name: network-policy-id
25159 description: UUID representing unique key to this instance
25162 example: __NETWORK-POLICY-ID__
25165 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
25168 $ref: "#/definitions/relationship"
25172 summary: delete an existing relationship
25173 description: delete an existing relationship
25174 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
25183 description: Response codes found in [response codes](https://wiki.onap.org/).
25185 - name: network-policy-id
25187 description: UUID representing unique key to this instance
25190 example: __NETWORK-POLICY-ID__
25191 /network/network-policies/network-policy/{network-policy-id}:
25195 summary: returns network-policy
25196 description: returns network-policy
25197 operationId: getNetworkNetworkPoliciesNetworkPolicy
25203 description: successful operation
25205 $ref: "#/getDefinitions/network-policy"
25207 description: Response codes found in [response codes](https://wiki.onap.org/).
25209 - name: network-policy-id
25211 description: UUID representing unique key to this instance
25214 example: __NETWORK-POLICY-ID__
25218 summary: create or update an existing network-policy
25220 Create or update an existing network-policy.
25222 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25223 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
25232 description: Response codes found in [response codes](https://wiki.onap.org/).
25234 - name: network-policy-id
25236 description: UUID representing unique key to this instance
25239 example: __NETWORK-POLICY-ID__
25242 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
25245 $ref: "#/definitions/network-policy"
25249 summary: update an existing network-policy
25251 Update an existing network-policy
25253 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25254 The PUT operation will entirely replace an existing object.
25255 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25257 Other differences between PUT and PATCH are:
25259 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25260 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25261 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25262 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
25271 description: Response codes found in [response codes](https://wiki.onap.org/).
25273 - name: network-policy-id
25275 description: UUID representing unique key to this instance
25278 example: __NETWORK-POLICY-ID__
25281 description: network-policy object that needs to be updated.
25284 $ref: "#/patchDefinitions/network-policy"
25288 summary: delete an existing network-policy
25289 description: delete an existing network-policy
25290 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
25299 description: Response codes found in [response codes](https://wiki.onap.org/).
25301 - name: network-policy-id
25303 description: UUID representing unique key to this instance
25306 example: __NETWORK-POLICY-ID__
25307 - name: resource-version
25309 description: resource-version for concurrency
25312 /network/network-policies:
25316 summary: returns network-policies
25317 description: returns network-policies
25318 operationId: getNetworkNetworkPolicies
25324 description: successful operation
25326 $ref: "#/getDefinitions/network-policies"
25328 description: Response codes found in [response codes](https://wiki.onap.org/).
25330 - name: network-policy-id
25335 - name: network-policy-fqdn
25340 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
25344 summary: see node definition for valid relationships
25345 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
25354 description: Response codes found in [response codes](https://wiki.onap.org/).
25358 description: Unique id of VNF. This is unique across the graph.
25361 example: __VNF-ID__
25364 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
25367 $ref: "#/definitions/relationship"
25371 summary: delete an existing relationship
25372 description: delete an existing relationship
25373 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
25382 description: Response codes found in [response codes](https://wiki.onap.org/).
25386 description: Unique id of VNF. This is unique across the graph.
25389 example: __VNF-ID__
25390 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
25394 summary: see node definition for valid relationships
25395 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25404 description: Response codes found in [response codes](https://wiki.onap.org/).
25408 description: Unique id of VNF. This is unique across the graph.
25411 example: __VNF-ID__
25412 - name: interface-name
25414 description: Name given to the interface
25417 example: __INTERFACE-NAME__
25418 - name: vlan-interface
25420 description: String that identifies the interface
25423 example: __VLAN-INTERFACE__
25426 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
25429 $ref: "#/definitions/relationship"
25433 summary: delete an existing relationship
25434 description: delete an existing relationship
25435 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25444 description: Response codes found in [response codes](https://wiki.onap.org/).
25448 description: Unique id of VNF. This is unique across the graph.
25451 example: __VNF-ID__
25452 - name: interface-name
25454 description: Name given to the interface
25457 example: __INTERFACE-NAME__
25458 - name: vlan-interface
25460 description: String that identifies the interface
25463 example: __VLAN-INTERFACE__
25464 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
25468 summary: see node definition for valid relationships
25469 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25478 description: Response codes found in [response codes](https://wiki.onap.org/).
25482 description: Unique id of VNF. This is unique across the graph.
25485 example: __VNF-ID__
25486 - name: interface-name
25488 description: Name given to the interface
25491 example: __INTERFACE-NAME__
25492 - name: vlan-interface
25494 description: String that identifies the interface
25497 example: __VLAN-INTERFACE__
25498 - name: l3-interface-ipv4-address
25500 description: IP address
25503 example: __L3-INTERFACE-IPV4-ADDRESS__
25506 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25509 $ref: "#/definitions/relationship"
25513 summary: delete an existing relationship
25514 description: delete an existing relationship
25515 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25524 description: Response codes found in [response codes](https://wiki.onap.org/).
25528 description: Unique id of VNF. This is unique across the graph.
25531 example: __VNF-ID__
25532 - name: interface-name
25534 description: Name given to the interface
25537 example: __INTERFACE-NAME__
25538 - name: vlan-interface
25540 description: String that identifies the interface
25543 example: __VLAN-INTERFACE__
25544 - name: l3-interface-ipv4-address
25546 description: IP address
25549 example: __L3-INTERFACE-IPV4-ADDRESS__
25550 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
25554 summary: returns l3-interface-ipv4-address-list
25555 description: returns l3-interface-ipv4-address-list
25556 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25562 description: successful operation
25564 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25566 description: Response codes found in [response codes](https://wiki.onap.org/).
25570 description: Unique id of VNF. This is unique across the graph.
25573 example: __VNF-ID__
25574 - name: interface-name
25576 description: Name given to the interface
25579 example: __INTERFACE-NAME__
25580 - name: vlan-interface
25582 description: String that identifies the interface
25585 example: __VLAN-INTERFACE__
25586 - name: l3-interface-ipv4-address
25588 description: IP address
25591 example: __L3-INTERFACE-IPV4-ADDRESS__
25595 summary: create or update an existing l3-interface-ipv4-address-list
25597 Create or update an existing l3-interface-ipv4-address-list.
25599 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25600 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25609 description: Response codes found in [response codes](https://wiki.onap.org/).
25613 description: Unique id of VNF. This is unique across the graph.
25616 example: __VNF-ID__
25617 - name: interface-name
25619 description: Name given to the interface
25622 example: __INTERFACE-NAME__
25623 - name: vlan-interface
25625 description: String that identifies the interface
25628 example: __VLAN-INTERFACE__
25629 - name: l3-interface-ipv4-address
25631 description: IP address
25634 example: __L3-INTERFACE-IPV4-ADDRESS__
25637 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25640 $ref: "#/definitions/l3-interface-ipv4-address-list"
25644 summary: update an existing l3-interface-ipv4-address-list
25646 Update an existing l3-interface-ipv4-address-list
25648 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25649 The PUT operation will entirely replace an existing object.
25650 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25652 Other differences between PUT and PATCH are:
25654 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25655 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25656 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25657 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25666 description: Response codes found in [response codes](https://wiki.onap.org/).
25670 description: Unique id of VNF. This is unique across the graph.
25673 example: __VNF-ID__
25674 - name: interface-name
25676 description: Name given to the interface
25679 example: __INTERFACE-NAME__
25680 - name: vlan-interface
25682 description: String that identifies the interface
25685 example: __VLAN-INTERFACE__
25686 - name: l3-interface-ipv4-address
25688 description: IP address
25691 example: __L3-INTERFACE-IPV4-ADDRESS__
25694 description: l3-interface-ipv4-address-list object that needs to be updated.
25697 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25701 summary: delete an existing l3-interface-ipv4-address-list
25702 description: delete an existing l3-interface-ipv4-address-list
25703 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25712 description: Response codes found in [response codes](https://wiki.onap.org/).
25716 description: Unique id of VNF. This is unique across the graph.
25719 example: __VNF-ID__
25720 - name: interface-name
25722 description: Name given to the interface
25725 example: __INTERFACE-NAME__
25726 - name: vlan-interface
25728 description: String that identifies the interface
25731 example: __VLAN-INTERFACE__
25732 - name: l3-interface-ipv4-address
25734 description: IP address
25737 example: __L3-INTERFACE-IPV4-ADDRESS__
25738 - name: resource-version
25740 description: resource-version for concurrency
25743 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
25747 summary: see node definition for valid relationships
25748 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25757 description: Response codes found in [response codes](https://wiki.onap.org/).
25761 description: Unique id of VNF. This is unique across the graph.
25764 example: __VNF-ID__
25765 - name: interface-name
25767 description: Name given to the interface
25770 example: __INTERFACE-NAME__
25771 - name: vlan-interface
25773 description: String that identifies the interface
25776 example: __VLAN-INTERFACE__
25777 - name: l3-interface-ipv6-address
25779 description: IP address
25782 example: __L3-INTERFACE-IPV6-ADDRESS__
25785 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25788 $ref: "#/definitions/relationship"
25792 summary: delete an existing relationship
25793 description: delete an existing relationship
25794 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25803 description: Response codes found in [response codes](https://wiki.onap.org/).
25807 description: Unique id of VNF. This is unique across the graph.
25810 example: __VNF-ID__
25811 - name: interface-name
25813 description: Name given to the interface
25816 example: __INTERFACE-NAME__
25817 - name: vlan-interface
25819 description: String that identifies the interface
25822 example: __VLAN-INTERFACE__
25823 - name: l3-interface-ipv6-address
25825 description: IP address
25828 example: __L3-INTERFACE-IPV6-ADDRESS__
25829 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
25833 summary: returns l3-interface-ipv6-address-list
25834 description: returns l3-interface-ipv6-address-list
25835 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25841 description: successful operation
25843 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25845 description: Response codes found in [response codes](https://wiki.onap.org/).
25849 description: Unique id of VNF. This is unique across the graph.
25852 example: __VNF-ID__
25853 - name: interface-name
25855 description: Name given to the interface
25858 example: __INTERFACE-NAME__
25859 - name: vlan-interface
25861 description: String that identifies the interface
25864 example: __VLAN-INTERFACE__
25865 - name: l3-interface-ipv6-address
25867 description: IP address
25870 example: __L3-INTERFACE-IPV6-ADDRESS__
25874 summary: create or update an existing l3-interface-ipv6-address-list
25876 Create or update an existing l3-interface-ipv6-address-list.
25878 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25879 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25888 description: Response codes found in [response codes](https://wiki.onap.org/).
25892 description: Unique id of VNF. This is unique across the graph.
25895 example: __VNF-ID__
25896 - name: interface-name
25898 description: Name given to the interface
25901 example: __INTERFACE-NAME__
25902 - name: vlan-interface
25904 description: String that identifies the interface
25907 example: __VLAN-INTERFACE__
25908 - name: l3-interface-ipv6-address
25910 description: IP address
25913 example: __L3-INTERFACE-IPV6-ADDRESS__
25916 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25919 $ref: "#/definitions/l3-interface-ipv6-address-list"
25923 summary: update an existing l3-interface-ipv6-address-list
25925 Update an existing l3-interface-ipv6-address-list
25927 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25928 The PUT operation will entirely replace an existing object.
25929 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25931 Other differences between PUT and PATCH are:
25933 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25934 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25935 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25936 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25945 description: Response codes found in [response codes](https://wiki.onap.org/).
25949 description: Unique id of VNF. This is unique across the graph.
25952 example: __VNF-ID__
25953 - name: interface-name
25955 description: Name given to the interface
25958 example: __INTERFACE-NAME__
25959 - name: vlan-interface
25961 description: String that identifies the interface
25964 example: __VLAN-INTERFACE__
25965 - name: l3-interface-ipv6-address
25967 description: IP address
25970 example: __L3-INTERFACE-IPV6-ADDRESS__
25973 description: l3-interface-ipv6-address-list object that needs to be updated.
25976 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25980 summary: delete an existing l3-interface-ipv6-address-list
25981 description: delete an existing l3-interface-ipv6-address-list
25982 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25991 description: Response codes found in [response codes](https://wiki.onap.org/).
25995 description: Unique id of VNF. This is unique across the graph.
25998 example: __VNF-ID__
25999 - name: interface-name
26001 description: Name given to the interface
26004 example: __INTERFACE-NAME__
26005 - name: vlan-interface
26007 description: String that identifies the interface
26010 example: __VLAN-INTERFACE__
26011 - name: l3-interface-ipv6-address
26013 description: IP address
26016 example: __L3-INTERFACE-IPV6-ADDRESS__
26017 - name: resource-version
26019 description: resource-version for concurrency
26022 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
26026 summary: returns vlan
26027 description: returns vlan
26028 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
26034 description: successful operation
26036 $ref: "#/getDefinitions/vlan"
26038 description: Response codes found in [response codes](https://wiki.onap.org/).
26042 description: Unique id of VNF. This is unique across the graph.
26045 example: __VNF-ID__
26046 - name: interface-name
26048 description: Name given to the interface
26051 example: __INTERFACE-NAME__
26052 - name: vlan-interface
26054 description: String that identifies the interface
26057 example: __VLAN-INTERFACE__
26061 summary: create or update an existing vlan
26063 Create or update an existing vlan.
26065 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26066 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
26075 description: Response codes found in [response codes](https://wiki.onap.org/).
26079 description: Unique id of VNF. This is unique across the graph.
26082 example: __VNF-ID__
26083 - name: interface-name
26085 description: Name given to the interface
26088 example: __INTERFACE-NAME__
26089 - name: vlan-interface
26091 description: String that identifies the interface
26094 example: __VLAN-INTERFACE__
26097 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
26100 $ref: "#/definitions/vlan"
26104 summary: update an existing vlan
26106 Update an existing vlan
26108 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26109 The PUT operation will entirely replace an existing object.
26110 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26112 Other differences between PUT and PATCH are:
26114 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26115 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26116 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26117 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
26126 description: Response codes found in [response codes](https://wiki.onap.org/).
26130 description: Unique id of VNF. This is unique across the graph.
26133 example: __VNF-ID__
26134 - name: interface-name
26136 description: Name given to the interface
26139 example: __INTERFACE-NAME__
26140 - name: vlan-interface
26142 description: String that identifies the interface
26145 example: __VLAN-INTERFACE__
26148 description: vlan object that needs to be updated.
26151 $ref: "#/patchDefinitions/vlan"
26155 summary: delete an existing vlan
26156 description: delete an existing vlan
26157 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
26166 description: Response codes found in [response codes](https://wiki.onap.org/).
26170 description: Unique id of VNF. This is unique across the graph.
26173 example: __VNF-ID__
26174 - name: interface-name
26176 description: Name given to the interface
26179 example: __INTERFACE-NAME__
26180 - name: vlan-interface
26182 description: String that identifies the interface
26185 example: __VLAN-INTERFACE__
26186 - name: resource-version
26188 description: resource-version for concurrency
26191 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
26195 summary: returns vlans
26196 description: returns vlans
26197 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
26203 description: successful operation
26205 $ref: "#/getDefinitions/vlans"
26207 description: Response codes found in [response codes](https://wiki.onap.org/).
26211 description: Unique id of VNF. This is unique across the graph.
26214 example: __VNF-ID__
26215 - name: interface-name
26217 description: Name given to the interface
26220 example: __INTERFACE-NAME__
26221 - name: vlan-interface
26226 - name: vlan-id-inner
26237 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
26241 summary: see node definition for valid relationships
26242 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26251 description: Response codes found in [response codes](https://wiki.onap.org/).
26255 description: Unique id of VNF. This is unique across the graph.
26258 example: __VNF-ID__
26259 - name: interface-name
26261 description: Name given to the interface
26264 example: __INTERFACE-NAME__
26267 description: PCI ID used to identify the sriov-vf
26270 example: __PCI-ID__
26273 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
26276 $ref: "#/definitions/relationship"
26280 summary: delete an existing relationship
26281 description: delete an existing relationship
26282 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26291 description: Response codes found in [response codes](https://wiki.onap.org/).
26295 description: Unique id of VNF. This is unique across the graph.
26298 example: __VNF-ID__
26299 - name: interface-name
26301 description: Name given to the interface
26304 example: __INTERFACE-NAME__
26307 description: PCI ID used to identify the sriov-vf
26310 example: __PCI-ID__
26311 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
26315 summary: returns sriov-vf
26316 description: returns sriov-vf
26317 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
26323 description: successful operation
26325 $ref: "#/getDefinitions/sriov-vf"
26327 description: Response codes found in [response codes](https://wiki.onap.org/).
26331 description: Unique id of VNF. This is unique across the graph.
26334 example: __VNF-ID__
26335 - name: interface-name
26337 description: Name given to the interface
26340 example: __INTERFACE-NAME__
26343 description: PCI ID used to identify the sriov-vf
26346 example: __PCI-ID__
26350 summary: create or update an existing sriov-vf
26352 Create or update an existing sriov-vf.
26354 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26355 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
26364 description: Response codes found in [response codes](https://wiki.onap.org/).
26368 description: Unique id of VNF. This is unique across the graph.
26371 example: __VNF-ID__
26372 - name: interface-name
26374 description: Name given to the interface
26377 example: __INTERFACE-NAME__
26380 description: PCI ID used to identify the sriov-vf
26383 example: __PCI-ID__
26386 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
26389 $ref: "#/definitions/sriov-vf"
26393 summary: update an existing sriov-vf
26395 Update an existing sriov-vf
26397 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26398 The PUT operation will entirely replace an existing object.
26399 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26401 Other differences between PUT and PATCH are:
26403 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26404 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26405 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26406 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
26415 description: Response codes found in [response codes](https://wiki.onap.org/).
26419 description: Unique id of VNF. This is unique across the graph.
26422 example: __VNF-ID__
26423 - name: interface-name
26425 description: Name given to the interface
26428 example: __INTERFACE-NAME__
26431 description: PCI ID used to identify the sriov-vf
26434 example: __PCI-ID__
26437 description: sriov-vf object that needs to be updated.
26440 $ref: "#/patchDefinitions/sriov-vf"
26444 summary: delete an existing sriov-vf
26445 description: delete an existing sriov-vf
26446 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
26455 description: Response codes found in [response codes](https://wiki.onap.org/).
26459 description: Unique id of VNF. This is unique across the graph.
26462 example: __VNF-ID__
26463 - name: interface-name
26465 description: Name given to the interface
26468 example: __INTERFACE-NAME__
26471 description: PCI ID used to identify the sriov-vf
26474 example: __PCI-ID__
26475 - name: resource-version
26477 description: resource-version for concurrency
26480 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
26484 summary: returns sriov-vfs
26485 description: returns sriov-vfs
26486 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
26492 description: successful operation
26494 $ref: "#/getDefinitions/sriov-vfs"
26496 description: Response codes found in [response codes](https://wiki.onap.org/).
26500 description: Unique id of VNF. This is unique across the graph.
26503 example: __VNF-ID__
26504 - name: interface-name
26506 description: Name given to the interface
26509 example: __INTERFACE-NAME__
26515 - name: vf-vlan-filter
26520 - name: vf-mac-filter
26525 - name: vf-vlan-strip
26530 - name: neutron-network-id
26535 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26539 summary: see node definition for valid relationships
26540 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
26549 description: Response codes found in [response codes](https://wiki.onap.org/).
26553 description: Unique id of VNF. This is unique across the graph.
26556 example: __VNF-ID__
26557 - name: interface-name
26559 description: Name given to the interface
26562 example: __INTERFACE-NAME__
26565 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
26568 $ref: "#/definitions/relationship"
26572 summary: delete an existing relationship
26573 description: delete an existing relationship
26574 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
26583 description: Response codes found in [response codes](https://wiki.onap.org/).
26587 description: Unique id of VNF. This is unique across the graph.
26590 example: __VNF-ID__
26591 - name: interface-name
26593 description: Name given to the interface
26596 example: __INTERFACE-NAME__
26597 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
26601 summary: see node definition for valid relationships
26602 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26611 description: Response codes found in [response codes](https://wiki.onap.org/).
26615 description: Unique id of VNF. This is unique across the graph.
26618 example: __VNF-ID__
26619 - name: interface-name
26621 description: Name given to the interface
26624 example: __INTERFACE-NAME__
26625 - name: l3-interface-ipv4-address
26627 description: IP address
26630 example: __L3-INTERFACE-IPV4-ADDRESS__
26633 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26636 $ref: "#/definitions/relationship"
26640 summary: delete an existing relationship
26641 description: delete an existing relationship
26642 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26651 description: Response codes found in [response codes](https://wiki.onap.org/).
26655 description: Unique id of VNF. This is unique across the graph.
26658 example: __VNF-ID__
26659 - name: interface-name
26661 description: Name given to the interface
26664 example: __INTERFACE-NAME__
26665 - name: l3-interface-ipv4-address
26667 description: IP address
26670 example: __L3-INTERFACE-IPV4-ADDRESS__
26671 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
26675 summary: returns l3-interface-ipv4-address-list
26676 description: returns l3-interface-ipv4-address-list
26677 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
26683 description: successful operation
26685 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26687 description: Response codes found in [response codes](https://wiki.onap.org/).
26691 description: Unique id of VNF. This is unique across the graph.
26694 example: __VNF-ID__
26695 - name: interface-name
26697 description: Name given to the interface
26700 example: __INTERFACE-NAME__
26701 - name: l3-interface-ipv4-address
26703 description: IP address
26706 example: __L3-INTERFACE-IPV4-ADDRESS__
26710 summary: create or update an existing l3-interface-ipv4-address-list
26712 Create or update an existing l3-interface-ipv4-address-list.
26714 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26715 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
26724 description: Response codes found in [response codes](https://wiki.onap.org/).
26728 description: Unique id of VNF. This is unique across the graph.
26731 example: __VNF-ID__
26732 - name: interface-name
26734 description: Name given to the interface
26737 example: __INTERFACE-NAME__
26738 - name: l3-interface-ipv4-address
26740 description: IP address
26743 example: __L3-INTERFACE-IPV4-ADDRESS__
26746 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26749 $ref: "#/definitions/l3-interface-ipv4-address-list"
26753 summary: update an existing l3-interface-ipv4-address-list
26755 Update an existing l3-interface-ipv4-address-list
26757 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26758 The PUT operation will entirely replace an existing object.
26759 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26761 Other differences between PUT and PATCH are:
26763 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26764 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26765 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26766 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
26775 description: Response codes found in [response codes](https://wiki.onap.org/).
26779 description: Unique id of VNF. This is unique across the graph.
26782 example: __VNF-ID__
26783 - name: interface-name
26785 description: Name given to the interface
26788 example: __INTERFACE-NAME__
26789 - name: l3-interface-ipv4-address
26791 description: IP address
26794 example: __L3-INTERFACE-IPV4-ADDRESS__
26797 description: l3-interface-ipv4-address-list object that needs to be updated.
26800 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26804 summary: delete an existing l3-interface-ipv4-address-list
26805 description: delete an existing l3-interface-ipv4-address-list
26806 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
26815 description: Response codes found in [response codes](https://wiki.onap.org/).
26819 description: Unique id of VNF. This is unique across the graph.
26822 example: __VNF-ID__
26823 - name: interface-name
26825 description: Name given to the interface
26828 example: __INTERFACE-NAME__
26829 - name: l3-interface-ipv4-address
26831 description: IP address
26834 example: __L3-INTERFACE-IPV4-ADDRESS__
26835 - name: resource-version
26837 description: resource-version for concurrency
26840 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
26844 summary: see node definition for valid relationships
26845 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26854 description: Response codes found in [response codes](https://wiki.onap.org/).
26858 description: Unique id of VNF. This is unique across the graph.
26861 example: __VNF-ID__
26862 - name: interface-name
26864 description: Name given to the interface
26867 example: __INTERFACE-NAME__
26868 - name: l3-interface-ipv6-address
26870 description: IP address
26873 example: __L3-INTERFACE-IPV6-ADDRESS__
26876 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26879 $ref: "#/definitions/relationship"
26883 summary: delete an existing relationship
26884 description: delete an existing relationship
26885 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26894 description: Response codes found in [response codes](https://wiki.onap.org/).
26898 description: Unique id of VNF. This is unique across the graph.
26901 example: __VNF-ID__
26902 - name: interface-name
26904 description: Name given to the interface
26907 example: __INTERFACE-NAME__
26908 - name: l3-interface-ipv6-address
26910 description: IP address
26913 example: __L3-INTERFACE-IPV6-ADDRESS__
26914 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
26918 summary: returns l3-interface-ipv6-address-list
26919 description: returns l3-interface-ipv6-address-list
26920 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
26926 description: successful operation
26928 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26930 description: Response codes found in [response codes](https://wiki.onap.org/).
26934 description: Unique id of VNF. This is unique across the graph.
26937 example: __VNF-ID__
26938 - name: interface-name
26940 description: Name given to the interface
26943 example: __INTERFACE-NAME__
26944 - name: l3-interface-ipv6-address
26946 description: IP address
26949 example: __L3-INTERFACE-IPV6-ADDRESS__
26953 summary: create or update an existing l3-interface-ipv6-address-list
26955 Create or update an existing l3-interface-ipv6-address-list.
26957 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26958 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
26967 description: Response codes found in [response codes](https://wiki.onap.org/).
26971 description: Unique id of VNF. This is unique across the graph.
26974 example: __VNF-ID__
26975 - name: interface-name
26977 description: Name given to the interface
26980 example: __INTERFACE-NAME__
26981 - name: l3-interface-ipv6-address
26983 description: IP address
26986 example: __L3-INTERFACE-IPV6-ADDRESS__
26989 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26992 $ref: "#/definitions/l3-interface-ipv6-address-list"
26996 summary: update an existing l3-interface-ipv6-address-list
26998 Update an existing l3-interface-ipv6-address-list
27000 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27001 The PUT operation will entirely replace an existing object.
27002 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27004 Other differences between PUT and PATCH are:
27006 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27007 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27008 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27009 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
27018 description: Response codes found in [response codes](https://wiki.onap.org/).
27022 description: Unique id of VNF. This is unique across the graph.
27025 example: __VNF-ID__
27026 - name: interface-name
27028 description: Name given to the interface
27031 example: __INTERFACE-NAME__
27032 - name: l3-interface-ipv6-address
27034 description: IP address
27037 example: __L3-INTERFACE-IPV6-ADDRESS__
27040 description: l3-interface-ipv6-address-list object that needs to be updated.
27043 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27047 summary: delete an existing l3-interface-ipv6-address-list
27048 description: delete an existing l3-interface-ipv6-address-list
27049 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
27058 description: Response codes found in [response codes](https://wiki.onap.org/).
27062 description: Unique id of VNF. This is unique across the graph.
27065 example: __VNF-ID__
27066 - name: interface-name
27068 description: Name given to the interface
27071 example: __INTERFACE-NAME__
27072 - name: l3-interface-ipv6-address
27074 description: IP address
27077 example: __L3-INTERFACE-IPV6-ADDRESS__
27078 - name: resource-version
27080 description: resource-version for concurrency
27083 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
27087 summary: returns l-interface
27088 description: returns l-interface
27089 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
27095 description: successful operation
27097 $ref: "#/getDefinitions/l-interface"
27099 description: Response codes found in [response codes](https://wiki.onap.org/).
27103 description: Unique id of VNF. This is unique across the graph.
27106 example: __VNF-ID__
27107 - name: interface-name
27109 description: Name given to the interface
27112 example: __INTERFACE-NAME__
27116 summary: create or update an existing l-interface
27118 Create or update an existing l-interface.
27120 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27121 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
27130 description: Response codes found in [response codes](https://wiki.onap.org/).
27134 description: Unique id of VNF. This is unique across the graph.
27137 example: __VNF-ID__
27138 - name: interface-name
27140 description: Name given to the interface
27143 example: __INTERFACE-NAME__
27146 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
27149 $ref: "#/definitions/l-interface"
27153 summary: update an existing l-interface
27155 Update an existing l-interface
27157 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27158 The PUT operation will entirely replace an existing object.
27159 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27161 Other differences between PUT and PATCH are:
27163 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27164 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27165 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27166 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
27175 description: Response codes found in [response codes](https://wiki.onap.org/).
27179 description: Unique id of VNF. This is unique across the graph.
27182 example: __VNF-ID__
27183 - name: interface-name
27185 description: Name given to the interface
27188 example: __INTERFACE-NAME__
27191 description: l-interface object that needs to be updated.
27194 $ref: "#/patchDefinitions/l-interface"
27198 summary: delete an existing l-interface
27199 description: delete an existing l-interface
27200 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
27209 description: Response codes found in [response codes](https://wiki.onap.org/).
27213 description: Unique id of VNF. This is unique across the graph.
27216 example: __VNF-ID__
27217 - name: interface-name
27219 description: Name given to the interface
27222 example: __INTERFACE-NAME__
27223 - name: resource-version
27225 description: resource-version for concurrency
27228 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
27232 summary: returns l-interfaces
27233 description: returns l-interfaces
27234 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
27240 description: successful operation
27242 $ref: "#/getDefinitions/l-interfaces"
27244 description: Response codes found in [response codes](https://wiki.onap.org/).
27248 description: Unique id of VNF. This is unique across the graph.
27251 example: __VNF-ID__
27252 - name: interface-name
27257 - name: interface-id
27267 - name: network-name
27272 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
27276 summary: see node definition for valid relationships
27277 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
27286 description: Response codes found in [response codes](https://wiki.onap.org/).
27290 description: Unique id of VNF. This is unique across the graph.
27293 example: __VNF-ID__
27294 - name: interface-name
27296 description: Name that identifies the link aggregate interface
27299 example: __INTERFACE-NAME__
27302 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
27305 $ref: "#/definitions/relationship"
27309 summary: delete an existing relationship
27310 description: delete an existing relationship
27311 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
27320 description: Response codes found in [response codes](https://wiki.onap.org/).
27324 description: Unique id of VNF. This is unique across the graph.
27327 example: __VNF-ID__
27328 - name: interface-name
27330 description: Name that identifies the link aggregate interface
27333 example: __INTERFACE-NAME__
27334 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
27338 summary: see node definition for valid relationships
27339 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27348 description: Response codes found in [response codes](https://wiki.onap.org/).
27352 description: Unique id of VNF. This is unique across the graph.
27355 example: __VNF-ID__
27356 - name: interface-name
27358 description: Name that identifies the link aggregate interface
27361 example: __INTERFACE-NAME__
27362 - name: interface-name
27364 description: Name given to the interface
27367 example: __INTERFACE-NAME__
27368 - name: vlan-interface
27370 description: String that identifies the interface
27373 example: __VLAN-INTERFACE__
27376 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
27379 $ref: "#/definitions/relationship"
27383 summary: delete an existing relationship
27384 description: delete an existing relationship
27385 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27394 description: Response codes found in [response codes](https://wiki.onap.org/).
27398 description: Unique id of VNF. This is unique across the graph.
27401 example: __VNF-ID__
27402 - name: interface-name
27404 description: Name that identifies the link aggregate interface
27407 example: __INTERFACE-NAME__
27408 - name: interface-name
27410 description: Name given to the interface
27413 example: __INTERFACE-NAME__
27414 - name: vlan-interface
27416 description: String that identifies the interface
27419 example: __VLAN-INTERFACE__
27420 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
27424 summary: see node definition for valid relationships
27425 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27434 description: Response codes found in [response codes](https://wiki.onap.org/).
27438 description: Unique id of VNF. This is unique across the graph.
27441 example: __VNF-ID__
27442 - name: interface-name
27444 description: Name that identifies the link aggregate interface
27447 example: __INTERFACE-NAME__
27448 - name: interface-name
27450 description: Name given to the interface
27453 example: __INTERFACE-NAME__
27454 - name: vlan-interface
27456 description: String that identifies the interface
27459 example: __VLAN-INTERFACE__
27460 - name: l3-interface-ipv4-address
27462 description: IP address
27465 example: __L3-INTERFACE-IPV4-ADDRESS__
27468 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27471 $ref: "#/definitions/relationship"
27475 summary: delete an existing relationship
27476 description: delete an existing relationship
27477 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27486 description: Response codes found in [response codes](https://wiki.onap.org/).
27490 description: Unique id of VNF. This is unique across the graph.
27493 example: __VNF-ID__
27494 - name: interface-name
27496 description: Name that identifies the link aggregate interface
27499 example: __INTERFACE-NAME__
27500 - name: interface-name
27502 description: Name given to the interface
27505 example: __INTERFACE-NAME__
27506 - name: vlan-interface
27508 description: String that identifies the interface
27511 example: __VLAN-INTERFACE__
27512 - name: l3-interface-ipv4-address
27514 description: IP address
27517 example: __L3-INTERFACE-IPV4-ADDRESS__
27518 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
27522 summary: returns l3-interface-ipv4-address-list
27523 description: returns l3-interface-ipv4-address-list
27524 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27530 description: successful operation
27532 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27534 description: Response codes found in [response codes](https://wiki.onap.org/).
27538 description: Unique id of VNF. This is unique across the graph.
27541 example: __VNF-ID__
27542 - name: interface-name
27544 description: Name that identifies the link aggregate interface
27547 example: __INTERFACE-NAME__
27548 - name: interface-name
27550 description: Name given to the interface
27553 example: __INTERFACE-NAME__
27554 - name: vlan-interface
27556 description: String that identifies the interface
27559 example: __VLAN-INTERFACE__
27560 - name: l3-interface-ipv4-address
27562 description: IP address
27565 example: __L3-INTERFACE-IPV4-ADDRESS__
27569 summary: create or update an existing l3-interface-ipv4-address-list
27571 Create or update an existing l3-interface-ipv4-address-list.
27573 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27574 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27583 description: Response codes found in [response codes](https://wiki.onap.org/).
27587 description: Unique id of VNF. This is unique across the graph.
27590 example: __VNF-ID__
27591 - name: interface-name
27593 description: Name that identifies the link aggregate interface
27596 example: __INTERFACE-NAME__
27597 - name: interface-name
27599 description: Name given to the interface
27602 example: __INTERFACE-NAME__
27603 - name: vlan-interface
27605 description: String that identifies the interface
27608 example: __VLAN-INTERFACE__
27609 - name: l3-interface-ipv4-address
27611 description: IP address
27614 example: __L3-INTERFACE-IPV4-ADDRESS__
27617 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27620 $ref: "#/definitions/l3-interface-ipv4-address-list"
27624 summary: update an existing l3-interface-ipv4-address-list
27626 Update an existing l3-interface-ipv4-address-list
27628 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27629 The PUT operation will entirely replace an existing object.
27630 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27632 Other differences between PUT and PATCH are:
27634 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27635 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27636 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27637 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27646 description: Response codes found in [response codes](https://wiki.onap.org/).
27650 description: Unique id of VNF. This is unique across the graph.
27653 example: __VNF-ID__
27654 - name: interface-name
27656 description: Name that identifies the link aggregate interface
27659 example: __INTERFACE-NAME__
27660 - name: interface-name
27662 description: Name given to the interface
27665 example: __INTERFACE-NAME__
27666 - name: vlan-interface
27668 description: String that identifies the interface
27671 example: __VLAN-INTERFACE__
27672 - name: l3-interface-ipv4-address
27674 description: IP address
27677 example: __L3-INTERFACE-IPV4-ADDRESS__
27680 description: l3-interface-ipv4-address-list object that needs to be updated.
27683 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27687 summary: delete an existing l3-interface-ipv4-address-list
27688 description: delete an existing l3-interface-ipv4-address-list
27689 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27698 description: Response codes found in [response codes](https://wiki.onap.org/).
27702 description: Unique id of VNF. This is unique across the graph.
27705 example: __VNF-ID__
27706 - name: interface-name
27708 description: Name that identifies the link aggregate interface
27711 example: __INTERFACE-NAME__
27712 - name: interface-name
27714 description: Name given to the interface
27717 example: __INTERFACE-NAME__
27718 - name: vlan-interface
27720 description: String that identifies the interface
27723 example: __VLAN-INTERFACE__
27724 - name: l3-interface-ipv4-address
27726 description: IP address
27729 example: __L3-INTERFACE-IPV4-ADDRESS__
27730 - name: resource-version
27732 description: resource-version for concurrency
27735 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
27739 summary: see node definition for valid relationships
27740 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27749 description: Response codes found in [response codes](https://wiki.onap.org/).
27753 description: Unique id of VNF. This is unique across the graph.
27756 example: __VNF-ID__
27757 - name: interface-name
27759 description: Name that identifies the link aggregate interface
27762 example: __INTERFACE-NAME__
27763 - name: interface-name
27765 description: Name given to the interface
27768 example: __INTERFACE-NAME__
27769 - name: vlan-interface
27771 description: String that identifies the interface
27774 example: __VLAN-INTERFACE__
27775 - name: l3-interface-ipv6-address
27777 description: IP address
27780 example: __L3-INTERFACE-IPV6-ADDRESS__
27783 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27786 $ref: "#/definitions/relationship"
27790 summary: delete an existing relationship
27791 description: delete an existing relationship
27792 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27801 description: Response codes found in [response codes](https://wiki.onap.org/).
27805 description: Unique id of VNF. This is unique across the graph.
27808 example: __VNF-ID__
27809 - name: interface-name
27811 description: Name that identifies the link aggregate interface
27814 example: __INTERFACE-NAME__
27815 - name: interface-name
27817 description: Name given to the interface
27820 example: __INTERFACE-NAME__
27821 - name: vlan-interface
27823 description: String that identifies the interface
27826 example: __VLAN-INTERFACE__
27827 - name: l3-interface-ipv6-address
27829 description: IP address
27832 example: __L3-INTERFACE-IPV6-ADDRESS__
27833 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
27837 summary: returns l3-interface-ipv6-address-list
27838 description: returns l3-interface-ipv6-address-list
27839 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27845 description: successful operation
27847 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27849 description: Response codes found in [response codes](https://wiki.onap.org/).
27853 description: Unique id of VNF. This is unique across the graph.
27856 example: __VNF-ID__
27857 - name: interface-name
27859 description: Name that identifies the link aggregate interface
27862 example: __INTERFACE-NAME__
27863 - name: interface-name
27865 description: Name given to the interface
27868 example: __INTERFACE-NAME__
27869 - name: vlan-interface
27871 description: String that identifies the interface
27874 example: __VLAN-INTERFACE__
27875 - name: l3-interface-ipv6-address
27877 description: IP address
27880 example: __L3-INTERFACE-IPV6-ADDRESS__
27884 summary: create or update an existing l3-interface-ipv6-address-list
27886 Create or update an existing l3-interface-ipv6-address-list.
27888 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27889 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27898 description: Response codes found in [response codes](https://wiki.onap.org/).
27902 description: Unique id of VNF. This is unique across the graph.
27905 example: __VNF-ID__
27906 - name: interface-name
27908 description: Name that identifies the link aggregate interface
27911 example: __INTERFACE-NAME__
27912 - name: interface-name
27914 description: Name given to the interface
27917 example: __INTERFACE-NAME__
27918 - name: vlan-interface
27920 description: String that identifies the interface
27923 example: __VLAN-INTERFACE__
27924 - name: l3-interface-ipv6-address
27926 description: IP address
27929 example: __L3-INTERFACE-IPV6-ADDRESS__
27932 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27935 $ref: "#/definitions/l3-interface-ipv6-address-list"
27939 summary: update an existing l3-interface-ipv6-address-list
27941 Update an existing l3-interface-ipv6-address-list
27943 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27944 The PUT operation will entirely replace an existing object.
27945 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27947 Other differences between PUT and PATCH are:
27949 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27950 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27951 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27952 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27961 description: Response codes found in [response codes](https://wiki.onap.org/).
27965 description: Unique id of VNF. This is unique across the graph.
27968 example: __VNF-ID__
27969 - name: interface-name
27971 description: Name that identifies the link aggregate interface
27974 example: __INTERFACE-NAME__
27975 - name: interface-name
27977 description: Name given to the interface
27980 example: __INTERFACE-NAME__
27981 - name: vlan-interface
27983 description: String that identifies the interface
27986 example: __VLAN-INTERFACE__
27987 - name: l3-interface-ipv6-address
27989 description: IP address
27992 example: __L3-INTERFACE-IPV6-ADDRESS__
27995 description: l3-interface-ipv6-address-list object that needs to be updated.
27998 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28002 summary: delete an existing l3-interface-ipv6-address-list
28003 description: delete an existing l3-interface-ipv6-address-list
28004 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28013 description: Response codes found in [response codes](https://wiki.onap.org/).
28017 description: Unique id of VNF. This is unique across the graph.
28020 example: __VNF-ID__
28021 - name: interface-name
28023 description: Name that identifies the link aggregate interface
28026 example: __INTERFACE-NAME__
28027 - name: interface-name
28029 description: Name given to the interface
28032 example: __INTERFACE-NAME__
28033 - name: vlan-interface
28035 description: String that identifies the interface
28038 example: __VLAN-INTERFACE__
28039 - name: l3-interface-ipv6-address
28041 description: IP address
28044 example: __L3-INTERFACE-IPV6-ADDRESS__
28045 - name: resource-version
28047 description: resource-version for concurrency
28050 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
28054 summary: returns vlan
28055 description: returns vlan
28056 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28062 description: successful operation
28064 $ref: "#/getDefinitions/vlan"
28066 description: Response codes found in [response codes](https://wiki.onap.org/).
28070 description: Unique id of VNF. This is unique across the graph.
28073 example: __VNF-ID__
28074 - name: interface-name
28076 description: Name that identifies the link aggregate interface
28079 example: __INTERFACE-NAME__
28080 - name: interface-name
28082 description: Name given to the interface
28085 example: __INTERFACE-NAME__
28086 - name: vlan-interface
28088 description: String that identifies the interface
28091 example: __VLAN-INTERFACE__
28095 summary: create or update an existing vlan
28097 Create or update an existing vlan.
28099 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28100 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28109 description: Response codes found in [response codes](https://wiki.onap.org/).
28113 description: Unique id of VNF. This is unique across the graph.
28116 example: __VNF-ID__
28117 - name: interface-name
28119 description: Name that identifies the link aggregate interface
28122 example: __INTERFACE-NAME__
28123 - name: interface-name
28125 description: Name given to the interface
28128 example: __INTERFACE-NAME__
28129 - name: vlan-interface
28131 description: String that identifies the interface
28134 example: __VLAN-INTERFACE__
28137 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
28140 $ref: "#/definitions/vlan"
28144 summary: update an existing vlan
28146 Update an existing vlan
28148 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28149 The PUT operation will entirely replace an existing object.
28150 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28152 Other differences between PUT and PATCH are:
28154 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28155 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28156 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28157 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28166 description: Response codes found in [response codes](https://wiki.onap.org/).
28170 description: Unique id of VNF. This is unique across the graph.
28173 example: __VNF-ID__
28174 - name: interface-name
28176 description: Name that identifies the link aggregate interface
28179 example: __INTERFACE-NAME__
28180 - name: interface-name
28182 description: Name given to the interface
28185 example: __INTERFACE-NAME__
28186 - name: vlan-interface
28188 description: String that identifies the interface
28191 example: __VLAN-INTERFACE__
28194 description: vlan object that needs to be updated.
28197 $ref: "#/patchDefinitions/vlan"
28201 summary: delete an existing vlan
28202 description: delete an existing vlan
28203 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28212 description: Response codes found in [response codes](https://wiki.onap.org/).
28216 description: Unique id of VNF. This is unique across the graph.
28219 example: __VNF-ID__
28220 - name: interface-name
28222 description: Name that identifies the link aggregate interface
28225 example: __INTERFACE-NAME__
28226 - name: interface-name
28228 description: Name given to the interface
28231 example: __INTERFACE-NAME__
28232 - name: vlan-interface
28234 description: String that identifies the interface
28237 example: __VLAN-INTERFACE__
28238 - name: resource-version
28240 description: resource-version for concurrency
28243 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
28247 summary: returns vlans
28248 description: returns vlans
28249 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
28255 description: successful operation
28257 $ref: "#/getDefinitions/vlans"
28259 description: Response codes found in [response codes](https://wiki.onap.org/).
28263 description: Unique id of VNF. This is unique across the graph.
28266 example: __VNF-ID__
28267 - name: interface-name
28269 description: Name that identifies the link aggregate interface
28272 example: __INTERFACE-NAME__
28273 - name: interface-name
28275 description: Name given to the interface
28278 example: __INTERFACE-NAME__
28279 - name: vlan-interface
28284 - name: vlan-id-inner
28295 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
28299 summary: see node definition for valid relationships
28300 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28309 description: Response codes found in [response codes](https://wiki.onap.org/).
28313 description: Unique id of VNF. This is unique across the graph.
28316 example: __VNF-ID__
28317 - name: interface-name
28319 description: Name that identifies the link aggregate interface
28322 example: __INTERFACE-NAME__
28323 - name: interface-name
28325 description: Name given to the interface
28328 example: __INTERFACE-NAME__
28331 description: PCI ID used to identify the sriov-vf
28334 example: __PCI-ID__
28337 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28340 $ref: "#/definitions/relationship"
28344 summary: delete an existing relationship
28345 description: delete an existing relationship
28346 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28355 description: Response codes found in [response codes](https://wiki.onap.org/).
28359 description: Unique id of VNF. This is unique across the graph.
28362 example: __VNF-ID__
28363 - name: interface-name
28365 description: Name that identifies the link aggregate interface
28368 example: __INTERFACE-NAME__
28369 - name: interface-name
28371 description: Name given to the interface
28374 example: __INTERFACE-NAME__
28377 description: PCI ID used to identify the sriov-vf
28380 example: __PCI-ID__
28381 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
28385 summary: returns sriov-vf
28386 description: returns sriov-vf
28387 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28393 description: successful operation
28395 $ref: "#/getDefinitions/sriov-vf"
28397 description: Response codes found in [response codes](https://wiki.onap.org/).
28401 description: Unique id of VNF. This is unique across the graph.
28404 example: __VNF-ID__
28405 - name: interface-name
28407 description: Name that identifies the link aggregate interface
28410 example: __INTERFACE-NAME__
28411 - name: interface-name
28413 description: Name given to the interface
28416 example: __INTERFACE-NAME__
28419 description: PCI ID used to identify the sriov-vf
28422 example: __PCI-ID__
28426 summary: create or update an existing sriov-vf
28428 Create or update an existing sriov-vf.
28430 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28431 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28440 description: Response codes found in [response codes](https://wiki.onap.org/).
28444 description: Unique id of VNF. This is unique across the graph.
28447 example: __VNF-ID__
28448 - name: interface-name
28450 description: Name that identifies the link aggregate interface
28453 example: __INTERFACE-NAME__
28454 - name: interface-name
28456 description: Name given to the interface
28459 example: __INTERFACE-NAME__
28462 description: PCI ID used to identify the sriov-vf
28465 example: __PCI-ID__
28468 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28471 $ref: "#/definitions/sriov-vf"
28475 summary: update an existing sriov-vf
28477 Update an existing sriov-vf
28479 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28480 The PUT operation will entirely replace an existing object.
28481 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28483 Other differences between PUT and PATCH are:
28485 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28486 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28487 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28488 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28497 description: Response codes found in [response codes](https://wiki.onap.org/).
28501 description: Unique id of VNF. This is unique across the graph.
28504 example: __VNF-ID__
28505 - name: interface-name
28507 description: Name that identifies the link aggregate interface
28510 example: __INTERFACE-NAME__
28511 - name: interface-name
28513 description: Name given to the interface
28516 example: __INTERFACE-NAME__
28519 description: PCI ID used to identify the sriov-vf
28522 example: __PCI-ID__
28525 description: sriov-vf object that needs to be updated.
28528 $ref: "#/patchDefinitions/sriov-vf"
28532 summary: delete an existing sriov-vf
28533 description: delete an existing sriov-vf
28534 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28543 description: Response codes found in [response codes](https://wiki.onap.org/).
28547 description: Unique id of VNF. This is unique across the graph.
28550 example: __VNF-ID__
28551 - name: interface-name
28553 description: Name that identifies the link aggregate interface
28556 example: __INTERFACE-NAME__
28557 - name: interface-name
28559 description: Name given to the interface
28562 example: __INTERFACE-NAME__
28565 description: PCI ID used to identify the sriov-vf
28568 example: __PCI-ID__
28569 - name: resource-version
28571 description: resource-version for concurrency
28574 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28578 summary: returns sriov-vfs
28579 description: returns sriov-vfs
28580 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
28586 description: successful operation
28588 $ref: "#/getDefinitions/sriov-vfs"
28590 description: Response codes found in [response codes](https://wiki.onap.org/).
28594 description: Unique id of VNF. This is unique across the graph.
28597 example: __VNF-ID__
28598 - name: interface-name
28600 description: Name that identifies the link aggregate interface
28603 example: __INTERFACE-NAME__
28604 - name: interface-name
28606 description: Name given to the interface
28609 example: __INTERFACE-NAME__
28615 - name: vf-vlan-filter
28620 - name: vf-mac-filter
28625 - name: vf-vlan-strip
28630 - name: neutron-network-id
28635 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28639 summary: see node definition for valid relationships
28640 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28649 description: Response codes found in [response codes](https://wiki.onap.org/).
28653 description: Unique id of VNF. This is unique across the graph.
28656 example: __VNF-ID__
28657 - name: interface-name
28659 description: Name that identifies the link aggregate interface
28662 example: __INTERFACE-NAME__
28663 - name: interface-name
28665 description: Name given to the interface
28668 example: __INTERFACE-NAME__
28671 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
28674 $ref: "#/definitions/relationship"
28678 summary: delete an existing relationship
28679 description: delete an existing relationship
28680 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28689 description: Response codes found in [response codes](https://wiki.onap.org/).
28693 description: Unique id of VNF. This is unique across the graph.
28696 example: __VNF-ID__
28697 - name: interface-name
28699 description: Name that identifies the link aggregate interface
28702 example: __INTERFACE-NAME__
28703 - name: interface-name
28705 description: Name given to the interface
28708 example: __INTERFACE-NAME__
28709 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
28713 summary: see node definition for valid relationships
28714 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28723 description: Response codes found in [response codes](https://wiki.onap.org/).
28727 description: Unique id of VNF. This is unique across the graph.
28730 example: __VNF-ID__
28731 - name: interface-name
28733 description: Name that identifies the link aggregate interface
28736 example: __INTERFACE-NAME__
28737 - name: interface-name
28739 description: Name given to the interface
28742 example: __INTERFACE-NAME__
28743 - name: l3-interface-ipv4-address
28745 description: IP address
28748 example: __L3-INTERFACE-IPV4-ADDRESS__
28751 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28754 $ref: "#/definitions/relationship"
28758 summary: delete an existing relationship
28759 description: delete an existing relationship
28760 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28769 description: Response codes found in [response codes](https://wiki.onap.org/).
28773 description: Unique id of VNF. This is unique across the graph.
28776 example: __VNF-ID__
28777 - name: interface-name
28779 description: Name that identifies the link aggregate interface
28782 example: __INTERFACE-NAME__
28783 - name: interface-name
28785 description: Name given to the interface
28788 example: __INTERFACE-NAME__
28789 - name: l3-interface-ipv4-address
28791 description: IP address
28794 example: __L3-INTERFACE-IPV4-ADDRESS__
28795 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
28799 summary: returns l3-interface-ipv4-address-list
28800 description: returns l3-interface-ipv4-address-list
28801 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28807 description: successful operation
28809 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28811 description: Response codes found in [response codes](https://wiki.onap.org/).
28815 description: Unique id of VNF. This is unique across the graph.
28818 example: __VNF-ID__
28819 - name: interface-name
28821 description: Name that identifies the link aggregate interface
28824 example: __INTERFACE-NAME__
28825 - name: interface-name
28827 description: Name given to the interface
28830 example: __INTERFACE-NAME__
28831 - name: l3-interface-ipv4-address
28833 description: IP address
28836 example: __L3-INTERFACE-IPV4-ADDRESS__
28840 summary: create or update an existing l3-interface-ipv4-address-list
28842 Create or update an existing l3-interface-ipv4-address-list.
28844 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28845 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28854 description: Response codes found in [response codes](https://wiki.onap.org/).
28858 description: Unique id of VNF. This is unique across the graph.
28861 example: __VNF-ID__
28862 - name: interface-name
28864 description: Name that identifies the link aggregate interface
28867 example: __INTERFACE-NAME__
28868 - name: interface-name
28870 description: Name given to the interface
28873 example: __INTERFACE-NAME__
28874 - name: l3-interface-ipv4-address
28876 description: IP address
28879 example: __L3-INTERFACE-IPV4-ADDRESS__
28882 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28885 $ref: "#/definitions/l3-interface-ipv4-address-list"
28889 summary: update an existing l3-interface-ipv4-address-list
28891 Update an existing l3-interface-ipv4-address-list
28893 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28894 The PUT operation will entirely replace an existing object.
28895 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28897 Other differences between PUT and PATCH are:
28899 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28900 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28901 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28902 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28911 description: Response codes found in [response codes](https://wiki.onap.org/).
28915 description: Unique id of VNF. This is unique across the graph.
28918 example: __VNF-ID__
28919 - name: interface-name
28921 description: Name that identifies the link aggregate interface
28924 example: __INTERFACE-NAME__
28925 - name: interface-name
28927 description: Name given to the interface
28930 example: __INTERFACE-NAME__
28931 - name: l3-interface-ipv4-address
28933 description: IP address
28936 example: __L3-INTERFACE-IPV4-ADDRESS__
28939 description: l3-interface-ipv4-address-list object that needs to be updated.
28942 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28946 summary: delete an existing l3-interface-ipv4-address-list
28947 description: delete an existing l3-interface-ipv4-address-list
28948 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28957 description: Response codes found in [response codes](https://wiki.onap.org/).
28961 description: Unique id of VNF. This is unique across the graph.
28964 example: __VNF-ID__
28965 - name: interface-name
28967 description: Name that identifies the link aggregate interface
28970 example: __INTERFACE-NAME__
28971 - name: interface-name
28973 description: Name given to the interface
28976 example: __INTERFACE-NAME__
28977 - name: l3-interface-ipv4-address
28979 description: IP address
28982 example: __L3-INTERFACE-IPV4-ADDRESS__
28983 - name: resource-version
28985 description: resource-version for concurrency
28988 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
28992 summary: see node definition for valid relationships
28993 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
29002 description: Response codes found in [response codes](https://wiki.onap.org/).
29006 description: Unique id of VNF. This is unique across the graph.
29009 example: __VNF-ID__
29010 - name: interface-name
29012 description: Name that identifies the link aggregate interface
29015 example: __INTERFACE-NAME__
29016 - name: interface-name
29018 description: Name given to the interface
29021 example: __INTERFACE-NAME__
29022 - name: l3-interface-ipv6-address
29024 description: IP address
29027 example: __L3-INTERFACE-IPV6-ADDRESS__
29030 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
29033 $ref: "#/definitions/relationship"
29037 summary: delete an existing relationship
29038 description: delete an existing relationship
29039 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
29048 description: Response codes found in [response codes](https://wiki.onap.org/).
29052 description: Unique id of VNF. This is unique across the graph.
29055 example: __VNF-ID__
29056 - name: interface-name
29058 description: Name that identifies the link aggregate interface
29061 example: __INTERFACE-NAME__
29062 - name: interface-name
29064 description: Name given to the interface
29067 example: __INTERFACE-NAME__
29068 - name: l3-interface-ipv6-address
29070 description: IP address
29073 example: __L3-INTERFACE-IPV6-ADDRESS__
29074 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
29078 summary: returns l3-interface-ipv6-address-list
29079 description: returns l3-interface-ipv6-address-list
29080 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29086 description: successful operation
29088 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29090 description: Response codes found in [response codes](https://wiki.onap.org/).
29094 description: Unique id of VNF. This is unique across the graph.
29097 example: __VNF-ID__
29098 - name: interface-name
29100 description: Name that identifies the link aggregate interface
29103 example: __INTERFACE-NAME__
29104 - name: interface-name
29106 description: Name given to the interface
29109 example: __INTERFACE-NAME__
29110 - name: l3-interface-ipv6-address
29112 description: IP address
29115 example: __L3-INTERFACE-IPV6-ADDRESS__
29119 summary: create or update an existing l3-interface-ipv6-address-list
29121 Create or update an existing l3-interface-ipv6-address-list.
29123 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29124 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29133 description: Response codes found in [response codes](https://wiki.onap.org/).
29137 description: Unique id of VNF. This is unique across the graph.
29140 example: __VNF-ID__
29141 - name: interface-name
29143 description: Name that identifies the link aggregate interface
29146 example: __INTERFACE-NAME__
29147 - name: interface-name
29149 description: Name given to the interface
29152 example: __INTERFACE-NAME__
29153 - name: l3-interface-ipv6-address
29155 description: IP address
29158 example: __L3-INTERFACE-IPV6-ADDRESS__
29161 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
29164 $ref: "#/definitions/l3-interface-ipv6-address-list"
29168 summary: update an existing l3-interface-ipv6-address-list
29170 Update an existing l3-interface-ipv6-address-list
29172 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29173 The PUT operation will entirely replace an existing object.
29174 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29176 Other differences between PUT and PATCH are:
29178 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29179 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29180 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29181 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29190 description: Response codes found in [response codes](https://wiki.onap.org/).
29194 description: Unique id of VNF. This is unique across the graph.
29197 example: __VNF-ID__
29198 - name: interface-name
29200 description: Name that identifies the link aggregate interface
29203 example: __INTERFACE-NAME__
29204 - name: interface-name
29206 description: Name given to the interface
29209 example: __INTERFACE-NAME__
29210 - name: l3-interface-ipv6-address
29212 description: IP address
29215 example: __L3-INTERFACE-IPV6-ADDRESS__
29218 description: l3-interface-ipv6-address-list object that needs to be updated.
29221 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29225 summary: delete an existing l3-interface-ipv6-address-list
29226 description: delete an existing l3-interface-ipv6-address-list
29227 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29236 description: Response codes found in [response codes](https://wiki.onap.org/).
29240 description: Unique id of VNF. This is unique across the graph.
29243 example: __VNF-ID__
29244 - name: interface-name
29246 description: Name that identifies the link aggregate interface
29249 example: __INTERFACE-NAME__
29250 - name: interface-name
29252 description: Name given to the interface
29255 example: __INTERFACE-NAME__
29256 - name: l3-interface-ipv6-address
29258 description: IP address
29261 example: __L3-INTERFACE-IPV6-ADDRESS__
29262 - name: resource-version
29264 description: resource-version for concurrency
29267 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
29271 summary: returns l-interface
29272 description: returns l-interface
29273 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
29279 description: successful operation
29281 $ref: "#/getDefinitions/l-interface"
29283 description: Response codes found in [response codes](https://wiki.onap.org/).
29287 description: Unique id of VNF. This is unique across the graph.
29290 example: __VNF-ID__
29291 - name: interface-name
29293 description: Name that identifies the link aggregate interface
29296 example: __INTERFACE-NAME__
29297 - name: interface-name
29299 description: Name given to the interface
29302 example: __INTERFACE-NAME__
29306 summary: create or update an existing l-interface
29308 Create or update an existing l-interface.
29310 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29311 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
29320 description: Response codes found in [response codes](https://wiki.onap.org/).
29324 description: Unique id of VNF. This is unique across the graph.
29327 example: __VNF-ID__
29328 - name: interface-name
29330 description: Name that identifies the link aggregate interface
29333 example: __INTERFACE-NAME__
29334 - name: interface-name
29336 description: Name given to the interface
29339 example: __INTERFACE-NAME__
29342 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
29345 $ref: "#/definitions/l-interface"
29349 summary: update an existing l-interface
29351 Update an existing l-interface
29353 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29354 The PUT operation will entirely replace an existing object.
29355 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29357 Other differences between PUT and PATCH are:
29359 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29360 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29361 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29362 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
29371 description: Response codes found in [response codes](https://wiki.onap.org/).
29375 description: Unique id of VNF. This is unique across the graph.
29378 example: __VNF-ID__
29379 - name: interface-name
29381 description: Name that identifies the link aggregate interface
29384 example: __INTERFACE-NAME__
29385 - name: interface-name
29387 description: Name given to the interface
29390 example: __INTERFACE-NAME__
29393 description: l-interface object that needs to be updated.
29396 $ref: "#/patchDefinitions/l-interface"
29400 summary: delete an existing l-interface
29401 description: delete an existing l-interface
29402 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
29411 description: Response codes found in [response codes](https://wiki.onap.org/).
29415 description: Unique id of VNF. This is unique across the graph.
29418 example: __VNF-ID__
29419 - name: interface-name
29421 description: Name that identifies the link aggregate interface
29424 example: __INTERFACE-NAME__
29425 - name: interface-name
29427 description: Name given to the interface
29430 example: __INTERFACE-NAME__
29431 - name: resource-version
29433 description: resource-version for concurrency
29436 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
29440 summary: returns l-interfaces
29441 description: returns l-interfaces
29442 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
29448 description: successful operation
29450 $ref: "#/getDefinitions/l-interfaces"
29452 description: Response codes found in [response codes](https://wiki.onap.org/).
29456 description: Unique id of VNF. This is unique across the graph.
29459 example: __VNF-ID__
29460 - name: interface-name
29462 description: Name that identifies the link aggregate interface
29465 example: __INTERFACE-NAME__
29466 - name: interface-name
29471 - name: interface-id
29481 - name: network-name
29486 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
29490 summary: returns lag-interface
29491 description: returns lag-interface
29492 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
29498 description: successful operation
29500 $ref: "#/getDefinitions/lag-interface"
29502 description: Response codes found in [response codes](https://wiki.onap.org/).
29506 description: Unique id of VNF. This is unique across the graph.
29509 example: __VNF-ID__
29510 - name: interface-name
29512 description: Name that identifies the link aggregate interface
29515 example: __INTERFACE-NAME__
29519 summary: create or update an existing lag-interface
29521 Create or update an existing lag-interface.
29523 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29524 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
29533 description: Response codes found in [response codes](https://wiki.onap.org/).
29537 description: Unique id of VNF. This is unique across the graph.
29540 example: __VNF-ID__
29541 - name: interface-name
29543 description: Name that identifies the link aggregate interface
29546 example: __INTERFACE-NAME__
29549 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
29552 $ref: "#/definitions/lag-interface"
29556 summary: update an existing lag-interface
29558 Update an existing lag-interface
29560 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29561 The PUT operation will entirely replace an existing object.
29562 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29564 Other differences between PUT and PATCH are:
29566 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29567 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29568 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29569 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
29578 description: Response codes found in [response codes](https://wiki.onap.org/).
29582 description: Unique id of VNF. This is unique across the graph.
29585 example: __VNF-ID__
29586 - name: interface-name
29588 description: Name that identifies the link aggregate interface
29591 example: __INTERFACE-NAME__
29594 description: lag-interface object that needs to be updated.
29597 $ref: "#/patchDefinitions/lag-interface"
29601 summary: delete an existing lag-interface
29602 description: delete an existing lag-interface
29603 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
29612 description: Response codes found in [response codes](https://wiki.onap.org/).
29616 description: Unique id of VNF. This is unique across the graph.
29619 example: __VNF-ID__
29620 - name: interface-name
29622 description: Name that identifies the link aggregate interface
29625 example: __INTERFACE-NAME__
29626 - name: resource-version
29628 description: resource-version for concurrency
29631 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
29635 summary: returns lag-interfaces
29636 description: returns lag-interfaces
29637 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
29643 description: successful operation
29645 $ref: "#/getDefinitions/lag-interfaces"
29647 description: Response codes found in [response codes](https://wiki.onap.org/).
29651 description: Unique id of VNF. This is unique across the graph.
29654 example: __VNF-ID__
29655 - name: interface-name
29660 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
29664 summary: see node definition for valid relationships
29665 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
29674 description: Response codes found in [response codes](https://wiki.onap.org/).
29678 description: Unique id of VNF. This is unique across the graph.
29681 example: __VNF-ID__
29682 - name: vf-module-id
29684 description: Unique ID of vf-module.
29687 example: __VF-MODULE-ID__
29690 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
29693 $ref: "#/definitions/relationship"
29697 summary: delete an existing relationship
29698 description: delete an existing relationship
29699 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
29708 description: Response codes found in [response codes](https://wiki.onap.org/).
29712 description: Unique id of VNF. This is unique across the graph.
29715 example: __VNF-ID__
29716 - name: vf-module-id
29718 description: Unique ID of vf-module.
29721 example: __VF-MODULE-ID__
29722 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
29726 summary: returns vf-module
29727 description: returns vf-module
29728 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
29734 description: successful operation
29736 $ref: "#/getDefinitions/vf-module"
29738 description: Response codes found in [response codes](https://wiki.onap.org/).
29742 description: Unique id of VNF. This is unique across the graph.
29745 example: __VNF-ID__
29746 - name: vf-module-id
29748 description: Unique ID of vf-module.
29751 example: __VF-MODULE-ID__
29755 summary: create or update an existing vf-module
29757 Create or update an existing vf-module.
29759 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29760 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
29769 description: Response codes found in [response codes](https://wiki.onap.org/).
29773 description: Unique id of VNF. This is unique across the graph.
29776 example: __VNF-ID__
29777 - name: vf-module-id
29779 description: Unique ID of vf-module.
29782 example: __VF-MODULE-ID__
29785 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
29788 $ref: "#/definitions/vf-module"
29792 summary: update an existing vf-module
29794 Update an existing vf-module
29796 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29797 The PUT operation will entirely replace an existing object.
29798 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29800 Other differences between PUT and PATCH are:
29802 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29803 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29804 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29805 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
29814 description: Response codes found in [response codes](https://wiki.onap.org/).
29818 description: Unique id of VNF. This is unique across the graph.
29821 example: __VNF-ID__
29822 - name: vf-module-id
29824 description: Unique ID of vf-module.
29827 example: __VF-MODULE-ID__
29830 description: vf-module object that needs to be updated.
29833 $ref: "#/patchDefinitions/vf-module"
29837 summary: delete an existing vf-module
29838 description: delete an existing vf-module
29839 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
29848 description: Response codes found in [response codes](https://wiki.onap.org/).
29852 description: Unique id of VNF. This is unique across the graph.
29855 example: __VNF-ID__
29856 - name: vf-module-id
29858 description: Unique ID of vf-module.
29861 example: __VF-MODULE-ID__
29862 - name: resource-version
29864 description: resource-version for concurrency
29867 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
29871 summary: returns vf-modules
29872 description: returns vf-modules
29873 operationId: getNetworkGenericVnfsGenericVnfVfModules
29879 description: successful operation
29881 $ref: "#/getDefinitions/vf-modules"
29883 description: Response codes found in [response codes](https://wiki.onap.org/).
29887 description: Unique id of VNF. This is unique across the graph.
29890 example: __VNF-ID__
29891 - name: vf-module-id
29896 - name: vf-module-name
29901 - name: heat-stack-id
29906 - name: persona-model-id
29911 - name: persona-model-version
29916 - name: widget-model-id
29921 - name: widget-model-version
29926 - name: contrail-service-instance-fqdn
29931 /network/generic-vnfs/generic-vnf/{vnf-id}:
29935 summary: returns generic-vnf
29936 description: returns generic-vnf
29937 operationId: getNetworkGenericVnfsGenericVnf
29943 description: successful operation
29945 $ref: "#/getDefinitions/generic-vnf"
29947 description: Response codes found in [response codes](https://wiki.onap.org/).
29951 description: Unique id of VNF. This is unique across the graph.
29954 example: __VNF-ID__
29958 summary: create or update an existing generic-vnf
29960 Create or update an existing generic-vnf.
29962 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29963 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
29972 description: Response codes found in [response codes](https://wiki.onap.org/).
29976 description: Unique id of VNF. This is unique across the graph.
29979 example: __VNF-ID__
29982 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
29985 $ref: "#/definitions/generic-vnf"
29989 summary: update an existing generic-vnf
29991 Update an existing generic-vnf
29993 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29994 The PUT operation will entirely replace an existing object.
29995 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29997 Other differences between PUT and PATCH are:
29999 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30000 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30001 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30002 operationId: UpdateNetworkGenericVnfsGenericVnf
30011 description: Response codes found in [response codes](https://wiki.onap.org/).
30015 description: Unique id of VNF. This is unique across the graph.
30018 example: __VNF-ID__
30021 description: generic-vnf object that needs to be updated.
30024 $ref: "#/patchDefinitions/generic-vnf"
30028 summary: delete an existing generic-vnf
30029 description: delete an existing generic-vnf
30030 operationId: deleteNetworkGenericVnfsGenericVnf
30039 description: Response codes found in [response codes](https://wiki.onap.org/).
30043 description: Unique id of VNF. This is unique across the graph.
30046 example: __VNF-ID__
30047 - name: resource-version
30049 description: resource-version for concurrency
30052 /network/generic-vnfs:
30056 summary: returns generic-vnfs
30057 description: returns generic-vnfs
30058 operationId: getNetworkGenericVnfs
30064 description: successful operation
30066 $ref: "#/getDefinitions/generic-vnfs"
30068 description: Response codes found in [response codes](https://wiki.onap.org/).
30095 - name: regional-resource-zone
30100 - name: prov-status
30105 - name: heat-stack-id
30115 - name: is-closed-loop-disabled
30120 - name: persona-model-id
30125 - name: persona-model-version
30130 - name: widget-model-id
30135 - name: widget-model-version
30140 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
30144 summary: see node definition for valid relationships
30145 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
30154 description: Response codes found in [response codes](https://wiki.onap.org/).
30158 description: Alphabetical concatenation of lag-interface names
30161 example: __LINK-NAME__
30164 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
30167 $ref: "#/definitions/relationship"
30171 summary: delete an existing relationship
30172 description: delete an existing relationship
30173 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
30182 description: Response codes found in [response codes](https://wiki.onap.org/).
30186 description: Alphabetical concatenation of lag-interface names
30189 example: __LINK-NAME__
30190 /network/lag-links/lag-link/{link-name}:
30194 summary: returns lag-link
30195 description: returns lag-link
30196 operationId: getNetworkLagLinksLagLink
30202 description: successful operation
30204 $ref: "#/getDefinitions/lag-link"
30206 description: Response codes found in [response codes](https://wiki.onap.org/).
30210 description: Alphabetical concatenation of lag-interface names
30213 example: __LINK-NAME__
30217 summary: create or update an existing lag-link
30219 Create or update an existing lag-link.
30221 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30222 operationId: createOrUpdateNetworkLagLinksLagLink
30231 description: Response codes found in [response codes](https://wiki.onap.org/).
30235 description: Alphabetical concatenation of lag-interface names
30238 example: __LINK-NAME__
30241 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
30244 $ref: "#/definitions/lag-link"
30248 summary: update an existing lag-link
30250 Update an existing lag-link
30252 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30253 The PUT operation will entirely replace an existing object.
30254 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30256 Other differences between PUT and PATCH are:
30258 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30259 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30260 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30261 operationId: UpdateNetworkLagLinksLagLink
30270 description: Response codes found in [response codes](https://wiki.onap.org/).
30274 description: Alphabetical concatenation of lag-interface names
30277 example: __LINK-NAME__
30280 description: lag-link object that needs to be updated.
30283 $ref: "#/patchDefinitions/lag-link"
30287 summary: delete an existing lag-link
30288 description: delete an existing lag-link
30289 operationId: deleteNetworkLagLinksLagLink
30298 description: Response codes found in [response codes](https://wiki.onap.org/).
30302 description: Alphabetical concatenation of lag-interface names
30305 example: __LINK-NAME__
30306 - name: resource-version
30308 description: resource-version for concurrency
30311 /network/lag-links:
30315 summary: returns lag-links
30316 description: returns lag-links
30317 operationId: getNetworkLagLinks
30323 description: successful operation
30325 $ref: "#/getDefinitions/lag-links"
30327 description: Response codes found in [response codes](https://wiki.onap.org/).
30334 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
30338 summary: see node definition for valid relationships
30339 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
30348 description: Response codes found in [response codes](https://wiki.onap.org/).
30352 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30355 example: __VNF-ID2__
30358 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
30361 $ref: "#/definitions/relationship"
30365 summary: delete an existing relationship
30366 description: delete an existing relationship
30367 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
30376 description: Response codes found in [response codes](https://wiki.onap.org/).
30380 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30383 example: __VNF-ID2__
30384 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
30388 summary: see node definition for valid relationships
30389 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30398 description: Response codes found in [response codes](https://wiki.onap.org/).
30402 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30405 example: __VNF-ID2__
30406 - name: interface-name
30408 description: Name given to the interface
30411 example: __INTERFACE-NAME__
30412 - name: vlan-interface
30414 description: String that identifies the interface
30417 example: __VLAN-INTERFACE__
30420 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
30423 $ref: "#/definitions/relationship"
30427 summary: delete an existing relationship
30428 description: delete an existing relationship
30429 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30438 description: Response codes found in [response codes](https://wiki.onap.org/).
30442 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30445 example: __VNF-ID2__
30446 - name: interface-name
30448 description: Name given to the interface
30451 example: __INTERFACE-NAME__
30452 - name: vlan-interface
30454 description: String that identifies the interface
30457 example: __VLAN-INTERFACE__
30458 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
30462 summary: see node definition for valid relationships
30463 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30472 description: Response codes found in [response codes](https://wiki.onap.org/).
30476 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30479 example: __VNF-ID2__
30480 - name: interface-name
30482 description: Name given to the interface
30485 example: __INTERFACE-NAME__
30486 - name: vlan-interface
30488 description: String that identifies the interface
30491 example: __VLAN-INTERFACE__
30492 - name: l3-interface-ipv4-address
30494 description: IP address
30497 example: __L3-INTERFACE-IPV4-ADDRESS__
30500 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30503 $ref: "#/definitions/relationship"
30507 summary: delete an existing relationship
30508 description: delete an existing relationship
30509 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30518 description: Response codes found in [response codes](https://wiki.onap.org/).
30522 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30525 example: __VNF-ID2__
30526 - name: interface-name
30528 description: Name given to the interface
30531 example: __INTERFACE-NAME__
30532 - name: vlan-interface
30534 description: String that identifies the interface
30537 example: __VLAN-INTERFACE__
30538 - name: l3-interface-ipv4-address
30540 description: IP address
30543 example: __L3-INTERFACE-IPV4-ADDRESS__
30544 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
30548 summary: returns l3-interface-ipv4-address-list
30549 description: returns l3-interface-ipv4-address-list
30550 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30556 description: successful operation
30558 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30560 description: Response codes found in [response codes](https://wiki.onap.org/).
30564 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30567 example: __VNF-ID2__
30568 - name: interface-name
30570 description: Name given to the interface
30573 example: __INTERFACE-NAME__
30574 - name: vlan-interface
30576 description: String that identifies the interface
30579 example: __VLAN-INTERFACE__
30580 - name: l3-interface-ipv4-address
30582 description: IP address
30585 example: __L3-INTERFACE-IPV4-ADDRESS__
30589 summary: create or update an existing l3-interface-ipv4-address-list
30591 Create or update an existing l3-interface-ipv4-address-list.
30593 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30594 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30603 description: Response codes found in [response codes](https://wiki.onap.org/).
30607 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30610 example: __VNF-ID2__
30611 - name: interface-name
30613 description: Name given to the interface
30616 example: __INTERFACE-NAME__
30617 - name: vlan-interface
30619 description: String that identifies the interface
30622 example: __VLAN-INTERFACE__
30623 - name: l3-interface-ipv4-address
30625 description: IP address
30628 example: __L3-INTERFACE-IPV4-ADDRESS__
30631 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30634 $ref: "#/definitions/l3-interface-ipv4-address-list"
30638 summary: update an existing l3-interface-ipv4-address-list
30640 Update an existing l3-interface-ipv4-address-list
30642 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30643 The PUT operation will entirely replace an existing object.
30644 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30646 Other differences between PUT and PATCH are:
30648 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30649 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30650 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30651 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30660 description: Response codes found in [response codes](https://wiki.onap.org/).
30664 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30667 example: __VNF-ID2__
30668 - name: interface-name
30670 description: Name given to the interface
30673 example: __INTERFACE-NAME__
30674 - name: vlan-interface
30676 description: String that identifies the interface
30679 example: __VLAN-INTERFACE__
30680 - name: l3-interface-ipv4-address
30682 description: IP address
30685 example: __L3-INTERFACE-IPV4-ADDRESS__
30688 description: l3-interface-ipv4-address-list object that needs to be updated.
30691 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30695 summary: delete an existing l3-interface-ipv4-address-list
30696 description: delete an existing l3-interface-ipv4-address-list
30697 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30706 description: Response codes found in [response codes](https://wiki.onap.org/).
30710 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30713 example: __VNF-ID2__
30714 - name: interface-name
30716 description: Name given to the interface
30719 example: __INTERFACE-NAME__
30720 - name: vlan-interface
30722 description: String that identifies the interface
30725 example: __VLAN-INTERFACE__
30726 - name: l3-interface-ipv4-address
30728 description: IP address
30731 example: __L3-INTERFACE-IPV4-ADDRESS__
30732 - name: resource-version
30734 description: resource-version for concurrency
30737 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
30741 summary: see node definition for valid relationships
30742 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30751 description: Response codes found in [response codes](https://wiki.onap.org/).
30755 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30758 example: __VNF-ID2__
30759 - name: interface-name
30761 description: Name given to the interface
30764 example: __INTERFACE-NAME__
30765 - name: vlan-interface
30767 description: String that identifies the interface
30770 example: __VLAN-INTERFACE__
30771 - name: l3-interface-ipv6-address
30773 description: IP address
30776 example: __L3-INTERFACE-IPV6-ADDRESS__
30779 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
30782 $ref: "#/definitions/relationship"
30786 summary: delete an existing relationship
30787 description: delete an existing relationship
30788 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30797 description: Response codes found in [response codes](https://wiki.onap.org/).
30801 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30804 example: __VNF-ID2__
30805 - name: interface-name
30807 description: Name given to the interface
30810 example: __INTERFACE-NAME__
30811 - name: vlan-interface
30813 description: String that identifies the interface
30816 example: __VLAN-INTERFACE__
30817 - name: l3-interface-ipv6-address
30819 description: IP address
30822 example: __L3-INTERFACE-IPV6-ADDRESS__
30823 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
30827 summary: returns l3-interface-ipv6-address-list
30828 description: returns l3-interface-ipv6-address-list
30829 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30835 description: successful operation
30837 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30839 description: Response codes found in [response codes](https://wiki.onap.org/).
30843 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30846 example: __VNF-ID2__
30847 - name: interface-name
30849 description: Name given to the interface
30852 example: __INTERFACE-NAME__
30853 - name: vlan-interface
30855 description: String that identifies the interface
30858 example: __VLAN-INTERFACE__
30859 - name: l3-interface-ipv6-address
30861 description: IP address
30864 example: __L3-INTERFACE-IPV6-ADDRESS__
30868 summary: create or update an existing l3-interface-ipv6-address-list
30870 Create or update an existing l3-interface-ipv6-address-list.
30872 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30873 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30882 description: Response codes found in [response codes](https://wiki.onap.org/).
30886 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30889 example: __VNF-ID2__
30890 - name: interface-name
30892 description: Name given to the interface
30895 example: __INTERFACE-NAME__
30896 - name: vlan-interface
30898 description: String that identifies the interface
30901 example: __VLAN-INTERFACE__
30902 - name: l3-interface-ipv6-address
30904 description: IP address
30907 example: __L3-INTERFACE-IPV6-ADDRESS__
30910 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
30913 $ref: "#/definitions/l3-interface-ipv6-address-list"
30917 summary: update an existing l3-interface-ipv6-address-list
30919 Update an existing l3-interface-ipv6-address-list
30921 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30922 The PUT operation will entirely replace an existing object.
30923 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30925 Other differences between PUT and PATCH are:
30927 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30928 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30929 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30930 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30939 description: Response codes found in [response codes](https://wiki.onap.org/).
30943 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30946 example: __VNF-ID2__
30947 - name: interface-name
30949 description: Name given to the interface
30952 example: __INTERFACE-NAME__
30953 - name: vlan-interface
30955 description: String that identifies the interface
30958 example: __VLAN-INTERFACE__
30959 - name: l3-interface-ipv6-address
30961 description: IP address
30964 example: __L3-INTERFACE-IPV6-ADDRESS__
30967 description: l3-interface-ipv6-address-list object that needs to be updated.
30970 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30974 summary: delete an existing l3-interface-ipv6-address-list
30975 description: delete an existing l3-interface-ipv6-address-list
30976 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30985 description: Response codes found in [response codes](https://wiki.onap.org/).
30989 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
30992 example: __VNF-ID2__
30993 - name: interface-name
30995 description: Name given to the interface
30998 example: __INTERFACE-NAME__
30999 - name: vlan-interface
31001 description: String that identifies the interface
31004 example: __VLAN-INTERFACE__
31005 - name: l3-interface-ipv6-address
31007 description: IP address
31010 example: __L3-INTERFACE-IPV6-ADDRESS__
31011 - name: resource-version
31013 description: resource-version for concurrency
31016 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31020 summary: returns vlan
31021 description: returns vlan
31022 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
31028 description: successful operation
31030 $ref: "#/getDefinitions/vlan"
31032 description: Response codes found in [response codes](https://wiki.onap.org/).
31036 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31039 example: __VNF-ID2__
31040 - name: interface-name
31042 description: Name given to the interface
31045 example: __INTERFACE-NAME__
31046 - name: vlan-interface
31048 description: String that identifies the interface
31051 example: __VLAN-INTERFACE__
31055 summary: create or update an existing vlan
31057 Create or update an existing vlan.
31059 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31060 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
31069 description: Response codes found in [response codes](https://wiki.onap.org/).
31073 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31076 example: __VNF-ID2__
31077 - name: interface-name
31079 description: Name given to the interface
31082 example: __INTERFACE-NAME__
31083 - name: vlan-interface
31085 description: String that identifies the interface
31088 example: __VLAN-INTERFACE__
31091 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
31094 $ref: "#/definitions/vlan"
31098 summary: update an existing vlan
31100 Update an existing vlan
31102 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31103 The PUT operation will entirely replace an existing object.
31104 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31106 Other differences between PUT and PATCH are:
31108 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31109 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31110 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31111 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
31120 description: Response codes found in [response codes](https://wiki.onap.org/).
31124 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31127 example: __VNF-ID2__
31128 - name: interface-name
31130 description: Name given to the interface
31133 example: __INTERFACE-NAME__
31134 - name: vlan-interface
31136 description: String that identifies the interface
31139 example: __VLAN-INTERFACE__
31142 description: vlan object that needs to be updated.
31145 $ref: "#/patchDefinitions/vlan"
31149 summary: delete an existing vlan
31150 description: delete an existing vlan
31151 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
31160 description: Response codes found in [response codes](https://wiki.onap.org/).
31164 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31167 example: __VNF-ID2__
31168 - name: interface-name
31170 description: Name given to the interface
31173 example: __INTERFACE-NAME__
31174 - name: vlan-interface
31176 description: String that identifies the interface
31179 example: __VLAN-INTERFACE__
31180 - name: resource-version
31182 description: resource-version for concurrency
31185 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
31189 summary: returns vlans
31190 description: returns vlans
31191 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
31197 description: successful operation
31199 $ref: "#/getDefinitions/vlans"
31201 description: Response codes found in [response codes](https://wiki.onap.org/).
31205 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31208 example: __VNF-ID2__
31209 - name: interface-name
31211 description: Name given to the interface
31214 example: __INTERFACE-NAME__
31215 - name: vlan-interface
31220 - name: vlan-id-inner
31231 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
31235 summary: see node definition for valid relationships
31236 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31245 description: Response codes found in [response codes](https://wiki.onap.org/).
31249 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31252 example: __VNF-ID2__
31253 - name: interface-name
31255 description: Name given to the interface
31258 example: __INTERFACE-NAME__
31261 description: PCI ID used to identify the sriov-vf
31264 example: __PCI-ID__
31267 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
31270 $ref: "#/definitions/relationship"
31274 summary: delete an existing relationship
31275 description: delete an existing relationship
31276 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31285 description: Response codes found in [response codes](https://wiki.onap.org/).
31289 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31292 example: __VNF-ID2__
31293 - name: interface-name
31295 description: Name given to the interface
31298 example: __INTERFACE-NAME__
31301 description: PCI ID used to identify the sriov-vf
31304 example: __PCI-ID__
31305 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
31309 summary: returns sriov-vf
31310 description: returns sriov-vf
31311 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
31317 description: successful operation
31319 $ref: "#/getDefinitions/sriov-vf"
31321 description: Response codes found in [response codes](https://wiki.onap.org/).
31325 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31328 example: __VNF-ID2__
31329 - name: interface-name
31331 description: Name given to the interface
31334 example: __INTERFACE-NAME__
31337 description: PCI ID used to identify the sriov-vf
31340 example: __PCI-ID__
31344 summary: create or update an existing sriov-vf
31346 Create or update an existing sriov-vf.
31348 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31349 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
31358 description: Response codes found in [response codes](https://wiki.onap.org/).
31362 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31365 example: __VNF-ID2__
31366 - name: interface-name
31368 description: Name given to the interface
31371 example: __INTERFACE-NAME__
31374 description: PCI ID used to identify the sriov-vf
31377 example: __PCI-ID__
31380 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
31383 $ref: "#/definitions/sriov-vf"
31387 summary: update an existing sriov-vf
31389 Update an existing sriov-vf
31391 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31392 The PUT operation will entirely replace an existing object.
31393 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31395 Other differences between PUT and PATCH are:
31397 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31398 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31399 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31400 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
31409 description: Response codes found in [response codes](https://wiki.onap.org/).
31413 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31416 example: __VNF-ID2__
31417 - name: interface-name
31419 description: Name given to the interface
31422 example: __INTERFACE-NAME__
31425 description: PCI ID used to identify the sriov-vf
31428 example: __PCI-ID__
31431 description: sriov-vf object that needs to be updated.
31434 $ref: "#/patchDefinitions/sriov-vf"
31438 summary: delete an existing sriov-vf
31439 description: delete an existing sriov-vf
31440 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
31449 description: Response codes found in [response codes](https://wiki.onap.org/).
31453 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31456 example: __VNF-ID2__
31457 - name: interface-name
31459 description: Name given to the interface
31462 example: __INTERFACE-NAME__
31465 description: PCI ID used to identify the sriov-vf
31468 example: __PCI-ID__
31469 - name: resource-version
31471 description: resource-version for concurrency
31474 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
31478 summary: returns sriov-vfs
31479 description: returns sriov-vfs
31480 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
31486 description: successful operation
31488 $ref: "#/getDefinitions/sriov-vfs"
31490 description: Response codes found in [response codes](https://wiki.onap.org/).
31494 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31497 example: __VNF-ID2__
31498 - name: interface-name
31500 description: Name given to the interface
31503 example: __INTERFACE-NAME__
31509 - name: vf-vlan-filter
31514 - name: vf-mac-filter
31519 - name: vf-vlan-strip
31524 - name: neutron-network-id
31529 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
31533 summary: see node definition for valid relationships
31534 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
31543 description: Response codes found in [response codes](https://wiki.onap.org/).
31547 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31550 example: __VNF-ID2__
31551 - name: interface-name
31553 description: Name given to the interface
31556 example: __INTERFACE-NAME__
31559 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
31562 $ref: "#/definitions/relationship"
31566 summary: delete an existing relationship
31567 description: delete an existing relationship
31568 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
31577 description: Response codes found in [response codes](https://wiki.onap.org/).
31581 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31584 example: __VNF-ID2__
31585 - name: interface-name
31587 description: Name given to the interface
31590 example: __INTERFACE-NAME__
31591 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
31595 summary: see node definition for valid relationships
31596 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
31605 description: Response codes found in [response codes](https://wiki.onap.org/).
31609 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31612 example: __VNF-ID2__
31613 - name: interface-name
31615 description: Name given to the interface
31618 example: __INTERFACE-NAME__
31619 - name: l3-interface-ipv4-address
31621 description: IP address
31624 example: __L3-INTERFACE-IPV4-ADDRESS__
31627 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
31630 $ref: "#/definitions/relationship"
31634 summary: delete an existing relationship
31635 description: delete an existing relationship
31636 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
31645 description: Response codes found in [response codes](https://wiki.onap.org/).
31649 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31652 example: __VNF-ID2__
31653 - name: interface-name
31655 description: Name given to the interface
31658 example: __INTERFACE-NAME__
31659 - name: l3-interface-ipv4-address
31661 description: IP address
31664 example: __L3-INTERFACE-IPV4-ADDRESS__
31665 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31669 summary: returns l3-interface-ipv4-address-list
31670 description: returns l3-interface-ipv4-address-list
31671 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
31677 description: successful operation
31679 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31681 description: Response codes found in [response codes](https://wiki.onap.org/).
31685 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31688 example: __VNF-ID2__
31689 - name: interface-name
31691 description: Name given to the interface
31694 example: __INTERFACE-NAME__
31695 - name: l3-interface-ipv4-address
31697 description: IP address
31700 example: __L3-INTERFACE-IPV4-ADDRESS__
31704 summary: create or update an existing l3-interface-ipv4-address-list
31706 Create or update an existing l3-interface-ipv4-address-list.
31708 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31709 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
31718 description: Response codes found in [response codes](https://wiki.onap.org/).
31722 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31725 example: __VNF-ID2__
31726 - name: interface-name
31728 description: Name given to the interface
31731 example: __INTERFACE-NAME__
31732 - name: l3-interface-ipv4-address
31734 description: IP address
31737 example: __L3-INTERFACE-IPV4-ADDRESS__
31740 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
31743 $ref: "#/definitions/l3-interface-ipv4-address-list"
31747 summary: update an existing l3-interface-ipv4-address-list
31749 Update an existing l3-interface-ipv4-address-list
31751 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31752 The PUT operation will entirely replace an existing object.
31753 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31755 Other differences between PUT and PATCH are:
31757 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31758 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31759 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31760 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
31769 description: Response codes found in [response codes](https://wiki.onap.org/).
31773 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31776 example: __VNF-ID2__
31777 - name: interface-name
31779 description: Name given to the interface
31782 example: __INTERFACE-NAME__
31783 - name: l3-interface-ipv4-address
31785 description: IP address
31788 example: __L3-INTERFACE-IPV4-ADDRESS__
31791 description: l3-interface-ipv4-address-list object that needs to be updated.
31794 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31798 summary: delete an existing l3-interface-ipv4-address-list
31799 description: delete an existing l3-interface-ipv4-address-list
31800 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
31809 description: Response codes found in [response codes](https://wiki.onap.org/).
31813 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31816 example: __VNF-ID2__
31817 - name: interface-name
31819 description: Name given to the interface
31822 example: __INTERFACE-NAME__
31823 - name: l3-interface-ipv4-address
31825 description: IP address
31828 example: __L3-INTERFACE-IPV4-ADDRESS__
31829 - name: resource-version
31831 description: resource-version for concurrency
31834 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
31838 summary: see node definition for valid relationships
31839 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31848 description: Response codes found in [response codes](https://wiki.onap.org/).
31852 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31855 example: __VNF-ID2__
31856 - name: interface-name
31858 description: Name given to the interface
31861 example: __INTERFACE-NAME__
31862 - name: l3-interface-ipv6-address
31864 description: IP address
31867 example: __L3-INTERFACE-IPV6-ADDRESS__
31870 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31873 $ref: "#/definitions/relationship"
31877 summary: delete an existing relationship
31878 description: delete an existing relationship
31879 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31888 description: Response codes found in [response codes](https://wiki.onap.org/).
31892 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31895 example: __VNF-ID2__
31896 - name: interface-name
31898 description: Name given to the interface
31901 example: __INTERFACE-NAME__
31902 - name: l3-interface-ipv6-address
31904 description: IP address
31907 example: __L3-INTERFACE-IPV6-ADDRESS__
31908 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31912 summary: returns l3-interface-ipv6-address-list
31913 description: returns l3-interface-ipv6-address-list
31914 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31920 description: successful operation
31922 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31924 description: Response codes found in [response codes](https://wiki.onap.org/).
31928 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31931 example: __VNF-ID2__
31932 - name: interface-name
31934 description: Name given to the interface
31937 example: __INTERFACE-NAME__
31938 - name: l3-interface-ipv6-address
31940 description: IP address
31943 example: __L3-INTERFACE-IPV6-ADDRESS__
31947 summary: create or update an existing l3-interface-ipv6-address-list
31949 Create or update an existing l3-interface-ipv6-address-list.
31951 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31952 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31961 description: Response codes found in [response codes](https://wiki.onap.org/).
31965 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
31968 example: __VNF-ID2__
31969 - name: interface-name
31971 description: Name given to the interface
31974 example: __INTERFACE-NAME__
31975 - name: l3-interface-ipv6-address
31977 description: IP address
31980 example: __L3-INTERFACE-IPV6-ADDRESS__
31983 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31986 $ref: "#/definitions/l3-interface-ipv6-address-list"
31990 summary: update an existing l3-interface-ipv6-address-list
31992 Update an existing l3-interface-ipv6-address-list
31994 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31995 The PUT operation will entirely replace an existing object.
31996 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31998 Other differences between PUT and PATCH are:
32000 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32001 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32002 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32003 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
32012 description: Response codes found in [response codes](https://wiki.onap.org/).
32016 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32019 example: __VNF-ID2__
32020 - name: interface-name
32022 description: Name given to the interface
32025 example: __INTERFACE-NAME__
32026 - name: l3-interface-ipv6-address
32028 description: IP address
32031 example: __L3-INTERFACE-IPV6-ADDRESS__
32034 description: l3-interface-ipv6-address-list object that needs to be updated.
32037 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32041 summary: delete an existing l3-interface-ipv6-address-list
32042 description: delete an existing l3-interface-ipv6-address-list
32043 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
32052 description: Response codes found in [response codes](https://wiki.onap.org/).
32056 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32059 example: __VNF-ID2__
32060 - name: interface-name
32062 description: Name given to the interface
32065 example: __INTERFACE-NAME__
32066 - name: l3-interface-ipv6-address
32068 description: IP address
32071 example: __L3-INTERFACE-IPV6-ADDRESS__
32072 - name: resource-version
32074 description: resource-version for concurrency
32077 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
32081 summary: returns l-interface
32082 description: returns l-interface
32083 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
32089 description: successful operation
32091 $ref: "#/getDefinitions/l-interface"
32093 description: Response codes found in [response codes](https://wiki.onap.org/).
32097 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32100 example: __VNF-ID2__
32101 - name: interface-name
32103 description: Name given to the interface
32106 example: __INTERFACE-NAME__
32110 summary: create or update an existing l-interface
32112 Create or update an existing l-interface.
32114 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32115 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
32124 description: Response codes found in [response codes](https://wiki.onap.org/).
32128 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32131 example: __VNF-ID2__
32132 - name: interface-name
32134 description: Name given to the interface
32137 example: __INTERFACE-NAME__
32140 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
32143 $ref: "#/definitions/l-interface"
32147 summary: update an existing l-interface
32149 Update an existing l-interface
32151 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32152 The PUT operation will entirely replace an existing object.
32153 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32155 Other differences between PUT and PATCH are:
32157 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32158 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32159 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32160 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
32169 description: Response codes found in [response codes](https://wiki.onap.org/).
32173 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32176 example: __VNF-ID2__
32177 - name: interface-name
32179 description: Name given to the interface
32182 example: __INTERFACE-NAME__
32185 description: l-interface object that needs to be updated.
32188 $ref: "#/patchDefinitions/l-interface"
32192 summary: delete an existing l-interface
32193 description: delete an existing l-interface
32194 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
32203 description: Response codes found in [response codes](https://wiki.onap.org/).
32207 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32210 example: __VNF-ID2__
32211 - name: interface-name
32213 description: Name given to the interface
32216 example: __INTERFACE-NAME__
32217 - name: resource-version
32219 description: resource-version for concurrency
32222 /network/newvces/newvce/{vnf-id2}/l-interfaces:
32226 summary: returns l-interfaces
32227 description: returns l-interfaces
32228 operationId: getNetworkNewvcesNewvceLInterfaces
32234 description: successful operation
32236 $ref: "#/getDefinitions/l-interfaces"
32238 description: Response codes found in [response codes](https://wiki.onap.org/).
32242 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32245 example: __VNF-ID2__
32246 - name: interface-name
32251 - name: interface-id
32261 - name: network-name
32266 /network/newvces/newvce/{vnf-id2}:
32270 summary: returns newvce
32271 description: returns newvce
32272 operationId: getNetworkNewvcesNewvce
32278 description: successful operation
32280 $ref: "#/getDefinitions/newvce"
32282 description: Response codes found in [response codes](https://wiki.onap.org/).
32286 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32289 example: __VNF-ID2__
32293 summary: create or update an existing newvce
32295 Create or update an existing newvce.
32297 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32298 operationId: createOrUpdateNetworkNewvcesNewvce
32307 description: Response codes found in [response codes](https://wiki.onap.org/).
32311 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32314 example: __VNF-ID2__
32317 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
32320 $ref: "#/definitions/newvce"
32324 summary: update an existing newvce
32326 Update an existing newvce
32328 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32329 The PUT operation will entirely replace an existing object.
32330 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32332 Other differences between PUT and PATCH are:
32334 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32335 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32336 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32337 operationId: UpdateNetworkNewvcesNewvce
32346 description: Response codes found in [response codes](https://wiki.onap.org/).
32350 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32353 example: __VNF-ID2__
32356 description: newvce object that needs to be updated.
32359 $ref: "#/patchDefinitions/newvce"
32363 summary: delete an existing newvce
32364 description: delete an existing newvce
32365 operationId: deleteNetworkNewvcesNewvce
32374 description: Response codes found in [response codes](https://wiki.onap.org/).
32378 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32381 example: __VNF-ID2__
32382 - name: resource-version
32384 description: resource-version for concurrency
32391 summary: returns newvces
32392 description: returns newvces
32393 operationId: getNetworkNewvces
32399 description: successful operation
32401 $ref: "#/getDefinitions/newvces"
32403 description: Response codes found in [response codes](https://wiki.onap.org/).
32425 - name: prov-status
32430 - name: heat-stack-id
32435 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
32439 summary: see node definition for valid relationships
32440 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
32449 description: Response codes found in [response codes](https://wiki.onap.org/).
32453 description: unique name of Physical Network Function.
32456 example: __PNF-NAME__
32459 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
32462 $ref: "#/definitions/relationship"
32466 summary: delete an existing relationship
32467 description: delete an existing relationship
32468 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
32477 description: Response codes found in [response codes](https://wiki.onap.org/).
32481 description: unique name of Physical Network Function.
32484 example: __PNF-NAME__
32485 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
32489 summary: see node definition for valid relationships
32490 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
32499 description: Response codes found in [response codes](https://wiki.onap.org/).
32503 description: unique name of Physical Network Function.
32506 example: __PNF-NAME__
32507 - name: interface-name
32509 description: Name that identifies the physical interface
32512 example: __INTERFACE-NAME__
32515 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
32518 $ref: "#/definitions/relationship"
32522 summary: delete an existing relationship
32523 description: delete an existing relationship
32524 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
32533 description: Response codes found in [response codes](https://wiki.onap.org/).
32537 description: unique name of Physical Network Function.
32540 example: __PNF-NAME__
32541 - name: interface-name
32543 description: Name that identifies the physical interface
32546 example: __INTERFACE-NAME__
32547 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
32551 summary: see node definition for valid relationships
32552 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32561 description: Response codes found in [response codes](https://wiki.onap.org/).
32565 description: unique name of Physical Network Function.
32568 example: __PNF-NAME__
32569 - name: interface-name
32571 description: Name that identifies the physical interface
32574 example: __INTERFACE-NAME__
32575 - name: interface-name
32577 description: Name given to the interface
32580 example: __INTERFACE-NAME__
32581 - name: vlan-interface
32583 description: String that identifies the interface
32586 example: __VLAN-INTERFACE__
32589 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
32592 $ref: "#/definitions/relationship"
32596 summary: delete an existing relationship
32597 description: delete an existing relationship
32598 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32607 description: Response codes found in [response codes](https://wiki.onap.org/).
32611 description: unique name of Physical Network Function.
32614 example: __PNF-NAME__
32615 - name: interface-name
32617 description: Name that identifies the physical interface
32620 example: __INTERFACE-NAME__
32621 - name: interface-name
32623 description: Name given to the interface
32626 example: __INTERFACE-NAME__
32627 - name: vlan-interface
32629 description: String that identifies the interface
32632 example: __VLAN-INTERFACE__
32633 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
32637 summary: see node definition for valid relationships
32638 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32647 description: Response codes found in [response codes](https://wiki.onap.org/).
32651 description: unique name of Physical Network Function.
32654 example: __PNF-NAME__
32655 - name: interface-name
32657 description: Name that identifies the physical interface
32660 example: __INTERFACE-NAME__
32661 - name: interface-name
32663 description: Name given to the interface
32666 example: __INTERFACE-NAME__
32667 - name: vlan-interface
32669 description: String that identifies the interface
32672 example: __VLAN-INTERFACE__
32673 - name: l3-interface-ipv4-address
32675 description: IP address
32678 example: __L3-INTERFACE-IPV4-ADDRESS__
32681 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32684 $ref: "#/definitions/relationship"
32688 summary: delete an existing relationship
32689 description: delete an existing relationship
32690 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32699 description: Response codes found in [response codes](https://wiki.onap.org/).
32703 description: unique name of Physical Network Function.
32706 example: __PNF-NAME__
32707 - name: interface-name
32709 description: Name that identifies the physical interface
32712 example: __INTERFACE-NAME__
32713 - name: interface-name
32715 description: Name given to the interface
32718 example: __INTERFACE-NAME__
32719 - name: vlan-interface
32721 description: String that identifies the interface
32724 example: __VLAN-INTERFACE__
32725 - name: l3-interface-ipv4-address
32727 description: IP address
32730 example: __L3-INTERFACE-IPV4-ADDRESS__
32731 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32735 summary: returns l3-interface-ipv4-address-list
32736 description: returns l3-interface-ipv4-address-list
32737 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32743 description: successful operation
32745 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32747 description: Response codes found in [response codes](https://wiki.onap.org/).
32751 description: unique name of Physical Network Function.
32754 example: __PNF-NAME__
32755 - name: interface-name
32757 description: Name that identifies the physical interface
32760 example: __INTERFACE-NAME__
32761 - name: interface-name
32763 description: Name given to the interface
32766 example: __INTERFACE-NAME__
32767 - name: vlan-interface
32769 description: String that identifies the interface
32772 example: __VLAN-INTERFACE__
32773 - name: l3-interface-ipv4-address
32775 description: IP address
32778 example: __L3-INTERFACE-IPV4-ADDRESS__
32782 summary: create or update an existing l3-interface-ipv4-address-list
32784 Create or update an existing l3-interface-ipv4-address-list.
32786 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32787 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32796 description: Response codes found in [response codes](https://wiki.onap.org/).
32800 description: unique name of Physical Network Function.
32803 example: __PNF-NAME__
32804 - name: interface-name
32806 description: Name that identifies the physical interface
32809 example: __INTERFACE-NAME__
32810 - name: interface-name
32812 description: Name given to the interface
32815 example: __INTERFACE-NAME__
32816 - name: vlan-interface
32818 description: String that identifies the interface
32821 example: __VLAN-INTERFACE__
32822 - name: l3-interface-ipv4-address
32824 description: IP address
32827 example: __L3-INTERFACE-IPV4-ADDRESS__
32830 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32833 $ref: "#/definitions/l3-interface-ipv4-address-list"
32837 summary: update an existing l3-interface-ipv4-address-list
32839 Update an existing l3-interface-ipv4-address-list
32841 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32842 The PUT operation will entirely replace an existing object.
32843 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32845 Other differences between PUT and PATCH are:
32847 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32848 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32849 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32850 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32859 description: Response codes found in [response codes](https://wiki.onap.org/).
32863 description: unique name of Physical Network Function.
32866 example: __PNF-NAME__
32867 - name: interface-name
32869 description: Name that identifies the physical interface
32872 example: __INTERFACE-NAME__
32873 - name: interface-name
32875 description: Name given to the interface
32878 example: __INTERFACE-NAME__
32879 - name: vlan-interface
32881 description: String that identifies the interface
32884 example: __VLAN-INTERFACE__
32885 - name: l3-interface-ipv4-address
32887 description: IP address
32890 example: __L3-INTERFACE-IPV4-ADDRESS__
32893 description: l3-interface-ipv4-address-list object that needs to be updated.
32896 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32900 summary: delete an existing l3-interface-ipv4-address-list
32901 description: delete an existing l3-interface-ipv4-address-list
32902 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32911 description: Response codes found in [response codes](https://wiki.onap.org/).
32915 description: unique name of Physical Network Function.
32918 example: __PNF-NAME__
32919 - name: interface-name
32921 description: Name that identifies the physical interface
32924 example: __INTERFACE-NAME__
32925 - name: interface-name
32927 description: Name given to the interface
32930 example: __INTERFACE-NAME__
32931 - name: vlan-interface
32933 description: String that identifies the interface
32936 example: __VLAN-INTERFACE__
32937 - name: l3-interface-ipv4-address
32939 description: IP address
32942 example: __L3-INTERFACE-IPV4-ADDRESS__
32943 - name: resource-version
32945 description: resource-version for concurrency
32948 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
32952 summary: see node definition for valid relationships
32953 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
32962 description: Response codes found in [response codes](https://wiki.onap.org/).
32966 description: unique name of Physical Network Function.
32969 example: __PNF-NAME__
32970 - name: interface-name
32972 description: Name that identifies the physical interface
32975 example: __INTERFACE-NAME__
32976 - name: interface-name
32978 description: Name given to the interface
32981 example: __INTERFACE-NAME__
32982 - name: vlan-interface
32984 description: String that identifies the interface
32987 example: __VLAN-INTERFACE__
32988 - name: l3-interface-ipv6-address
32990 description: IP address
32993 example: __L3-INTERFACE-IPV6-ADDRESS__
32996 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32999 $ref: "#/definitions/relationship"
33003 summary: delete an existing relationship
33004 description: delete an existing relationship
33005 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33014 description: Response codes found in [response codes](https://wiki.onap.org/).
33018 description: unique name of Physical Network Function.
33021 example: __PNF-NAME__
33022 - name: interface-name
33024 description: Name that identifies the physical interface
33027 example: __INTERFACE-NAME__
33028 - name: interface-name
33030 description: Name given to the interface
33033 example: __INTERFACE-NAME__
33034 - name: vlan-interface
33036 description: String that identifies the interface
33039 example: __VLAN-INTERFACE__
33040 - name: l3-interface-ipv6-address
33042 description: IP address
33045 example: __L3-INTERFACE-IPV6-ADDRESS__
33046 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33050 summary: returns l3-interface-ipv6-address-list
33051 description: returns l3-interface-ipv6-address-list
33052 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33058 description: successful operation
33060 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33062 description: Response codes found in [response codes](https://wiki.onap.org/).
33066 description: unique name of Physical Network Function.
33069 example: __PNF-NAME__
33070 - name: interface-name
33072 description: Name that identifies the physical interface
33075 example: __INTERFACE-NAME__
33076 - name: interface-name
33078 description: Name given to the interface
33081 example: __INTERFACE-NAME__
33082 - name: vlan-interface
33084 description: String that identifies the interface
33087 example: __VLAN-INTERFACE__
33088 - name: l3-interface-ipv6-address
33090 description: IP address
33093 example: __L3-INTERFACE-IPV6-ADDRESS__
33097 summary: create or update an existing l3-interface-ipv6-address-list
33099 Create or update an existing l3-interface-ipv6-address-list.
33101 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33102 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33111 description: Response codes found in [response codes](https://wiki.onap.org/).
33115 description: unique name of Physical Network Function.
33118 example: __PNF-NAME__
33119 - name: interface-name
33121 description: Name that identifies the physical interface
33124 example: __INTERFACE-NAME__
33125 - name: interface-name
33127 description: Name given to the interface
33130 example: __INTERFACE-NAME__
33131 - name: vlan-interface
33133 description: String that identifies the interface
33136 example: __VLAN-INTERFACE__
33137 - name: l3-interface-ipv6-address
33139 description: IP address
33142 example: __L3-INTERFACE-IPV6-ADDRESS__
33145 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33148 $ref: "#/definitions/l3-interface-ipv6-address-list"
33152 summary: update an existing l3-interface-ipv6-address-list
33154 Update an existing l3-interface-ipv6-address-list
33156 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33157 The PUT operation will entirely replace an existing object.
33158 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33160 Other differences between PUT and PATCH are:
33162 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33163 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33164 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33165 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33174 description: Response codes found in [response codes](https://wiki.onap.org/).
33178 description: unique name of Physical Network Function.
33181 example: __PNF-NAME__
33182 - name: interface-name
33184 description: Name that identifies the physical interface
33187 example: __INTERFACE-NAME__
33188 - name: interface-name
33190 description: Name given to the interface
33193 example: __INTERFACE-NAME__
33194 - name: vlan-interface
33196 description: String that identifies the interface
33199 example: __VLAN-INTERFACE__
33200 - name: l3-interface-ipv6-address
33202 description: IP address
33205 example: __L3-INTERFACE-IPV6-ADDRESS__
33208 description: l3-interface-ipv6-address-list object that needs to be updated.
33211 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33215 summary: delete an existing l3-interface-ipv6-address-list
33216 description: delete an existing l3-interface-ipv6-address-list
33217 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33226 description: Response codes found in [response codes](https://wiki.onap.org/).
33230 description: unique name of Physical Network Function.
33233 example: __PNF-NAME__
33234 - name: interface-name
33236 description: Name that identifies the physical interface
33239 example: __INTERFACE-NAME__
33240 - name: interface-name
33242 description: Name given to the interface
33245 example: __INTERFACE-NAME__
33246 - name: vlan-interface
33248 description: String that identifies the interface
33251 example: __VLAN-INTERFACE__
33252 - name: l3-interface-ipv6-address
33254 description: IP address
33257 example: __L3-INTERFACE-IPV6-ADDRESS__
33258 - name: resource-version
33260 description: resource-version for concurrency
33263 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
33267 summary: returns vlan
33268 description: returns vlan
33269 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
33275 description: successful operation
33277 $ref: "#/getDefinitions/vlan"
33279 description: Response codes found in [response codes](https://wiki.onap.org/).
33283 description: unique name of Physical Network Function.
33286 example: __PNF-NAME__
33287 - name: interface-name
33289 description: Name that identifies the physical interface
33292 example: __INTERFACE-NAME__
33293 - name: interface-name
33295 description: Name given to the interface
33298 example: __INTERFACE-NAME__
33299 - name: vlan-interface
33301 description: String that identifies the interface
33304 example: __VLAN-INTERFACE__
33308 summary: create or update an existing vlan
33310 Create or update an existing vlan.
33312 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33313 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
33322 description: Response codes found in [response codes](https://wiki.onap.org/).
33326 description: unique name of Physical Network Function.
33329 example: __PNF-NAME__
33330 - name: interface-name
33332 description: Name that identifies the physical interface
33335 example: __INTERFACE-NAME__
33336 - name: interface-name
33338 description: Name given to the interface
33341 example: __INTERFACE-NAME__
33342 - name: vlan-interface
33344 description: String that identifies the interface
33347 example: __VLAN-INTERFACE__
33350 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
33353 $ref: "#/definitions/vlan"
33357 summary: update an existing vlan
33359 Update an existing vlan
33361 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33362 The PUT operation will entirely replace an existing object.
33363 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33365 Other differences between PUT and PATCH are:
33367 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33368 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33369 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33370 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
33379 description: Response codes found in [response codes](https://wiki.onap.org/).
33383 description: unique name of Physical Network Function.
33386 example: __PNF-NAME__
33387 - name: interface-name
33389 description: Name that identifies the physical interface
33392 example: __INTERFACE-NAME__
33393 - name: interface-name
33395 description: Name given to the interface
33398 example: __INTERFACE-NAME__
33399 - name: vlan-interface
33401 description: String that identifies the interface
33404 example: __VLAN-INTERFACE__
33407 description: vlan object that needs to be updated.
33410 $ref: "#/patchDefinitions/vlan"
33414 summary: delete an existing vlan
33415 description: delete an existing vlan
33416 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
33425 description: Response codes found in [response codes](https://wiki.onap.org/).
33429 description: unique name of Physical Network Function.
33432 example: __PNF-NAME__
33433 - name: interface-name
33435 description: Name that identifies the physical interface
33438 example: __INTERFACE-NAME__
33439 - name: interface-name
33441 description: Name given to the interface
33444 example: __INTERFACE-NAME__
33445 - name: vlan-interface
33447 description: String that identifies the interface
33450 example: __VLAN-INTERFACE__
33451 - name: resource-version
33453 description: resource-version for concurrency
33456 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
33460 summary: returns vlans
33461 description: returns vlans
33462 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
33468 description: successful operation
33470 $ref: "#/getDefinitions/vlans"
33472 description: Response codes found in [response codes](https://wiki.onap.org/).
33476 description: unique name of Physical Network Function.
33479 example: __PNF-NAME__
33480 - name: interface-name
33482 description: Name that identifies the physical interface
33485 example: __INTERFACE-NAME__
33486 - name: interface-name
33488 description: Name given to the interface
33491 example: __INTERFACE-NAME__
33492 - name: vlan-interface
33497 - name: vlan-id-inner
33508 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
33512 summary: see node definition for valid relationships
33513 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33522 description: Response codes found in [response codes](https://wiki.onap.org/).
33526 description: unique name of Physical Network Function.
33529 example: __PNF-NAME__
33530 - name: interface-name
33532 description: Name that identifies the physical interface
33535 example: __INTERFACE-NAME__
33536 - name: interface-name
33538 description: Name given to the interface
33541 example: __INTERFACE-NAME__
33544 description: PCI ID used to identify the sriov-vf
33547 example: __PCI-ID__
33550 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
33553 $ref: "#/definitions/relationship"
33557 summary: delete an existing relationship
33558 description: delete an existing relationship
33559 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33568 description: Response codes found in [response codes](https://wiki.onap.org/).
33572 description: unique name of Physical Network Function.
33575 example: __PNF-NAME__
33576 - name: interface-name
33578 description: Name that identifies the physical interface
33581 example: __INTERFACE-NAME__
33582 - name: interface-name
33584 description: Name given to the interface
33587 example: __INTERFACE-NAME__
33590 description: PCI ID used to identify the sriov-vf
33593 example: __PCI-ID__
33594 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
33598 summary: returns sriov-vf
33599 description: returns sriov-vf
33600 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33606 description: successful operation
33608 $ref: "#/getDefinitions/sriov-vf"
33610 description: Response codes found in [response codes](https://wiki.onap.org/).
33614 description: unique name of Physical Network Function.
33617 example: __PNF-NAME__
33618 - name: interface-name
33620 description: Name that identifies the physical interface
33623 example: __INTERFACE-NAME__
33624 - name: interface-name
33626 description: Name given to the interface
33629 example: __INTERFACE-NAME__
33632 description: PCI ID used to identify the sriov-vf
33635 example: __PCI-ID__
33639 summary: create or update an existing sriov-vf
33641 Create or update an existing sriov-vf.
33643 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33644 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33653 description: Response codes found in [response codes](https://wiki.onap.org/).
33657 description: unique name of Physical Network Function.
33660 example: __PNF-NAME__
33661 - name: interface-name
33663 description: Name that identifies the physical interface
33666 example: __INTERFACE-NAME__
33667 - name: interface-name
33669 description: Name given to the interface
33672 example: __INTERFACE-NAME__
33675 description: PCI ID used to identify the sriov-vf
33678 example: __PCI-ID__
33681 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
33684 $ref: "#/definitions/sriov-vf"
33688 summary: update an existing sriov-vf
33690 Update an existing sriov-vf
33692 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33693 The PUT operation will entirely replace an existing object.
33694 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33696 Other differences between PUT and PATCH are:
33698 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33699 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33700 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33701 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33710 description: Response codes found in [response codes](https://wiki.onap.org/).
33714 description: unique name of Physical Network Function.
33717 example: __PNF-NAME__
33718 - name: interface-name
33720 description: Name that identifies the physical interface
33723 example: __INTERFACE-NAME__
33724 - name: interface-name
33726 description: Name given to the interface
33729 example: __INTERFACE-NAME__
33732 description: PCI ID used to identify the sriov-vf
33735 example: __PCI-ID__
33738 description: sriov-vf object that needs to be updated.
33741 $ref: "#/patchDefinitions/sriov-vf"
33745 summary: delete an existing sriov-vf
33746 description: delete an existing sriov-vf
33747 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33756 description: Response codes found in [response codes](https://wiki.onap.org/).
33760 description: unique name of Physical Network Function.
33763 example: __PNF-NAME__
33764 - name: interface-name
33766 description: Name that identifies the physical interface
33769 example: __INTERFACE-NAME__
33770 - name: interface-name
33772 description: Name given to the interface
33775 example: __INTERFACE-NAME__
33778 description: PCI ID used to identify the sriov-vf
33781 example: __PCI-ID__
33782 - name: resource-version
33784 description: resource-version for concurrency
33787 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
33791 summary: returns sriov-vfs
33792 description: returns sriov-vfs
33793 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
33799 description: successful operation
33801 $ref: "#/getDefinitions/sriov-vfs"
33803 description: Response codes found in [response codes](https://wiki.onap.org/).
33807 description: unique name of Physical Network Function.
33810 example: __PNF-NAME__
33811 - name: interface-name
33813 description: Name that identifies the physical interface
33816 example: __INTERFACE-NAME__
33817 - name: interface-name
33819 description: Name given to the interface
33822 example: __INTERFACE-NAME__
33828 - name: vf-vlan-filter
33833 - name: vf-mac-filter
33838 - name: vf-vlan-strip
33843 - name: neutron-network-id
33848 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
33852 summary: see node definition for valid relationships
33853 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
33862 description: Response codes found in [response codes](https://wiki.onap.org/).
33866 description: unique name of Physical Network Function.
33869 example: __PNF-NAME__
33870 - name: interface-name
33872 description: Name that identifies the physical interface
33875 example: __INTERFACE-NAME__
33876 - name: interface-name
33878 description: Name given to the interface
33881 example: __INTERFACE-NAME__
33884 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
33887 $ref: "#/definitions/relationship"
33891 summary: delete an existing relationship
33892 description: delete an existing relationship
33893 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
33902 description: Response codes found in [response codes](https://wiki.onap.org/).
33906 description: unique name of Physical Network Function.
33909 example: __PNF-NAME__
33910 - name: interface-name
33912 description: Name that identifies the physical interface
33915 example: __INTERFACE-NAME__
33916 - name: interface-name
33918 description: Name given to the interface
33921 example: __INTERFACE-NAME__
33922 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
33926 summary: see node definition for valid relationships
33927 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33936 description: Response codes found in [response codes](https://wiki.onap.org/).
33940 description: unique name of Physical Network Function.
33943 example: __PNF-NAME__
33944 - name: interface-name
33946 description: Name that identifies the physical interface
33949 example: __INTERFACE-NAME__
33950 - name: interface-name
33952 description: Name given to the interface
33955 example: __INTERFACE-NAME__
33956 - name: l3-interface-ipv4-address
33958 description: IP address
33961 example: __L3-INTERFACE-IPV4-ADDRESS__
33964 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
33967 $ref: "#/definitions/relationship"
33971 summary: delete an existing relationship
33972 description: delete an existing relationship
33973 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33982 description: Response codes found in [response codes](https://wiki.onap.org/).
33986 description: unique name of Physical Network Function.
33989 example: __PNF-NAME__
33990 - name: interface-name
33992 description: Name that identifies the physical interface
33995 example: __INTERFACE-NAME__
33996 - name: interface-name
33998 description: Name given to the interface
34001 example: __INTERFACE-NAME__
34002 - name: l3-interface-ipv4-address
34004 description: IP address
34007 example: __L3-INTERFACE-IPV4-ADDRESS__
34008 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
34012 summary: returns l3-interface-ipv4-address-list
34013 description: returns l3-interface-ipv4-address-list
34014 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34020 description: successful operation
34022 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34024 description: Response codes found in [response codes](https://wiki.onap.org/).
34028 description: unique name of Physical Network Function.
34031 example: __PNF-NAME__
34032 - name: interface-name
34034 description: Name that identifies the physical interface
34037 example: __INTERFACE-NAME__
34038 - name: interface-name
34040 description: Name given to the interface
34043 example: __INTERFACE-NAME__
34044 - name: l3-interface-ipv4-address
34046 description: IP address
34049 example: __L3-INTERFACE-IPV4-ADDRESS__
34053 summary: create or update an existing l3-interface-ipv4-address-list
34055 Create or update an existing l3-interface-ipv4-address-list.
34057 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34058 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34067 description: Response codes found in [response codes](https://wiki.onap.org/).
34071 description: unique name of Physical Network Function.
34074 example: __PNF-NAME__
34075 - name: interface-name
34077 description: Name that identifies the physical interface
34080 example: __INTERFACE-NAME__
34081 - name: interface-name
34083 description: Name given to the interface
34086 example: __INTERFACE-NAME__
34087 - name: l3-interface-ipv4-address
34089 description: IP address
34092 example: __L3-INTERFACE-IPV4-ADDRESS__
34095 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34098 $ref: "#/definitions/l3-interface-ipv4-address-list"
34102 summary: update an existing l3-interface-ipv4-address-list
34104 Update an existing l3-interface-ipv4-address-list
34106 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34107 The PUT operation will entirely replace an existing object.
34108 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34110 Other differences between PUT and PATCH are:
34112 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34113 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34114 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34115 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34124 description: Response codes found in [response codes](https://wiki.onap.org/).
34128 description: unique name of Physical Network Function.
34131 example: __PNF-NAME__
34132 - name: interface-name
34134 description: Name that identifies the physical interface
34137 example: __INTERFACE-NAME__
34138 - name: interface-name
34140 description: Name given to the interface
34143 example: __INTERFACE-NAME__
34144 - name: l3-interface-ipv4-address
34146 description: IP address
34149 example: __L3-INTERFACE-IPV4-ADDRESS__
34152 description: l3-interface-ipv4-address-list object that needs to be updated.
34155 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34159 summary: delete an existing l3-interface-ipv4-address-list
34160 description: delete an existing l3-interface-ipv4-address-list
34161 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34170 description: Response codes found in [response codes](https://wiki.onap.org/).
34174 description: unique name of Physical Network Function.
34177 example: __PNF-NAME__
34178 - name: interface-name
34180 description: Name that identifies the physical interface
34183 example: __INTERFACE-NAME__
34184 - name: interface-name
34186 description: Name given to the interface
34189 example: __INTERFACE-NAME__
34190 - name: l3-interface-ipv4-address
34192 description: IP address
34195 example: __L3-INTERFACE-IPV4-ADDRESS__
34196 - name: resource-version
34198 description: resource-version for concurrency
34201 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
34205 summary: see node definition for valid relationships
34206 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34215 description: Response codes found in [response codes](https://wiki.onap.org/).
34219 description: unique name of Physical Network Function.
34222 example: __PNF-NAME__
34223 - name: interface-name
34225 description: Name that identifies the physical interface
34228 example: __INTERFACE-NAME__
34229 - name: interface-name
34231 description: Name given to the interface
34234 example: __INTERFACE-NAME__
34235 - name: l3-interface-ipv6-address
34237 description: IP address
34240 example: __L3-INTERFACE-IPV6-ADDRESS__
34243 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34246 $ref: "#/definitions/relationship"
34250 summary: delete an existing relationship
34251 description: delete an existing relationship
34252 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34261 description: Response codes found in [response codes](https://wiki.onap.org/).
34265 description: unique name of Physical Network Function.
34268 example: __PNF-NAME__
34269 - name: interface-name
34271 description: Name that identifies the physical interface
34274 example: __INTERFACE-NAME__
34275 - name: interface-name
34277 description: Name given to the interface
34280 example: __INTERFACE-NAME__
34281 - name: l3-interface-ipv6-address
34283 description: IP address
34286 example: __L3-INTERFACE-IPV6-ADDRESS__
34287 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
34291 summary: returns l3-interface-ipv6-address-list
34292 description: returns l3-interface-ipv6-address-list
34293 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34299 description: successful operation
34301 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34303 description: Response codes found in [response codes](https://wiki.onap.org/).
34307 description: unique name of Physical Network Function.
34310 example: __PNF-NAME__
34311 - name: interface-name
34313 description: Name that identifies the physical interface
34316 example: __INTERFACE-NAME__
34317 - name: interface-name
34319 description: Name given to the interface
34322 example: __INTERFACE-NAME__
34323 - name: l3-interface-ipv6-address
34325 description: IP address
34328 example: __L3-INTERFACE-IPV6-ADDRESS__
34332 summary: create or update an existing l3-interface-ipv6-address-list
34334 Create or update an existing l3-interface-ipv6-address-list.
34336 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34337 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34346 description: Response codes found in [response codes](https://wiki.onap.org/).
34350 description: unique name of Physical Network Function.
34353 example: __PNF-NAME__
34354 - name: interface-name
34356 description: Name that identifies the physical interface
34359 example: __INTERFACE-NAME__
34360 - name: interface-name
34362 description: Name given to the interface
34365 example: __INTERFACE-NAME__
34366 - name: l3-interface-ipv6-address
34368 description: IP address
34371 example: __L3-INTERFACE-IPV6-ADDRESS__
34374 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34377 $ref: "#/definitions/l3-interface-ipv6-address-list"
34381 summary: update an existing l3-interface-ipv6-address-list
34383 Update an existing l3-interface-ipv6-address-list
34385 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34386 The PUT operation will entirely replace an existing object.
34387 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34389 Other differences between PUT and PATCH are:
34391 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34392 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34393 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34394 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34403 description: Response codes found in [response codes](https://wiki.onap.org/).
34407 description: unique name of Physical Network Function.
34410 example: __PNF-NAME__
34411 - name: interface-name
34413 description: Name that identifies the physical interface
34416 example: __INTERFACE-NAME__
34417 - name: interface-name
34419 description: Name given to the interface
34422 example: __INTERFACE-NAME__
34423 - name: l3-interface-ipv6-address
34425 description: IP address
34428 example: __L3-INTERFACE-IPV6-ADDRESS__
34431 description: l3-interface-ipv6-address-list object that needs to be updated.
34434 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34438 summary: delete an existing l3-interface-ipv6-address-list
34439 description: delete an existing l3-interface-ipv6-address-list
34440 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34449 description: Response codes found in [response codes](https://wiki.onap.org/).
34453 description: unique name of Physical Network Function.
34456 example: __PNF-NAME__
34457 - name: interface-name
34459 description: Name that identifies the physical interface
34462 example: __INTERFACE-NAME__
34463 - name: interface-name
34465 description: Name given to the interface
34468 example: __INTERFACE-NAME__
34469 - name: l3-interface-ipv6-address
34471 description: IP address
34474 example: __L3-INTERFACE-IPV6-ADDRESS__
34475 - name: resource-version
34477 description: resource-version for concurrency
34480 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
34484 summary: returns l-interface
34485 description: returns l-interface
34486 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
34492 description: successful operation
34494 $ref: "#/getDefinitions/l-interface"
34496 description: Response codes found in [response codes](https://wiki.onap.org/).
34500 description: unique name of Physical Network Function.
34503 example: __PNF-NAME__
34504 - name: interface-name
34506 description: Name that identifies the physical interface
34509 example: __INTERFACE-NAME__
34510 - name: interface-name
34512 description: Name given to the interface
34515 example: __INTERFACE-NAME__
34519 summary: create or update an existing l-interface
34521 Create or update an existing l-interface.
34523 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34524 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
34533 description: Response codes found in [response codes](https://wiki.onap.org/).
34537 description: unique name of Physical Network Function.
34540 example: __PNF-NAME__
34541 - name: interface-name
34543 description: Name that identifies the physical interface
34546 example: __INTERFACE-NAME__
34547 - name: interface-name
34549 description: Name given to the interface
34552 example: __INTERFACE-NAME__
34555 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
34558 $ref: "#/definitions/l-interface"
34562 summary: update an existing l-interface
34564 Update an existing l-interface
34566 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34567 The PUT operation will entirely replace an existing object.
34568 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34570 Other differences between PUT and PATCH are:
34572 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34573 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34574 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34575 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
34584 description: Response codes found in [response codes](https://wiki.onap.org/).
34588 description: unique name of Physical Network Function.
34591 example: __PNF-NAME__
34592 - name: interface-name
34594 description: Name that identifies the physical interface
34597 example: __INTERFACE-NAME__
34598 - name: interface-name
34600 description: Name given to the interface
34603 example: __INTERFACE-NAME__
34606 description: l-interface object that needs to be updated.
34609 $ref: "#/patchDefinitions/l-interface"
34613 summary: delete an existing l-interface
34614 description: delete an existing l-interface
34615 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
34624 description: Response codes found in [response codes](https://wiki.onap.org/).
34628 description: unique name of Physical Network Function.
34631 example: __PNF-NAME__
34632 - name: interface-name
34634 description: Name that identifies the physical interface
34637 example: __INTERFACE-NAME__
34638 - name: interface-name
34640 description: Name given to the interface
34643 example: __INTERFACE-NAME__
34644 - name: resource-version
34646 description: resource-version for concurrency
34649 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
34653 summary: returns l-interfaces
34654 description: returns l-interfaces
34655 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
34661 description: successful operation
34663 $ref: "#/getDefinitions/l-interfaces"
34665 description: Response codes found in [response codes](https://wiki.onap.org/).
34669 description: unique name of Physical Network Function.
34672 example: __PNF-NAME__
34673 - name: interface-name
34675 description: Name that identifies the physical interface
34678 example: __INTERFACE-NAME__
34679 - name: interface-name
34684 - name: interface-id
34694 - name: network-name
34699 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
34703 summary: returns p-interface
34704 description: returns p-interface
34705 operationId: getNetworkPnfsPnfPInterfacesPInterface
34711 description: successful operation
34713 $ref: "#/getDefinitions/p-interface"
34715 description: Response codes found in [response codes](https://wiki.onap.org/).
34719 description: unique name of Physical Network Function.
34722 example: __PNF-NAME__
34723 - name: interface-name
34725 description: Name that identifies the physical interface
34728 example: __INTERFACE-NAME__
34732 summary: create or update an existing p-interface
34734 Create or update an existing p-interface.
34736 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34737 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
34746 description: Response codes found in [response codes](https://wiki.onap.org/).
34750 description: unique name of Physical Network Function.
34753 example: __PNF-NAME__
34754 - name: interface-name
34756 description: Name that identifies the physical interface
34759 example: __INTERFACE-NAME__
34762 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
34765 $ref: "#/definitions/p-interface"
34769 summary: update an existing p-interface
34771 Update an existing p-interface
34773 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34774 The PUT operation will entirely replace an existing object.
34775 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34777 Other differences between PUT and PATCH are:
34779 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34780 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34781 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34782 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
34791 description: Response codes found in [response codes](https://wiki.onap.org/).
34795 description: unique name of Physical Network Function.
34798 example: __PNF-NAME__
34799 - name: interface-name
34801 description: Name that identifies the physical interface
34804 example: __INTERFACE-NAME__
34807 description: p-interface object that needs to be updated.
34810 $ref: "#/patchDefinitions/p-interface"
34814 summary: delete an existing p-interface
34815 description: delete an existing p-interface
34816 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
34825 description: Response codes found in [response codes](https://wiki.onap.org/).
34829 description: unique name of Physical Network Function.
34832 example: __PNF-NAME__
34833 - name: interface-name
34835 description: Name that identifies the physical interface
34838 example: __INTERFACE-NAME__
34839 - name: resource-version
34841 description: resource-version for concurrency
34844 /network/pnfs/pnf/{pnf-name}/p-interfaces:
34848 summary: returns p-interfaces
34849 description: returns p-interfaces
34850 operationId: getNetworkPnfsPnfPInterfaces
34856 description: successful operation
34858 $ref: "#/getDefinitions/p-interfaces"
34860 description: Response codes found in [response codes](https://wiki.onap.org/).
34864 description: unique name of Physical Network Function.
34867 example: __PNF-NAME__
34868 - name: interface-name
34873 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
34877 summary: see node definition for valid relationships
34878 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
34887 description: Response codes found in [response codes](https://wiki.onap.org/).
34891 description: unique name of Physical Network Function.
34894 example: __PNF-NAME__
34895 - name: interface-name
34897 description: Name that identifies the link aggregate interface
34900 example: __INTERFACE-NAME__
34903 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
34906 $ref: "#/definitions/relationship"
34910 summary: delete an existing relationship
34911 description: delete an existing relationship
34912 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
34921 description: Response codes found in [response codes](https://wiki.onap.org/).
34925 description: unique name of Physical Network Function.
34928 example: __PNF-NAME__
34929 - name: interface-name
34931 description: Name that identifies the link aggregate interface
34934 example: __INTERFACE-NAME__
34935 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34939 summary: see node definition for valid relationships
34940 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34949 description: Response codes found in [response codes](https://wiki.onap.org/).
34953 description: unique name of Physical Network Function.
34956 example: __PNF-NAME__
34957 - name: interface-name
34959 description: Name that identifies the link aggregate interface
34962 example: __INTERFACE-NAME__
34963 - name: interface-name
34965 description: Name given to the interface
34968 example: __INTERFACE-NAME__
34969 - name: vlan-interface
34971 description: String that identifies the interface
34974 example: __VLAN-INTERFACE__
34977 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34980 $ref: "#/definitions/relationship"
34984 summary: delete an existing relationship
34985 description: delete an existing relationship
34986 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34995 description: Response codes found in [response codes](https://wiki.onap.org/).
34999 description: unique name of Physical Network Function.
35002 example: __PNF-NAME__
35003 - name: interface-name
35005 description: Name that identifies the link aggregate interface
35008 example: __INTERFACE-NAME__
35009 - name: interface-name
35011 description: Name given to the interface
35014 example: __INTERFACE-NAME__
35015 - name: vlan-interface
35017 description: String that identifies the interface
35020 example: __VLAN-INTERFACE__
35021 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
35025 summary: see node definition for valid relationships
35026 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35035 description: Response codes found in [response codes](https://wiki.onap.org/).
35039 description: unique name of Physical Network Function.
35042 example: __PNF-NAME__
35043 - name: interface-name
35045 description: Name that identifies the link aggregate interface
35048 example: __INTERFACE-NAME__
35049 - name: interface-name
35051 description: Name given to the interface
35054 example: __INTERFACE-NAME__
35055 - name: vlan-interface
35057 description: String that identifies the interface
35060 example: __VLAN-INTERFACE__
35061 - name: l3-interface-ipv4-address
35063 description: IP address
35066 example: __L3-INTERFACE-IPV4-ADDRESS__
35069 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35072 $ref: "#/definitions/relationship"
35076 summary: delete an existing relationship
35077 description: delete an existing relationship
35078 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35087 description: Response codes found in [response codes](https://wiki.onap.org/).
35091 description: unique name of Physical Network Function.
35094 example: __PNF-NAME__
35095 - name: interface-name
35097 description: Name that identifies the link aggregate interface
35100 example: __INTERFACE-NAME__
35101 - name: interface-name
35103 description: Name given to the interface
35106 example: __INTERFACE-NAME__
35107 - name: vlan-interface
35109 description: String that identifies the interface
35112 example: __VLAN-INTERFACE__
35113 - name: l3-interface-ipv4-address
35115 description: IP address
35118 example: __L3-INTERFACE-IPV4-ADDRESS__
35119 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
35123 summary: returns l3-interface-ipv4-address-list
35124 description: returns l3-interface-ipv4-address-list
35125 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35131 description: successful operation
35133 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35135 description: Response codes found in [response codes](https://wiki.onap.org/).
35139 description: unique name of Physical Network Function.
35142 example: __PNF-NAME__
35143 - name: interface-name
35145 description: Name that identifies the link aggregate interface
35148 example: __INTERFACE-NAME__
35149 - name: interface-name
35151 description: Name given to the interface
35154 example: __INTERFACE-NAME__
35155 - name: vlan-interface
35157 description: String that identifies the interface
35160 example: __VLAN-INTERFACE__
35161 - name: l3-interface-ipv4-address
35163 description: IP address
35166 example: __L3-INTERFACE-IPV4-ADDRESS__
35170 summary: create or update an existing l3-interface-ipv4-address-list
35172 Create or update an existing l3-interface-ipv4-address-list.
35174 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35175 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35184 description: Response codes found in [response codes](https://wiki.onap.org/).
35188 description: unique name of Physical Network Function.
35191 example: __PNF-NAME__
35192 - name: interface-name
35194 description: Name that identifies the link aggregate interface
35197 example: __INTERFACE-NAME__
35198 - name: interface-name
35200 description: Name given to the interface
35203 example: __INTERFACE-NAME__
35204 - name: vlan-interface
35206 description: String that identifies the interface
35209 example: __VLAN-INTERFACE__
35210 - name: l3-interface-ipv4-address
35212 description: IP address
35215 example: __L3-INTERFACE-IPV4-ADDRESS__
35218 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35221 $ref: "#/definitions/l3-interface-ipv4-address-list"
35225 summary: update an existing l3-interface-ipv4-address-list
35227 Update an existing l3-interface-ipv4-address-list
35229 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35230 The PUT operation will entirely replace an existing object.
35231 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35233 Other differences between PUT and PATCH are:
35235 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35236 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35237 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35238 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35247 description: Response codes found in [response codes](https://wiki.onap.org/).
35251 description: unique name of Physical Network Function.
35254 example: __PNF-NAME__
35255 - name: interface-name
35257 description: Name that identifies the link aggregate interface
35260 example: __INTERFACE-NAME__
35261 - name: interface-name
35263 description: Name given to the interface
35266 example: __INTERFACE-NAME__
35267 - name: vlan-interface
35269 description: String that identifies the interface
35272 example: __VLAN-INTERFACE__
35273 - name: l3-interface-ipv4-address
35275 description: IP address
35278 example: __L3-INTERFACE-IPV4-ADDRESS__
35281 description: l3-interface-ipv4-address-list object that needs to be updated.
35284 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35288 summary: delete an existing l3-interface-ipv4-address-list
35289 description: delete an existing l3-interface-ipv4-address-list
35290 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35299 description: Response codes found in [response codes](https://wiki.onap.org/).
35303 description: unique name of Physical Network Function.
35306 example: __PNF-NAME__
35307 - name: interface-name
35309 description: Name that identifies the link aggregate interface
35312 example: __INTERFACE-NAME__
35313 - name: interface-name
35315 description: Name given to the interface
35318 example: __INTERFACE-NAME__
35319 - name: vlan-interface
35321 description: String that identifies the interface
35324 example: __VLAN-INTERFACE__
35325 - name: l3-interface-ipv4-address
35327 description: IP address
35330 example: __L3-INTERFACE-IPV4-ADDRESS__
35331 - name: resource-version
35333 description: resource-version for concurrency
35336 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
35340 summary: see node definition for valid relationships
35341 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35350 description: Response codes found in [response codes](https://wiki.onap.org/).
35354 description: unique name of Physical Network Function.
35357 example: __PNF-NAME__
35358 - name: interface-name
35360 description: Name that identifies the link aggregate interface
35363 example: __INTERFACE-NAME__
35364 - name: interface-name
35366 description: Name given to the interface
35369 example: __INTERFACE-NAME__
35370 - name: vlan-interface
35372 description: String that identifies the interface
35375 example: __VLAN-INTERFACE__
35376 - name: l3-interface-ipv6-address
35378 description: IP address
35381 example: __L3-INTERFACE-IPV6-ADDRESS__
35384 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35387 $ref: "#/definitions/relationship"
35391 summary: delete an existing relationship
35392 description: delete an existing relationship
35393 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35402 description: Response codes found in [response codes](https://wiki.onap.org/).
35406 description: unique name of Physical Network Function.
35409 example: __PNF-NAME__
35410 - name: interface-name
35412 description: Name that identifies the link aggregate interface
35415 example: __INTERFACE-NAME__
35416 - name: interface-name
35418 description: Name given to the interface
35421 example: __INTERFACE-NAME__
35422 - name: vlan-interface
35424 description: String that identifies the interface
35427 example: __VLAN-INTERFACE__
35428 - name: l3-interface-ipv6-address
35430 description: IP address
35433 example: __L3-INTERFACE-IPV6-ADDRESS__
35434 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
35438 summary: returns l3-interface-ipv6-address-list
35439 description: returns l3-interface-ipv6-address-list
35440 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35446 description: successful operation
35448 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35450 description: Response codes found in [response codes](https://wiki.onap.org/).
35454 description: unique name of Physical Network Function.
35457 example: __PNF-NAME__
35458 - name: interface-name
35460 description: Name that identifies the link aggregate interface
35463 example: __INTERFACE-NAME__
35464 - name: interface-name
35466 description: Name given to the interface
35469 example: __INTERFACE-NAME__
35470 - name: vlan-interface
35472 description: String that identifies the interface
35475 example: __VLAN-INTERFACE__
35476 - name: l3-interface-ipv6-address
35478 description: IP address
35481 example: __L3-INTERFACE-IPV6-ADDRESS__
35485 summary: create or update an existing l3-interface-ipv6-address-list
35487 Create or update an existing l3-interface-ipv6-address-list.
35489 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35490 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35499 description: Response codes found in [response codes](https://wiki.onap.org/).
35503 description: unique name of Physical Network Function.
35506 example: __PNF-NAME__
35507 - name: interface-name
35509 description: Name that identifies the link aggregate interface
35512 example: __INTERFACE-NAME__
35513 - name: interface-name
35515 description: Name given to the interface
35518 example: __INTERFACE-NAME__
35519 - name: vlan-interface
35521 description: String that identifies the interface
35524 example: __VLAN-INTERFACE__
35525 - name: l3-interface-ipv6-address
35527 description: IP address
35530 example: __L3-INTERFACE-IPV6-ADDRESS__
35533 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35536 $ref: "#/definitions/l3-interface-ipv6-address-list"
35540 summary: update an existing l3-interface-ipv6-address-list
35542 Update an existing l3-interface-ipv6-address-list
35544 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35545 The PUT operation will entirely replace an existing object.
35546 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35548 Other differences between PUT and PATCH are:
35550 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35551 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35552 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35553 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35562 description: Response codes found in [response codes](https://wiki.onap.org/).
35566 description: unique name of Physical Network Function.
35569 example: __PNF-NAME__
35570 - name: interface-name
35572 description: Name that identifies the link aggregate interface
35575 example: __INTERFACE-NAME__
35576 - name: interface-name
35578 description: Name given to the interface
35581 example: __INTERFACE-NAME__
35582 - name: vlan-interface
35584 description: String that identifies the interface
35587 example: __VLAN-INTERFACE__
35588 - name: l3-interface-ipv6-address
35590 description: IP address
35593 example: __L3-INTERFACE-IPV6-ADDRESS__
35596 description: l3-interface-ipv6-address-list object that needs to be updated.
35599 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35603 summary: delete an existing l3-interface-ipv6-address-list
35604 description: delete an existing l3-interface-ipv6-address-list
35605 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35614 description: Response codes found in [response codes](https://wiki.onap.org/).
35618 description: unique name of Physical Network Function.
35621 example: __PNF-NAME__
35622 - name: interface-name
35624 description: Name that identifies the link aggregate interface
35627 example: __INTERFACE-NAME__
35628 - name: interface-name
35630 description: Name given to the interface
35633 example: __INTERFACE-NAME__
35634 - name: vlan-interface
35636 description: String that identifies the interface
35639 example: __VLAN-INTERFACE__
35640 - name: l3-interface-ipv6-address
35642 description: IP address
35645 example: __L3-INTERFACE-IPV6-ADDRESS__
35646 - name: resource-version
35648 description: resource-version for concurrency
35651 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35655 summary: returns vlan
35656 description: returns vlan
35657 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35663 description: successful operation
35665 $ref: "#/getDefinitions/vlan"
35667 description: Response codes found in [response codes](https://wiki.onap.org/).
35671 description: unique name of Physical Network Function.
35674 example: __PNF-NAME__
35675 - name: interface-name
35677 description: Name that identifies the link aggregate interface
35680 example: __INTERFACE-NAME__
35681 - name: interface-name
35683 description: Name given to the interface
35686 example: __INTERFACE-NAME__
35687 - name: vlan-interface
35689 description: String that identifies the interface
35692 example: __VLAN-INTERFACE__
35696 summary: create or update an existing vlan
35698 Create or update an existing vlan.
35700 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35701 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35710 description: Response codes found in [response codes](https://wiki.onap.org/).
35714 description: unique name of Physical Network Function.
35717 example: __PNF-NAME__
35718 - name: interface-name
35720 description: Name that identifies the link aggregate interface
35723 example: __INTERFACE-NAME__
35724 - name: interface-name
35726 description: Name given to the interface
35729 example: __INTERFACE-NAME__
35730 - name: vlan-interface
35732 description: String that identifies the interface
35735 example: __VLAN-INTERFACE__
35738 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
35741 $ref: "#/definitions/vlan"
35745 summary: update an existing vlan
35747 Update an existing vlan
35749 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35750 The PUT operation will entirely replace an existing object.
35751 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35753 Other differences between PUT and PATCH are:
35755 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35756 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35757 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35758 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35767 description: Response codes found in [response codes](https://wiki.onap.org/).
35771 description: unique name of Physical Network Function.
35774 example: __PNF-NAME__
35775 - name: interface-name
35777 description: Name that identifies the link aggregate interface
35780 example: __INTERFACE-NAME__
35781 - name: interface-name
35783 description: Name given to the interface
35786 example: __INTERFACE-NAME__
35787 - name: vlan-interface
35789 description: String that identifies the interface
35792 example: __VLAN-INTERFACE__
35795 description: vlan object that needs to be updated.
35798 $ref: "#/patchDefinitions/vlan"
35802 summary: delete an existing vlan
35803 description: delete an existing vlan
35804 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35813 description: Response codes found in [response codes](https://wiki.onap.org/).
35817 description: unique name of Physical Network Function.
35820 example: __PNF-NAME__
35821 - name: interface-name
35823 description: Name that identifies the link aggregate interface
35826 example: __INTERFACE-NAME__
35827 - name: interface-name
35829 description: Name given to the interface
35832 example: __INTERFACE-NAME__
35833 - name: vlan-interface
35835 description: String that identifies the interface
35838 example: __VLAN-INTERFACE__
35839 - name: resource-version
35841 description: resource-version for concurrency
35844 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
35848 summary: returns vlans
35849 description: returns vlans
35850 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
35856 description: successful operation
35858 $ref: "#/getDefinitions/vlans"
35860 description: Response codes found in [response codes](https://wiki.onap.org/).
35864 description: unique name of Physical Network Function.
35867 example: __PNF-NAME__
35868 - name: interface-name
35870 description: Name that identifies the link aggregate interface
35873 example: __INTERFACE-NAME__
35874 - name: interface-name
35876 description: Name given to the interface
35879 example: __INTERFACE-NAME__
35880 - name: vlan-interface
35885 - name: vlan-id-inner
35896 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
35900 summary: see node definition for valid relationships
35901 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35910 description: Response codes found in [response codes](https://wiki.onap.org/).
35914 description: unique name of Physical Network Function.
35917 example: __PNF-NAME__
35918 - name: interface-name
35920 description: Name that identifies the link aggregate interface
35923 example: __INTERFACE-NAME__
35924 - name: interface-name
35926 description: Name given to the interface
35929 example: __INTERFACE-NAME__
35932 description: PCI ID used to identify the sriov-vf
35935 example: __PCI-ID__
35938 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35941 $ref: "#/definitions/relationship"
35945 summary: delete an existing relationship
35946 description: delete an existing relationship
35947 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35956 description: Response codes found in [response codes](https://wiki.onap.org/).
35960 description: unique name of Physical Network Function.
35963 example: __PNF-NAME__
35964 - name: interface-name
35966 description: Name that identifies the link aggregate interface
35969 example: __INTERFACE-NAME__
35970 - name: interface-name
35972 description: Name given to the interface
35975 example: __INTERFACE-NAME__
35978 description: PCI ID used to identify the sriov-vf
35981 example: __PCI-ID__
35982 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
35986 summary: returns sriov-vf
35987 description: returns sriov-vf
35988 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35994 description: successful operation
35996 $ref: "#/getDefinitions/sriov-vf"
35998 description: Response codes found in [response codes](https://wiki.onap.org/).
36002 description: unique name of Physical Network Function.
36005 example: __PNF-NAME__
36006 - name: interface-name
36008 description: Name that identifies the link aggregate interface
36011 example: __INTERFACE-NAME__
36012 - name: interface-name
36014 description: Name given to the interface
36017 example: __INTERFACE-NAME__
36020 description: PCI ID used to identify the sriov-vf
36023 example: __PCI-ID__
36027 summary: create or update an existing sriov-vf
36029 Create or update an existing sriov-vf.
36031 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36032 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36041 description: Response codes found in [response codes](https://wiki.onap.org/).
36045 description: unique name of Physical Network Function.
36048 example: __PNF-NAME__
36049 - name: interface-name
36051 description: Name that identifies the link aggregate interface
36054 example: __INTERFACE-NAME__
36055 - name: interface-name
36057 description: Name given to the interface
36060 example: __INTERFACE-NAME__
36063 description: PCI ID used to identify the sriov-vf
36066 example: __PCI-ID__
36069 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
36072 $ref: "#/definitions/sriov-vf"
36076 summary: update an existing sriov-vf
36078 Update an existing sriov-vf
36080 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36081 The PUT operation will entirely replace an existing object.
36082 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36084 Other differences between PUT and PATCH are:
36086 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36087 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36088 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36089 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36098 description: Response codes found in [response codes](https://wiki.onap.org/).
36102 description: unique name of Physical Network Function.
36105 example: __PNF-NAME__
36106 - name: interface-name
36108 description: Name that identifies the link aggregate interface
36111 example: __INTERFACE-NAME__
36112 - name: interface-name
36114 description: Name given to the interface
36117 example: __INTERFACE-NAME__
36120 description: PCI ID used to identify the sriov-vf
36123 example: __PCI-ID__
36126 description: sriov-vf object that needs to be updated.
36129 $ref: "#/patchDefinitions/sriov-vf"
36133 summary: delete an existing sriov-vf
36134 description: delete an existing sriov-vf
36135 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36144 description: Response codes found in [response codes](https://wiki.onap.org/).
36148 description: unique name of Physical Network Function.
36151 example: __PNF-NAME__
36152 - name: interface-name
36154 description: Name that identifies the link aggregate interface
36157 example: __INTERFACE-NAME__
36158 - name: interface-name
36160 description: Name given to the interface
36163 example: __INTERFACE-NAME__
36166 description: PCI ID used to identify the sriov-vf
36169 example: __PCI-ID__
36170 - name: resource-version
36172 description: resource-version for concurrency
36175 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36179 summary: returns sriov-vfs
36180 description: returns sriov-vfs
36181 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
36187 description: successful operation
36189 $ref: "#/getDefinitions/sriov-vfs"
36191 description: Response codes found in [response codes](https://wiki.onap.org/).
36195 description: unique name of Physical Network Function.
36198 example: __PNF-NAME__
36199 - name: interface-name
36201 description: Name that identifies the link aggregate interface
36204 example: __INTERFACE-NAME__
36205 - name: interface-name
36207 description: Name given to the interface
36210 example: __INTERFACE-NAME__
36216 - name: vf-vlan-filter
36221 - name: vf-mac-filter
36226 - name: vf-vlan-strip
36231 - name: neutron-network-id
36236 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36240 summary: see node definition for valid relationships
36241 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
36250 description: Response codes found in [response codes](https://wiki.onap.org/).
36254 description: unique name of Physical Network Function.
36257 example: __PNF-NAME__
36258 - name: interface-name
36260 description: Name that identifies the link aggregate interface
36263 example: __INTERFACE-NAME__
36264 - name: interface-name
36266 description: Name given to the interface
36269 example: __INTERFACE-NAME__
36272 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
36275 $ref: "#/definitions/relationship"
36279 summary: delete an existing relationship
36280 description: delete an existing relationship
36281 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
36290 description: Response codes found in [response codes](https://wiki.onap.org/).
36294 description: unique name of Physical Network Function.
36297 example: __PNF-NAME__
36298 - name: interface-name
36300 description: Name that identifies the link aggregate interface
36303 example: __INTERFACE-NAME__
36304 - name: interface-name
36306 description: Name given to the interface
36309 example: __INTERFACE-NAME__
36310 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
36314 summary: see node definition for valid relationships
36315 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36324 description: Response codes found in [response codes](https://wiki.onap.org/).
36328 description: unique name of Physical Network Function.
36331 example: __PNF-NAME__
36332 - name: interface-name
36334 description: Name that identifies the link aggregate interface
36337 example: __INTERFACE-NAME__
36338 - name: interface-name
36340 description: Name given to the interface
36343 example: __INTERFACE-NAME__
36344 - name: l3-interface-ipv4-address
36346 description: IP address
36349 example: __L3-INTERFACE-IPV4-ADDRESS__
36352 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36355 $ref: "#/definitions/relationship"
36359 summary: delete an existing relationship
36360 description: delete an existing relationship
36361 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36370 description: Response codes found in [response codes](https://wiki.onap.org/).
36374 description: unique name of Physical Network Function.
36377 example: __PNF-NAME__
36378 - name: interface-name
36380 description: Name that identifies the link aggregate interface
36383 example: __INTERFACE-NAME__
36384 - name: interface-name
36386 description: Name given to the interface
36389 example: __INTERFACE-NAME__
36390 - name: l3-interface-ipv4-address
36392 description: IP address
36395 example: __L3-INTERFACE-IPV4-ADDRESS__
36396 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
36400 summary: returns l3-interface-ipv4-address-list
36401 description: returns l3-interface-ipv4-address-list
36402 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36408 description: successful operation
36410 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36412 description: Response codes found in [response codes](https://wiki.onap.org/).
36416 description: unique name of Physical Network Function.
36419 example: __PNF-NAME__
36420 - name: interface-name
36422 description: Name that identifies the link aggregate interface
36425 example: __INTERFACE-NAME__
36426 - name: interface-name
36428 description: Name given to the interface
36431 example: __INTERFACE-NAME__
36432 - name: l3-interface-ipv4-address
36434 description: IP address
36437 example: __L3-INTERFACE-IPV4-ADDRESS__
36441 summary: create or update an existing l3-interface-ipv4-address-list
36443 Create or update an existing l3-interface-ipv4-address-list.
36445 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36446 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36455 description: Response codes found in [response codes](https://wiki.onap.org/).
36459 description: unique name of Physical Network Function.
36462 example: __PNF-NAME__
36463 - name: interface-name
36465 description: Name that identifies the link aggregate interface
36468 example: __INTERFACE-NAME__
36469 - name: interface-name
36471 description: Name given to the interface
36474 example: __INTERFACE-NAME__
36475 - name: l3-interface-ipv4-address
36477 description: IP address
36480 example: __L3-INTERFACE-IPV4-ADDRESS__
36483 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36486 $ref: "#/definitions/l3-interface-ipv4-address-list"
36490 summary: update an existing l3-interface-ipv4-address-list
36492 Update an existing l3-interface-ipv4-address-list
36494 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36495 The PUT operation will entirely replace an existing object.
36496 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36498 Other differences between PUT and PATCH are:
36500 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36501 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36502 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36503 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36512 description: Response codes found in [response codes](https://wiki.onap.org/).
36516 description: unique name of Physical Network Function.
36519 example: __PNF-NAME__
36520 - name: interface-name
36522 description: Name that identifies the link aggregate interface
36525 example: __INTERFACE-NAME__
36526 - name: interface-name
36528 description: Name given to the interface
36531 example: __INTERFACE-NAME__
36532 - name: l3-interface-ipv4-address
36534 description: IP address
36537 example: __L3-INTERFACE-IPV4-ADDRESS__
36540 description: l3-interface-ipv4-address-list object that needs to be updated.
36543 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36547 summary: delete an existing l3-interface-ipv4-address-list
36548 description: delete an existing l3-interface-ipv4-address-list
36549 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36558 description: Response codes found in [response codes](https://wiki.onap.org/).
36562 description: unique name of Physical Network Function.
36565 example: __PNF-NAME__
36566 - name: interface-name
36568 description: Name that identifies the link aggregate interface
36571 example: __INTERFACE-NAME__
36572 - name: interface-name
36574 description: Name given to the interface
36577 example: __INTERFACE-NAME__
36578 - name: l3-interface-ipv4-address
36580 description: IP address
36583 example: __L3-INTERFACE-IPV4-ADDRESS__
36584 - name: resource-version
36586 description: resource-version for concurrency
36589 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
36593 summary: see node definition for valid relationships
36594 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36603 description: Response codes found in [response codes](https://wiki.onap.org/).
36607 description: unique name of Physical Network Function.
36610 example: __PNF-NAME__
36611 - name: interface-name
36613 description: Name that identifies the link aggregate interface
36616 example: __INTERFACE-NAME__
36617 - name: interface-name
36619 description: Name given to the interface
36622 example: __INTERFACE-NAME__
36623 - name: l3-interface-ipv6-address
36625 description: IP address
36628 example: __L3-INTERFACE-IPV6-ADDRESS__
36631 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36634 $ref: "#/definitions/relationship"
36638 summary: delete an existing relationship
36639 description: delete an existing relationship
36640 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36649 description: Response codes found in [response codes](https://wiki.onap.org/).
36653 description: unique name of Physical Network Function.
36656 example: __PNF-NAME__
36657 - name: interface-name
36659 description: Name that identifies the link aggregate interface
36662 example: __INTERFACE-NAME__
36663 - name: interface-name
36665 description: Name given to the interface
36668 example: __INTERFACE-NAME__
36669 - name: l3-interface-ipv6-address
36671 description: IP address
36674 example: __L3-INTERFACE-IPV6-ADDRESS__
36675 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
36679 summary: returns l3-interface-ipv6-address-list
36680 description: returns l3-interface-ipv6-address-list
36681 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36687 description: successful operation
36689 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36691 description: Response codes found in [response codes](https://wiki.onap.org/).
36695 description: unique name of Physical Network Function.
36698 example: __PNF-NAME__
36699 - name: interface-name
36701 description: Name that identifies the link aggregate interface
36704 example: __INTERFACE-NAME__
36705 - name: interface-name
36707 description: Name given to the interface
36710 example: __INTERFACE-NAME__
36711 - name: l3-interface-ipv6-address
36713 description: IP address
36716 example: __L3-INTERFACE-IPV6-ADDRESS__
36720 summary: create or update an existing l3-interface-ipv6-address-list
36722 Create or update an existing l3-interface-ipv6-address-list.
36724 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36725 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36734 description: Response codes found in [response codes](https://wiki.onap.org/).
36738 description: unique name of Physical Network Function.
36741 example: __PNF-NAME__
36742 - name: interface-name
36744 description: Name that identifies the link aggregate interface
36747 example: __INTERFACE-NAME__
36748 - name: interface-name
36750 description: Name given to the interface
36753 example: __INTERFACE-NAME__
36754 - name: l3-interface-ipv6-address
36756 description: IP address
36759 example: __L3-INTERFACE-IPV6-ADDRESS__
36762 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36765 $ref: "#/definitions/l3-interface-ipv6-address-list"
36769 summary: update an existing l3-interface-ipv6-address-list
36771 Update an existing l3-interface-ipv6-address-list
36773 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36774 The PUT operation will entirely replace an existing object.
36775 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36777 Other differences between PUT and PATCH are:
36779 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36780 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36781 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36782 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36791 description: Response codes found in [response codes](https://wiki.onap.org/).
36795 description: unique name of Physical Network Function.
36798 example: __PNF-NAME__
36799 - name: interface-name
36801 description: Name that identifies the link aggregate interface
36804 example: __INTERFACE-NAME__
36805 - name: interface-name
36807 description: Name given to the interface
36810 example: __INTERFACE-NAME__
36811 - name: l3-interface-ipv6-address
36813 description: IP address
36816 example: __L3-INTERFACE-IPV6-ADDRESS__
36819 description: l3-interface-ipv6-address-list object that needs to be updated.
36822 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36826 summary: delete an existing l3-interface-ipv6-address-list
36827 description: delete an existing l3-interface-ipv6-address-list
36828 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36837 description: Response codes found in [response codes](https://wiki.onap.org/).
36841 description: unique name of Physical Network Function.
36844 example: __PNF-NAME__
36845 - name: interface-name
36847 description: Name that identifies the link aggregate interface
36850 example: __INTERFACE-NAME__
36851 - name: interface-name
36853 description: Name given to the interface
36856 example: __INTERFACE-NAME__
36857 - name: l3-interface-ipv6-address
36859 description: IP address
36862 example: __L3-INTERFACE-IPV6-ADDRESS__
36863 - name: resource-version
36865 description: resource-version for concurrency
36868 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
36872 summary: returns l-interface
36873 description: returns l-interface
36874 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
36880 description: successful operation
36882 $ref: "#/getDefinitions/l-interface"
36884 description: Response codes found in [response codes](https://wiki.onap.org/).
36888 description: unique name of Physical Network Function.
36891 example: __PNF-NAME__
36892 - name: interface-name
36894 description: Name that identifies the link aggregate interface
36897 example: __INTERFACE-NAME__
36898 - name: interface-name
36900 description: Name given to the interface
36903 example: __INTERFACE-NAME__
36907 summary: create or update an existing l-interface
36909 Create or update an existing l-interface.
36911 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36912 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
36921 description: Response codes found in [response codes](https://wiki.onap.org/).
36925 description: unique name of Physical Network Function.
36928 example: __PNF-NAME__
36929 - name: interface-name
36931 description: Name that identifies the link aggregate interface
36934 example: __INTERFACE-NAME__
36935 - name: interface-name
36937 description: Name given to the interface
36940 example: __INTERFACE-NAME__
36943 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
36946 $ref: "#/definitions/l-interface"
36950 summary: update an existing l-interface
36952 Update an existing l-interface
36954 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36955 The PUT operation will entirely replace an existing object.
36956 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36958 Other differences between PUT and PATCH are:
36960 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36961 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36962 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36963 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
36972 description: Response codes found in [response codes](https://wiki.onap.org/).
36976 description: unique name of Physical Network Function.
36979 example: __PNF-NAME__
36980 - name: interface-name
36982 description: Name that identifies the link aggregate interface
36985 example: __INTERFACE-NAME__
36986 - name: interface-name
36988 description: Name given to the interface
36991 example: __INTERFACE-NAME__
36994 description: l-interface object that needs to be updated.
36997 $ref: "#/patchDefinitions/l-interface"
37001 summary: delete an existing l-interface
37002 description: delete an existing l-interface
37003 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
37012 description: Response codes found in [response codes](https://wiki.onap.org/).
37016 description: unique name of Physical Network Function.
37019 example: __PNF-NAME__
37020 - name: interface-name
37022 description: Name that identifies the link aggregate interface
37025 example: __INTERFACE-NAME__
37026 - name: interface-name
37028 description: Name given to the interface
37031 example: __INTERFACE-NAME__
37032 - name: resource-version
37034 description: resource-version for concurrency
37037 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
37041 summary: returns l-interfaces
37042 description: returns l-interfaces
37043 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
37049 description: successful operation
37051 $ref: "#/getDefinitions/l-interfaces"
37053 description: Response codes found in [response codes](https://wiki.onap.org/).
37057 description: unique name of Physical Network Function.
37060 example: __PNF-NAME__
37061 - name: interface-name
37063 description: Name that identifies the link aggregate interface
37066 example: __INTERFACE-NAME__
37067 - name: interface-name
37072 - name: interface-id
37082 - name: network-name
37087 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
37091 summary: returns lag-interface
37092 description: returns lag-interface
37093 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
37099 description: successful operation
37101 $ref: "#/getDefinitions/lag-interface"
37103 description: Response codes found in [response codes](https://wiki.onap.org/).
37107 description: unique name of Physical Network Function.
37110 example: __PNF-NAME__
37111 - name: interface-name
37113 description: Name that identifies the link aggregate interface
37116 example: __INTERFACE-NAME__
37120 summary: create or update an existing lag-interface
37122 Create or update an existing lag-interface.
37124 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37125 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
37134 description: Response codes found in [response codes](https://wiki.onap.org/).
37138 description: unique name of Physical Network Function.
37141 example: __PNF-NAME__
37142 - name: interface-name
37144 description: Name that identifies the link aggregate interface
37147 example: __INTERFACE-NAME__
37150 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
37153 $ref: "#/definitions/lag-interface"
37157 summary: update an existing lag-interface
37159 Update an existing lag-interface
37161 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37162 The PUT operation will entirely replace an existing object.
37163 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37165 Other differences between PUT and PATCH are:
37167 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37168 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37169 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37170 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
37179 description: Response codes found in [response codes](https://wiki.onap.org/).
37183 description: unique name of Physical Network Function.
37186 example: __PNF-NAME__
37187 - name: interface-name
37189 description: Name that identifies the link aggregate interface
37192 example: __INTERFACE-NAME__
37195 description: lag-interface object that needs to be updated.
37198 $ref: "#/patchDefinitions/lag-interface"
37202 summary: delete an existing lag-interface
37203 description: delete an existing lag-interface
37204 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
37213 description: Response codes found in [response codes](https://wiki.onap.org/).
37217 description: unique name of Physical Network Function.
37220 example: __PNF-NAME__
37221 - name: interface-name
37223 description: Name that identifies the link aggregate interface
37226 example: __INTERFACE-NAME__
37227 - name: resource-version
37229 description: resource-version for concurrency
37232 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
37236 summary: returns lag-interfaces
37237 description: returns lag-interfaces
37238 operationId: getNetworkPnfsPnfLagInterfaces
37244 description: successful operation
37246 $ref: "#/getDefinitions/lag-interfaces"
37248 description: Response codes found in [response codes](https://wiki.onap.org/).
37252 description: unique name of Physical Network Function.
37255 example: __PNF-NAME__
37256 - name: interface-name
37261 /network/pnfs/pnf/{pnf-name}:
37265 summary: returns pnf
37266 description: returns pnf
37267 operationId: getNetworkPnfsPnf
37273 description: successful operation
37275 $ref: "#/getDefinitions/pnf"
37277 description: Response codes found in [response codes](https://wiki.onap.org/).
37281 description: unique name of Physical Network Function.
37284 example: __PNF-NAME__
37288 summary: create or update an existing pnf
37290 Create or update an existing pnf.
37292 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37293 operationId: createOrUpdateNetworkPnfsPnf
37302 description: Response codes found in [response codes](https://wiki.onap.org/).
37306 description: unique name of Physical Network Function.
37309 example: __PNF-NAME__
37312 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
37315 $ref: "#/definitions/pnf"
37319 summary: update an existing pnf
37321 Update an existing pnf
37323 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37324 The PUT operation will entirely replace an existing object.
37325 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37327 Other differences between PUT and PATCH are:
37329 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37330 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37331 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37332 operationId: UpdateNetworkPnfsPnf
37341 description: Response codes found in [response codes](https://wiki.onap.org/).
37345 description: unique name of Physical Network Function.
37348 example: __PNF-NAME__
37351 description: pnf object that needs to be updated.
37354 $ref: "#/patchDefinitions/pnf"
37358 summary: delete an existing pnf
37359 description: delete an existing pnf
37360 operationId: deleteNetworkPnfsPnf
37369 description: Response codes found in [response codes](https://wiki.onap.org/).
37373 description: unique name of Physical Network Function.
37376 example: __PNF-NAME__
37377 - name: resource-version
37379 description: resource-version for concurrency
37386 summary: returns pnfs
37387 description: returns pnfs
37388 operationId: getNetworkPnfs
37394 description: successful operation
37396 $ref: "#/getDefinitions/pnfs"
37398 description: Response codes found in [response codes](https://wiki.onap.org/).
37405 - name: orchestration-status
37410 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
37414 summary: see node definition for valid relationships
37415 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
37424 description: Response codes found in [response codes](https://wiki.onap.org/).
37428 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37431 example: __LINK-NAME__
37434 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
37437 $ref: "#/definitions/relationship"
37441 summary: delete an existing relationship
37442 description: delete an existing relationship
37443 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
37452 description: Response codes found in [response codes](https://wiki.onap.org/).
37456 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37459 example: __LINK-NAME__
37460 /network/physical-links/physical-link/{link-name}:
37464 summary: returns physical-link
37465 description: returns physical-link
37466 operationId: getNetworkPhysicalLinksPhysicalLink
37472 description: successful operation
37474 $ref: "#/getDefinitions/physical-link"
37476 description: Response codes found in [response codes](https://wiki.onap.org/).
37480 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37483 example: __LINK-NAME__
37487 summary: create or update an existing physical-link
37489 Create or update an existing physical-link.
37491 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37492 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
37501 description: Response codes found in [response codes](https://wiki.onap.org/).
37505 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37508 example: __LINK-NAME__
37511 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
37514 $ref: "#/definitions/physical-link"
37518 summary: update an existing physical-link
37520 Update an existing physical-link
37522 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37523 The PUT operation will entirely replace an existing object.
37524 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37526 Other differences between PUT and PATCH are:
37528 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37529 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37530 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37531 operationId: UpdateNetworkPhysicalLinksPhysicalLink
37540 description: Response codes found in [response codes](https://wiki.onap.org/).
37544 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37547 example: __LINK-NAME__
37550 description: physical-link object that needs to be updated.
37553 $ref: "#/patchDefinitions/physical-link"
37557 summary: delete an existing physical-link
37558 description: delete an existing physical-link
37559 operationId: deleteNetworkPhysicalLinksPhysicalLink
37568 description: Response codes found in [response codes](https://wiki.onap.org/).
37572 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
37575 example: __LINK-NAME__
37576 - name: resource-version
37578 description: resource-version for concurrency
37581 /network/physical-links:
37585 summary: returns physical-links
37586 description: returns physical-links
37587 operationId: getNetworkPhysicalLinks
37593 description: successful operation
37595 $ref: "#/getDefinitions/physical-links"
37597 description: Response codes found in [response codes](https://wiki.onap.org/).
37609 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
37613 summary: see node definition for valid relationships
37614 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
37623 description: Response codes found in [response codes](https://wiki.onap.org/).
37625 - name: ipsec-configuration-id
37627 description: UUID of this configuration
37630 example: __IPSEC-CONFIGURATION-ID__
37633 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
37636 $ref: "#/definitions/relationship"
37640 summary: delete an existing relationship
37641 description: delete an existing relationship
37642 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
37651 description: Response codes found in [response codes](https://wiki.onap.org/).
37653 - name: ipsec-configuration-id
37655 description: UUID of this configuration
37658 example: __IPSEC-CONFIGURATION-ID__
37659 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
37663 summary: see node definition for valid relationships
37664 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
37673 description: Response codes found in [response codes](https://wiki.onap.org/).
37675 - name: ipsec-configuration-id
37677 description: UUID of this configuration
37680 example: __IPSEC-CONFIGURATION-ID__
37681 - name: vig-address-type
37683 description: indicates whether the VIG is for AVPN or INTERNET
37686 example: __VIG-ADDRESS-TYPE__
37689 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
37692 $ref: "#/definitions/relationship"
37696 summary: delete an existing relationship
37697 description: delete an existing relationship
37698 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
37707 description: Response codes found in [response codes](https://wiki.onap.org/).
37709 - name: ipsec-configuration-id
37711 description: UUID of this configuration
37714 example: __IPSEC-CONFIGURATION-ID__
37715 - name: vig-address-type
37717 description: indicates whether the VIG is for AVPN or INTERNET
37720 example: __VIG-ADDRESS-TYPE__
37721 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
37725 summary: returns vig-server
37726 description: returns vig-server
37727 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
37733 description: successful operation
37735 $ref: "#/getDefinitions/vig-server"
37737 description: Response codes found in [response codes](https://wiki.onap.org/).
37739 - name: ipsec-configuration-id
37741 description: UUID of this configuration
37744 example: __IPSEC-CONFIGURATION-ID__
37745 - name: vig-address-type
37747 description: indicates whether the VIG is for AVPN or INTERNET
37750 example: __VIG-ADDRESS-TYPE__
37754 summary: create or update an existing vig-server
37756 Create or update an existing vig-server.
37758 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37759 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
37768 description: Response codes found in [response codes](https://wiki.onap.org/).
37770 - name: ipsec-configuration-id
37772 description: UUID of this configuration
37775 example: __IPSEC-CONFIGURATION-ID__
37776 - name: vig-address-type
37778 description: indicates whether the VIG is for AVPN or INTERNET
37781 example: __VIG-ADDRESS-TYPE__
37784 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
37787 $ref: "#/definitions/vig-server"
37791 summary: update an existing vig-server
37793 Update an existing vig-server
37795 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37796 The PUT operation will entirely replace an existing object.
37797 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37799 Other differences between PUT and PATCH are:
37801 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37802 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37803 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37804 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
37813 description: Response codes found in [response codes](https://wiki.onap.org/).
37815 - name: ipsec-configuration-id
37817 description: UUID of this configuration
37820 example: __IPSEC-CONFIGURATION-ID__
37821 - name: vig-address-type
37823 description: indicates whether the VIG is for AVPN or INTERNET
37826 example: __VIG-ADDRESS-TYPE__
37829 description: vig-server object that needs to be updated.
37832 $ref: "#/patchDefinitions/vig-server"
37836 summary: delete an existing vig-server
37837 description: delete an existing vig-server
37838 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
37847 description: Response codes found in [response codes](https://wiki.onap.org/).
37849 - name: ipsec-configuration-id
37851 description: UUID of this configuration
37854 example: __IPSEC-CONFIGURATION-ID__
37855 - name: vig-address-type
37857 description: indicates whether the VIG is for AVPN or INTERNET
37860 example: __VIG-ADDRESS-TYPE__
37861 - name: resource-version
37863 description: resource-version for concurrency
37866 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
37870 summary: returns vig-servers
37871 description: returns vig-servers
37872 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
37878 description: successful operation
37880 $ref: "#/getDefinitions/vig-servers"
37882 description: Response codes found in [response codes](https://wiki.onap.org/).
37884 - name: ipsec-configuration-id
37886 description: UUID of this configuration
37889 example: __IPSEC-CONFIGURATION-ID__
37890 - name: vig-address-type
37895 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
37899 summary: returns ipsec-configuration
37900 description: returns ipsec-configuration
37901 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
37907 description: successful operation
37909 $ref: "#/getDefinitions/ipsec-configuration"
37911 description: Response codes found in [response codes](https://wiki.onap.org/).
37913 - name: ipsec-configuration-id
37915 description: UUID of this configuration
37918 example: __IPSEC-CONFIGURATION-ID__
37922 summary: create or update an existing ipsec-configuration
37924 Create or update an existing ipsec-configuration.
37926 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37927 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
37936 description: Response codes found in [response codes](https://wiki.onap.org/).
37938 - name: ipsec-configuration-id
37940 description: UUID of this configuration
37943 example: __IPSEC-CONFIGURATION-ID__
37946 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
37949 $ref: "#/definitions/ipsec-configuration"
37953 summary: update an existing ipsec-configuration
37955 Update an existing ipsec-configuration
37957 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37958 The PUT operation will entirely replace an existing object.
37959 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37961 Other differences between PUT and PATCH are:
37963 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37964 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37965 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37966 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
37975 description: Response codes found in [response codes](https://wiki.onap.org/).
37977 - name: ipsec-configuration-id
37979 description: UUID of this configuration
37982 example: __IPSEC-CONFIGURATION-ID__
37985 description: ipsec-configuration object that needs to be updated.
37988 $ref: "#/patchDefinitions/ipsec-configuration"
37992 summary: delete an existing ipsec-configuration
37993 description: delete an existing ipsec-configuration
37994 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
38003 description: Response codes found in [response codes](https://wiki.onap.org/).
38005 - name: ipsec-configuration-id
38007 description: UUID of this configuration
38010 example: __IPSEC-CONFIGURATION-ID__
38011 - name: resource-version
38013 description: resource-version for concurrency
38016 /network/ipsec-configurations:
38020 summary: returns ipsec-configurations
38021 description: returns ipsec-configurations
38022 operationId: getNetworkIpsecConfigurations
38028 description: successful operation
38030 $ref: "#/getDefinitions/ipsec-configurations"
38032 description: Response codes found in [response codes](https://wiki.onap.org/).
38034 - name: ipsec-configuration-id
38039 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
38043 summary: see node definition for valid relationships
38044 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
38053 description: Response codes found in [response codes](https://wiki.onap.org/).
38055 - name: route-table-reference-id
38057 description: Route Table Reference id, UUID assigned to this instance.
38060 example: __ROUTE-TABLE-REFERENCE-ID__
38063 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
38066 $ref: "#/definitions/relationship"
38070 summary: delete an existing relationship
38071 description: delete an existing relationship
38072 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
38081 description: Response codes found in [response codes](https://wiki.onap.org/).
38083 - name: route-table-reference-id
38085 description: Route Table Reference id, UUID assigned to this instance.
38088 example: __ROUTE-TABLE-REFERENCE-ID__
38089 /network/route-table-references/route-table-reference/{route-table-reference-id}:
38093 summary: returns route-table-reference
38094 description: returns route-table-reference
38095 operationId: getNetworkRouteTableReferencesRouteTableReference
38101 description: successful operation
38103 $ref: "#/getDefinitions/route-table-reference"
38105 description: Response codes found in [response codes](https://wiki.onap.org/).
38107 - name: route-table-reference-id
38109 description: Route Table Reference id, UUID assigned to this instance.
38112 example: __ROUTE-TABLE-REFERENCE-ID__
38116 summary: create or update an existing route-table-reference
38118 Create or update an existing route-table-reference.
38120 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38121 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
38130 description: Response codes found in [response codes](https://wiki.onap.org/).
38132 - name: route-table-reference-id
38134 description: Route Table Reference id, UUID assigned to this instance.
38137 example: __ROUTE-TABLE-REFERENCE-ID__
38140 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
38143 $ref: "#/definitions/route-table-reference"
38147 summary: update an existing route-table-reference
38149 Update an existing route-table-reference
38151 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38152 The PUT operation will entirely replace an existing object.
38153 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38155 Other differences between PUT and PATCH are:
38157 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38158 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38159 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38160 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
38169 description: Response codes found in [response codes](https://wiki.onap.org/).
38171 - name: route-table-reference-id
38173 description: Route Table Reference id, UUID assigned to this instance.
38176 example: __ROUTE-TABLE-REFERENCE-ID__
38179 description: route-table-reference object that needs to be updated.
38182 $ref: "#/patchDefinitions/route-table-reference"
38186 summary: delete an existing route-table-reference
38187 description: delete an existing route-table-reference
38188 operationId: deleteNetworkRouteTableReferencesRouteTableReference
38197 description: Response codes found in [response codes](https://wiki.onap.org/).
38199 - name: route-table-reference-id
38201 description: Route Table Reference id, UUID assigned to this instance.
38204 example: __ROUTE-TABLE-REFERENCE-ID__
38205 - name: resource-version
38207 description: resource-version for concurrency
38210 /network/route-table-references:
38214 summary: returns route-table-references
38215 description: returns route-table-references
38216 operationId: getNetworkRouteTableReferences
38222 description: successful operation
38224 $ref: "#/getDefinitions/route-table-references"
38226 description: Response codes found in [response codes](https://wiki.onap.org/).
38228 - name: route-table-reference-id
38233 - name: route-table-reference-fqdn
38246 $ref: "#/definitions/action-data"
38255 APIs that are more action related than REST (e.g., notify, update).
38259 $ref: "#/definitions/update"
38262 $ref: "#/definitions/notify"
38265 Represents a slice or partial piece of a resource that gets separately allotted
38266 ###### Related Nodes
38267 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
38268 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
38269 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
38270 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
38271 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
38272 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
38273 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
38275 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
38276 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
38282 description: Allotted Resource id UUID assigned to this instance.
38285 description: The descriptive information assigned to this allotted resource instance
38288 description: Link back to more information in the controller
38291 description: the ASDC model id for this resource or service model.
38292 persona-model-version:
38294 description: the ASDC model version for this resource or service model.
38297 description: the ASDC model version for this resource or service model.
38298 persona-model-customization-id:
38300 description: captures the id of all the configuration used to customize the resource for the service.
38303 description: Concurrency value
38307 $ref: "#/definitions/tunnel-xconnect"
38311 $ref: "#/definitions/relationship"
38312 allotted-resources:
38314 This object is used to store slices of services being offered
38319 $ref: "#/definitions/allotted-resource"
38322 Availability zone, a collection of compute hosts/pservers
38323 ###### Related Nodes
38324 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
38325 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
38326 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
38327 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
38328 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
38329 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
38330 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
38331 - FROM vce( vce Uses availability-zone, MANY2MANY)
38333 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
38334 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
38337 - availability-zone-name
38340 availability-zone-name:
38342 description: Name of the availability zone. Unique across a cloud region
38345 description: Type of hypervisor. Source of truth should define valid values.
38348 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
38351 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38355 $ref: "#/definitions/relationship"
38356 availability-zones:
38358 Collection of availability zones
38363 $ref: "#/definitions/availability-zone"
38364 az-and-dvs-switches:
38368 $ref: "#/definitions/dvs-switches"
38371 $ref: "#/definitions/availability-zone"
38374 Namespace for business related constructs
38379 $ref: "#/definitions/connector"
38383 $ref: "#/definitions/customer"
38386 ###### Related Nodes
38387 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
38389 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
38395 description: unique identifier of probe
38398 description: identifier of probe
38401 description: type of probe
38404 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38408 $ref: "#/definitions/relationship"
38409 classes-of-service:
38411 class-of-service of probe
38416 $ref: "#/definitions/class-of-service"
38417 cloud-infrastructure:
38419 Namespace for cloud infrastructure.
38424 $ref: "#/definitions/complex"
38428 $ref: "#/definitions/cloud-region"
38432 $ref: "#/definitions/network-profile"
38436 $ref: "#/definitions/pserver"
38437 virtual-data-centers:
38440 $ref: "#/definitions/virtual-data-center"
38443 cloud-region designates an installation of a cloud cluster or region or instantiation.
38444 ###### Related Nodes
38445 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
38446 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
38447 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
38448 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
38449 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
38450 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
38451 - FROM image( image BelongsTo cloud-region, MANY2ONE)
38452 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
38453 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
38454 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
38455 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
38456 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
38458 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
38459 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
38467 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
38470 description: Identifier used by the vendor for the region. Second part of composite key
38473 description: Type of the cloud (e.g., openstack)
38474 owner-defined-type:
38476 description: Cloud-owner defined type indicator (e.g., DCP, LCP)
38477 cloud-region-version:
38479 description: Software version employed at the site
38482 description: URL of the keystone identity service
38485 description: Zone where the cloud is homed
38488 description: complex name for cloud-region instance
38491 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38495 $ref: "#/definitions/volume-group"
38499 $ref: "#/definitions/tenant"
38503 $ref: "#/definitions/flavor"
38507 $ref: "#/definitions/group-assignment"
38511 $ref: "#/definitions/snapshot"
38515 $ref: "#/definitions/image"
38519 $ref: "#/definitions/dvs-switch"
38523 $ref: "#/definitions/oam-network"
38524 availability-zones:
38527 $ref: "#/definitions/availability-zone"
38531 $ref: "#/definitions/relationship"
38537 $ref: "#/definitions/cloud-region"
38540 Collection of physical locations that can house cloud-regions.
38541 ###### Related Nodes
38542 - TO l3-network( complex Uses l3-network, MANY2MANY)
38543 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
38544 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
38545 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
38546 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
38547 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
38548 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
38549 - FROM vce( vce LocatedIn complex, MANY2MANY)
38550 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
38551 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
38553 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
38554 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
38557 - physical-location-id
38558 - physical-location-type
38565 physical-location-id:
38567 description: Unique identifier for physical location, e.g., CLLI
38570 description: Data center code which can be an alternate way to identify a complex
38573 description: Gamma complex name for LCP instance.
38576 description: URL of the keystone identity service
38579 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38580 physical-location-type:
38582 description: Type, e.g., central office, data center.
38608 $ref: "#/definitions/ctag-pool"
38612 $ref: "#/definitions/relationship"
38615 Collection of physical locations that can house cloud-regions.
38620 $ref: "#/definitions/complex"
38623 Port Mirror Configuration.
38624 ###### Related Nodes
38625 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
38626 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
38627 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
38628 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
38629 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
38631 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
38632 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
38633 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
38636 - configuration-type
38637 - configuration-sub-type
38638 - orchestration-status
38639 - operational-status
38640 - configuration-selflink
38641 - model-customization-id
38645 description: UUID assigned to configuration.
38648 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
38649 configuration-name:
38651 description: Name of the configuration.
38652 configuration-type:
38654 description: port-mirroring-configuration.
38655 configuration-sub-type:
38657 description: vprobe, pprobe.
38658 model-invariant-id:
38660 description: the ASDC model id for this resource or service model.
38663 description: the ASDC model version for this resource or service model.
38664 orchestration-status:
38666 description: Orchestration status of the configuration.
38667 operational-status:
38669 description: Indicator for whether the resource is considered operational.
38670 configuration-selflink:
38672 description: URL to endpoint where AAI can get more details from SDN-GC.
38673 model-customization-id:
38675 description: id of the configuration used to customize the resource
38678 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38682 $ref: "#/definitions/relationship"
38686 $ref: "#/definitions/metadatum"
38689 Collection of configurations
38694 $ref: "#/definitions/configuration"
38697 Collection of resource instances used to connect a variety of disparate inventory widgets
38698 ###### Related Nodes
38699 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
38700 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
38701 - FROM service-instance( service-instance Uses connector, MANY2MANY)
38703 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
38705 - resource-instance-id
38707 resource-instance-id:
38709 description: Unique id of resource instance.
38712 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38715 description: the ASDC model id for this resource or service model.
38716 persona-model-version:
38718 description: the ASDC model version for this resource or service model.
38721 description: the ASDC model version for this resource or service model.
38724 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38725 widget-model-version:
38727 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38731 $ref: "#/definitions/relationship"
38735 $ref: "#/definitions/metadatum"
38738 Collection of resource instances used to connect a variety of disparate inventory widgets
38743 $ref: "#/definitions/connector"
38744 constrained-element-set:
38746 This is how we would capture constraints defining allowed sets of elements.
38747 ###### Related Nodes
38748 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
38749 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
38750 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
38752 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
38753 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
38755 - constrained-element-set-uuid
38759 constrained-element-set-uuid:
38767 element-choice-sets:
38770 $ref: "#/definitions/element-choice-set"
38774 $ref: "#/definitions/relationship"
38775 constrained-element-sets:
38777 constrained-element-set:
38780 $ref: "#/definitions/constrained-element-set"
38783 ###### Related Nodes
38784 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
38786 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
38796 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38800 $ref: "#/definitions/relationship"
38806 $ref: "#/definitions/ctag-assignment"
38809 A collection of C tags (vlan tags) grouped for a specific purpose.
38810 ###### Related Nodes
38811 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
38812 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
38813 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
38815 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
38818 - availability-zone-name
38819 - ctag-pool-purpose
38823 description: The Target provider edge router
38824 availability-zone-name:
38826 description: Name of the availability zone
38829 description: Describes what the intended purpose of this pool is.
38832 description: Comma separated list of ctags
38835 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38839 $ref: "#/definitions/relationship"
38845 $ref: "#/definitions/ctag-pool"
38848 customer identifiers to provide linkage back to BSS information.
38849 ###### Related Nodes
38850 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
38852 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
38854 - global-customer-id
38858 global-customer-id:
38860 description: Global customer id used across ECOMP to uniquely identify customer.
38863 description: Subscriber name, an alternate way to retrieve a customer.
38866 description: Subscriber type, a way to provide VID with only the INFRA customers.
38869 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38870 service-subscriptions:
38873 $ref: "#/definitions/service-subscription"
38877 $ref: "#/definitions/relationship"
38880 Collection of customer identifiers to provide linkage back to BSS information.
38885 $ref: "#/definitions/customer"
38893 description: See mis-na-virtualization-platform.yang
38896 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38900 $ref: "#/definitions/relationship"
38906 $ref: "#/definitions/cvlan-tag-entry"
38909 Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
38910 ###### Related Nodes
38911 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
38912 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
38920 description: DVS switch name
38923 description: URL used to reach the vcenter
38926 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
38930 $ref: "#/definitions/relationship"
38933 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
38938 $ref: "#/definitions/dvs-switch"
38941 Internal map to define the properties of an edge and interpret the map EdgeRules
38959 edge-tag-query-request:
38970 $ref: "#/definitions/start-node-filter"
38971 include-node-filter:
38974 $ref: "#/definitions/include-node-filter"
38978 $ref: "#/definitions/secondary-filter"
38979 edge-tag-query-result:
38981 tagged-inventory-item-list:
38984 $ref: "#/definitions/tagged-inventory-item-list"
38985 element-choice-set:
38987 This is how we would capture constraints defining allowed sets of elements.
38988 ###### Related Nodes
38989 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
38990 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
38992 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
38993 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
38995 - element-choice-set-uuid
38996 - element-choice-set-name
38998 element-choice-set-uuid:
39000 element-choice-set-name:
39009 $ref: "#/definitions/model-element"
39013 $ref: "#/definitions/relationship"
39014 element-choice-sets:
39016 element-choice-set:
39019 $ref: "#/definitions/element-choice-set"
39022 Metadata for entitlement group.
39023 ###### Related Nodes
39024 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
39025 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
39027 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
39034 description: Unique ID for the entitlement group the resource comes from, should be uuid.
39037 description: Unique ID of an entitlement resource.
39040 description: Concurrency value
39044 $ref: "#/definitions/relationship"
39047 Entitlements, keyed by group-uuid and resource-uuid, related to license management
39052 $ref: "#/definitions/entitlement"
39055 Persist EMS address information used by EMS driver.
39056 ###### Related Nodes
39057 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
39059 -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
39065 description: Unique ID of EMS.
39068 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39069 esr-system-info-list:
39071 $ref: "#/definitions/esr-system-info-list"
39074 $ref: "#/definitions/relationship-list"
39080 $ref: "#/definitions/esr-ems"
39083 Persist common address information of external systems.
39084 ###### Related Nodes
39085 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
39086 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
39087 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
39088 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
39090 -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
39092 - esr-system-info-id
39097 esr-system-info-id:
39099 description: Unique ID of esr system info.
39102 description: name of external system.
39105 description: type of external systems.
39108 description: vendor of external systems.
39111 description: version of external systems.
39114 description: url used to access external systems.
39117 description: username used to access external systems.
39120 description: password used to access external systems.
39123 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
39126 description: protocol of third party SDNC, for example netconf/snmp.
39129 description: ca file content if enabled ssl on auth-url.
39132 description: Whether to verify VIM's certificate.
39135 description: service IP of ftp server.
39138 description: service port of ftp server.
39141 description: domain info for authentication.
39144 description: default tenant of VIM.
39147 description: ftp passive mode or not.
39150 description: resource or performance data file path.
39153 description: the status of external system.
39156 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39160 $ref: "#/definitions/relationship"
39161 esr-system-info-list:
39163 Collection of persistent block-level external system auth info.
39168 $ref: "#/definitions/esr-system-info"
39169 esr-thirdparty-sdnc:
39171 Persist SDNC address information used by ONAP SDNC.
39172 ###### Related Nodes
39173 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
39174 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
39176 -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
39178 - thirdparty-sdnc-id
39180 thirdparty-sdnc-id:
39182 description: Unique ID of SDNC.
39185 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
39188 description: password used to access SDNC server.
39191 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39192 esr-system-info-list:
39194 $ref: "#/definitions/esr-system-info-list"
39197 $ref: "#/definitions/relationship-list"
39198 esr-thirdparty-sdnc-list:
39200 esr-thirdparty-sdnc:
39203 $ref: "#/definitions/esr-thirdparty-sdnc"
39206 Persist VNFM address information used by VF-C.
39207 ###### Related Nodes
39208 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
39210 -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
39216 description: Unique ID of VNFM.
39219 description: indecate the VIM to deploy VNF.
39222 description: certificate url of VNFM.
39225 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39226 esr-system-info-list:
39228 $ref: "#/definitions/esr-system-info-list"
39231 $ref: "#/definitions/relationship-list"
39237 $ref: "#/definitions/esr-vnfm"
39240 evc object is an optional child object of the Configuration object.
39241 ###### Related Nodes
39242 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
39244 -(4) IF this TO node is deleted, this EVC is DELETED also
39250 description: Unique/key field for the evc object
39251 forwarding-path-topology:
39253 description: Point-to-Point, Multi-Point
39256 description: Commited Information Rate
39259 description: CIR units
39260 connection-diversity-group-id:
39262 description: Diversity Group ID
39265 description: formerly Performance Group
39266 esp-evc-circuit-id:
39268 description: EVC Circuit ID of ESP EVC
39271 description: Committed Information Rate (For ESP)
39274 description: CIR units (For ESP)
39277 description: Identifies ESP
39278 collector-pop-clli:
39280 description: Collector POP CLLI (from the hostname of the access pnf)
39281 inter-connect-type-ingress:
39283 description: Interconnect type on ingress side of EVC.
39284 tagmode-access-ingress:
39286 description: tagode for collector side of EVC
39287 tagmode-access-egress:
39289 description: tagMode for network side of EVC
39293 $ref: "#/definitions/relationship"
39296 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39302 $ref: "#/definitions/evc"
39305 Namespace for external system.
39309 $ref: "#/definitions/esr-ems-list"
39312 $ref: "#/definitions/esr-vnfm-list"
39313 esr-thirdparty-sdnc-list:
39315 $ref: "#/definitions/esr-thirdparty-sdnc-list"
39318 Extra properties for inventory item for response list
39326 ###### Related Nodes
39327 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
39328 - FROM vserver( vserver Uses flavor, MANY2ONE)
39330 -FLAVOR cannot be deleted if related to VSERVER
39339 description: Flavor id, expected to be unique across cloud-region.
39342 description: Flavor name
39346 description: Number of CPUs
39350 description: Amount of memory
39354 description: Disk space
39358 description: Amount of ephemeral disk space
39361 description: amount of swap space allocation
39364 description: whether flavor is available to all users or private to the tenant it was created in.
39367 description: URL to endpoint where AAI can get more details
39370 description: Boolean as to whether this flavor is no longer enabled
39373 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39377 $ref: "#/definitions/relationship"
39380 Collection of openstack flavors.
39385 $ref: "#/definitions/flavor"
39388 Entity describing a sequenced segment of forwarding path
39389 ###### Related Nodes
39390 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
39391 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
39392 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
39393 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
39394 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
39396 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
39397 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
39404 description: Unique ID of this segmentation
39407 description: ingress, intermediate, egress
39411 $ref: "#/definitions/relationship"
39414 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39417 forwarder object is an optional child object of the Configuration object.
39418 ###### Related Nodes
39419 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
39421 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
39427 description: Key for forwarder-evc object
39430 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
39433 description: Internal VLAN.
39436 description: SVLAN value for ingress of egress forwarder.
39439 description: CVLAN value for ingress of egress forwarder.
39443 $ref: "#/definitions/relationship"
39446 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39452 $ref: "#/definitions/forwarder-evc"
39458 $ref: "#/definitions/forwarder"
39461 Entity that describes the sequenced forwarding path between interfaces of services or resources
39462 ###### Related Nodes
39463 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
39464 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
39465 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
39467 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
39468 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
39469 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
39471 - forwarding-path-id
39472 - forwarding-path-name
39474 forwarding-path-id:
39476 description: Unique ID of this FP
39477 forwarding-path-name:
39479 description: Name of the FP
39483 $ref: "#/definitions/relationship"
39486 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39489 description: the self link for this FP
39493 $ref: "#/definitions/forwarder"
39499 $ref: "#/definitions/forwarding-path"
39502 General purpose VNF
39503 ###### Related Nodes
39504 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
39505 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
39506 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
39507 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
39508 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
39509 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
39510 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
39511 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
39512 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
39513 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
39514 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
39515 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
39516 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
39517 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
39518 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
39519 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
39520 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
39522 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
39528 - is-closed-loop-disabled
39532 description: Unique id of VNF. This is unique across the graph.
39535 description: Name of VNF.
39538 description: Alternate name of VNF.
39541 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
39544 description: Unique identifier of service from ASDC
39545 regional-resource-zone:
39547 description: Regional way of organizing pservers, source of truth should define values
39550 description: Trigger for operational monitoring of this resource by Service Assurance systems.
39553 description: Indicator for whether the resource is considered operational
39556 description: License key
39559 description: Client should send valid enumerated value
39560 orchestration-status:
39562 description: Orchestration status of this VNF, used by MSO.
39565 description: Heat stack id corresponding to this instance, managed by MSO
39568 description: Corresponds to the SDN-C catalog id used to configure this VCE
39571 description: identifier of managed by company or customer
39574 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
39575 ipv4-loopback0-address:
39577 description: v4 Loopback0 address
39580 description: v6 Loopback address
39581 management-v6-address:
39583 description: v6 management address
39587 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
39590 description: units associated with vcpu, used for VNFs with no vservers/flavors
39594 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
39597 description: units associated with vmemory, used for VNFs with no vservers/flavors
39601 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
39604 description: units associated with vdisk, used for VNFs with no vservers/flavors
39607 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
39608 is-closed-loop-disabled:
39610 description: used to indicate whether closed loop function is enabled on this node
39613 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39616 description: details regarding the generic-vnf operation
39617 encrypted-access-flag:
39619 description: indicates whether generic-vnf access uses SSH
39622 description: the ASDC model id for this resource or service model.
39623 persona-model-version:
39625 description: the ASDC model version for this resource or service model.
39628 description: the ASDC model version for this resource or service model.
39631 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39632 widget-model-version:
39634 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39637 description: as-number of the VNF
39638 regional-resource-subzone:
39640 description: represents sub zone of the rr plane
39644 $ref: "#/definitions/relationship"
39648 $ref: "#/definitions/l-interface"
39652 $ref: "#/definitions/lag-interface"
39656 $ref: "#/definitions/vf-module"
39664 $ref: "#/definitions/generic-vnf"
39667 Openstack group-assignment used to store exclusivity groups (EG).
39668 ###### Related Nodes
39669 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
39670 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
39671 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
39680 description: Group id, expected to be unique across cloud-region.
39683 description: Group type - the type of group this instance refers to
39686 description: Group name - name assigned to the group
39689 description: Group description - description of the group
39692 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39696 $ref: "#/definitions/relationship"
39699 Collection of openstack group assignments
39704 $ref: "#/definitions/group-assignment"
39707 ###### Related Nodes
39708 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
39710 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
39718 description: host-route id
39721 description: subnet prefix
39724 description: Could be ip-address, hostname, or service-instance
39727 description: Should be ip-address, hostname, or service-instance to match next-hop
39730 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39734 $ref: "#/definitions/relationship"
39740 $ref: "#/definitions/host-route"
39743 Collection of HPA Capabilities
39748 $ref: "#/definitions/hpa-capability"
39751 Represents a HPA capability
39752 ###### Related Nodes
39753 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
39754 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
39755 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
39757 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
39759 - hpa-capability-id
39764 description: UUID to uniquely identify a HPA capability
39767 description: Name of the HPACapability
39770 description: HPA schema version
39773 description: Hardware architecture
39776 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39780 $ref: "#/definitions/relationship"
39781 hpa-feature-attributes:
39784 $ref: "#/definitions/hpa-feature-attributes"
39785 hpa-feature-attributes:
39787 HPA Capability Feature attributes
39788 ###### Related Nodes
39789 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
39791 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
39793 - hpa-attribute-key
39797 description: name of the specific HPA attribute
39798 hpa-attribute-value:
39800 description: JSON string specifying the value, unit and type of the specific HPA attribute
39803 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39807 $ref: "#/definitions/relationship"
39811 ###### Related Nodes
39812 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
39813 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
39814 - FROM vserver( vserver Uses image, MANY2ONE)
39816 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
39817 -IMAGE cannot be deleted if related to VSERVER
39828 description: Image id, expected to be unique across cloud region
39831 description: Image name
39832 image-architecture:
39834 description: Operating system architecture.
39837 description: The common name of the operating system distribution in lowercase
39840 description: The operating system version as specified by the distributor.
39843 description: The application that the image instantiates.
39844 application-vendor:
39846 description: The vendor of the application.
39847 application-version:
39849 description: The version of the application.
39852 description: URL to endpoint where AAI can get more details
39855 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
39859 $ref: "#/definitions/relationship"
39863 $ref: "#/definitions/metadatum"
39866 Collectio of Openstack images.
39871 $ref: "#/definitions/image"
39872 include-node-filter:
39878 InstanceFilter for performing a named-query or model query
39881 InstanceFilters for performing a named-query or model query
39886 $ref: "#/definitions/instance-filter"
39889 General mechanism for grouping instances
39890 ###### Related Nodes
39891 - TO model( instance-group Targets model, MANY2MANY)
39892 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
39893 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
39894 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
39895 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
39904 description: Instance Group ID, UUID assigned to this instance.
39907 description: Descriptive text to help identify the usage of this instance-group
39910 description: Only valid value today is lower case ha for high availability
39913 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
39916 description: Concurrency value
39920 $ref: "#/definitions/relationship"
39923 Collection of openstack route table references
39928 $ref: "#/definitions/instance-group"
39933 $ref: "#/definitions/search"
39936 $ref: "#/definitions/actions"
39937 cloud-infrastructure:
39939 $ref: "#/definitions/cloud-infrastructure"
39942 $ref: "#/definitions/business"
39943 service-design-and-creation:
39945 $ref: "#/definitions/service-design-and-creation"
39948 $ref: "#/definitions/network"
39951 inventory-item-type:
39953 inventory-item-link:
39955 inventory-item-data:
39958 $ref: "#/definitions/inventory-item-data"
39959 tagged-inventory-item-list:
39962 $ref: "#/definitions/tagged-inventory-item-list"
39963 inventory-item-data:
39969 inventory-response-item:
39971 Inventory item for response list
39977 $ref: "#/definitions/extra-properties"
39978 inventory-response-items:
39980 $ref: "#/definitions/inventory-response-items"
39981 inventory-response-items:
39983 Container for inventory items in response list
39985 inventory-response-item:
39988 $ref: "#/definitions/inventory-response-item"
39989 ipsec-configuration:
39991 IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
39992 ###### Related Nodes
39993 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
39994 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
39996 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
39998 - ipsec-configuration-id
40000 ipsec-configuration-id:
40002 description: UUID of this configuration
40003 requested-vig-address-type:
40005 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
40006 requested-encryption-strength:
40008 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
40009 requested-dmz-type:
40011 description: can offer a shared DMZ or a DMZ specific to a customer
40012 shared-dmz-network-address:
40014 description: Network address of shared DMZ
40015 requested-customer-name:
40017 description: If the DMZ is a custom DMZ, this field will indicate the customer information
40020 description: can be 1 or 2
40021 ikev1-authentication:
40023 description: Contains values like md5, sha1, sha256, sha384
40026 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
40029 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
40032 description: Group name defined in VIG for clients using aggressive mode
40035 description: pre-shared key for the above group name
40038 description: Lifetime for IKEv1 SA
40039 ipsec-authentication:
40041 description: md5, sha1, sha256, sha384
40044 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
40047 description: Life time for IPSec SA
40050 description: enable PFS or not
40053 description: user ID for xAuth, sm-user, ,nmteHostName
40054 xauth-user-password:
40056 description: Encrypted using the Juniper $9$ algorithm
40059 description: The time between DPD probe
40062 description: Maximum number of DPD before claiming the tunnel is down
40065 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40069 $ref: "#/definitions/relationship"
40073 $ref: "#/definitions/vig-server"
40074 ipsec-configurations:
40076 ipsec-configuration:
40079 $ref: "#/definitions/ipsec-configuration"
40088 Logical interfaces, e.g., a vnic.
40089 ###### Related Nodes
40090 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
40091 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
40092 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
40093 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
40094 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
40095 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
40096 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
40097 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
40098 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
40099 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
40101 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
40102 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
40103 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
40109 description: Name given to the interface
40112 description: E.g., CUSTOMER, UPLINK, etc.
40115 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
40118 description: URL to endpoint where AAI can get more details
40121 description: ID of interface
40124 description: MAC address for the interface
40127 description: Name of the network
40130 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
40133 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40137 $ref: "#/definitions/vlan"
40141 $ref: "#/definitions/sriov-vf"
40145 $ref: "#/definitions/relationship"
40146 l3-interface-ipv4-address-list:
40149 $ref: "#/definitions/l3-interface-ipv4-address-list"
40150 l3-interface-ipv6-address-list:
40153 $ref: "#/definitions/l3-interface-ipv6-address-list"
40156 Collection of logical interfaces.
40161 $ref: "#/definitions/l-interface"
40162 l3-interface-ipv4-address-list:
40165 ###### Related Nodes
40166 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
40167 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
40168 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
40169 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
40171 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
40173 - l3-interface-ipv4-address
40175 l3-interface-ipv4-address:
40177 description: IP address
40178 l3-interface-ipv4-prefix-length:
40181 description: Prefix length, 32 for single address
40185 description: Inner VLAN tag
40189 description: Outer VLAN tag
40192 description: Indicator of fixed or floating address
40195 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40196 neutron-network-id:
40198 description: Neutron network id of the interface that address belongs to
40201 description: Neutron id of subnet that address belongs to
40205 $ref: "#/definitions/relationship"
40206 l3-interface-ipv6-address-list:
40209 ###### Related Nodes
40210 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
40211 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
40212 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
40213 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
40215 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
40217 - l3-interface-ipv6-address
40219 l3-interface-ipv6-address:
40221 description: IP address
40222 l3-interface-ipv6-prefix-length:
40225 description: Prefix length, 128 for single address
40229 description: Inner VLAN tag
40233 description: Outer VLAN tag
40236 description: Indicator of fixed or floating address
40239 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40240 neutron-network-id:
40242 description: Neutron network id of the interface that address belongs to
40245 description: Neutron id of subnet that address belongs to
40249 $ref: "#/definitions/relationship"
40252 Generic network definition
40253 ###### Related Nodes
40254 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
40255 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
40256 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
40257 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
40258 - FROM complex( complex Uses l3-network, MANY2MANY)
40259 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
40260 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
40261 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
40262 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
40263 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
40264 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
40265 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
40266 - FROM tenant( tenant Uses l3-network, MANY2MANY)
40267 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
40269 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
40274 - is-provider-network
40275 - is-shared-network
40276 - is-external-network
40280 description: Network ID, should be uuid. Unique across A&AI.
40283 description: Name of the network, governed by some naming convention..
40286 description: Type of the network - who defines these values?
40289 description: Role the network plans - who defines these values?
40290 network-technology:
40292 description: Network technology - who defines these values?
40293 neutron-network-id:
40295 description: Neutron network id of this Interface
40298 description: Set to true if bound to VPN
40301 description: Unique identifier of service from ASDC
40302 network-role-instance:
40305 description: network role instance
40308 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40309 orchestration-status:
40311 description: Orchestration status of this VNF, mastered by MSO
40314 description: Heat stack id corresponding to this instance, managed by MSO
40317 description: Corresponds to the SDN-C catalog id used to configure this VCE
40318 contrail-network-fqdn:
40320 description: Contrail FQDN for the network
40323 description: the ASDC model id for this resource or service model.
40324 persona-model-version:
40326 description: the ASDC model version for this resource or service model.
40329 description: the ASDC model version for this resource or service model.
40332 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40333 widget-model-version:
40335 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40336 physical-network-name:
40338 description: Name associated with the physical network.
40339 is-provider-network:
40341 description: boolean indicatating whether or not network is a provider network.
40344 description: boolean indicatating whether or not network is a shared network.
40345 is-external-network:
40347 description: boolean indicatating whether or not network is an external network.
40351 $ref: "#/definitions/subnet"
40355 $ref: "#/definitions/ctag-assignment"
40356 segmentation-assignments:
40359 $ref: "#/definitions/segmentation-assignment"
40363 $ref: "#/definitions/relationship"
40364 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
40370 $ref: "#/definitions/l3-network"
40373 Link aggregate interface
40374 ###### Related Nodes
40375 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
40376 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
40377 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
40378 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
40379 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
40380 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
40381 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
40383 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
40384 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
40385 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
40391 description: Name that identifies the link aggregate interface
40394 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40397 description: Captures the numeric part of the speed
40400 description: Captures the units corresponding to the speed
40404 $ref: "#/definitions/relationship"
40408 $ref: "#/definitions/l-interface"
40411 Collection of link aggregate interfaces.
40416 $ref: "#/definitions/lag-interface"
40419 LAG links can connect lag-interfaces
40420 ###### Related Nodes
40421 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
40422 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
40424 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
40430 description: Alphabetical concatenation of lag-interface names
40433 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40437 $ref: "#/definitions/relationship"
40440 Collection of link aggregation connections
40445 $ref: "#/definitions/lag-link"
40448 Metadata for license group.
40449 ###### Related Nodes
40450 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
40451 - TO vce( license BelongsTo vce, MANY2ONE)(4)
40453 -(4) IF this TO node is deleted, this LICENSE is DELETED also
40460 description: Unique ID for the license group the resource belongs to, should be uuid.
40463 description: Unique ID of a license resource.
40466 description: Concurrency value
40470 $ref: "#/definitions/relationship"
40473 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
40478 $ref: "#/definitions/license"
40481 describes a line-of-business
40482 ###### Related Nodes
40483 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
40486 - line-of-business-name
40488 line-of-business-name:
40490 description: Name of the line-of-business (product)
40493 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40497 $ref: "#/definitions/relationship"
40500 Collection of lines-of-business
40505 $ref: "#/definitions/line-of-business"
40508 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
40509 ###### Related Nodes
40510 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
40511 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
40512 - TO logical-link( logical-link Uses logical-link, ONE2MANY)
40513 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
40514 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
40515 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
40516 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
40517 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
40518 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
40519 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
40520 - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
40522 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
40529 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
40532 description: Type of logical link, e.g., evc
40535 description: Captures the numeric part of the speed
40538 description: Captures the units corresponding to the speed
40541 description: v4, v6, or ds for dual stack
40544 description: For example, static or BGP
40547 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40550 description: the ASDC model id for this resource or service model.
40551 persona-model-version:
40553 description: the ASDC model version for this resource or service model.
40556 description: the ASDC model version for this resource or service model.
40559 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40560 widget-model-version:
40562 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40563 operational-status:
40565 description: Indication of operational status of the logical link.
40568 description: Indication of the network use of the logical link.
40571 description: Alias or alternate name (CLCI or D1 name).
40574 description: UUID of the logical-link, SDNC generates this.
40578 $ref: "#/definitions/relationship"
40581 Collection of logical connections
40586 $ref: "#/definitions/logical-link"
40589 Collection of metadatum (key/value pairs)
40594 $ref: "#/definitions/metadatum"
40598 ###### Related Nodes
40599 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
40600 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
40601 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
40602 - TO model( metadatum BelongsTo model, MANY2ONE)(4)
40604 -(4) IF this TO node is deleted, this METADATUM is DELETED also
40615 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40618 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
40619 ###### Related Nodes
40620 - TO model( model-element isA model, MANY2ONE)
40621 - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
40622 - FROM named-query( named-query AppliesTo model, ONE2MANY)
40623 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
40624 - FROM model-element( model-element isA model, MANY2ONE)
40625 - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
40627 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
40628 -(2) IF this MODEL node is deleted, this TO node is DELETED also
40629 -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
40632 - model-name-version-id
40638 model-name-version-id:
40640 description: Unique identifier corresponding to one version of a model in ASDC
40643 description: Type of the model, e.g., service, resource, widget, etc.
40646 description: Name of the model, which can change from version to version.
40649 description: Invariant unique ID which does not change from version to version
40652 description: Version
40655 description: Description
40658 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40662 $ref: "#/definitions/model-element"
40666 $ref: "#/definitions/metadatum"
40670 $ref: "#/definitions/relationship"
40671 model-and-named-query-search:
40673 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
40677 $ref: "#/definitions/query-parameters"
40680 $ref: "#/definitions/instance-filters"
40685 This is how we would capture constraints defining allowed sets of elements.
40686 ###### Related Nodes
40687 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
40688 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
40690 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
40691 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
40693 - model-constraint-uuid
40694 - constrained-element-set-uuid-to-replace
40696 model-constraint-uuid:
40698 constrained-element-set-uuid-to-replace:
40700 constrained-element-sets:
40703 $ref: "#/definitions/constrained-element-set"
40709 $ref: "#/definitions/model-constraint"
40712 Defines how other models combine to make up a higher-level model.
40713 ###### Related Nodes
40714 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
40715 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
40716 - TO model( model-element isA model, MANY2ONE)
40717 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
40718 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
40719 - FROM model (PARENT of model-element, model startsWith model-element)(3)
40720 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
40722 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
40723 -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
40724 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
40726 - model-element-uuid
40727 - new-data-del-flag
40730 model-element-uuid:
40734 description: Indicates whether this element was created as part of instantiation from this model
40737 description: How many of this type of element are required/allowed
40742 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40746 $ref: "#/definitions/model-element"
40747 description: Defines how other models combine to make up a higher-level model
40751 $ref: "#/definitions/model-constraint"
40752 description: Describes new constraints on this model element that are not part of that model's definition
40756 $ref: "#/definitions/relationship"
40762 $ref: "#/definitions/model-element"
40765 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
40766 ###### Related Nodes
40767 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
40768 - FROM model-element( model-element IsA model-ver, MANY2ONE)
40769 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
40770 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
40772 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
40773 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
40774 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
40783 description: Unique identifier corresponding to one version of a model in ASDC
40786 description: Name of the model, which can change from version to version.
40789 description: Version
40792 description: Description
40795 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40799 $ref: "#/definitions/model-element"
40803 $ref: "#/definitions/metadatum"
40807 $ref: "#/definitions/relationship"
40813 $ref: "#/definitions/model-ver"
40816 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
40821 $ref: "#/definitions/model"
40822 multicast-configuration:
40824 ###### Related Nodes
40825 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
40828 - multicast-configuration-id
40829 - multicast-protocol
40832 multicast-configuration-id:
40834 description: Unique id of multicast configuration.
40835 multicast-protocol:
40837 description: protocol of multicast configuration
40840 description: rp type of multicast configuration
40843 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
40847 $ref: "#/definitions/relationship"
40848 multicast-configurations:
40850 multicast configuration of generic-vnf ip-address
40852 multicast-configuration:
40855 $ref: "#/definitions/multicast-configuration"
40861 $ref: "#/definitions/named-query"
40865 ###### Related Nodes
40866 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
40867 - TO model( named-query AppliesTo model, ONE2MANY)
40868 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
40870 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
40874 - named-query-version
40880 named-query-version:
40882 required-input-param:
40888 named-query-elements:
40891 $ref: "#/definitions/named-query-element"
40895 $ref: "#/definitions/relationship"
40896 named-query-element:
40899 ###### Related Nodes
40900 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
40901 - TO model( named-query-element IsA model, MANY2ONE)
40902 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
40903 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
40904 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
40905 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
40907 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
40908 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
40910 - named-query-element-uuid
40912 named-query-element-uuid:
40914 property-collect-list:
40918 property-limit-desc:
40922 named-query-elements:
40925 $ref: "#/definitions/named-query-element"
40929 $ref: "#/definitions/related-lookup"
40930 property-constraints:
40933 $ref: "#/definitions/property-constraint"
40937 $ref: "#/definitions/relationship"
40938 named-query-elements:
40940 named-query-element:
40943 $ref: "#/definitions/named-query-element"
40946 Namespace for network inventory resources.
40951 $ref: "#/definitions/logical-link"
40955 $ref: "#/definitions/site-pair-set"
40959 $ref: "#/definitions/vpn-binding"
40963 $ref: "#/definitions/vpls-pe"
40964 multicast-configurations:
40967 $ref: "#/definitions/multicast-configuration"
40971 $ref: "#/definitions/vce"
40975 $ref: "#/definitions/vnfc"
40979 $ref: "#/definitions/l3-network"
40983 $ref: "#/definitions/network-policy"
40987 $ref: "#/definitions/generic-vnf"
40991 $ref: "#/definitions/lag-link"
40995 $ref: "#/definitions/newvce"
40999 $ref: "#/definitions/pnf"
41003 $ref: "#/definitions/physical-link"
41004 ipsec-configurations:
41007 $ref: "#/definitions/ipsec-configuration"
41008 route-table-references:
41011 $ref: "#/definitions/route-table-reference"
41017 $ref: "#/definitions/network-policy"
41020 ###### Related Nodes
41021 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
41024 - network-policy-id
41028 description: UUID representing unique key to this instance
41029 network-policy-fqdn:
41031 description: Contrail FQDN for the policy
41034 description: ID for the openStack Heat instance
41037 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41041 $ref: "#/definitions/relationship"
41044 Network profile populated by SDN-GP for SNMP
41045 ###### Related Nodes
41046 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
41053 description: Unique name of network profile.
41056 description: Encrypted SNMP community string
41059 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41063 $ref: "#/definitions/relationship"
41066 Collection of network profiles
41071 $ref: "#/definitions/network-profile"
41074 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
41075 ###### Related Nodes
41076 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
41078 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
41086 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41089 description: Name of VNF.
41092 description: Alternate name of VNF.
41095 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
41098 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41101 description: Indicator for whether the resource is considered operational
41104 description: License key
41107 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
41110 description: Client should send valid enumerated value.
41113 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41114 ipv4-loopback0-address:
41116 description: v4 Loopback0 address
41117 orchestration-status:
41119 description: Orchestration status of this VNF, mastered by MSO.
41122 description: Heat stack id corresponding to this instance, managed by MSO
41125 description: Corresponds to the SDN-C catalog id used to configure this VCE
41129 $ref: "#/definitions/relationship"
41133 $ref: "#/definitions/l-interface"
41136 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
41141 $ref: "#/definitions/newvce"
41144 inventory-item-data:
41147 $ref: "#/definitions/inventory-item-data"
41148 notification-event:
41152 notification-event-header:
41154 $ref: "#/definitions/notification-event-header"
41155 notification-event-header:
41196 $ref: "#/definitions/key-data"
41201 OAM network, to be deprecated shortly. Do not use for new purposes.
41202 ###### Related Nodes
41203 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
41204 - TO complex( oam-network AppliesTo complex, MANY2MANY)
41205 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
41214 description: UUID of the network. Unique across a cloud-region
41217 description: Name of the network.
41221 description: cvlan-id
41222 ipv4-oam-gateway-address:
41224 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
41225 ipv4-oam-gateway-address-prefix-length:
41228 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
41231 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41235 $ref: "#/definitions/relationship"
41238 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
41243 $ref: "#/definitions/oam-network"
41244 operational-environment:
41246 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
41247 ###### Related Nodes
41248 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
41249 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
41252 - operational-environment-id
41253 - operational-environment-name
41254 - operational-environment-type
41255 - operational-environment-status
41259 operational-environment-id:
41261 description: UUID of an operational environment
41262 operational-environment-name:
41264 description: Operational Environment name
41265 operational-environment-type:
41267 description: Operational Environment Type.
41268 operational-environment-status:
41270 description: Status
41273 description: Tenant Context.
41276 description: Workload Context.
41279 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41283 $ref: "#/definitions/relationship"
41284 operational-environments:
41286 a logical partition of the cloud which allows to have multiple environments in the production AIC.
41288 operational-environment:
41291 $ref: "#/definitions/operational-environment"
41294 Allows for legacy POST of old-style and new-style models
41296 - model-invariant-id
41297 - model-name-version-id
41303 model-invariant-id:
41305 description: Unique identifier corresponding to the main definition of a model in ASDC
41306 model-name-version-id:
41308 description: Unique identifier corresponding to one version of a model in ASDC
41311 description: Type of the model, e.g., service, resource, widget, etc.
41314 description: Name of the model, which can change from version to version.
41317 description: Invariant unique ID which does not change from version to version
41320 description: Version
41323 description: Description
41326 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41329 $ref: "#/definitions/model-vers"
41332 $ref: "#/definitions/relationship-list"
41335 Collection of owning-entities
41340 $ref: "#/definitions/owning-entity"
41343 describes an owning-entity
41344 ###### Related Nodes
41345 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
41349 - owning-entity-name
41353 description: UUID of an owning entity
41354 owning-entity-name:
41356 description: Owning entity name
41359 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41363 $ref: "#/definitions/relationship"
41366 Physical interface (e.g., nic)
41367 ###### Related Nodes
41368 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
41369 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
41370 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
41371 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
41372 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
41373 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
41374 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
41376 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
41377 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
41378 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
41384 description: Name that identifies the physical interface
41387 description: Captures the numeric part of the speed
41390 description: Captures the units corresponding to the speed
41393 description: Nature of the services and connectivity on this port.
41394 equipment-identifier:
41396 description: CLEI or other specification for p-interface hardware.
41399 description: Role specification for p-interface hardware.
41402 description: Indicates the physical properties of the interface.
41405 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41409 $ref: "#/definitions/relationship"
41413 $ref: "#/definitions/l-interface"
41416 Collection of physical interfaces.
41421 $ref: "#/definitions/p-interface"
41424 Collection of physical connections, typically between p-interfaces
41425 ###### Related Nodes
41426 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
41428 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
41434 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
41437 description: Captures the numeric part of the speed
41440 description: Captures the units corresponding to the speed
41443 description: Circuit it
41446 description: Dual access mode (e.g., primary, secondary
41449 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
41450 service-provider-name:
41452 description: Name of the service Provider on this link.
41455 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41459 $ref: "#/definitions/relationship"
41462 Collection of physical connections, typically between p-interfaces
41467 $ref: "#/definitions/physical-link"
41470 describes a platform
41471 ###### Related Nodes
41472 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
41479 description: Name of the platform
41482 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41486 $ref: "#/definitions/relationship"
41489 Collection of platforms
41494 $ref: "#/definitions/platform"
41497 PNF represents a physical network function. typically equipment used in the D1 world.
41498 ###### Related Nodes
41499 - TO complex( pnf LocatedIn complex, MANY2ONE)
41500 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
41501 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
41502 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
41504 -(1) IF this PNF node is deleted, this FROM node is DELETED also
41511 description: unique name of Physical Network Function.
41514 description: name of Physical Network Function.
41517 description: source of name2
41520 description: id of pnf
41523 description: Equipment type. Source of truth should define valid values.
41526 description: Equipment vendor. Source of truth should define valid values.
41529 description: Equipment model. Source of truth should define valid values.
41532 description: identifier of managed by company or customer
41535 description: ipv4-oam-address with new naming convention for IP addresses
41538 description: sw-version is the version of SW for the hosted application on the PNF.
41539 orchestration-status:
41541 description: orchestration-status is the status of orchestration on the PNF.
41544 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
41547 description: ID of the physical frame (relay rack) where pnf is installed.
41550 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41554 $ref: "#/definitions/relationship"
41558 $ref: "#/definitions/p-interface"
41562 $ref: "#/definitions/lag-interface"
41565 Collection of Physical Network Functions.
41570 $ref: "#/definitions/pnf"
41573 Used to capture the network interfaces of this VCE
41574 ###### Related Nodes
41575 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
41576 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
41578 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
41579 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
41582 - orchestration-status
41586 description: Unique ID of the interface
41587 neutron-network-id:
41589 description: Neutron network id of this Interface
41590 neutron-network-name:
41592 description: Neutron network name of this Interface
41595 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
41598 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41601 description: Unique ID for port group in vmware
41604 description: Likely to duplicate value of neutron network name
41607 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
41608 orchestration-status:
41610 description: Orchestration status of this VNF, mastered by MSO
41613 description: Heat stack id corresponding to this instance, managed by MSO
41616 description: Corresponds to the SDN-C catalog id used to configure this VCE
41620 $ref: "#/definitions/cvlan-tag-entry"
41624 $ref: "#/definitions/relationship"
41630 $ref: "#/definitions/port-group"
41633 describes the project
41634 ###### Related Nodes
41635 - TO service-instance( project Uses service-instance, ONE2MANY)
41642 description: Name of the project deploying a service
41645 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41649 $ref: "#/definitions/relationship"
41652 Collection of projects
41657 $ref: "#/definitions/project"
41660 Property holder for query properties or instance properties
41666 property-constraint:
41669 ###### Related Nodes
41670 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
41672 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
41674 - property-constraint-uuid
41679 property-constraint-uuid:
41689 property-constraints:
41691 property-constraint:
41694 $ref: "#/definitions/property-constraint"
41697 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
41698 ###### Related Nodes
41699 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
41700 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
41701 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
41702 - TO complex( pserver LocatedIn complex, MANY2ONE)
41703 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
41704 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
41705 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
41706 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
41707 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
41709 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
41710 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
41718 description: Value from executing hostname on the compute node.
41721 description: PTNII name
41725 description: Number of cpus
41729 description: Disk size, in GBs
41733 description: RAM size, in MBs
41736 description: Equipment type. Source of truth should define valid values.
41739 description: Equipment vendor. Source of truth should define valid values.
41742 description: Equipment model. Source of truth should define valid values.
41745 description: Fully-qualified domain name
41748 description: URL to endpoint where AAI can get more details
41751 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
41754 description: Serial number, may be queried
41757 description: ID of Pserver
41760 description: internet topology of Pserver
41763 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
41766 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41769 description: alternative pserver name
41772 description: purpose of pserver
41776 $ref: "#/definitions/relationship"
41780 $ref: "#/definitions/p-interface"
41784 $ref: "#/definitions/lag-interface"
41787 Collection of compute hosts.
41792 $ref: "#/definitions/pserver"
41795 QueryParameters for performing a named-query or model query
41799 $ref: "#/definitions/named-query"
41802 $ref: "#/definitions/model"
41806 ###### Related Nodes
41807 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
41809 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
41811 - related-lookup-uuid
41813 - source-node-property
41815 - target-node-property
41817 related-lookup-uuid:
41821 source-node-property:
41825 target-node-property:
41827 property-collect-list:
41834 $ref: "#/definitions/relationship"
41840 $ref: "#/definitions/related-lookup"
41841 related-to-property:
41845 description: Key part of a key/value pair
41848 description: Value part of a key/value pair
41853 description: A keyword provided by A&AI to indicate type of node.
41856 description: URL to the object in A&AI.
41860 $ref: "#/definitions/relationship-data"
41864 - relationship-value
41868 description: A keyword provided by A&AI to indicate an attribute.
41869 relationship-value:
41871 description: Value of the attribute.
41877 $ref: "#/definitions/relationship"
41878 reserved-prop-names:
41880 Internal map to define some reserved properties of a vertex
41882 last-mod-source-of-truth:
41898 Response container for the results of a named-query or model query
41900 inventory-response-items:
41902 $ref: "#/definitions/inventory-response-items"
41907 description: The specific type of node in the A&AI graph
41910 description: The URL to the specific resource
41911 route-table-reference:
41913 Openstack route table reference.
41914 ###### Related Nodes
41915 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
41918 - route-table-reference-id
41919 - route-table-reference-fqdn
41921 route-table-reference-id:
41923 description: Route Table Reference id, UUID assigned to this instance.
41924 route-table-reference-fqdn:
41926 description: FQDN entry in the route table.
41929 description: Concurrency value
41933 $ref: "#/definitions/relationship"
41934 route-table-references:
41936 Collection of openstack route table references
41938 route-table-reference:
41941 $ref: "#/definitions/route-table-reference"
41944 Route target information
41945 ###### Related Nodes
41946 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
41948 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
41950 - global-route-target
41951 - route-target-role
41953 global-route-target:
41955 description: Number used to identify an RT, globally unique in the network
41958 description: Role assigned to this route target
41961 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41965 $ref: "#/definitions/relationship"
41968 Collection of route target information
41973 $ref: "#/definitions/route-target"
41976 ###### Related Nodes
41977 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
41978 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
41980 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
41981 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
41983 - routing-instance-id
41985 routing-instance-id:
41987 description: Unique id of routing instance
41990 description: rpm owner
41993 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41997 $ref: "#/definitions/site-pair"
42001 $ref: "#/definitions/relationship"
42004 set of probes related to generic-vnf routing instance
42009 $ref: "#/definitions/routing-instance"
42014 $ref: "#/definitions/oam-networks"
42015 az-and-dvs-switches:
42018 $ref: "#/definitions/az-and-dvs-switches"
42021 edge-tag-query-result:
42023 $ref: "#/definitions/edge-tag-query-result"
42024 edge-tag-query-request:
42026 $ref: "#/definitions/edge-tag-query-request"
42029 $ref: "#/definitions/search-results"
42032 $ref: "#/definitions/sdn-zone-response"
42038 $ref: "#/definitions/result-data"
42041 SecondaryFilt for performing a named-query or model query
42052 SecondaryFilts for performing a named-query or model query
42057 $ref: "#/definitions/secondary-filt"
42058 segmentation-assignment:
42060 Openstack segmentation assignment.
42061 ###### Related Nodes
42062 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
42064 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
42070 description: Route Table Reference id, UUID assigned to this instance.
42073 description: Concurrency value
42077 $ref: "#/definitions/relationship"
42078 segmentation-assignments:
42080 Collection of openstack segmentation assignments
42082 segmentation-assignment:
42085 $ref: "#/definitions/segmentation-assignment"
42088 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
42091 - service-description
42095 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
42096 service-description:
42098 description: Description of the service
42101 description: URL to endpoint where AAI can get more details
42104 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42107 description: service version
42111 $ref: "#/definitions/relationship"
42112 service-capabilities:
42114 Collection of service capabilities.
42116 service-capability:
42119 $ref: "#/definitions/service-capability"
42120 service-capability:
42122 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
42123 ###### Related Nodes
42124 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
42125 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
42127 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
42135 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
42138 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
42141 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42145 $ref: "#/definitions/relationship"
42146 service-design-and-creation:
42148 Namespace for objects managed by ASDC
42153 $ref: "#/definitions/vnf-image"
42157 $ref: "#/definitions/service"
42158 service-capabilities:
42161 $ref: "#/definitions/service-capability"
42165 $ref: "#/definitions/model"
42169 $ref: "#/definitions/named-query"
42172 Instance of a service
42173 ###### Related Nodes
42174 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
42175 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
42176 - TO connector( service-instance Uses connector, MANY2MANY)
42177 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
42178 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
42179 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
42180 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
42181 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
42182 - TO vce( service-instance ComposedOf vce, ONE2MANY)
42183 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
42184 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
42186 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
42187 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
42188 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
42190 - service-instance-id
42192 service-instance-id:
42194 description: Uniquely identifies this instance of a service
42195 service-instance-name:
42197 description: This field will store a name assigned to the service-instance.
42200 description: the ASDC model id for this resource or service model.
42201 persona-model-version:
42203 description: the ASDC model version for this resource or service model.
42206 description: the ASDC model version for this resource or service model.
42209 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42210 widget-model-version:
42212 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42215 description: Indicates the total bandwidth to be used for this service.
42218 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
42219 bandwidth-down-wan1:
42221 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
42224 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
42225 bandwidth-down-wan2:
42227 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
42230 description: URL customers will use to access the vHN Portal.
42231 service-instance-location-id:
42233 description: An identifier that customers assign to the location where this service is being used.
42236 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42240 $ref: "#/definitions/relationship"
42244 $ref: "#/definitions/metadatum"
42247 Collection of service instances
42252 $ref: "#/definitions/service-instance"
42253 service-subscription:
42255 Object that group service instances.
42256 ###### Related Nodes
42257 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
42258 - TO tenant( service-subscription Uses tenant, MANY2MANY)
42259 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
42261 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
42262 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
42268 description: Value defined by orchestration to identify this service across ECOMP.
42269 temp-ub-sub-account-id:
42271 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
42274 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42278 $ref: "#/definitions/service-instance"
42282 $ref: "#/definitions/relationship"
42283 service-subscriptions:
42285 Collection of objects that group service instances.
42287 service-subscription:
42290 $ref: "#/definitions/service-subscription"
42293 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
42298 $ref: "#/definitions/service"
42301 ###### Related Nodes
42302 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
42303 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
42305 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
42306 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
42312 description: unique identifier of probe
42315 description: Prefix address
42318 description: Prefix address
42321 description: ip version, v4, v6
42322 destination-hostname:
42324 description: Hostname of the destination equipment to which SLAs are measured against.
42325 destination-equip-type:
42327 description: The type of destinatination equipment. Could be Router, etc.
42330 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42331 classes-of-service:
42334 $ref: "#/definitions/class-of-service"
42338 $ref: "#/definitions/relationship"
42341 Set of instances for probes used to measure service level agreements
42342 ###### Related Nodes
42343 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
42344 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
42346 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
42352 description: Unique id of site pair set.
42355 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42359 $ref: "#/definitions/routing-instance"
42363 $ref: "#/definitions/relationship"
42366 Collection of sets of instances for probes related to generic-vnf
42371 $ref: "#/definitions/site-pair-set"
42379 $ref: "#/definitions/site-pair"
42383 ###### Related Nodes
42384 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
42385 - FROM vserver( vserver Uses snapshot, ONE2ONE)
42392 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
42395 description: Snapshot name
42396 snapshot-architecture:
42398 description: Operating system architecture
42399 snapshot-os-distro:
42401 description: The common name of the operating system distribution in lowercase
42402 snapshot-os-version:
42404 description: The operating system version as specified by the distributor.
42407 description: The application that the image instantiates.
42408 application-vendor:
42410 description: The vendor of the application.
42411 application-version:
42413 description: The version of the application.
42416 description: URL to endpoint where AAI can get more details
42419 description: This field contains the UUID of the previous snapshot (if any).
42422 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42426 $ref: "#/definitions/relationship"
42429 Collection of openstack snapshots
42434 $ref: "#/definitions/snapshot"
42437 SR-IOV Physical Function
42438 ###### Related Nodes
42439 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
42440 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
42442 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
42448 description: Identifier for the sriov-pf
42451 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42455 $ref: "#/definitions/relationship"
42458 Collection of SR-IOV Physical Functions.
42463 $ref: "#/definitions/sriov-pf"
42466 SR-IOV Virtual Function (not to be confused with virtual network function)
42467 ###### Related Nodes
42468 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
42470 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
42476 description: PCI ID used to identify the sriov-vf
42479 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
42482 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
42485 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
42486 vf-vlan-anti-spoof-check:
42488 description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
42489 vf-mac-anti-spoof-check:
42491 description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
42494 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
42495 vf-broadcast-allow:
42497 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
42498 vf-unknown-multicast-allow:
42500 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
42501 vf-unknown-unicast-allow:
42503 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
42506 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
42509 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
42512 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42513 neutron-network-id:
42515 description: Neutron network id of the interface
42519 $ref: "#/definitions/relationship"
42522 Collection of SR-IOV Virtual Functions.
42527 $ref: "#/definitions/sriov-vf"
42536 ###### Related Nodes
42537 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
42538 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
42539 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
42541 -(4) IF this TO node is deleted, this SUBNET is DELETED also
42542 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
42550 description: Subnet ID, should be UUID.
42553 description: Name associated with the subnet.
42556 description: Neutron id of this subnet
42559 description: gateway ip address
42560 network-start-address:
42562 description: network start address
42565 description: cidr mask
42568 description: ip version
42569 orchestration-status:
42571 description: Orchestration status of this VNF, mastered by MSO
42574 description: dhcp enabled
42577 description: the start address reserved for use by dhcp
42580 description: the last address reserved for use by dhcp
42583 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42587 $ref: "#/definitions/relationship"
42593 $ref: "#/definitions/subnet"
42594 tagged-inventory-item-list:
42599 $ref: "#/definitions/inventory-item"
42603 ###### Related Nodes
42604 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
42605 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
42606 - TO l3-network( tenant Uses l3-network, MANY2MANY)
42607 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
42608 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
42609 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
42611 -TENANT cannot be deleted if related to VSERVER
42619 description: Unique id relative to the cloud-region.
42622 description: Readable name of tenant
42625 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42629 $ref: "#/definitions/vserver"
42633 $ref: "#/definitions/relationship"
42636 Collection of openstack tenants.
42641 $ref: "#/definitions/tenant"
42644 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
42645 ###### Related Nodes
42646 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
42648 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
42651 - bandwidth-up-wan1
42652 - bandwidth-down-wan1
42653 - bandwidth-up-wan2
42654 - bandwidth-down-wan2
42658 description: Allotted Resource id UUID assigned to this instance.
42661 description: The WAN uplink bandwidth for WAN1
42662 bandwidth-down-wan1:
42664 description: The WAN downlink bandwidth for WAN1
42667 description: The WAN uplink bandwidth for WAN2
42668 bandwidth-down-wan2:
42670 description: The WAN downlink bandwidth for WAN2
42673 description: Concurrency value
42677 $ref: "#/definitions/relationship"
42680 This object is used to store the specific tunnel cross connect aspects of an allotted resource
42685 $ref: "#/definitions/tunnel-xconnect"
42688 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
42697 $ref: "#/definitions/update-node-key"
42703 $ref: "#/definitions/action"
42712 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
42713 ###### Related Nodes
42714 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
42715 - TO complex( vce LocatedIn complex, MANY2MANY)
42716 - TO vserver( vce HostedOn vserver, ONE2MANY)
42717 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
42718 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
42720 -(1) IF this VCE node is deleted, this FROM node is DELETED also
42728 description: Unique id of VNF. This is unique across the graph.
42731 description: Name of VNF.
42734 description: Alternate name of VNF.
42737 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
42740 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
42741 regional-resource-zone:
42743 description: Regional way of organizing pservers, source of truth should define values
42746 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42749 description: Indicator for whether the resource is considered operational
42752 description: License key
42755 description: Network role being played by this VNF
42756 orchestration-status:
42758 description: Orchestration status of this VNF, mastered by MSO
42761 description: Heat stack id corresponding to this instance, managed by MSO
42764 description: Corresponds to the SDN-C catalog id used to configure this VCE
42767 description: Unique ID of VPE connected to this VCE.
42768 v6-vce-wan-address:
42770 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
42773 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
42776 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42777 ipv4-loopback0-address:
42779 description: Loopback0 address
42780 entitlement-resource-uuid:
42782 description: Entitlement resource uuid
42786 $ref: "#/definitions/port-group"
42790 $ref: "#/definitions/relationship"
42793 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
42798 $ref: "#/definitions/vce"
42801 a deployment unit of VNFCs
42802 ###### Related Nodes
42803 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
42804 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
42805 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
42806 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
42807 - TO vserver( vf-module Uses vserver, ONE2MANY)
42809 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
42810 -VF-MODULE cannot be deleted if related to VNFC
42814 - is-base-vf-module
42818 description: Unique ID of vf-module.
42821 description: Name of vf-module
42824 description: Heat stack id corresponding to this instance.
42825 orchestration-status:
42827 description: orchestration status of this vf-module, mastered by MSO
42830 description: used to indicate whether or not this object is base vf module
42833 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42836 description: the ASDC model id for this resource or service model.
42837 persona-model-version:
42839 description: the ASDC model version for this resource or service model.
42842 description: the ASDC model version for this resource or service model.
42845 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42846 widget-model-version:
42848 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42849 contrail-service-instance-fqdn:
42851 description: the Contrail unique ID for a service-instance
42855 $ref: "#/definitions/relationship"
42858 Collection of vf-modules, a deployment unit of VNFCs
42863 $ref: "#/definitions/vf-module"
42866 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
42867 ###### Related Nodes
42868 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
42870 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
42876 description: indicates whether the VIG is for AVPN or INTERNET
42879 description: v4 IP of the vig server
42882 description: v6 IP of the vig server
42885 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42889 $ref: "#/definitions/relationship"
42895 $ref: "#/definitions/vig-server"
42896 vip-ipv4-address-list:
42899 ###### Related Nodes
42900 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
42901 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
42902 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
42903 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
42910 description: IP address
42911 vip-ipv4-prefix-length:
42914 description: Prefix length, 32 for single address
42918 description: Inner VLAN tag
42922 description: Outer VLAN tag
42925 description: Indicator of fixed or floating address
42928 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42929 neutron-network-id:
42931 description: Neutron network id of the interface that address belongs to
42934 description: Neutron id of subnet that address belongs to
42938 $ref: "#/definitions/relationship"
42939 vip-ipv6-address-list:
42942 ###### Related Nodes
42943 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
42944 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
42945 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
42946 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
42953 description: IP address
42954 vip-ipv6-prefix-length:
42957 description: Prefix length, 128 for single address
42961 description: Inner VLAN tag
42965 description: Outer VLAN tag
42968 description: Indicator of fixed or floating address
42971 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42972 neutron-network-id:
42974 description: Neutron network id of the interface that address belongs to
42977 description: Neutron id of subnet that address belongs to
42981 $ref: "#/definitions/relationship"
42982 virtual-data-center:
42984 Virtual organization of cloud infrastructure elements in a data center context
42985 ###### Related Nodes
42986 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
42987 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
42988 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
42996 description: Unique ID of the vdc
42999 description: Name of the virtual data center
43002 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43006 $ref: "#/definitions/relationship"
43007 virtual-data-centers:
43009 Virtual organization of cloud infrastructure elements in a data center context
43011 virtual-data-center:
43014 $ref: "#/definitions/virtual-data-center"
43018 ###### Related Nodes
43019 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
43020 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
43021 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
43022 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
43023 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
43024 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
43026 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
43027 -(2) IF this VLAN node is deleted, this TO node is DELETED also
43028 -(4) IF this TO node is deleted, this VLAN is DELETED also
43034 description: String that identifies the interface
43038 description: Inner VLAN tag
43042 description: Outer VLAN tag
43045 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43048 description: Captures the numeric part of the speed
43051 description: Captures the units corresponding to the speed
43054 description: Used to describe (the service associated with) the vlan
43055 backdoor-connection:
43057 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
43060 description: This indicates the customers VPN ID associated with this vlan
43064 $ref: "#/definitions/relationship"
43065 l3-interface-ipv4-address-list:
43068 $ref: "#/definitions/l3-interface-ipv4-address-list"
43069 l3-interface-ipv6-address-list:
43072 $ref: "#/definitions/l3-interface-ipv6-address-list"
43078 $ref: "#/definitions/vlan"
43087 description: Unique id of VNF. This is unique across the graph.
43090 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
43091 ###### Related Nodes
43092 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
43094 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
43099 - application-vendor
43103 description: Unique ID of this asset
43106 description: The application that the image instantiates.
43107 application-vendor:
43109 description: The vendor of the application.
43110 application-version:
43112 description: The version of the application.
43115 description: URL to endpoint where AAI can get more details
43118 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43122 $ref: "#/definitions/relationship"
43125 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
43130 $ref: "#/definitions/vnf-image"
43133 ###### Related Nodes
43134 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
43135 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
43136 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
43138 -(4) IF this TO node is deleted, this VNFC is DELETED also
43141 - vnfc-function-code
43144 - is-closed-loop-disabled
43148 description: Unique ID of vnfc.
43149 vnfc-function-code:
43151 description: function code
43157 description: prov status of this vnfc
43158 orchestration-status:
43160 description: Orchestration status of this VNF, mastered by APP-C
43161 ipaddress-v4-oam-vip:
43163 description: Oam V4 vip address of this vnfc
43166 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
43167 is-closed-loop-disabled:
43169 description: used to indicate whether closed loop function is enabled on this node
43172 description: Group notation of VNFC
43175 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43179 $ref: "#/definitions/relationship"
43182 virtual network components associated with a vserver from application controller.
43187 $ref: "#/definitions/vnfc"
43190 Ephemeral Block storage volume.
43191 ###### Related Nodes
43192 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
43194 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
43201 description: Unique ID of block storage volume relative to the vserver.
43204 description: URL to endpoint where AAI can get more details
43207 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43211 $ref: "#/definitions/relationship"
43214 Persistent block-level storage.
43215 ###### Related Nodes
43216 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
43217 - TO complex( volume-group LocatedIn complex, MANY2ONE)
43218 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
43219 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
43220 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
43224 - volume-group-name
43229 description: Unique ID of volume-group.
43232 description: Name of the volume group.
43235 description: Heat stack id corresponding to this volume-group
43238 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
43239 orchestration-status:
43241 description: Orchestration status of this volume-group
43244 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43248 $ref: "#/definitions/relationship"
43251 Collection of persistent block-level storage.
43256 $ref: "#/definitions/volume-group"
43259 Collection of ephemeral Block storage volumes.
43264 $ref: "#/definitions/volume"
43267 VPLS Provider Edge routers.
43268 ###### Related Nodes
43269 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
43270 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
43271 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
43272 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
43274 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
43282 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43285 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
43288 description: Client should send valid enumerated value, e.g., VPLS-PE.
43292 description: Temporary location for stag to get to VCE
43295 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43299 $ref: "#/definitions/relationship"
43303 $ref: "#/definitions/p-interface"
43307 $ref: "#/definitions/lag-interface"
43310 Collection of VPLS Provider Edge routers
43315 $ref: "#/definitions/vpls-pe"
43319 ###### Related Nodes
43320 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
43322 -VPN-BINDING cannot be deleted if related to L3-NETWORK
43327 - global-route-target
43331 description: VPN ID, globally unique within A&AI
43334 description: VPN Name
43335 global-route-target:
43337 description: Number used to identify a VPN, globally unique in the network
43340 description: the platform associated with the VPN example AVPN, Mobility
43343 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43347 $ref: "#/definitions/relationship"
43348 description: l3-networks relate to vpn-bindings
43354 $ref: "#/definitions/vpn-binding"
43357 Virtual Servers, aka virtual machine or VM.
43358 ###### Related Nodes
43359 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
43360 - TO flavor( vserver Uses flavor, MANY2ONE)
43361 - TO image( vserver Uses image, MANY2ONE)
43362 - TO pserver( vserver HostedOn pserver, MANY2ONE)
43363 - TO snapshot( vserver Uses snapshot, ONE2ONE)
43364 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
43365 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
43366 - FROM vce( vce HostedOn vserver, ONE2MANY)
43367 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
43368 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
43369 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
43371 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
43372 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
43378 - is-closed-loop-disabled
43382 description: Unique identifier for this vserver relative to its tenant
43385 description: Name of vserver
43388 description: Alternative name of vserver
43391 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43394 description: URL to endpoint where AAI can get more details
43397 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
43398 is-closed-loop-disabled:
43400 description: Used to indicate whether closed loop function is enabled on this node
43403 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43407 $ref: "#/definitions/volume"
43411 $ref: "#/definitions/relationship"
43415 $ref: "#/definitions/l-interface"
43418 Collection of virtual Servers, aka virtual machines or VMs.
43423 $ref: "#/definitions/vserver"
43426 A zone is a grouping of assets in a location homing to the same connections into the CBB
43427 ###### Related Nodes
43428 - TO complex( zone LocatedIn complex, MANY2ONE)
43429 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
43430 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
43431 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
43441 description: Code assigned by AIC to the zone
43444 description: English name associated with the zone
43447 description: Design of zone [Medium/Large?]
43450 description: Context of zone [production/test]
43453 description: Status of a zone.
43456 description: Concurrency value
43460 $ref: "#/definitions/relationship"
43463 Collection of zones
43468 $ref: "#/definitions/zone"
43477 $ref: "#/patchDefinitions/action-data"
43486 APIs that are more action related than REST (e.g., notify, update).
43490 $ref: "#/patchDefinitions/update"
43493 $ref: "#/patchDefinitions/notify"
43496 Represents a slice or partial piece of a resource that gets separately allotted
43497 ###### Related Nodes
43498 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
43499 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
43500 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
43501 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
43502 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
43503 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
43504 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
43506 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
43507 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
43513 description: Allotted Resource id UUID assigned to this instance.
43516 description: The descriptive information assigned to this allotted resource instance
43519 description: Link back to more information in the controller
43522 description: the ASDC model id for this resource or service model.
43523 persona-model-version:
43525 description: the ASDC model version for this resource or service model.
43528 description: the ASDC model version for this resource or service model.
43529 persona-model-customization-id:
43531 description: captures the id of all the configuration used to customize the resource for the service.
43532 allotted-resources:
43534 This object is used to store slices of services being offered
43539 $ref: "#/patchDefinitions/allotted-resource"
43542 Availability zone, a collection of compute hosts/pservers
43543 ###### Related Nodes
43544 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
43545 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
43546 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
43547 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
43548 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
43549 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
43550 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
43551 - FROM vce( vce Uses availability-zone, MANY2MANY)
43553 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
43554 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
43557 - availability-zone-name
43560 availability-zone-name:
43562 description: Name of the availability zone. Unique across a cloud region
43565 description: Type of hypervisor. Source of truth should define valid values.
43568 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
43569 availability-zones:
43571 Collection of availability zones
43576 $ref: "#/patchDefinitions/availability-zone"
43577 az-and-dvs-switches:
43581 $ref: "#/patchDefinitions/dvs-switches"
43584 $ref: "#/patchDefinitions/availability-zone"
43587 Namespace for business related constructs
43592 $ref: "#/patchDefinitions/connector"
43596 $ref: "#/patchDefinitions/customer"
43599 ###### Related Nodes
43600 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
43602 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
43608 description: unique identifier of probe
43611 description: identifier of probe
43614 description: type of probe
43615 classes-of-service:
43617 class-of-service of probe
43622 $ref: "#/patchDefinitions/class-of-service"
43623 cloud-infrastructure:
43625 Namespace for cloud infrastructure.
43630 $ref: "#/patchDefinitions/complex"
43634 $ref: "#/patchDefinitions/cloud-region"
43638 $ref: "#/patchDefinitions/network-profile"
43642 $ref: "#/patchDefinitions/pserver"
43643 virtual-data-centers:
43646 $ref: "#/patchDefinitions/virtual-data-center"
43649 cloud-region designates an installation of a cloud cluster or region or instantiation.
43650 ###### Related Nodes
43651 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
43652 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
43653 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
43654 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
43655 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
43656 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
43657 - FROM image( image BelongsTo cloud-region, MANY2ONE)
43658 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
43659 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
43660 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
43661 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
43662 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
43664 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
43665 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
43673 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
43676 description: Identifier used by the vendor for the region. Second part of composite key
43679 description: Type of the cloud (e.g., openstack)
43680 owner-defined-type:
43682 description: Cloud-owner defined type indicator (e.g., DCP, LCP)
43683 cloud-region-version:
43685 description: Software version employed at the site
43688 description: URL of the keystone identity service
43691 description: Zone where the cloud is homed
43694 description: complex name for cloud-region instance
43700 $ref: "#/patchDefinitions/cloud-region"
43703 Collection of physical locations that can house cloud-regions.
43704 ###### Related Nodes
43705 - TO l3-network( complex Uses l3-network, MANY2MANY)
43706 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
43707 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
43708 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
43709 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
43710 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
43711 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
43712 - FROM vce( vce LocatedIn complex, MANY2MANY)
43713 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
43714 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
43716 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
43717 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
43720 - physical-location-id
43721 - physical-location-type
43728 physical-location-id:
43730 description: Unique identifier for physical location, e.g., CLLI
43733 description: Data center code which can be an alternate way to identify a complex
43736 description: Gamma complex name for LCP instance.
43739 description: URL of the keystone identity service
43742 Collection of physical locations that can house cloud-regions.
43747 $ref: "#/patchDefinitions/complex"
43750 Port Mirror Configuration.
43751 ###### Related Nodes
43752 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
43753 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
43754 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
43755 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
43756 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
43758 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
43759 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
43760 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
43763 - configuration-type
43764 - configuration-sub-type
43765 - orchestration-status
43766 - operational-status
43767 - configuration-selflink
43768 - model-customization-id
43772 description: UUID assigned to configuration.
43775 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
43776 configuration-name:
43778 description: Name of the configuration.
43779 configuration-type:
43781 description: port-mirroring-configuration.
43782 configuration-sub-type:
43784 description: vprobe, pprobe.
43785 model-invariant-id:
43787 description: the ASDC model id for this resource or service model.
43790 description: the ASDC model version for this resource or service model.
43791 orchestration-status:
43793 description: Orchestration status of the configuration.
43794 operational-status:
43796 description: Indicator for whether the resource is considered operational.
43797 configuration-selflink:
43799 description: URL to endpoint where AAI can get more details from SDN-GC.
43800 model-customization-id:
43802 description: id of the configuration used to customize the resource
43805 Collection of configurations
43810 $ref: "#/patchDefinitions/configuration"
43813 Collection of resource instances used to connect a variety of disparate inventory widgets
43814 ###### Related Nodes
43815 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
43816 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
43817 - FROM service-instance( service-instance Uses connector, MANY2MANY)
43819 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
43821 - resource-instance-id
43823 resource-instance-id:
43825 description: Unique id of resource instance.
43828 Collection of resource instances used to connect a variety of disparate inventory widgets
43833 $ref: "#/patchDefinitions/connector"
43834 constrained-element-set:
43836 This is how we would capture constraints defining allowed sets of elements.
43837 ###### Related Nodes
43838 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
43839 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
43840 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
43842 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
43843 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
43845 - constrained-element-set-uuid
43849 constrained-element-set-uuid:
43855 constrained-element-sets:
43857 constrained-element-set:
43860 $ref: "#/patchDefinitions/constrained-element-set"
43863 ###### Related Nodes
43864 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
43866 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
43879 $ref: "#/patchDefinitions/ctag-assignment"
43882 A collection of C tags (vlan tags) grouped for a specific purpose.
43883 ###### Related Nodes
43884 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
43885 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
43886 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
43888 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
43891 - availability-zone-name
43892 - ctag-pool-purpose
43896 description: The Target provider edge router
43897 availability-zone-name:
43899 description: Name of the availability zone
43902 description: Describes what the intended purpose of this pool is.
43905 description: Comma separated list of ctags
43911 $ref: "#/patchDefinitions/ctag-pool"
43914 customer identifiers to provide linkage back to BSS information.
43915 ###### Related Nodes
43916 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
43918 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
43920 - global-customer-id
43924 global-customer-id:
43926 description: Global customer id used across ECOMP to uniquely identify customer.
43929 description: Subscriber name, an alternate way to retrieve a customer.
43932 description: Subscriber type, a way to provide VID with only the INFRA customers.
43935 Collection of customer identifiers to provide linkage back to BSS information.
43940 $ref: "#/patchDefinitions/customer"
43948 description: See mis-na-virtualization-platform.yang
43954 $ref: "#/patchDefinitions/cvlan-tag-entry"
43957 Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
43958 ###### Related Nodes
43959 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
43960 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
43968 description: DVS switch name
43971 description: URL used to reach the vcenter
43974 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
43979 $ref: "#/patchDefinitions/dvs-switch"
43982 Internal map to define the properties of an edge and interpret the map EdgeRules
44000 edge-tag-query-request:
44011 $ref: "#/patchDefinitions/start-node-filter"
44012 include-node-filter:
44015 $ref: "#/patchDefinitions/include-node-filter"
44019 $ref: "#/patchDefinitions/secondary-filter"
44020 edge-tag-query-result:
44022 tagged-inventory-item-list:
44025 $ref: "#/patchDefinitions/tagged-inventory-item-list"
44026 element-choice-set:
44028 This is how we would capture constraints defining allowed sets of elements.
44029 ###### Related Nodes
44030 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
44031 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
44033 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
44034 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
44036 - element-choice-set-uuid
44037 - element-choice-set-name
44039 element-choice-set-uuid:
44041 element-choice-set-name:
44045 element-choice-sets:
44047 element-choice-set:
44050 $ref: "#/patchDefinitions/element-choice-set"
44053 Metadata for entitlement group.
44054 ###### Related Nodes
44055 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
44056 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
44058 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
44065 description: Unique ID for the entitlement group the resource comes from, should be uuid.
44068 description: Unique ID of an entitlement resource.
44071 Entitlements, keyed by group-uuid and resource-uuid, related to license management
44076 $ref: "#/patchDefinitions/entitlement"
44079 Persist EMS address information used by EMS driver.
44080 ###### Related Nodes
44081 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
44083 -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
44089 description: Unique ID of EMS.
44095 $ref: "#/patchDefinitions/esr-ems"
44098 Persist common address information of external systems.
44099 ###### Related Nodes
44100 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
44101 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
44102 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
44103 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
44105 -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
44107 - esr-system-info-id
44112 esr-system-info-id:
44114 description: Unique ID of esr system info.
44117 description: name of external system.
44120 description: type of external systems.
44123 description: vendor of external systems.
44126 description: version of external systems.
44129 description: url used to access external systems.
44132 description: username used to access external systems.
44135 description: password used to access external systems.
44138 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
44141 description: protocol of third party SDNC, for example netconf/snmp.
44144 description: ca file content if enabled ssl on auth-url.
44147 description: Whether to verify VIM's certificate.
44150 description: service IP of ftp server.
44153 description: service port of ftp server.
44156 description: domain info for authentication.
44159 description: default tenant of VIM.
44162 description: ftp passive mode or not.
44165 description: resource or performance data file path.
44168 description: the status of external system.
44169 esr-system-info-list:
44171 Collection of persistent block-level external system auth info.
44176 $ref: "#/patchDefinitions/esr-system-info"
44177 esr-thirdparty-sdnc:
44179 Persist SDNC address information used by ONAP SDNC.
44180 ###### Related Nodes
44181 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
44182 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
44184 -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
44186 - thirdparty-sdnc-id
44188 thirdparty-sdnc-id:
44190 description: Unique ID of SDNC.
44193 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
44196 description: password used to access SDNC server.
44197 esr-thirdparty-sdnc-list:
44199 esr-thirdparty-sdnc:
44202 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
44205 Persist VNFM address information used by VF-C.
44206 ###### Related Nodes
44207 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
44209 -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
44215 description: Unique ID of VNFM.
44218 description: indecate the VIM to deploy VNF.
44221 description: certificate url of VNFM.
44227 $ref: "#/patchDefinitions/esr-vnfm"
44230 evc object is an optional child object of the Configuration object.
44231 ###### Related Nodes
44232 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
44234 -(4) IF this TO node is deleted, this EVC is DELETED also
44240 description: Unique/key field for the evc object
44241 forwarding-path-topology:
44243 description: Point-to-Point, Multi-Point
44246 description: Commited Information Rate
44249 description: CIR units
44250 connection-diversity-group-id:
44252 description: Diversity Group ID
44255 description: formerly Performance Group
44256 esp-evc-circuit-id:
44258 description: EVC Circuit ID of ESP EVC
44261 description: Committed Information Rate (For ESP)
44264 description: CIR units (For ESP)
44267 description: Identifies ESP
44268 collector-pop-clli:
44270 description: Collector POP CLLI (from the hostname of the access pnf)
44271 inter-connect-type-ingress:
44273 description: Interconnect type on ingress side of EVC.
44274 tagmode-access-ingress:
44276 description: tagode for collector side of EVC
44277 tagmode-access-egress:
44279 description: tagMode for network side of EVC
44285 $ref: "#/patchDefinitions/evc"
44288 Namespace for external system.
44292 $ref: "#/patchDefinitions/esr-ems-list"
44295 $ref: "#/patchDefinitions/esr-vnfm-list"
44296 esr-thirdparty-sdnc-list:
44298 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
44301 Extra properties for inventory item for response list
44309 ###### Related Nodes
44310 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
44311 - FROM vserver( vserver Uses flavor, MANY2ONE)
44313 -FLAVOR cannot be deleted if related to VSERVER
44322 description: Flavor id, expected to be unique across cloud-region.
44325 description: Flavor name
44329 description: Number of CPUs
44333 description: Amount of memory
44337 description: Disk space
44341 description: Amount of ephemeral disk space
44344 description: amount of swap space allocation
44347 description: whether flavor is available to all users or private to the tenant it was created in.
44350 description: URL to endpoint where AAI can get more details
44353 description: Boolean as to whether this flavor is no longer enabled
44356 Collection of openstack flavors.
44361 $ref: "#/patchDefinitions/flavor"
44364 Entity describing a sequenced segment of forwarding path
44365 ###### Related Nodes
44366 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
44367 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
44368 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
44369 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
44370 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
44372 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
44373 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
44380 description: Unique ID of this segmentation
44383 description: ingress, intermediate, egress
44386 forwarder object is an optional child object of the Configuration object.
44387 ###### Related Nodes
44388 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
44390 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
44396 description: Key for forwarder-evc object
44399 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
44402 description: Internal VLAN.
44405 description: SVLAN value for ingress of egress forwarder.
44408 description: CVLAN value for ingress of egress forwarder.
44414 $ref: "#/patchDefinitions/forwarder-evc"
44420 $ref: "#/patchDefinitions/forwarder"
44423 Entity that describes the sequenced forwarding path between interfaces of services or resources
44424 ###### Related Nodes
44425 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
44426 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
44427 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
44429 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
44430 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
44431 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
44433 - forwarding-path-id
44434 - forwarding-path-name
44436 forwarding-path-id:
44438 description: Unique ID of this FP
44439 forwarding-path-name:
44441 description: Name of the FP
44447 $ref: "#/patchDefinitions/forwarding-path"
44450 General purpose VNF
44451 ###### Related Nodes
44452 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
44453 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
44454 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
44455 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
44456 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
44457 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
44458 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
44459 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
44460 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
44461 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
44462 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
44463 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
44464 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
44465 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
44466 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
44467 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
44468 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
44470 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
44476 - is-closed-loop-disabled
44480 description: Unique id of VNF. This is unique across the graph.
44483 description: Name of VNF.
44486 description: Alternate name of VNF.
44489 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
44492 description: Unique identifier of service from ASDC
44493 regional-resource-zone:
44495 description: Regional way of organizing pservers, source of truth should define values
44498 description: Trigger for operational monitoring of this resource by Service Assurance systems.
44501 description: Indicator for whether the resource is considered operational
44504 description: License key
44507 description: Client should send valid enumerated value
44508 orchestration-status:
44510 description: Orchestration status of this VNF, used by MSO.
44513 description: Heat stack id corresponding to this instance, managed by MSO
44516 description: Corresponds to the SDN-C catalog id used to configure this VCE
44519 description: identifier of managed by company or customer
44522 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
44523 ipv4-loopback0-address:
44525 description: v4 Loopback0 address
44528 description: v6 Loopback address
44529 management-v6-address:
44531 description: v6 management address
44535 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
44538 description: units associated with vcpu, used for VNFs with no vservers/flavors
44542 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
44545 description: units associated with vmemory, used for VNFs with no vservers/flavors
44549 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
44552 description: units associated with vdisk, used for VNFs with no vservers/flavors
44555 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
44556 is-closed-loop-disabled:
44558 description: used to indicate whether closed loop function is enabled on this node
44566 $ref: "#/patchDefinitions/generic-vnf"
44569 Openstack group-assignment used to store exclusivity groups (EG).
44570 ###### Related Nodes
44571 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
44572 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
44573 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
44582 description: Group id, expected to be unique across cloud-region.
44585 description: Group type - the type of group this instance refers to
44588 description: Group name - name assigned to the group
44591 description: Group description - description of the group
44594 Collection of openstack group assignments
44599 $ref: "#/patchDefinitions/group-assignment"
44602 ###### Related Nodes
44603 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
44605 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
44613 description: host-route id
44616 description: subnet prefix
44619 description: Could be ip-address, hostname, or service-instance
44622 description: Should be ip-address, hostname, or service-instance to match next-hop
44628 $ref: "#/patchDefinitions/host-route"
44631 Collection of HPA Capabilities
44636 $ref: "#/patchDefinitions/hpa-capability"
44639 Represents a HPA capability
44640 ###### Related Nodes
44641 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
44642 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
44643 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
44645 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
44647 - hpa-capability-id
44652 description: UUID to uniquely identify a HPA capability
44655 description: Name of the HPACapability
44658 description: HPA schema version
44661 description: Hardware architecture
44662 hpa-feature-attributes:
44664 HPA Capability Feature attributes
44665 ###### Related Nodes
44666 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
44668 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
44670 - hpa-attribute-key
44674 description: name of the specific HPA attribute
44675 hpa-attribute-value:
44677 description: JSON string specifying the value, unit and type of the specific HPA attribute
44681 ###### Related Nodes
44682 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
44683 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
44684 - FROM vserver( vserver Uses image, MANY2ONE)
44686 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
44687 -IMAGE cannot be deleted if related to VSERVER
44698 description: Image id, expected to be unique across cloud region
44701 description: Image name
44702 image-architecture:
44704 description: Operating system architecture.
44707 description: The common name of the operating system distribution in lowercase
44710 description: The operating system version as specified by the distributor.
44713 description: The application that the image instantiates.
44714 application-vendor:
44716 description: The vendor of the application.
44717 application-version:
44719 description: The version of the application.
44722 description: URL to endpoint where AAI can get more details
44725 Collectio of Openstack images.
44730 $ref: "#/patchDefinitions/image"
44731 include-node-filter:
44737 InstanceFilter for performing a named-query or model query
44740 InstanceFilters for performing a named-query or model query
44745 $ref: "#/patchDefinitions/instance-filter"
44748 General mechanism for grouping instances
44749 ###### Related Nodes
44750 - TO model( instance-group Targets model, MANY2MANY)
44751 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
44752 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
44753 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
44754 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
44763 description: Instance Group ID, UUID assigned to this instance.
44766 description: Descriptive text to help identify the usage of this instance-group
44769 description: Only valid value today is lower case ha for high availability
44772 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
44775 Collection of openstack route table references
44780 $ref: "#/patchDefinitions/instance-group"
44785 $ref: "#/patchDefinitions/search"
44788 $ref: "#/patchDefinitions/actions"
44789 cloud-infrastructure:
44791 $ref: "#/patchDefinitions/cloud-infrastructure"
44794 $ref: "#/patchDefinitions/business"
44795 service-design-and-creation:
44797 $ref: "#/patchDefinitions/service-design-and-creation"
44800 $ref: "#/patchDefinitions/network"
44803 inventory-item-type:
44805 inventory-item-link:
44807 inventory-item-data:
44810 $ref: "#/patchDefinitions/inventory-item-data"
44811 tagged-inventory-item-list:
44814 $ref: "#/patchDefinitions/tagged-inventory-item-list"
44815 inventory-item-data:
44821 inventory-response-item:
44823 Inventory item for response list
44829 $ref: "#/patchDefinitions/extra-properties"
44830 inventory-response-items:
44832 $ref: "#/patchDefinitions/inventory-response-items"
44833 inventory-response-items:
44835 Container for inventory items in response list
44837 inventory-response-item:
44840 $ref: "#/patchDefinitions/inventory-response-item"
44841 ipsec-configuration:
44843 IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
44844 ###### Related Nodes
44845 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
44846 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
44848 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
44850 - ipsec-configuration-id
44852 ipsec-configuration-id:
44854 description: UUID of this configuration
44855 requested-vig-address-type:
44857 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
44858 requested-encryption-strength:
44860 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
44861 requested-dmz-type:
44863 description: can offer a shared DMZ or a DMZ specific to a customer
44864 shared-dmz-network-address:
44866 description: Network address of shared DMZ
44867 requested-customer-name:
44869 description: If the DMZ is a custom DMZ, this field will indicate the customer information
44872 description: can be 1 or 2
44873 ikev1-authentication:
44875 description: Contains values like md5, sha1, sha256, sha384
44878 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
44881 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
44884 description: Group name defined in VIG for clients using aggressive mode
44887 description: pre-shared key for the above group name
44890 description: Lifetime for IKEv1 SA
44891 ipsec-authentication:
44893 description: md5, sha1, sha256, sha384
44896 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
44899 description: Life time for IPSec SA
44902 description: enable PFS or not
44905 description: user ID for xAuth, sm-user, ,nmteHostName
44906 xauth-user-password:
44908 description: Encrypted using the Juniper $9$ algorithm
44911 description: The time between DPD probe
44914 description: Maximum number of DPD before claiming the tunnel is down
44915 ipsec-configurations:
44917 ipsec-configuration:
44920 $ref: "#/patchDefinitions/ipsec-configuration"
44929 Logical interfaces, e.g., a vnic.
44930 ###### Related Nodes
44931 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
44932 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
44933 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
44934 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
44935 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
44936 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
44937 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
44938 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
44939 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
44940 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
44942 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
44943 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
44944 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
44950 description: Name given to the interface
44953 description: E.g., CUSTOMER, UPLINK, etc.
44956 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
44959 description: URL to endpoint where AAI can get more details
44962 description: ID of interface
44965 description: MAC address for the interface
44968 description: Name of the network
44971 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
44974 Collection of logical interfaces.
44979 $ref: "#/patchDefinitions/l-interface"
44980 l3-interface-ipv4-address-list:
44983 ###### Related Nodes
44984 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
44985 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
44986 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
44987 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
44989 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
44991 - l3-interface-ipv4-address
44993 l3-interface-ipv4-address:
44995 description: IP address
44996 l3-interface-ipv4-prefix-length:
44999 description: Prefix length, 32 for single address
45003 description: Inner VLAN tag
45007 description: Outer VLAN tag
45010 description: Indicator of fixed or floating address
45011 l3-interface-ipv6-address-list:
45014 ###### Related Nodes
45015 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
45016 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
45017 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
45018 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
45020 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
45022 - l3-interface-ipv6-address
45024 l3-interface-ipv6-address:
45026 description: IP address
45027 l3-interface-ipv6-prefix-length:
45030 description: Prefix length, 128 for single address
45034 description: Inner VLAN tag
45038 description: Outer VLAN tag
45041 description: Indicator of fixed or floating address
45044 Generic network definition
45045 ###### Related Nodes
45046 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
45047 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
45048 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
45049 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
45050 - FROM complex( complex Uses l3-network, MANY2MANY)
45051 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
45052 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
45053 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
45054 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
45055 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
45056 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
45057 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
45058 - FROM tenant( tenant Uses l3-network, MANY2MANY)
45059 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
45061 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
45066 - is-provider-network
45067 - is-shared-network
45068 - is-external-network
45072 description: Network ID, should be uuid. Unique across A&AI.
45075 description: Name of the network, governed by some naming convention..
45078 description: Type of the network - who defines these values?
45081 description: Role the network plans - who defines these values?
45082 network-technology:
45084 description: Network technology - who defines these values?
45085 neutron-network-id:
45087 description: Neutron network id of this Interface
45090 description: Set to true if bound to VPN
45093 description: Unique identifier of service from ASDC
45094 network-role-instance:
45097 description: network role instance
45103 $ref: "#/patchDefinitions/l3-network"
45106 Link aggregate interface
45107 ###### Related Nodes
45108 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
45109 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
45110 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
45111 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
45112 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
45113 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
45114 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
45116 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
45117 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
45118 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
45124 description: Name that identifies the link aggregate interface
45127 Collection of link aggregate interfaces.
45132 $ref: "#/patchDefinitions/lag-interface"
45135 LAG links can connect lag-interfaces
45136 ###### Related Nodes
45137 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
45138 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
45140 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
45146 description: Alphabetical concatenation of lag-interface names
45149 Collection of link aggregation connections
45154 $ref: "#/patchDefinitions/lag-link"
45157 Metadata for license group.
45158 ###### Related Nodes
45159 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
45160 - TO vce( license BelongsTo vce, MANY2ONE)(4)
45162 -(4) IF this TO node is deleted, this LICENSE is DELETED also
45169 description: Unique ID for the license group the resource belongs to, should be uuid.
45172 description: Unique ID of a license resource.
45175 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
45180 $ref: "#/patchDefinitions/license"
45183 describes a line-of-business
45184 ###### Related Nodes
45185 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
45188 - line-of-business-name
45190 line-of-business-name:
45192 description: Name of the line-of-business (product)
45195 Collection of lines-of-business
45200 $ref: "#/patchDefinitions/line-of-business"
45203 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
45204 ###### Related Nodes
45205 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
45206 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
45207 - TO logical-link( logical-link Uses logical-link, ONE2MANY)
45208 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
45209 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
45210 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
45211 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
45212 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
45213 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
45214 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
45215 - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
45217 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
45224 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
45227 description: Type of logical link, e.g., evc
45230 description: Captures the numeric part of the speed
45233 description: Captures the units corresponding to the speed
45236 description: v4, v6, or ds for dual stack
45239 description: For example, static or BGP
45242 Collection of logical connections
45247 $ref: "#/patchDefinitions/logical-link"
45250 Collection of metadatum (key/value pairs)
45255 $ref: "#/patchDefinitions/metadatum"
45259 ###### Related Nodes
45260 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
45261 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
45262 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
45263 - TO model( metadatum BelongsTo model, MANY2ONE)(4)
45265 -(4) IF this TO node is deleted, this METADATUM is DELETED also
45276 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
45277 ###### Related Nodes
45278 - TO model( model-element isA model, MANY2ONE)
45279 - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
45280 - FROM named-query( named-query AppliesTo model, ONE2MANY)
45281 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
45282 - FROM model-element( model-element isA model, MANY2ONE)
45283 - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
45285 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
45286 -(2) IF this MODEL node is deleted, this TO node is DELETED also
45287 -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
45290 - model-name-version-id
45296 model-name-version-id:
45298 description: Unique identifier corresponding to one version of a model in ASDC
45301 description: Type of the model, e.g., service, resource, widget, etc.
45304 description: Name of the model, which can change from version to version.
45307 description: Invariant unique ID which does not change from version to version
45310 description: Version
45313 description: Description
45314 model-and-named-query-search:
45316 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
45320 $ref: "#/patchDefinitions/query-parameters"
45323 $ref: "#/patchDefinitions/instance-filters"
45328 This is how we would capture constraints defining allowed sets of elements.
45329 ###### Related Nodes
45330 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
45331 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
45333 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
45334 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
45336 - model-constraint-uuid
45337 - constrained-element-set-uuid-to-replace
45339 model-constraint-uuid:
45341 constrained-element-set-uuid-to-replace:
45343 constrained-element-sets:
45346 $ref: "#/patchDefinitions/constrained-element-set"
45352 $ref: "#/patchDefinitions/model-constraint"
45355 Defines how other models combine to make up a higher-level model.
45356 ###### Related Nodes
45357 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
45358 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
45359 - TO model( model-element isA model, MANY2ONE)
45360 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
45361 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
45362 - FROM model (PARENT of model-element, model startsWith model-element)(3)
45363 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
45365 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
45366 -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
45367 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
45369 - model-element-uuid
45370 - new-data-del-flag
45373 model-element-uuid:
45377 description: Indicates whether this element was created as part of instantiation from this model
45380 description: How many of this type of element are required/allowed
45388 $ref: "#/patchDefinitions/model-element"
45391 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
45392 ###### Related Nodes
45393 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
45394 - FROM model-element( model-element IsA model-ver, MANY2ONE)
45395 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
45396 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
45398 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
45399 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
45400 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
45409 description: Unique identifier corresponding to one version of a model in ASDC
45412 description: Name of the model, which can change from version to version.
45415 description: Version
45418 description: Description
45424 $ref: "#/patchDefinitions/model-ver"
45427 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
45432 $ref: "#/patchDefinitions/model"
45433 multicast-configuration:
45435 ###### Related Nodes
45436 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
45439 - multicast-configuration-id
45440 - multicast-protocol
45443 multicast-configuration-id:
45445 description: Unique id of multicast configuration.
45446 multicast-protocol:
45448 description: protocol of multicast configuration
45451 description: rp type of multicast configuration
45452 multicast-configurations:
45454 multicast configuration of generic-vnf ip-address
45456 multicast-configuration:
45459 $ref: "#/patchDefinitions/multicast-configuration"
45465 $ref: "#/patchDefinitions/named-query"
45469 ###### Related Nodes
45470 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
45471 - TO model( named-query AppliesTo model, ONE2MANY)
45472 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
45474 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
45478 - named-query-version
45484 named-query-version:
45486 required-input-param:
45490 named-query-element:
45493 ###### Related Nodes
45494 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
45495 - TO model( named-query-element IsA model, MANY2ONE)
45496 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
45497 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
45498 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
45499 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
45501 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
45502 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
45504 - named-query-element-uuid
45506 named-query-element-uuid:
45508 property-collect-list:
45510 named-query-elements:
45512 named-query-element:
45515 $ref: "#/patchDefinitions/named-query-element"
45518 Namespace for network inventory resources.
45523 $ref: "#/patchDefinitions/logical-link"
45527 $ref: "#/patchDefinitions/site-pair-set"
45531 $ref: "#/patchDefinitions/vpn-binding"
45535 $ref: "#/patchDefinitions/vpls-pe"
45536 multicast-configurations:
45539 $ref: "#/patchDefinitions/multicast-configuration"
45543 $ref: "#/patchDefinitions/vce"
45547 $ref: "#/patchDefinitions/vnfc"
45551 $ref: "#/patchDefinitions/l3-network"
45555 $ref: "#/patchDefinitions/network-policy"
45559 $ref: "#/patchDefinitions/generic-vnf"
45563 $ref: "#/patchDefinitions/lag-link"
45567 $ref: "#/patchDefinitions/newvce"
45571 $ref: "#/patchDefinitions/pnf"
45575 $ref: "#/patchDefinitions/physical-link"
45576 ipsec-configurations:
45579 $ref: "#/patchDefinitions/ipsec-configuration"
45580 route-table-references:
45583 $ref: "#/patchDefinitions/route-table-reference"
45589 $ref: "#/patchDefinitions/network-policy"
45592 ###### Related Nodes
45593 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
45596 - network-policy-id
45600 description: UUID representing unique key to this instance
45601 network-policy-fqdn:
45603 description: Contrail FQDN for the policy
45606 description: ID for the openStack Heat instance
45609 Network profile populated by SDN-GP for SNMP
45610 ###### Related Nodes
45611 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
45618 description: Unique name of network profile.
45621 description: Encrypted SNMP community string
45624 Collection of network profiles
45629 $ref: "#/patchDefinitions/network-profile"
45632 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
45633 ###### Related Nodes
45634 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
45636 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
45644 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45647 description: Name of VNF.
45650 description: Alternate name of VNF.
45653 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
45656 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45659 description: Indicator for whether the resource is considered operational
45662 description: License key
45665 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
45668 description: Client should send valid enumerated value.
45671 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
45676 $ref: "#/patchDefinitions/newvce"
45679 inventory-item-data:
45682 $ref: "#/patchDefinitions/inventory-item-data"
45683 notification-event:
45687 notification-event-header:
45689 $ref: "#/patchDefinitions/notification-event-header"
45690 notification-event-header:
45731 $ref: "#/patchDefinitions/key-data"
45736 OAM network, to be deprecated shortly. Do not use for new purposes.
45737 ###### Related Nodes
45738 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
45739 - TO complex( oam-network AppliesTo complex, MANY2MANY)
45740 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
45749 description: UUID of the network. Unique across a cloud-region
45752 description: Name of the network.
45756 description: cvlan-id
45757 ipv4-oam-gateway-address:
45759 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
45760 ipv4-oam-gateway-address-prefix-length:
45763 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
45766 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
45771 $ref: "#/patchDefinitions/oam-network"
45772 operational-environment:
45774 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
45775 ###### Related Nodes
45776 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
45777 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
45780 - operational-environment-id
45781 - operational-environment-name
45782 - operational-environment-type
45783 - operational-environment-status
45787 operational-environment-id:
45789 description: UUID of an operational environment
45790 operational-environment-name:
45792 description: Operational Environment name
45793 operational-environment-type:
45795 description: Operational Environment Type.
45796 operational-environment-status:
45798 description: Status
45801 description: Tenant Context.
45804 description: Workload Context.
45805 operational-environments:
45807 a logical partition of the cloud which allows to have multiple environments in the production AIC.
45809 operational-environment:
45812 $ref: "#/patchDefinitions/operational-environment"
45815 Allows for legacy POST of old-style and new-style models
45817 - model-invariant-id
45818 - model-name-version-id
45824 model-invariant-id:
45826 description: Unique identifier corresponding to the main definition of a model in ASDC
45827 model-name-version-id:
45829 description: Unique identifier corresponding to one version of a model in ASDC
45832 description: Type of the model, e.g., service, resource, widget, etc.
45835 description: Name of the model, which can change from version to version.
45838 description: Invariant unique ID which does not change from version to version
45841 description: Version
45844 description: Description
45847 Collection of owning-entities
45852 $ref: "#/patchDefinitions/owning-entity"
45855 describes an owning-entity
45856 ###### Related Nodes
45857 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
45861 - owning-entity-name
45865 description: UUID of an owning entity
45866 owning-entity-name:
45868 description: Owning entity name
45871 Physical interface (e.g., nic)
45872 ###### Related Nodes
45873 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
45874 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
45875 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
45876 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
45877 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
45878 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
45879 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
45881 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
45882 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
45883 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
45889 description: Name that identifies the physical interface
45892 description: Captures the numeric part of the speed
45895 description: Captures the units corresponding to the speed
45898 description: Nature of the services and connectivity on this port.
45899 equipment-identifier:
45901 description: CLEI or other specification for p-interface hardware.
45904 description: Role specification for p-interface hardware.
45907 description: Indicates the physical properties of the interface.
45910 Collection of physical interfaces.
45915 $ref: "#/patchDefinitions/p-interface"
45918 Collection of physical connections, typically between p-interfaces
45919 ###### Related Nodes
45920 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
45922 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
45928 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
45931 description: Captures the numeric part of the speed
45934 description: Captures the units corresponding to the speed
45937 description: Circuit it
45940 description: Dual access mode (e.g., primary, secondary
45943 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
45944 service-provider-name:
45946 description: Name of the service Provider on this link.
45949 Collection of physical connections, typically between p-interfaces
45954 $ref: "#/patchDefinitions/physical-link"
45957 describes a platform
45958 ###### Related Nodes
45959 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
45966 description: Name of the platform
45969 Collection of platforms
45974 $ref: "#/patchDefinitions/platform"
45977 PNF represents a physical network function. typically equipment used in the D1 world.
45978 ###### Related Nodes
45979 - TO complex( pnf LocatedIn complex, MANY2ONE)
45980 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
45981 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
45982 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
45984 -(1) IF this PNF node is deleted, this FROM node is DELETED also
45991 description: unique name of Physical Network Function.
45994 description: name of Physical Network Function.
45997 description: source of name2
46000 description: id of pnf
46003 description: Equipment type. Source of truth should define valid values.
46006 description: Equipment vendor. Source of truth should define valid values.
46009 description: Equipment model. Source of truth should define valid values.
46012 description: identifier of managed by company or customer
46015 description: ipv4-oam-address with new naming convention for IP addresses
46018 description: sw-version is the version of SW for the hosted application on the PNF.
46019 orchestration-status:
46021 description: orchestration-status is the status of orchestration on the PNF.
46024 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
46027 description: ID of the physical frame (relay rack) where pnf is installed.
46030 Collection of Physical Network Functions.
46035 $ref: "#/patchDefinitions/pnf"
46038 Used to capture the network interfaces of this VCE
46039 ###### Related Nodes
46040 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
46041 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
46043 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
46044 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
46047 - orchestration-status
46051 description: Unique ID of the interface
46052 neutron-network-id:
46054 description: Neutron network id of this Interface
46055 neutron-network-name:
46057 description: Neutron network name of this Interface
46060 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46066 $ref: "#/patchDefinitions/port-group"
46069 describes the project
46070 ###### Related Nodes
46071 - TO service-instance( project Uses service-instance, ONE2MANY)
46078 description: Name of the project deploying a service
46081 Collection of projects
46086 $ref: "#/patchDefinitions/project"
46089 Property holder for query properties or instance properties
46095 property-constraint:
46098 ###### Related Nodes
46099 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
46101 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
46103 - property-constraint-uuid
46108 property-constraint-uuid:
46116 property-constraints:
46118 property-constraint:
46121 $ref: "#/patchDefinitions/property-constraint"
46124 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
46125 ###### Related Nodes
46126 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
46127 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
46128 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
46129 - TO complex( pserver LocatedIn complex, MANY2ONE)
46130 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
46131 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
46132 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
46133 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
46134 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
46136 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
46137 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
46145 description: Value from executing hostname on the compute node.
46148 description: PTNII name
46152 description: Number of cpus
46156 description: Disk size, in GBs
46160 description: RAM size, in MBs
46163 description: Equipment type. Source of truth should define valid values.
46166 description: Equipment vendor. Source of truth should define valid values.
46169 description: Equipment model. Source of truth should define valid values.
46172 description: Fully-qualified domain name
46175 description: URL to endpoint where AAI can get more details
46178 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
46181 description: Serial number, may be queried
46184 description: ID of Pserver
46187 description: internet topology of Pserver
46190 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
46193 Collection of compute hosts.
46198 $ref: "#/patchDefinitions/pserver"
46201 QueryParameters for performing a named-query or model query
46205 $ref: "#/patchDefinitions/named-query"
46208 $ref: "#/patchDefinitions/model"
46212 ###### Related Nodes
46213 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
46215 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
46217 - related-lookup-uuid
46219 - source-node-property
46221 - target-node-property
46223 related-lookup-uuid:
46227 source-node-property:
46231 target-node-property:
46233 property-collect-list:
46240 $ref: "#/patchDefinitions/related-lookup"
46241 related-to-property:
46245 description: Key part of a key/value pair
46248 description: Value part of a key/value pair
46253 description: A keyword provided by A&AI to indicate type of node.
46256 description: URL to the object in A&AI.
46260 $ref: "#/patchDefinitions/relationship-data"
46261 related-to-property:
46264 $ref: "#/patchDefinitions/related-to-property"
46268 - relationship-value
46272 description: A keyword provided by A&AI to indicate an attribute.
46273 relationship-value:
46275 description: Value of the attribute.
46276 reserved-prop-names:
46278 Internal map to define some reserved properties of a vertex
46280 last-mod-source-of-truth:
46296 Response container for the results of a named-query or model query
46298 inventory-response-items:
46300 $ref: "#/patchDefinitions/inventory-response-items"
46305 description: The specific type of node in the A&AI graph
46308 description: The URL to the specific resource
46309 route-table-reference:
46311 Openstack route table reference.
46312 ###### Related Nodes
46313 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
46316 - route-table-reference-id
46317 - route-table-reference-fqdn
46319 route-table-reference-id:
46321 description: Route Table Reference id, UUID assigned to this instance.
46322 route-table-reference-fqdn:
46324 description: FQDN entry in the route table.
46325 route-table-references:
46327 Collection of openstack route table references
46329 route-table-reference:
46332 $ref: "#/patchDefinitions/route-table-reference"
46335 Route target information
46336 ###### Related Nodes
46337 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
46339 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
46341 - global-route-target
46342 - route-target-role
46344 global-route-target:
46346 description: Number used to identify an RT, globally unique in the network
46349 description: Role assigned to this route target
46352 Collection of route target information
46357 $ref: "#/patchDefinitions/route-target"
46360 ###### Related Nodes
46361 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
46362 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
46364 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
46365 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
46367 - routing-instance-id
46369 routing-instance-id:
46371 description: Unique id of routing instance
46374 description: rpm owner
46377 set of probes related to generic-vnf routing instance
46382 $ref: "#/patchDefinitions/routing-instance"
46387 $ref: "#/patchDefinitions/oam-networks"
46388 az-and-dvs-switches:
46391 $ref: "#/patchDefinitions/az-and-dvs-switches"
46394 edge-tag-query-result:
46396 $ref: "#/patchDefinitions/edge-tag-query-result"
46397 edge-tag-query-request:
46399 $ref: "#/patchDefinitions/edge-tag-query-request"
46402 $ref: "#/patchDefinitions/search-results"
46405 $ref: "#/patchDefinitions/sdn-zone-response"
46411 $ref: "#/patchDefinitions/result-data"
46414 SecondaryFilt for performing a named-query or model query
46425 SecondaryFilts for performing a named-query or model query
46430 $ref: "#/patchDefinitions/secondary-filt"
46431 segmentation-assignment:
46433 Openstack segmentation assignment.
46434 ###### Related Nodes
46435 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
46437 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
46443 description: Route Table Reference id, UUID assigned to this instance.
46444 segmentation-assignments:
46446 Collection of openstack segmentation assignments
46448 segmentation-assignment:
46451 $ref: "#/patchDefinitions/segmentation-assignment"
46454 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
46457 - service-description
46461 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
46462 service-description:
46464 description: Description of the service
46467 description: URL to endpoint where AAI can get more details
46468 service-capabilities:
46470 Collection of service capabilities.
46472 service-capability:
46475 $ref: "#/patchDefinitions/service-capability"
46476 service-capability:
46478 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
46479 ###### Related Nodes
46480 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
46481 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
46483 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
46491 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
46494 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
46495 service-design-and-creation:
46497 Namespace for objects managed by ASDC
46502 $ref: "#/patchDefinitions/vnf-image"
46506 $ref: "#/patchDefinitions/service"
46507 service-capabilities:
46510 $ref: "#/patchDefinitions/service-capability"
46514 $ref: "#/patchDefinitions/model"
46518 $ref: "#/patchDefinitions/named-query"
46521 Instance of a service
46522 ###### Related Nodes
46523 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
46524 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
46525 - TO connector( service-instance Uses connector, MANY2MANY)
46526 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
46527 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
46528 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
46529 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
46530 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
46531 - TO vce( service-instance ComposedOf vce, ONE2MANY)
46532 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
46533 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
46535 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
46536 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
46537 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
46539 - service-instance-id
46541 service-instance-id:
46543 description: Uniquely identifies this instance of a service
46544 service-instance-name:
46546 description: This field will store a name assigned to the service-instance.
46549 description: the ASDC model id for this resource or service model.
46550 persona-model-version:
46552 description: the ASDC model version for this resource or service model.
46555 description: the ASDC model version for this resource or service model.
46558 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
46559 widget-model-version:
46561 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
46564 description: Indicates the total bandwidth to be used for this service.
46567 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
46568 bandwidth-down-wan1:
46570 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
46573 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
46574 bandwidth-down-wan2:
46576 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
46579 description: URL customers will use to access the vHN Portal.
46580 service-instance-location-id:
46582 description: An identifier that customers assign to the location where this service is being used.
46585 Collection of service instances
46590 $ref: "#/patchDefinitions/service-instance"
46591 service-subscription:
46593 Object that group service instances.
46594 ###### Related Nodes
46595 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
46596 - TO tenant( service-subscription Uses tenant, MANY2MANY)
46597 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
46599 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
46600 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
46606 description: Value defined by orchestration to identify this service across ECOMP.
46607 temp-ub-sub-account-id:
46609 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
46610 service-subscriptions:
46612 Collection of objects that group service instances.
46614 service-subscription:
46617 $ref: "#/patchDefinitions/service-subscription"
46620 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
46625 $ref: "#/patchDefinitions/service"
46628 ###### Related Nodes
46629 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
46630 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
46632 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
46633 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
46639 description: unique identifier of probe
46642 description: Prefix address
46645 description: Prefix address
46648 description: ip version, v4, v6
46649 destination-hostname:
46651 description: Hostname of the destination equipment to which SLAs are measured against.
46652 destination-equip-type:
46654 description: The type of destinatination equipment. Could be Router, etc.
46657 Set of instances for probes used to measure service level agreements
46658 ###### Related Nodes
46659 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
46660 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
46662 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
46668 description: Unique id of site pair set.
46671 Collection of sets of instances for probes related to generic-vnf
46676 $ref: "#/patchDefinitions/site-pair-set"
46684 $ref: "#/patchDefinitions/site-pair"
46688 ###### Related Nodes
46689 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
46690 - FROM vserver( vserver Uses snapshot, ONE2ONE)
46697 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
46700 description: Snapshot name
46701 snapshot-architecture:
46703 description: Operating system architecture
46704 snapshot-os-distro:
46706 description: The common name of the operating system distribution in lowercase
46707 snapshot-os-version:
46709 description: The operating system version as specified by the distributor.
46712 description: The application that the image instantiates.
46713 application-vendor:
46715 description: The vendor of the application.
46716 application-version:
46718 description: The version of the application.
46721 description: URL to endpoint where AAI can get more details
46724 description: This field contains the UUID of the previous snapshot (if any).
46727 Collection of openstack snapshots
46732 $ref: "#/patchDefinitions/snapshot"
46735 SR-IOV Physical Function
46736 ###### Related Nodes
46737 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
46738 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
46740 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
46746 description: Identifier for the sriov-pf
46749 Collection of SR-IOV Physical Functions.
46754 $ref: "#/patchDefinitions/sriov-pf"
46757 SR-IOV Virtual Function (not to be confused with virtual network function)
46758 ###### Related Nodes
46759 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
46761 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
46767 description: PCI ID used to identify the sriov-vf
46770 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
46773 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
46776 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
46777 vf-vlan-anti-spoof-check:
46779 description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
46780 vf-mac-anti-spoof-check:
46782 description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
46785 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
46786 vf-broadcast-allow:
46788 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
46789 vf-unknown-multicast-allow:
46791 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
46792 vf-unknown-unicast-allow:
46794 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
46797 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
46800 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
46803 Collection of SR-IOV Virtual Functions.
46808 $ref: "#/patchDefinitions/sriov-vf"
46817 ###### Related Nodes
46818 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
46819 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
46820 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
46822 -(4) IF this TO node is deleted, this SUBNET is DELETED also
46823 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
46831 description: Subnet ID, should be UUID.
46834 description: Name associated with the subnet.
46837 description: Neutron id of this subnet
46840 description: gateway ip address
46841 network-start-address:
46843 description: network start address
46846 description: cidr mask
46849 description: ip version
46850 orchestration-status:
46852 description: Orchestration status of this VNF, mastered by MSO
46855 description: dhcp enabled
46858 description: the start address reserved for use by dhcp
46861 description: the last address reserved for use by dhcp
46867 $ref: "#/patchDefinitions/subnet"
46868 tagged-inventory-item-list:
46873 $ref: "#/patchDefinitions/inventory-item"
46877 ###### Related Nodes
46878 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
46879 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
46880 - TO l3-network( tenant Uses l3-network, MANY2MANY)
46881 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
46882 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
46883 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
46885 -TENANT cannot be deleted if related to VSERVER
46893 description: Unique id relative to the cloud-region.
46896 description: Readable name of tenant
46899 Collection of openstack tenants.
46904 $ref: "#/patchDefinitions/tenant"
46907 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
46908 ###### Related Nodes
46909 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
46911 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
46914 - bandwidth-up-wan1
46915 - bandwidth-down-wan1
46916 - bandwidth-up-wan2
46917 - bandwidth-down-wan2
46921 description: Allotted Resource id UUID assigned to this instance.
46924 description: The WAN uplink bandwidth for WAN1
46925 bandwidth-down-wan1:
46927 description: The WAN downlink bandwidth for WAN1
46930 description: The WAN uplink bandwidth for WAN2
46931 bandwidth-down-wan2:
46933 description: The WAN downlink bandwidth for WAN2
46936 This object is used to store the specific tunnel cross connect aspects of an allotted resource
46941 $ref: "#/patchDefinitions/tunnel-xconnect"
46944 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
46953 $ref: "#/patchDefinitions/update-node-key"
46959 $ref: "#/patchDefinitions/action"
46968 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
46969 ###### Related Nodes
46970 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
46971 - TO complex( vce LocatedIn complex, MANY2MANY)
46972 - TO vserver( vce HostedOn vserver, ONE2MANY)
46973 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
46974 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
46976 -(1) IF this VCE node is deleted, this FROM node is DELETED also
46984 description: Unique id of VNF. This is unique across the graph.
46987 description: Name of VNF.
46990 description: Alternate name of VNF.
46993 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
46996 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
46997 regional-resource-zone:
46999 description: Regional way of organizing pservers, source of truth should define values
47002 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47005 description: Indicator for whether the resource is considered operational
47008 description: License key
47011 description: Network role being played by this VNF
47012 orchestration-status:
47014 description: Orchestration status of this VNF, mastered by MSO
47017 description: Heat stack id corresponding to this instance, managed by MSO
47020 description: Corresponds to the SDN-C catalog id used to configure this VCE
47023 description: Unique ID of VPE connected to this VCE.
47024 v6-vce-wan-address:
47026 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
47029 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
47032 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
47037 $ref: "#/patchDefinitions/vce"
47040 a deployment unit of VNFCs
47041 ###### Related Nodes
47042 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
47043 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
47044 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
47045 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
47046 - TO vserver( vf-module Uses vserver, ONE2MANY)
47048 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
47049 -VF-MODULE cannot be deleted if related to VNFC
47053 - is-base-vf-module
47057 description: Unique ID of vf-module.
47060 description: Name of vf-module
47063 description: Heat stack id corresponding to this instance.
47064 orchestration-status:
47066 description: orchestration status of this vf-module, mastered by MSO
47069 description: used to indicate whether or not this object is base vf module
47072 Collection of vf-modules, a deployment unit of VNFCs
47077 $ref: "#/patchDefinitions/vf-module"
47080 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
47081 ###### Related Nodes
47082 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
47084 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
47090 description: indicates whether the VIG is for AVPN or INTERNET
47093 description: v4 IP of the vig server
47096 description: v6 IP of the vig server
47102 $ref: "#/patchDefinitions/vig-server"
47103 vip-ipv4-address-list:
47106 ###### Related Nodes
47107 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
47108 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
47109 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
47110 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
47117 description: IP address
47118 vip-ipv4-prefix-length:
47121 description: Prefix length, 32 for single address
47125 description: Inner VLAN tag
47129 description: Outer VLAN tag
47132 description: Indicator of fixed or floating address
47133 vip-ipv6-address-list:
47136 ###### Related Nodes
47137 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
47138 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
47139 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
47140 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
47147 description: IP address
47148 vip-ipv6-prefix-length:
47151 description: Prefix length, 128 for single address
47155 description: Inner VLAN tag
47159 description: Outer VLAN tag
47162 description: Indicator of fixed or floating address
47163 virtual-data-center:
47165 Virtual organization of cloud infrastructure elements in a data center context
47166 ###### Related Nodes
47167 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
47168 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
47169 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
47177 description: Unique ID of the vdc
47180 description: Name of the virtual data center
47181 virtual-data-centers:
47183 Virtual organization of cloud infrastructure elements in a data center context
47185 virtual-data-center:
47188 $ref: "#/patchDefinitions/virtual-data-center"
47192 ###### Related Nodes
47193 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
47194 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
47195 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
47196 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
47197 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
47198 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
47200 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
47201 -(2) IF this VLAN node is deleted, this TO node is DELETED also
47202 -(4) IF this TO node is deleted, this VLAN is DELETED also
47208 description: String that identifies the interface
47212 description: Inner VLAN tag
47216 description: Outer VLAN tag
47222 $ref: "#/patchDefinitions/vlan"
47231 description: Unique id of VNF. This is unique across the graph.
47234 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
47235 ###### Related Nodes
47236 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
47238 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
47243 - application-vendor
47247 description: Unique ID of this asset
47250 description: The application that the image instantiates.
47251 application-vendor:
47253 description: The vendor of the application.
47254 application-version:
47256 description: The version of the application.
47259 description: URL to endpoint where AAI can get more details
47262 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
47267 $ref: "#/patchDefinitions/vnf-image"
47270 ###### Related Nodes
47271 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
47272 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
47273 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
47275 -(4) IF this TO node is deleted, this VNFC is DELETED also
47278 - vnfc-function-code
47281 - is-closed-loop-disabled
47285 description: Unique ID of vnfc.
47286 vnfc-function-code:
47288 description: function code
47294 description: prov status of this vnfc
47295 orchestration-status:
47297 description: Orchestration status of this VNF, mastered by APP-C
47298 ipaddress-v4-oam-vip:
47300 description: Oam V4 vip address of this vnfc
47303 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
47304 is-closed-loop-disabled:
47306 description: used to indicate whether closed loop function is enabled on this node
47309 description: Group notation of VNFC
47312 virtual network components associated with a vserver from application controller.
47317 $ref: "#/patchDefinitions/vnfc"
47320 Ephemeral Block storage volume.
47321 ###### Related Nodes
47322 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
47324 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
47331 description: Unique ID of block storage volume relative to the vserver.
47334 description: URL to endpoint where AAI can get more details
47337 Persistent block-level storage.
47338 ###### Related Nodes
47339 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
47340 - TO complex( volume-group LocatedIn complex, MANY2ONE)
47341 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
47342 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
47343 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
47347 - volume-group-name
47352 description: Unique ID of volume-group.
47355 description: Name of the volume group.
47358 description: Heat stack id corresponding to this volume-group
47361 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
47362 orchestration-status:
47364 description: Orchestration status of this volume-group
47367 Collection of persistent block-level storage.
47372 $ref: "#/patchDefinitions/volume-group"
47375 Collection of ephemeral Block storage volumes.
47380 $ref: "#/patchDefinitions/volume"
47383 VPLS Provider Edge routers.
47384 ###### Related Nodes
47385 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
47386 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
47387 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
47388 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
47390 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
47398 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
47401 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
47404 description: Client should send valid enumerated value, e.g., VPLS-PE.
47408 description: Temporary location for stag to get to VCE
47411 Collection of VPLS Provider Edge routers
47416 $ref: "#/patchDefinitions/vpls-pe"
47420 ###### Related Nodes
47421 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
47423 -VPN-BINDING cannot be deleted if related to L3-NETWORK
47428 - global-route-target
47432 description: VPN ID, globally unique within A&AI
47435 description: VPN Name
47436 global-route-target:
47438 description: Number used to identify a VPN, globally unique in the network
47441 description: the platform associated with the VPN example AVPN, Mobility
47447 $ref: "#/patchDefinitions/vpn-binding"
47450 Virtual Servers, aka virtual machine or VM.
47451 ###### Related Nodes
47452 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
47453 - TO flavor( vserver Uses flavor, MANY2ONE)
47454 - TO image( vserver Uses image, MANY2ONE)
47455 - TO pserver( vserver HostedOn pserver, MANY2ONE)
47456 - TO snapshot( vserver Uses snapshot, ONE2ONE)
47457 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
47458 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
47459 - FROM vce( vce HostedOn vserver, ONE2MANY)
47460 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
47461 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
47462 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
47464 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
47465 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
47471 - is-closed-loop-disabled
47475 description: Unique identifier for this vserver relative to its tenant
47478 description: Name of vserver
47481 description: Alternative name of vserver
47484 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47487 description: URL to endpoint where AAI can get more details
47490 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
47491 is-closed-loop-disabled:
47493 description: Used to indicate whether closed loop function is enabled on this node
47496 Collection of virtual Servers, aka virtual machines or VMs.
47501 $ref: "#/patchDefinitions/vserver"
47504 A zone is a grouping of assets in a location homing to the same connections into the CBB
47505 ###### Related Nodes
47506 - TO complex( zone LocatedIn complex, MANY2ONE)
47507 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
47508 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
47509 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
47519 description: Code assigned by AIC to the zone
47522 description: English name associated with the zone
47525 description: Design of zone [Medium/Large?]
47528 description: Context of zone [production/test]
47531 description: Status of a zone.
47534 Collection of zones
47539 $ref: "#/patchDefinitions/zone"
47548 $ref: "#/getDefinitions/action-data"
47557 APIs that are more action related than REST (e.g., notify, update).
47561 $ref: "#/getDefinitions/update"
47564 $ref: "#/getDefinitions/notify"
47567 Represents a slice or partial piece of a resource that gets separately allotted
47568 ###### Related Nodes
47569 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
47570 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
47571 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
47572 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
47573 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
47574 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
47575 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
47577 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
47578 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
47584 description: Allotted Resource id UUID assigned to this instance.
47587 description: The descriptive information assigned to this allotted resource instance
47590 description: Link back to more information in the controller
47593 description: the ASDC model id for this resource or service model.
47594 persona-model-version:
47596 description: the ASDC model version for this resource or service model.
47599 description: the ASDC model version for this resource or service model.
47600 persona-model-customization-id:
47602 description: captures the id of all the configuration used to customize the resource for the service.
47605 description: Concurrency value
47609 $ref: "#/getDefinitions/tunnel-xconnect"
47613 $ref: "#/getDefinitions/relationship"
47614 allotted-resources:
47616 This object is used to store slices of services being offered
47621 $ref: "#/getDefinitions/allotted-resource"
47624 Availability zone, a collection of compute hosts/pservers
47625 ###### Related Nodes
47626 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
47627 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
47628 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
47629 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
47630 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
47631 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
47632 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
47633 - FROM vce( vce Uses availability-zone, MANY2MANY)
47635 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
47636 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
47639 - availability-zone-name
47642 availability-zone-name:
47644 description: Name of the availability zone. Unique across a cloud region
47647 description: Type of hypervisor. Source of truth should define valid values.
47650 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
47653 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47657 $ref: "#/getDefinitions/relationship"
47658 availability-zones:
47660 Collection of availability zones
47665 $ref: "#/getDefinitions/availability-zone"
47666 az-and-dvs-switches:
47670 $ref: "#/getDefinitions/dvs-switches"
47673 $ref: "#/getDefinitions/availability-zone"
47676 Namespace for business related constructs
47681 $ref: "#/getDefinitions/connector"
47685 $ref: "#/getDefinitions/customer"
47688 ###### Related Nodes
47689 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
47691 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
47697 description: unique identifier of probe
47700 description: identifier of probe
47703 description: type of probe
47706 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47710 $ref: "#/getDefinitions/relationship"
47711 classes-of-service:
47713 class-of-service of probe
47718 $ref: "#/getDefinitions/class-of-service"
47719 cloud-infrastructure:
47721 Namespace for cloud infrastructure.
47726 $ref: "#/getDefinitions/complex"
47730 $ref: "#/getDefinitions/cloud-region"
47734 $ref: "#/getDefinitions/network-profile"
47738 $ref: "#/getDefinitions/pserver"
47739 virtual-data-centers:
47742 $ref: "#/getDefinitions/virtual-data-center"
47745 cloud-region designates an installation of a cloud cluster or region or instantiation.
47746 ###### Related Nodes
47747 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
47748 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
47749 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
47750 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
47751 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
47752 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
47753 - FROM image( image BelongsTo cloud-region, MANY2ONE)
47754 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
47755 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
47756 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
47757 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
47758 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
47760 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
47761 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
47769 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
47772 description: Identifier used by the vendor for the region. Second part of composite key
47775 description: Type of the cloud (e.g., openstack)
47776 owner-defined-type:
47778 description: Cloud-owner defined type indicator (e.g., DCP, LCP)
47779 cloud-region-version:
47781 description: Software version employed at the site
47784 description: URL of the keystone identity service
47787 description: Zone where the cloud is homed
47790 description: complex name for cloud-region instance
47793 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47797 $ref: "#/getDefinitions/volume-group"
47801 $ref: "#/getDefinitions/tenant"
47805 $ref: "#/getDefinitions/flavor"
47809 $ref: "#/getDefinitions/group-assignment"
47813 $ref: "#/getDefinitions/snapshot"
47817 $ref: "#/getDefinitions/image"
47821 $ref: "#/getDefinitions/dvs-switch"
47825 $ref: "#/getDefinitions/oam-network"
47826 availability-zones:
47829 $ref: "#/getDefinitions/availability-zone"
47833 $ref: "#/getDefinitions/relationship"
47839 $ref: "#/getDefinitions/cloud-region"
47842 Collection of physical locations that can house cloud-regions.
47843 ###### Related Nodes
47844 - TO l3-network( complex Uses l3-network, MANY2MANY)
47845 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
47846 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
47847 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
47848 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
47849 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
47850 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
47851 - FROM vce( vce LocatedIn complex, MANY2MANY)
47852 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
47853 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
47855 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
47856 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
47859 - physical-location-id
47860 - physical-location-type
47867 physical-location-id:
47869 description: Unique identifier for physical location, e.g., CLLI
47872 description: Data center code which can be an alternate way to identify a complex
47875 description: Gamma complex name for LCP instance.
47878 description: URL of the keystone identity service
47881 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47882 physical-location-type:
47884 description: Type, e.g., central office, data center.
47910 $ref: "#/getDefinitions/ctag-pool"
47914 $ref: "#/getDefinitions/relationship"
47917 Collection of physical locations that can house cloud-regions.
47922 $ref: "#/getDefinitions/complex"
47925 Port Mirror Configuration.
47926 ###### Related Nodes
47927 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
47928 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
47929 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
47930 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
47931 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
47933 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
47934 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
47935 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
47938 - configuration-type
47939 - configuration-sub-type
47940 - orchestration-status
47941 - operational-status
47942 - configuration-selflink
47943 - model-customization-id
47947 description: UUID assigned to configuration.
47950 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
47951 configuration-name:
47953 description: Name of the configuration.
47954 configuration-type:
47956 description: port-mirroring-configuration.
47957 configuration-sub-type:
47959 description: vprobe, pprobe.
47960 model-invariant-id:
47962 description: the ASDC model id for this resource or service model.
47965 description: the ASDC model version for this resource or service model.
47966 orchestration-status:
47968 description: Orchestration status of the configuration.
47969 operational-status:
47971 description: Indicator for whether the resource is considered operational.
47972 configuration-selflink:
47974 description: URL to endpoint where AAI can get more details from SDN-GC.
47975 model-customization-id:
47977 description: id of the configuration used to customize the resource
47980 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47984 $ref: "#/getDefinitions/relationship"
47988 $ref: "#/getDefinitions/metadatum"
47991 Collection of configurations
47996 $ref: "#/getDefinitions/configuration"
47999 Collection of resource instances used to connect a variety of disparate inventory widgets
48000 ###### Related Nodes
48001 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
48002 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
48003 - FROM service-instance( service-instance Uses connector, MANY2MANY)
48005 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
48007 - resource-instance-id
48009 resource-instance-id:
48011 description: Unique id of resource instance.
48014 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48017 description: the ASDC model id for this resource or service model.
48018 persona-model-version:
48020 description: the ASDC model version for this resource or service model.
48023 description: the ASDC model version for this resource or service model.
48026 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48027 widget-model-version:
48029 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48033 $ref: "#/getDefinitions/relationship"
48037 $ref: "#/getDefinitions/metadatum"
48040 Collection of resource instances used to connect a variety of disparate inventory widgets
48045 $ref: "#/getDefinitions/connector"
48046 constrained-element-set:
48048 This is how we would capture constraints defining allowed sets of elements.
48049 ###### Related Nodes
48050 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
48051 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
48052 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
48054 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
48055 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
48057 - constrained-element-set-uuid
48061 constrained-element-set-uuid:
48069 element-choice-sets:
48072 $ref: "#/getDefinitions/element-choice-set"
48076 $ref: "#/getDefinitions/relationship"
48077 constrained-element-sets:
48079 constrained-element-set:
48082 $ref: "#/getDefinitions/constrained-element-set"
48085 ###### Related Nodes
48086 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
48088 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
48098 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48102 $ref: "#/getDefinitions/relationship"
48108 $ref: "#/getDefinitions/ctag-assignment"
48111 A collection of C tags (vlan tags) grouped for a specific purpose.
48112 ###### Related Nodes
48113 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
48114 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
48115 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
48117 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
48120 - availability-zone-name
48121 - ctag-pool-purpose
48125 description: The Target provider edge router
48126 availability-zone-name:
48128 description: Name of the availability zone
48131 description: Describes what the intended purpose of this pool is.
48134 description: Comma separated list of ctags
48137 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48141 $ref: "#/getDefinitions/relationship"
48147 $ref: "#/getDefinitions/ctag-pool"
48150 customer identifiers to provide linkage back to BSS information.
48151 ###### Related Nodes
48152 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
48154 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
48156 - global-customer-id
48160 global-customer-id:
48162 description: Global customer id used across ECOMP to uniquely identify customer.
48165 description: Subscriber name, an alternate way to retrieve a customer.
48168 description: Subscriber type, a way to provide VID with only the INFRA customers.
48171 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48172 service-subscriptions:
48175 $ref: "#/getDefinitions/service-subscription"
48179 $ref: "#/getDefinitions/relationship"
48182 Collection of customer identifiers to provide linkage back to BSS information.
48187 $ref: "#/getDefinitions/customer"
48195 description: See mis-na-virtualization-platform.yang
48198 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48202 $ref: "#/getDefinitions/relationship"
48208 $ref: "#/getDefinitions/cvlan-tag-entry"
48211 Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
48212 ###### Related Nodes
48213 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
48214 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
48222 description: DVS switch name
48225 description: URL used to reach the vcenter
48228 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48232 $ref: "#/getDefinitions/relationship"
48235 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
48240 $ref: "#/getDefinitions/dvs-switch"
48243 Internal map to define the properties of an edge and interpret the map EdgeRules
48261 edge-tag-query-request:
48272 $ref: "#/getDefinitions/start-node-filter"
48273 include-node-filter:
48276 $ref: "#/getDefinitions/include-node-filter"
48280 $ref: "#/getDefinitions/secondary-filter"
48281 edge-tag-query-result:
48283 tagged-inventory-item-list:
48286 $ref: "#/getDefinitions/tagged-inventory-item-list"
48287 element-choice-set:
48289 This is how we would capture constraints defining allowed sets of elements.
48290 ###### Related Nodes
48291 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
48292 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
48294 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
48295 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
48297 - element-choice-set-uuid
48298 - element-choice-set-name
48300 element-choice-set-uuid:
48302 element-choice-set-name:
48311 $ref: "#/getDefinitions/model-element"
48315 $ref: "#/getDefinitions/relationship"
48316 element-choice-sets:
48318 element-choice-set:
48321 $ref: "#/getDefinitions/element-choice-set"
48324 Metadata for entitlement group.
48325 ###### Related Nodes
48326 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
48327 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
48329 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
48336 description: Unique ID for the entitlement group the resource comes from, should be uuid.
48339 description: Unique ID of an entitlement resource.
48342 description: Concurrency value
48346 $ref: "#/getDefinitions/relationship"
48349 Entitlements, keyed by group-uuid and resource-uuid, related to license management
48354 $ref: "#/getDefinitions/entitlement"
48357 Persist EMS address information used by EMS driver.
48358 ###### Related Nodes
48359 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
48361 -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
48367 description: Unique ID of EMS.
48370 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48371 esr-system-info-list:
48373 $ref: "#/getDefinitions/esr-system-info-list"
48376 $ref: "#/getDefinitions/relationship-list"
48382 $ref: "#/getDefinitions/esr-ems"
48385 Persist common address information of external systems.
48386 ###### Related Nodes
48387 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
48388 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
48389 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
48390 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
48392 -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
48394 - esr-system-info-id
48399 esr-system-info-id:
48401 description: Unique ID of esr system info.
48404 description: name of external system.
48407 description: type of external systems.
48410 description: vendor of external systems.
48413 description: version of external systems.
48416 description: url used to access external systems.
48419 description: username used to access external systems.
48422 description: password used to access external systems.
48425 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
48428 description: protocol of third party SDNC, for example netconf/snmp.
48431 description: ca file content if enabled ssl on auth-url.
48434 description: Whether to verify VIM's certificate.
48437 description: service IP of ftp server.
48440 description: service port of ftp server.
48443 description: domain info for authentication.
48446 description: default tenant of VIM.
48449 description: ftp passive mode or not.
48452 description: resource or performance data file path.
48455 description: the status of external system.
48458 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48462 $ref: "#/getDefinitions/relationship"
48463 esr-system-info-list:
48465 Collection of persistent block-level external system auth info.
48470 $ref: "#/getDefinitions/esr-system-info"
48471 esr-thirdparty-sdnc:
48473 Persist SDNC address information used by ONAP SDNC.
48474 ###### Related Nodes
48475 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
48476 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
48478 -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
48480 - thirdparty-sdnc-id
48482 thirdparty-sdnc-id:
48484 description: Unique ID of SDNC.
48487 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
48490 description: password used to access SDNC server.
48493 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48494 esr-system-info-list:
48496 $ref: "#/getDefinitions/esr-system-info-list"
48499 $ref: "#/getDefinitions/relationship-list"
48500 esr-thirdparty-sdnc-list:
48502 esr-thirdparty-sdnc:
48505 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
48508 Persist VNFM address information used by VF-C.
48509 ###### Related Nodes
48510 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
48512 -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
48518 description: Unique ID of VNFM.
48521 description: indecate the VIM to deploy VNF.
48524 description: certificate url of VNFM.
48527 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48528 esr-system-info-list:
48530 $ref: "#/getDefinitions/esr-system-info-list"
48533 $ref: "#/getDefinitions/relationship-list"
48539 $ref: "#/getDefinitions/esr-vnfm"
48542 evc object is an optional child object of the Configuration object.
48543 ###### Related Nodes
48544 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
48546 -(4) IF this TO node is deleted, this EVC is DELETED also
48552 description: Unique/key field for the evc object
48553 forwarding-path-topology:
48555 description: Point-to-Point, Multi-Point
48558 description: Commited Information Rate
48561 description: CIR units
48562 connection-diversity-group-id:
48564 description: Diversity Group ID
48567 description: formerly Performance Group
48568 esp-evc-circuit-id:
48570 description: EVC Circuit ID of ESP EVC
48573 description: Committed Information Rate (For ESP)
48576 description: CIR units (For ESP)
48579 description: Identifies ESP
48580 collector-pop-clli:
48582 description: Collector POP CLLI (from the hostname of the access pnf)
48583 inter-connect-type-ingress:
48585 description: Interconnect type on ingress side of EVC.
48586 tagmode-access-ingress:
48588 description: tagode for collector side of EVC
48589 tagmode-access-egress:
48591 description: tagMode for network side of EVC
48595 $ref: "#/getDefinitions/relationship"
48598 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48604 $ref: "#/getDefinitions/evc"
48607 Namespace for external system.
48611 $ref: "#/getDefinitions/esr-ems-list"
48614 $ref: "#/getDefinitions/esr-vnfm-list"
48615 esr-thirdparty-sdnc-list:
48617 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
48620 Extra properties for inventory item for response list
48628 ###### Related Nodes
48629 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
48630 - FROM vserver( vserver Uses flavor, MANY2ONE)
48632 -FLAVOR cannot be deleted if related to VSERVER
48641 description: Flavor id, expected to be unique across cloud-region.
48644 description: Flavor name
48648 description: Number of CPUs
48652 description: Amount of memory
48656 description: Disk space
48660 description: Amount of ephemeral disk space
48663 description: amount of swap space allocation
48666 description: whether flavor is available to all users or private to the tenant it was created in.
48669 description: URL to endpoint where AAI can get more details
48672 description: Boolean as to whether this flavor is no longer enabled
48675 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48679 $ref: "#/getDefinitions/relationship"
48682 Collection of openstack flavors.
48687 $ref: "#/getDefinitions/flavor"
48690 Entity describing a sequenced segment of forwarding path
48691 ###### Related Nodes
48692 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
48693 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
48694 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
48695 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
48696 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
48698 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
48699 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
48706 description: Unique ID of this segmentation
48709 description: ingress, intermediate, egress
48713 $ref: "#/getDefinitions/relationship"
48716 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48719 forwarder object is an optional child object of the Configuration object.
48720 ###### Related Nodes
48721 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
48723 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
48729 description: Key for forwarder-evc object
48732 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
48735 description: Internal VLAN.
48738 description: SVLAN value for ingress of egress forwarder.
48741 description: CVLAN value for ingress of egress forwarder.
48745 $ref: "#/getDefinitions/relationship"
48748 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48754 $ref: "#/getDefinitions/forwarder-evc"
48760 $ref: "#/getDefinitions/forwarder"
48763 Entity that describes the sequenced forwarding path between interfaces of services or resources
48764 ###### Related Nodes
48765 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
48766 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
48767 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
48769 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
48770 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
48771 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
48773 - forwarding-path-id
48774 - forwarding-path-name
48776 forwarding-path-id:
48778 description: Unique ID of this FP
48779 forwarding-path-name:
48781 description: Name of the FP
48785 $ref: "#/getDefinitions/relationship"
48788 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48791 description: the self link for this FP
48795 $ref: "#/getDefinitions/forwarder"
48801 $ref: "#/getDefinitions/forwarding-path"
48804 General purpose VNF
48805 ###### Related Nodes
48806 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
48807 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
48808 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
48809 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
48810 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
48811 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
48812 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
48813 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
48814 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
48815 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
48816 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
48817 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
48818 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
48819 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
48820 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
48821 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
48822 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
48824 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
48830 - is-closed-loop-disabled
48834 description: Unique id of VNF. This is unique across the graph.
48837 description: Name of VNF.
48840 description: Alternate name of VNF.
48843 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
48846 description: Unique identifier of service from ASDC
48847 regional-resource-zone:
48849 description: Regional way of organizing pservers, source of truth should define values
48852 description: Trigger for operational monitoring of this resource by Service Assurance systems.
48855 description: Indicator for whether the resource is considered operational
48858 description: License key
48861 description: Client should send valid enumerated value
48862 orchestration-status:
48864 description: Orchestration status of this VNF, used by MSO.
48867 description: Heat stack id corresponding to this instance, managed by MSO
48870 description: Corresponds to the SDN-C catalog id used to configure this VCE
48873 description: identifier of managed by company or customer
48876 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
48877 ipv4-loopback0-address:
48879 description: v4 Loopback0 address
48882 description: v6 Loopback address
48883 management-v6-address:
48885 description: v6 management address
48889 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
48892 description: units associated with vcpu, used for VNFs with no vservers/flavors
48896 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
48899 description: units associated with vmemory, used for VNFs with no vservers/flavors
48903 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
48906 description: units associated with vdisk, used for VNFs with no vservers/flavors
48909 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
48910 is-closed-loop-disabled:
48912 description: used to indicate whether closed loop function is enabled on this node
48915 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48918 description: details regarding the generic-vnf operation
48919 encrypted-access-flag:
48921 description: indicates whether generic-vnf access uses SSH
48924 description: the ASDC model id for this resource or service model.
48925 persona-model-version:
48927 description: the ASDC model version for this resource or service model.
48930 description: the ASDC model version for this resource or service model.
48933 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48934 widget-model-version:
48936 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48939 description: as-number of the VNF
48940 regional-resource-subzone:
48942 description: represents sub zone of the rr plane
48946 $ref: "#/getDefinitions/relationship"
48950 $ref: "#/getDefinitions/l-interface"
48954 $ref: "#/getDefinitions/lag-interface"
48958 $ref: "#/getDefinitions/vf-module"
48966 $ref: "#/getDefinitions/generic-vnf"
48969 Openstack group-assignment used to store exclusivity groups (EG).
48970 ###### Related Nodes
48971 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
48972 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
48973 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
48982 description: Group id, expected to be unique across cloud-region.
48985 description: Group type - the type of group this instance refers to
48988 description: Group name - name assigned to the group
48991 description: Group description - description of the group
48994 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48998 $ref: "#/getDefinitions/relationship"
49001 Collection of openstack group assignments
49006 $ref: "#/getDefinitions/group-assignment"
49009 ###### Related Nodes
49010 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
49012 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
49020 description: host-route id
49023 description: subnet prefix
49026 description: Could be ip-address, hostname, or service-instance
49029 description: Should be ip-address, hostname, or service-instance to match next-hop
49032 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49036 $ref: "#/getDefinitions/relationship"
49042 $ref: "#/getDefinitions/host-route"
49045 Collection of HPA Capabilities
49050 $ref: "#/getDefinitions/hpa-capability"
49053 Represents a HPA capability
49054 ###### Related Nodes
49055 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
49056 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
49057 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
49059 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
49061 - hpa-capability-id
49066 description: UUID to uniquely identify a HPA capability
49069 description: Name of the HPACapability
49072 description: HPA schema version
49075 description: Hardware architecture
49078 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49082 $ref: "#/getDefinitions/relationship"
49083 hpa-feature-attributes:
49086 $ref: "#/getDefinitions/hpa-feature-attributes"
49087 hpa-feature-attributes:
49089 HPA Capability Feature attributes
49090 ###### Related Nodes
49091 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
49093 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
49095 - hpa-attribute-key
49099 description: name of the specific HPA attribute
49100 hpa-attribute-value:
49102 description: JSON string specifying the value, unit and type of the specific HPA attribute
49105 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49109 $ref: "#/getDefinitions/relationship"
49113 ###### Related Nodes
49114 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
49115 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
49116 - FROM vserver( vserver Uses image, MANY2ONE)
49118 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
49119 -IMAGE cannot be deleted if related to VSERVER
49130 description: Image id, expected to be unique across cloud region
49133 description: Image name
49134 image-architecture:
49136 description: Operating system architecture.
49139 description: The common name of the operating system distribution in lowercase
49142 description: The operating system version as specified by the distributor.
49145 description: The application that the image instantiates.
49146 application-vendor:
49148 description: The vendor of the application.
49149 application-version:
49151 description: The version of the application.
49154 description: URL to endpoint where AAI can get more details
49157 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49161 $ref: "#/getDefinitions/relationship"
49165 $ref: "#/getDefinitions/metadatum"
49168 Collectio of Openstack images.
49173 $ref: "#/getDefinitions/image"
49174 include-node-filter:
49180 InstanceFilter for performing a named-query or model query
49183 InstanceFilters for performing a named-query or model query
49188 $ref: "#/getDefinitions/instance-filter"
49191 General mechanism for grouping instances
49192 ###### Related Nodes
49193 - TO model( instance-group Targets model, MANY2MANY)
49194 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
49195 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
49196 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
49197 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
49206 description: Instance Group ID, UUID assigned to this instance.
49209 description: Descriptive text to help identify the usage of this instance-group
49212 description: Only valid value today is lower case ha for high availability
49215 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
49218 description: Concurrency value
49222 $ref: "#/getDefinitions/relationship"
49225 Collection of openstack route table references
49230 $ref: "#/getDefinitions/instance-group"
49235 $ref: "#/getDefinitions/search"
49238 $ref: "#/getDefinitions/actions"
49239 cloud-infrastructure:
49241 $ref: "#/getDefinitions/cloud-infrastructure"
49244 $ref: "#/getDefinitions/business"
49245 service-design-and-creation:
49247 $ref: "#/getDefinitions/service-design-and-creation"
49250 $ref: "#/getDefinitions/network"
49253 inventory-item-type:
49255 inventory-item-link:
49257 inventory-item-data:
49260 $ref: "#/getDefinitions/inventory-item-data"
49261 tagged-inventory-item-list:
49264 $ref: "#/getDefinitions/tagged-inventory-item-list"
49265 inventory-item-data:
49271 inventory-response-item:
49273 Inventory item for response list
49279 $ref: "#/getDefinitions/extra-properties"
49280 inventory-response-items:
49282 $ref: "#/getDefinitions/inventory-response-items"
49283 inventory-response-items:
49285 Container for inventory items in response list
49287 inventory-response-item:
49290 $ref: "#/getDefinitions/inventory-response-item"
49291 ipsec-configuration:
49293 IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
49294 ###### Related Nodes
49295 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
49296 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
49298 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
49300 - ipsec-configuration-id
49302 ipsec-configuration-id:
49304 description: UUID of this configuration
49305 requested-vig-address-type:
49307 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
49308 requested-encryption-strength:
49310 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
49311 requested-dmz-type:
49313 description: can offer a shared DMZ or a DMZ specific to a customer
49314 shared-dmz-network-address:
49316 description: Network address of shared DMZ
49317 requested-customer-name:
49319 description: If the DMZ is a custom DMZ, this field will indicate the customer information
49322 description: can be 1 or 2
49323 ikev1-authentication:
49325 description: Contains values like md5, sha1, sha256, sha384
49328 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49331 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
49334 description: Group name defined in VIG for clients using aggressive mode
49337 description: pre-shared key for the above group name
49340 description: Lifetime for IKEv1 SA
49341 ipsec-authentication:
49343 description: md5, sha1, sha256, sha384
49346 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49349 description: Life time for IPSec SA
49352 description: enable PFS or not
49355 description: user ID for xAuth, sm-user, ,nmteHostName
49356 xauth-user-password:
49358 description: Encrypted using the Juniper $9$ algorithm
49361 description: The time between DPD probe
49364 description: Maximum number of DPD before claiming the tunnel is down
49367 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49371 $ref: "#/getDefinitions/relationship"
49375 $ref: "#/getDefinitions/vig-server"
49376 ipsec-configurations:
49378 ipsec-configuration:
49381 $ref: "#/getDefinitions/ipsec-configuration"
49390 Logical interfaces, e.g., a vnic.
49391 ###### Related Nodes
49392 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
49393 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
49394 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
49395 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
49396 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
49397 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
49398 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
49399 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
49400 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
49401 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
49403 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
49404 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
49405 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
49411 description: Name given to the interface
49414 description: E.g., CUSTOMER, UPLINK, etc.
49417 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
49420 description: URL to endpoint where AAI can get more details
49423 description: ID of interface
49426 description: MAC address for the interface
49429 description: Name of the network
49432 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
49435 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49439 $ref: "#/getDefinitions/vlan"
49443 $ref: "#/getDefinitions/sriov-vf"
49447 $ref: "#/getDefinitions/relationship"
49448 l3-interface-ipv4-address-list:
49451 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
49452 l3-interface-ipv6-address-list:
49455 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
49458 Collection of logical interfaces.
49463 $ref: "#/getDefinitions/l-interface"
49464 l3-interface-ipv4-address-list:
49467 ###### Related Nodes
49468 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49469 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
49470 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
49471 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
49473 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
49475 - l3-interface-ipv4-address
49477 l3-interface-ipv4-address:
49479 description: IP address
49480 l3-interface-ipv4-prefix-length:
49483 description: Prefix length, 32 for single address
49487 description: Inner VLAN tag
49491 description: Outer VLAN tag
49494 description: Indicator of fixed or floating address
49497 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49498 neutron-network-id:
49500 description: Neutron network id of the interface that address belongs to
49503 description: Neutron id of subnet that address belongs to
49507 $ref: "#/getDefinitions/relationship"
49508 l3-interface-ipv6-address-list:
49511 ###### Related Nodes
49512 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49513 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
49514 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
49515 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
49517 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
49519 - l3-interface-ipv6-address
49521 l3-interface-ipv6-address:
49523 description: IP address
49524 l3-interface-ipv6-prefix-length:
49527 description: Prefix length, 128 for single address
49531 description: Inner VLAN tag
49535 description: Outer VLAN tag
49538 description: Indicator of fixed or floating address
49541 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49542 neutron-network-id:
49544 description: Neutron network id of the interface that address belongs to
49547 description: Neutron id of subnet that address belongs to
49551 $ref: "#/getDefinitions/relationship"
49554 Generic network definition
49555 ###### Related Nodes
49556 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
49557 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
49558 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
49559 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
49560 - FROM complex( complex Uses l3-network, MANY2MANY)
49561 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
49562 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49563 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49564 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
49565 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
49566 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
49567 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
49568 - FROM tenant( tenant Uses l3-network, MANY2MANY)
49569 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
49571 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
49576 - is-provider-network
49577 - is-shared-network
49578 - is-external-network
49582 description: Network ID, should be uuid. Unique across A&AI.
49585 description: Name of the network, governed by some naming convention..
49588 description: Type of the network - who defines these values?
49591 description: Role the network plans - who defines these values?
49592 network-technology:
49594 description: Network technology - who defines these values?
49595 neutron-network-id:
49597 description: Neutron network id of this Interface
49600 description: Set to true if bound to VPN
49603 description: Unique identifier of service from ASDC
49604 network-role-instance:
49607 description: network role instance
49610 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49611 orchestration-status:
49613 description: Orchestration status of this VNF, mastered by MSO
49616 description: Heat stack id corresponding to this instance, managed by MSO
49619 description: Corresponds to the SDN-C catalog id used to configure this VCE
49620 contrail-network-fqdn:
49622 description: Contrail FQDN for the network
49625 description: the ASDC model id for this resource or service model.
49626 persona-model-version:
49628 description: the ASDC model version for this resource or service model.
49631 description: the ASDC model version for this resource or service model.
49634 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49635 widget-model-version:
49637 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49638 physical-network-name:
49640 description: Name associated with the physical network.
49641 is-provider-network:
49643 description: boolean indicatating whether or not network is a provider network.
49646 description: boolean indicatating whether or not network is a shared network.
49647 is-external-network:
49649 description: boolean indicatating whether or not network is an external network.
49653 $ref: "#/getDefinitions/subnet"
49657 $ref: "#/getDefinitions/ctag-assignment"
49658 segmentation-assignments:
49661 $ref: "#/getDefinitions/segmentation-assignment"
49665 $ref: "#/getDefinitions/relationship"
49666 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
49672 $ref: "#/getDefinitions/l3-network"
49675 Link aggregate interface
49676 ###### Related Nodes
49677 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
49678 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
49679 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
49680 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
49681 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
49682 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
49683 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
49685 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
49686 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
49687 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
49693 description: Name that identifies the link aggregate interface
49696 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49699 description: Captures the numeric part of the speed
49702 description: Captures the units corresponding to the speed
49706 $ref: "#/getDefinitions/relationship"
49710 $ref: "#/getDefinitions/l-interface"
49713 Collection of link aggregate interfaces.
49718 $ref: "#/getDefinitions/lag-interface"
49721 LAG links can connect lag-interfaces
49722 ###### Related Nodes
49723 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
49724 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
49726 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
49732 description: Alphabetical concatenation of lag-interface names
49735 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49739 $ref: "#/getDefinitions/relationship"
49742 Collection of link aggregation connections
49747 $ref: "#/getDefinitions/lag-link"
49750 Metadata for license group.
49751 ###### Related Nodes
49752 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
49753 - TO vce( license BelongsTo vce, MANY2ONE)(4)
49755 -(4) IF this TO node is deleted, this LICENSE is DELETED also
49762 description: Unique ID for the license group the resource belongs to, should be uuid.
49765 description: Unique ID of a license resource.
49768 description: Concurrency value
49772 $ref: "#/getDefinitions/relationship"
49775 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
49780 $ref: "#/getDefinitions/license"
49783 describes a line-of-business
49784 ###### Related Nodes
49785 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
49788 - line-of-business-name
49790 line-of-business-name:
49792 description: Name of the line-of-business (product)
49795 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49799 $ref: "#/getDefinitions/relationship"
49802 Collection of lines-of-business
49807 $ref: "#/getDefinitions/line-of-business"
49810 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
49811 ###### Related Nodes
49812 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
49813 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
49814 - TO logical-link( logical-link Uses logical-link, ONE2MANY)
49815 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
49816 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
49817 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
49818 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
49819 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
49820 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
49821 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
49822 - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
49824 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
49831 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
49834 description: Type of logical link, e.g., evc
49837 description: Captures the numeric part of the speed
49840 description: Captures the units corresponding to the speed
49843 description: v4, v6, or ds for dual stack
49846 description: For example, static or BGP
49849 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49852 description: the ASDC model id for this resource or service model.
49853 persona-model-version:
49855 description: the ASDC model version for this resource or service model.
49858 description: the ASDC model version for this resource or service model.
49861 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49862 widget-model-version:
49864 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49865 operational-status:
49867 description: Indication of operational status of the logical link.
49870 description: Indication of the network use of the logical link.
49873 description: Alias or alternate name (CLCI or D1 name).
49876 description: UUID of the logical-link, SDNC generates this.
49880 $ref: "#/getDefinitions/relationship"
49883 Collection of logical connections
49888 $ref: "#/getDefinitions/logical-link"
49891 Collection of metadatum (key/value pairs)
49896 $ref: "#/getDefinitions/metadatum"
49900 ###### Related Nodes
49901 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
49902 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
49903 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
49904 - TO model( metadatum BelongsTo model, MANY2ONE)(4)
49906 -(4) IF this TO node is deleted, this METADATUM is DELETED also
49917 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49920 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
49921 ###### Related Nodes
49922 - TO model( model-element isA model, MANY2ONE)
49923 - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)(2)
49924 - FROM named-query( named-query AppliesTo model, ONE2MANY)
49925 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
49926 - FROM model-element( model-element isA model, MANY2ONE)
49927 - FROM metadatum( metadatum BelongsTo model, MANY2ONE)(1)
49929 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
49930 -(2) IF this MODEL node is deleted, this TO node is DELETED also
49931 -MODEL cannot be deleted if related to NAMED-QUERY,NAMED-QUERY-ELEMENT
49934 - model-name-version-id
49940 model-name-version-id:
49942 description: Unique identifier corresponding to one version of a model in ASDC
49945 description: Type of the model, e.g., service, resource, widget, etc.
49948 description: Name of the model, which can change from version to version.
49951 description: Invariant unique ID which does not change from version to version
49954 description: Version
49957 description: Description
49960 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49964 $ref: "#/getDefinitions/model-element"
49968 $ref: "#/getDefinitions/metadatum"
49972 $ref: "#/getDefinitions/relationship"
49973 model-and-named-query-search:
49975 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
49979 $ref: "#/getDefinitions/query-parameters"
49982 $ref: "#/getDefinitions/instance-filters"
49987 This is how we would capture constraints defining allowed sets of elements.
49988 ###### Related Nodes
49989 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
49990 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
49992 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
49993 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
49995 - model-constraint-uuid
49996 - constrained-element-set-uuid-to-replace
49998 model-constraint-uuid:
50000 constrained-element-set-uuid-to-replace:
50002 constrained-element-sets:
50005 $ref: "#/getDefinitions/constrained-element-set"
50011 $ref: "#/getDefinitions/model-constraint"
50014 Defines how other models combine to make up a higher-level model.
50015 ###### Related Nodes
50016 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
50017 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
50018 - TO model( model-element isA model, MANY2ONE)
50019 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
50020 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
50021 - FROM model (PARENT of model-element, model startsWith model-element)(3)
50022 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
50024 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
50025 -(3) IF this FROM node is deleted, this MODEL-ELEMENT is DELETED also
50026 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
50028 - model-element-uuid
50029 - new-data-del-flag
50032 model-element-uuid:
50036 description: Indicates whether this element was created as part of instantiation from this model
50039 description: How many of this type of element are required/allowed
50044 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50048 $ref: "#/getDefinitions/model-element"
50049 description: Defines how other models combine to make up a higher-level model
50053 $ref: "#/getDefinitions/model-constraint"
50054 description: Describes new constraints on this model element that are not part of that model's definition
50058 $ref: "#/getDefinitions/relationship"
50064 $ref: "#/getDefinitions/model-element"
50067 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
50068 ###### Related Nodes
50069 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
50070 - FROM model-element( model-element IsA model-ver, MANY2ONE)
50071 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
50072 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
50074 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
50075 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
50076 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
50085 description: Unique identifier corresponding to one version of a model in ASDC
50088 description: Name of the model, which can change from version to version.
50091 description: Version
50094 description: Description
50097 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50101 $ref: "#/getDefinitions/model-element"
50105 $ref: "#/getDefinitions/metadatum"
50109 $ref: "#/getDefinitions/relationship"
50115 $ref: "#/getDefinitions/model-ver"
50118 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
50123 $ref: "#/getDefinitions/model"
50124 multicast-configuration:
50126 ###### Related Nodes
50127 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
50130 - multicast-configuration-id
50131 - multicast-protocol
50134 multicast-configuration-id:
50136 description: Unique id of multicast configuration.
50137 multicast-protocol:
50139 description: protocol of multicast configuration
50142 description: rp type of multicast configuration
50145 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50149 $ref: "#/getDefinitions/relationship"
50150 multicast-configurations:
50152 multicast configuration of generic-vnf ip-address
50154 multicast-configuration:
50157 $ref: "#/getDefinitions/multicast-configuration"
50163 $ref: "#/getDefinitions/named-query"
50167 ###### Related Nodes
50168 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
50169 - TO model( named-query AppliesTo model, ONE2MANY)
50170 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
50172 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
50176 - named-query-version
50182 named-query-version:
50184 required-input-param:
50190 named-query-elements:
50193 $ref: "#/getDefinitions/named-query-element"
50197 $ref: "#/getDefinitions/relationship"
50198 named-query-element:
50201 ###### Related Nodes
50202 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
50203 - TO model( named-query-element IsA model, MANY2ONE)
50204 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
50205 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
50206 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
50207 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
50209 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
50210 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
50212 - named-query-element-uuid
50214 named-query-element-uuid:
50216 property-collect-list:
50220 property-limit-desc:
50224 named-query-elements:
50227 $ref: "#/getDefinitions/named-query-element"
50231 $ref: "#/getDefinitions/related-lookup"
50232 property-constraints:
50235 $ref: "#/getDefinitions/property-constraint"
50239 $ref: "#/getDefinitions/relationship"
50240 named-query-elements:
50242 named-query-element:
50245 $ref: "#/getDefinitions/named-query-element"
50248 Namespace for network inventory resources.
50253 $ref: "#/getDefinitions/logical-link"
50257 $ref: "#/getDefinitions/site-pair-set"
50261 $ref: "#/getDefinitions/vpn-binding"
50265 $ref: "#/getDefinitions/vpls-pe"
50266 multicast-configurations:
50269 $ref: "#/getDefinitions/multicast-configuration"
50273 $ref: "#/getDefinitions/vce"
50277 $ref: "#/getDefinitions/vnfc"
50281 $ref: "#/getDefinitions/l3-network"
50285 $ref: "#/getDefinitions/network-policy"
50289 $ref: "#/getDefinitions/generic-vnf"
50293 $ref: "#/getDefinitions/lag-link"
50297 $ref: "#/getDefinitions/newvce"
50301 $ref: "#/getDefinitions/pnf"
50305 $ref: "#/getDefinitions/physical-link"
50306 ipsec-configurations:
50309 $ref: "#/getDefinitions/ipsec-configuration"
50310 route-table-references:
50313 $ref: "#/getDefinitions/route-table-reference"
50319 $ref: "#/getDefinitions/network-policy"
50322 ###### Related Nodes
50323 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
50326 - network-policy-id
50330 description: UUID representing unique key to this instance
50331 network-policy-fqdn:
50333 description: Contrail FQDN for the policy
50336 description: ID for the openStack Heat instance
50339 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50343 $ref: "#/getDefinitions/relationship"
50346 Network profile populated by SDN-GP for SNMP
50347 ###### Related Nodes
50348 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
50355 description: Unique name of network profile.
50358 description: Encrypted SNMP community string
50361 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50365 $ref: "#/getDefinitions/relationship"
50368 Collection of network profiles
50373 $ref: "#/getDefinitions/network-profile"
50376 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
50377 ###### Related Nodes
50378 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
50380 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
50388 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
50391 description: Name of VNF.
50394 description: Alternate name of VNF.
50397 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
50400 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50403 description: Indicator for whether the resource is considered operational
50406 description: License key
50409 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
50412 description: Client should send valid enumerated value.
50415 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50416 ipv4-loopback0-address:
50418 description: v4 Loopback0 address
50419 orchestration-status:
50421 description: Orchestration status of this VNF, mastered by MSO.
50424 description: Heat stack id corresponding to this instance, managed by MSO
50427 description: Corresponds to the SDN-C catalog id used to configure this VCE
50431 $ref: "#/getDefinitions/relationship"
50435 $ref: "#/getDefinitions/l-interface"
50438 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
50443 $ref: "#/getDefinitions/newvce"
50446 inventory-item-data:
50449 $ref: "#/getDefinitions/inventory-item-data"
50450 notification-event:
50454 notification-event-header:
50456 $ref: "#/getDefinitions/notification-event-header"
50457 notification-event-header:
50498 $ref: "#/getDefinitions/key-data"
50503 OAM network, to be deprecated shortly. Do not use for new purposes.
50504 ###### Related Nodes
50505 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
50506 - TO complex( oam-network AppliesTo complex, MANY2MANY)
50507 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
50516 description: UUID of the network. Unique across a cloud-region
50519 description: Name of the network.
50523 description: cvlan-id
50524 ipv4-oam-gateway-address:
50526 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50527 ipv4-oam-gateway-address-prefix-length:
50530 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50533 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50537 $ref: "#/getDefinitions/relationship"
50540 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
50545 $ref: "#/getDefinitions/oam-network"
50546 operational-environment:
50548 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50549 ###### Related Nodes
50550 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50551 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50554 - operational-environment-id
50555 - operational-environment-name
50556 - operational-environment-type
50557 - operational-environment-status
50561 operational-environment-id:
50563 description: UUID of an operational environment
50564 operational-environment-name:
50566 description: Operational Environment name
50567 operational-environment-type:
50569 description: Operational Environment Type.
50570 operational-environment-status:
50572 description: Status
50575 description: Tenant Context.
50578 description: Workload Context.
50581 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50585 $ref: "#/getDefinitions/relationship"
50586 operational-environments:
50588 a logical partition of the cloud which allows to have multiple environments in the production AIC.
50590 operational-environment:
50593 $ref: "#/getDefinitions/operational-environment"
50596 Allows for legacy POST of old-style and new-style models
50598 - model-invariant-id
50599 - model-name-version-id
50605 model-invariant-id:
50607 description: Unique identifier corresponding to the main definition of a model in ASDC
50608 model-name-version-id:
50610 description: Unique identifier corresponding to one version of a model in ASDC
50613 description: Type of the model, e.g., service, resource, widget, etc.
50616 description: Name of the model, which can change from version to version.
50619 description: Invariant unique ID which does not change from version to version
50622 description: Version
50625 description: Description
50628 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50631 $ref: "#/getDefinitions/model-vers"
50634 $ref: "#/getDefinitions/relationship-list"
50637 Collection of owning-entities
50642 $ref: "#/getDefinitions/owning-entity"
50645 describes an owning-entity
50646 ###### Related Nodes
50647 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
50651 - owning-entity-name
50655 description: UUID of an owning entity
50656 owning-entity-name:
50658 description: Owning entity name
50661 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50665 $ref: "#/getDefinitions/relationship"
50668 Physical interface (e.g., nic)
50669 ###### Related Nodes
50670 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
50671 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
50672 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
50673 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
50674 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
50675 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
50676 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
50678 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
50679 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
50680 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
50686 description: Name that identifies the physical interface
50689 description: Captures the numeric part of the speed
50692 description: Captures the units corresponding to the speed
50695 description: Nature of the services and connectivity on this port.
50696 equipment-identifier:
50698 description: CLEI or other specification for p-interface hardware.
50701 description: Role specification for p-interface hardware.
50704 description: Indicates the physical properties of the interface.
50707 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50711 $ref: "#/getDefinitions/relationship"
50715 $ref: "#/getDefinitions/l-interface"
50718 Collection of physical interfaces.
50723 $ref: "#/getDefinitions/p-interface"
50726 Collection of physical connections, typically between p-interfaces
50727 ###### Related Nodes
50728 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
50730 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
50736 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50739 description: Captures the numeric part of the speed
50742 description: Captures the units corresponding to the speed
50745 description: Circuit it
50748 description: Dual access mode (e.g., primary, secondary
50751 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50752 service-provider-name:
50754 description: Name of the service Provider on this link.
50757 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50761 $ref: "#/getDefinitions/relationship"
50764 Collection of physical connections, typically between p-interfaces
50769 $ref: "#/getDefinitions/physical-link"
50772 describes a platform
50773 ###### Related Nodes
50774 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
50781 description: Name of the platform
50784 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50788 $ref: "#/getDefinitions/relationship"
50791 Collection of platforms
50796 $ref: "#/getDefinitions/platform"
50799 PNF represents a physical network function. typically equipment used in the D1 world.
50800 ###### Related Nodes
50801 - TO complex( pnf LocatedIn complex, MANY2ONE)
50802 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
50803 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
50804 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
50806 -(1) IF this PNF node is deleted, this FROM node is DELETED also
50813 description: unique name of Physical Network Function.
50816 description: name of Physical Network Function.
50819 description: source of name2
50822 description: id of pnf
50825 description: Equipment type. Source of truth should define valid values.
50828 description: Equipment vendor. Source of truth should define valid values.
50831 description: Equipment model. Source of truth should define valid values.
50834 description: identifier of managed by company or customer
50837 description: ipv4-oam-address with new naming convention for IP addresses
50840 description: sw-version is the version of SW for the hosted application on the PNF.
50841 orchestration-status:
50843 description: orchestration-status is the status of orchestration on the PNF.
50846 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
50849 description: ID of the physical frame (relay rack) where pnf is installed.
50852 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50856 $ref: "#/getDefinitions/relationship"
50860 $ref: "#/getDefinitions/p-interface"
50864 $ref: "#/getDefinitions/lag-interface"
50867 Collection of Physical Network Functions.
50872 $ref: "#/getDefinitions/pnf"
50875 Used to capture the network interfaces of this VCE
50876 ###### Related Nodes
50877 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
50878 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
50880 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
50881 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
50884 - orchestration-status
50888 description: Unique ID of the interface
50889 neutron-network-id:
50891 description: Neutron network id of this Interface
50892 neutron-network-name:
50894 description: Neutron network name of this Interface
50897 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50900 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50903 description: Unique ID for port group in vmware
50906 description: Likely to duplicate value of neutron network name
50909 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
50910 orchestration-status:
50912 description: Orchestration status of this VNF, mastered by MSO
50915 description: Heat stack id corresponding to this instance, managed by MSO
50918 description: Corresponds to the SDN-C catalog id used to configure this VCE
50922 $ref: "#/getDefinitions/cvlan-tag-entry"
50926 $ref: "#/getDefinitions/relationship"
50932 $ref: "#/getDefinitions/port-group"
50935 describes the project
50936 ###### Related Nodes
50937 - TO service-instance( project Uses service-instance, ONE2MANY)
50944 description: Name of the project deploying a service
50947 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50951 $ref: "#/getDefinitions/relationship"
50954 Collection of projects
50959 $ref: "#/getDefinitions/project"
50962 Property holder for query properties or instance properties
50968 property-constraint:
50971 ###### Related Nodes
50972 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
50974 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
50976 - property-constraint-uuid
50981 property-constraint-uuid:
50991 property-constraints:
50993 property-constraint:
50996 $ref: "#/getDefinitions/property-constraint"
50999 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
51000 ###### Related Nodes
51001 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
51002 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
51003 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
51004 - TO complex( pserver LocatedIn complex, MANY2ONE)
51005 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
51006 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
51007 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
51008 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
51009 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
51011 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
51012 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
51020 description: Value from executing hostname on the compute node.
51023 description: PTNII name
51027 description: Number of cpus
51031 description: Disk size, in GBs
51035 description: RAM size, in MBs
51038 description: Equipment type. Source of truth should define valid values.
51041 description: Equipment vendor. Source of truth should define valid values.
51044 description: Equipment model. Source of truth should define valid values.
51047 description: Fully-qualified domain name
51050 description: URL to endpoint where AAI can get more details
51053 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
51056 description: Serial number, may be queried
51059 description: ID of Pserver
51062 description: internet topology of Pserver
51065 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
51068 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51071 description: alternative pserver name
51074 description: purpose of pserver
51078 $ref: "#/getDefinitions/relationship"
51082 $ref: "#/getDefinitions/p-interface"
51086 $ref: "#/getDefinitions/lag-interface"
51089 Collection of compute hosts.
51094 $ref: "#/getDefinitions/pserver"
51097 QueryParameters for performing a named-query or model query
51101 $ref: "#/getDefinitions/named-query"
51104 $ref: "#/getDefinitions/model"
51108 ###### Related Nodes
51109 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
51111 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
51113 - related-lookup-uuid
51115 - source-node-property
51117 - target-node-property
51119 related-lookup-uuid:
51123 source-node-property:
51127 target-node-property:
51129 property-collect-list:
51136 $ref: "#/getDefinitions/relationship"
51142 $ref: "#/getDefinitions/related-lookup"
51143 related-to-property:
51147 description: Key part of a key/value pair
51150 description: Value part of a key/value pair
51155 description: A keyword provided by A&AI to indicate type of node.
51158 description: URL to the object in A&AI.
51162 $ref: "#/getDefinitions/relationship-data"
51163 related-to-property:
51166 $ref: "#/getDefinitions/related-to-property"
51170 - relationship-value
51174 description: A keyword provided by A&AI to indicate an attribute.
51175 relationship-value:
51177 description: Value of the attribute.
51183 $ref: "#/getDefinitions/relationship"
51184 reserved-prop-names:
51186 Internal map to define some reserved properties of a vertex
51188 last-mod-source-of-truth:
51204 Response container for the results of a named-query or model query
51206 inventory-response-items:
51208 $ref: "#/getDefinitions/inventory-response-items"
51213 description: The specific type of node in the A&AI graph
51216 description: The URL to the specific resource
51217 route-table-reference:
51219 Openstack route table reference.
51220 ###### Related Nodes
51221 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
51224 - route-table-reference-id
51225 - route-table-reference-fqdn
51227 route-table-reference-id:
51229 description: Route Table Reference id, UUID assigned to this instance.
51230 route-table-reference-fqdn:
51232 description: FQDN entry in the route table.
51235 description: Concurrency value
51239 $ref: "#/getDefinitions/relationship"
51240 route-table-references:
51242 Collection of openstack route table references
51244 route-table-reference:
51247 $ref: "#/getDefinitions/route-table-reference"
51250 Route target information
51251 ###### Related Nodes
51252 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
51254 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
51256 - global-route-target
51257 - route-target-role
51259 global-route-target:
51261 description: Number used to identify an RT, globally unique in the network
51264 description: Role assigned to this route target
51267 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51271 $ref: "#/getDefinitions/relationship"
51274 Collection of route target information
51279 $ref: "#/getDefinitions/route-target"
51282 ###### Related Nodes
51283 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
51284 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
51286 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
51287 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
51289 - routing-instance-id
51291 routing-instance-id:
51293 description: Unique id of routing instance
51296 description: rpm owner
51299 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51303 $ref: "#/getDefinitions/site-pair"
51307 $ref: "#/getDefinitions/relationship"
51310 set of probes related to generic-vnf routing instance
51315 $ref: "#/getDefinitions/routing-instance"
51320 $ref: "#/getDefinitions/oam-networks"
51321 az-and-dvs-switches:
51324 $ref: "#/getDefinitions/az-and-dvs-switches"
51327 edge-tag-query-result:
51329 $ref: "#/getDefinitions/edge-tag-query-result"
51330 edge-tag-query-request:
51332 $ref: "#/getDefinitions/edge-tag-query-request"
51335 $ref: "#/getDefinitions/search-results"
51338 $ref: "#/getDefinitions/sdn-zone-response"
51344 $ref: "#/getDefinitions/result-data"
51347 SecondaryFilt for performing a named-query or model query
51358 SecondaryFilts for performing a named-query or model query
51363 $ref: "#/getDefinitions/secondary-filt"
51364 segmentation-assignment:
51366 Openstack segmentation assignment.
51367 ###### Related Nodes
51368 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
51370 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
51376 description: Route Table Reference id, UUID assigned to this instance.
51379 description: Concurrency value
51383 $ref: "#/getDefinitions/relationship"
51384 segmentation-assignments:
51386 Collection of openstack segmentation assignments
51388 segmentation-assignment:
51391 $ref: "#/getDefinitions/segmentation-assignment"
51394 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
51397 - service-description
51401 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51402 service-description:
51404 description: Description of the service
51407 description: URL to endpoint where AAI can get more details
51410 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51413 description: service version
51417 $ref: "#/getDefinitions/relationship"
51418 service-capabilities:
51420 Collection of service capabilities.
51422 service-capability:
51425 $ref: "#/getDefinitions/service-capability"
51426 service-capability:
51428 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
51429 ###### Related Nodes
51430 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
51431 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
51433 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
51441 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51444 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
51447 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51451 $ref: "#/getDefinitions/relationship"
51452 service-design-and-creation:
51454 Namespace for objects managed by ASDC
51459 $ref: "#/getDefinitions/vnf-image"
51463 $ref: "#/getDefinitions/service"
51464 service-capabilities:
51467 $ref: "#/getDefinitions/service-capability"
51471 $ref: "#/getDefinitions/model"
51475 $ref: "#/getDefinitions/named-query"
51478 Instance of a service
51479 ###### Related Nodes
51480 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
51481 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
51482 - TO connector( service-instance Uses connector, MANY2MANY)
51483 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
51484 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
51485 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51486 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
51487 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
51488 - TO vce( service-instance ComposedOf vce, ONE2MANY)
51489 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
51490 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51492 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
51493 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
51494 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
51496 - service-instance-id
51498 service-instance-id:
51500 description: Uniquely identifies this instance of a service
51501 service-instance-name:
51503 description: This field will store a name assigned to the service-instance.
51506 description: the ASDC model id for this resource or service model.
51507 persona-model-version:
51509 description: the ASDC model version for this resource or service model.
51512 description: the ASDC model version for this resource or service model.
51515 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51516 widget-model-version:
51518 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51521 description: Indicates the total bandwidth to be used for this service.
51524 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51525 bandwidth-down-wan1:
51527 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51530 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51531 bandwidth-down-wan2:
51533 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51536 description: URL customers will use to access the vHN Portal.
51537 service-instance-location-id:
51539 description: An identifier that customers assign to the location where this service is being used.
51542 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51546 $ref: "#/getDefinitions/relationship"
51550 $ref: "#/getDefinitions/metadatum"
51553 Collection of service instances
51558 $ref: "#/getDefinitions/service-instance"
51559 service-subscription:
51561 Object that group service instances.
51562 ###### Related Nodes
51563 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
51564 - TO tenant( service-subscription Uses tenant, MANY2MANY)
51565 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
51567 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
51568 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
51574 description: Value defined by orchestration to identify this service across ECOMP.
51575 temp-ub-sub-account-id:
51577 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51580 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51584 $ref: "#/getDefinitions/service-instance"
51588 $ref: "#/getDefinitions/relationship"
51589 service-subscriptions:
51591 Collection of objects that group service instances.
51593 service-subscription:
51596 $ref: "#/getDefinitions/service-subscription"
51599 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
51604 $ref: "#/getDefinitions/service"
51607 ###### Related Nodes
51608 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
51609 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
51611 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
51612 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
51618 description: unique identifier of probe
51621 description: Prefix address
51624 description: Prefix address
51627 description: ip version, v4, v6
51628 destination-hostname:
51630 description: Hostname of the destination equipment to which SLAs are measured against.
51631 destination-equip-type:
51633 description: The type of destinatination equipment. Could be Router, etc.
51636 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51637 classes-of-service:
51640 $ref: "#/getDefinitions/class-of-service"
51644 $ref: "#/getDefinitions/relationship"
51647 Set of instances for probes used to measure service level agreements
51648 ###### Related Nodes
51649 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51650 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
51652 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
51658 description: Unique id of site pair set.
51661 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51665 $ref: "#/getDefinitions/routing-instance"
51669 $ref: "#/getDefinitions/relationship"
51672 Collection of sets of instances for probes related to generic-vnf
51677 $ref: "#/getDefinitions/site-pair-set"
51685 $ref: "#/getDefinitions/site-pair"
51689 ###### Related Nodes
51690 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
51691 - FROM vserver( vserver Uses snapshot, ONE2ONE)
51698 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51701 description: Snapshot name
51702 snapshot-architecture:
51704 description: Operating system architecture
51705 snapshot-os-distro:
51707 description: The common name of the operating system distribution in lowercase
51708 snapshot-os-version:
51710 description: The operating system version as specified by the distributor.
51713 description: The application that the image instantiates.
51714 application-vendor:
51716 description: The vendor of the application.
51717 application-version:
51719 description: The version of the application.
51722 description: URL to endpoint where AAI can get more details
51725 description: This field contains the UUID of the previous snapshot (if any).
51728 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51732 $ref: "#/getDefinitions/relationship"
51735 Collection of openstack snapshots
51740 $ref: "#/getDefinitions/snapshot"
51743 SR-IOV Physical Function
51744 ###### Related Nodes
51745 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
51746 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
51748 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
51754 description: Identifier for the sriov-pf
51757 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51761 $ref: "#/getDefinitions/relationship"
51764 Collection of SR-IOV Physical Functions.
51769 $ref: "#/getDefinitions/sriov-pf"
51772 SR-IOV Virtual Function (not to be confused with virtual network function)
51773 ###### Related Nodes
51774 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
51776 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
51782 description: PCI ID used to identify the sriov-vf
51785 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51788 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51791 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51792 vf-vlan-anti-spoof-check:
51794 description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
51795 vf-mac-anti-spoof-check:
51797 description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
51800 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51801 vf-broadcast-allow:
51803 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51804 vf-unknown-multicast-allow:
51806 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51807 vf-unknown-unicast-allow:
51809 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51812 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51815 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
51818 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51819 neutron-network-id:
51821 description: Neutron network id of the interface
51825 $ref: "#/getDefinitions/relationship"
51828 Collection of SR-IOV Virtual Functions.
51833 $ref: "#/getDefinitions/sriov-vf"
51842 ###### Related Nodes
51843 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
51844 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
51845 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
51847 -(4) IF this TO node is deleted, this SUBNET is DELETED also
51848 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
51856 description: Subnet ID, should be UUID.
51859 description: Name associated with the subnet.
51862 description: Neutron id of this subnet
51865 description: gateway ip address
51866 network-start-address:
51868 description: network start address
51871 description: cidr mask
51874 description: ip version
51875 orchestration-status:
51877 description: Orchestration status of this VNF, mastered by MSO
51880 description: dhcp enabled
51883 description: the start address reserved for use by dhcp
51886 description: the last address reserved for use by dhcp
51889 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51893 $ref: "#/getDefinitions/relationship"
51899 $ref: "#/getDefinitions/subnet"
51900 tagged-inventory-item-list:
51905 $ref: "#/getDefinitions/inventory-item"
51909 ###### Related Nodes
51910 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
51911 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
51912 - TO l3-network( tenant Uses l3-network, MANY2MANY)
51913 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
51914 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
51915 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
51917 -TENANT cannot be deleted if related to VSERVER
51925 description: Unique id relative to the cloud-region.
51928 description: Readable name of tenant
51931 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51935 $ref: "#/getDefinitions/vserver"
51939 $ref: "#/getDefinitions/relationship"
51942 Collection of openstack tenants.
51947 $ref: "#/getDefinitions/tenant"
51950 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51951 ###### Related Nodes
51952 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
51954 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
51957 - bandwidth-up-wan1
51958 - bandwidth-down-wan1
51959 - bandwidth-up-wan2
51960 - bandwidth-down-wan2
51964 description: Allotted Resource id UUID assigned to this instance.
51967 description: The WAN uplink bandwidth for WAN1
51968 bandwidth-down-wan1:
51970 description: The WAN downlink bandwidth for WAN1
51973 description: The WAN uplink bandwidth for WAN2
51974 bandwidth-down-wan2:
51976 description: The WAN downlink bandwidth for WAN2
51979 description: Concurrency value
51983 $ref: "#/getDefinitions/relationship"
51986 This object is used to store the specific tunnel cross connect aspects of an allotted resource
51991 $ref: "#/getDefinitions/tunnel-xconnect"
51994 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
52003 $ref: "#/getDefinitions/update-node-key"
52009 $ref: "#/getDefinitions/action"
52018 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
52019 ###### Related Nodes
52020 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
52021 - TO complex( vce LocatedIn complex, MANY2MANY)
52022 - TO vserver( vce HostedOn vserver, ONE2MANY)
52023 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
52024 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
52026 -(1) IF this VCE node is deleted, this FROM node is DELETED also
52034 description: Unique id of VNF. This is unique across the graph.
52037 description: Name of VNF.
52040 description: Alternate name of VNF.
52043 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
52046 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
52047 regional-resource-zone:
52049 description: Regional way of organizing pservers, source of truth should define values
52052 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52055 description: Indicator for whether the resource is considered operational
52058 description: License key
52061 description: Network role being played by this VNF
52062 orchestration-status:
52064 description: Orchestration status of this VNF, mastered by MSO
52067 description: Heat stack id corresponding to this instance, managed by MSO
52070 description: Corresponds to the SDN-C catalog id used to configure this VCE
52073 description: Unique ID of VPE connected to this VCE.
52074 v6-vce-wan-address:
52076 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
52079 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
52082 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52083 ipv4-loopback0-address:
52085 description: Loopback0 address
52086 entitlement-resource-uuid:
52088 description: Entitlement resource uuid
52092 $ref: "#/getDefinitions/port-group"
52096 $ref: "#/getDefinitions/relationship"
52099 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
52104 $ref: "#/getDefinitions/vce"
52107 a deployment unit of VNFCs
52108 ###### Related Nodes
52109 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
52110 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
52111 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
52112 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
52113 - TO vserver( vf-module Uses vserver, ONE2MANY)
52115 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
52116 -VF-MODULE cannot be deleted if related to VNFC
52120 - is-base-vf-module
52124 description: Unique ID of vf-module.
52127 description: Name of vf-module
52130 description: Heat stack id corresponding to this instance.
52131 orchestration-status:
52133 description: orchestration status of this vf-module, mastered by MSO
52136 description: used to indicate whether or not this object is base vf module
52139 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52142 description: the ASDC model id for this resource or service model.
52143 persona-model-version:
52145 description: the ASDC model version for this resource or service model.
52148 description: the ASDC model version for this resource or service model.
52151 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52152 widget-model-version:
52154 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52155 contrail-service-instance-fqdn:
52157 description: the Contrail unique ID for a service-instance
52161 $ref: "#/getDefinitions/relationship"
52164 Collection of vf-modules, a deployment unit of VNFCs
52169 $ref: "#/getDefinitions/vf-module"
52172 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
52173 ###### Related Nodes
52174 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
52176 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
52182 description: indicates whether the VIG is for AVPN or INTERNET
52185 description: v4 IP of the vig server
52188 description: v6 IP of the vig server
52191 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52195 $ref: "#/getDefinitions/relationship"
52201 $ref: "#/getDefinitions/vig-server"
52202 vip-ipv4-address-list:
52205 ###### Related Nodes
52206 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
52207 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
52208 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
52209 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
52216 description: IP address
52217 vip-ipv4-prefix-length:
52220 description: Prefix length, 32 for single address
52224 description: Inner VLAN tag
52228 description: Outer VLAN tag
52231 description: Indicator of fixed or floating address
52234 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52235 neutron-network-id:
52237 description: Neutron network id of the interface that address belongs to
52240 description: Neutron id of subnet that address belongs to
52244 $ref: "#/getDefinitions/relationship"
52245 vip-ipv6-address-list:
52248 ###### Related Nodes
52249 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
52250 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
52251 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
52252 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
52259 description: IP address
52260 vip-ipv6-prefix-length:
52263 description: Prefix length, 128 for single address
52267 description: Inner VLAN tag
52271 description: Outer VLAN tag
52274 description: Indicator of fixed or floating address
52277 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52278 neutron-network-id:
52280 description: Neutron network id of the interface that address belongs to
52283 description: Neutron id of subnet that address belongs to
52287 $ref: "#/getDefinitions/relationship"
52288 virtual-data-center:
52290 Virtual organization of cloud infrastructure elements in a data center context
52291 ###### Related Nodes
52292 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
52293 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
52294 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
52302 description: Unique ID of the vdc
52305 description: Name of the virtual data center
52308 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52312 $ref: "#/getDefinitions/relationship"
52313 virtual-data-centers:
52315 Virtual organization of cloud infrastructure elements in a data center context
52317 virtual-data-center:
52320 $ref: "#/getDefinitions/virtual-data-center"
52324 ###### Related Nodes
52325 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
52326 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
52327 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
52328 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
52329 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
52330 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
52332 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
52333 -(2) IF this VLAN node is deleted, this TO node is DELETED also
52334 -(4) IF this TO node is deleted, this VLAN is DELETED also
52340 description: String that identifies the interface
52344 description: Inner VLAN tag
52348 description: Outer VLAN tag
52351 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52354 description: Captures the numeric part of the speed
52357 description: Captures the units corresponding to the speed
52360 description: Used to describe (the service associated with) the vlan
52361 backdoor-connection:
52363 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
52366 description: This indicates the customers VPN ID associated with this vlan
52370 $ref: "#/getDefinitions/relationship"
52371 l3-interface-ipv4-address-list:
52374 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
52375 l3-interface-ipv6-address-list:
52378 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
52384 $ref: "#/getDefinitions/vlan"
52393 description: Unique id of VNF. This is unique across the graph.
52396 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52397 ###### Related Nodes
52398 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
52400 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
52405 - application-vendor
52409 description: Unique ID of this asset
52412 description: The application that the image instantiates.
52413 application-vendor:
52415 description: The vendor of the application.
52416 application-version:
52418 description: The version of the application.
52421 description: URL to endpoint where AAI can get more details
52424 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52428 $ref: "#/getDefinitions/relationship"
52431 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52436 $ref: "#/getDefinitions/vnf-image"
52439 ###### Related Nodes
52440 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
52441 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
52442 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
52444 -(4) IF this TO node is deleted, this VNFC is DELETED also
52447 - vnfc-function-code
52450 - is-closed-loop-disabled
52454 description: Unique ID of vnfc.
52455 vnfc-function-code:
52457 description: function code
52463 description: prov status of this vnfc
52464 orchestration-status:
52466 description: Orchestration status of this VNF, mastered by APP-C
52467 ipaddress-v4-oam-vip:
52469 description: Oam V4 vip address of this vnfc
52472 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52473 is-closed-loop-disabled:
52475 description: used to indicate whether closed loop function is enabled on this node
52478 description: Group notation of VNFC
52481 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52485 $ref: "#/getDefinitions/relationship"
52488 virtual network components associated with a vserver from application controller.
52493 $ref: "#/getDefinitions/vnfc"
52496 Ephemeral Block storage volume.
52497 ###### Related Nodes
52498 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
52500 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
52507 description: Unique ID of block storage volume relative to the vserver.
52510 description: URL to endpoint where AAI can get more details
52513 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52517 $ref: "#/getDefinitions/relationship"
52520 Persistent block-level storage.
52521 ###### Related Nodes
52522 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
52523 - TO complex( volume-group LocatedIn complex, MANY2ONE)
52524 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
52525 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
52526 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
52530 - volume-group-name
52535 description: Unique ID of volume-group.
52538 description: Name of the volume group.
52541 description: Heat stack id corresponding to this volume-group
52544 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
52545 orchestration-status:
52547 description: Orchestration status of this volume-group
52550 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52554 $ref: "#/getDefinitions/relationship"
52557 Collection of persistent block-level storage.
52562 $ref: "#/getDefinitions/volume-group"
52565 Collection of ephemeral Block storage volumes.
52570 $ref: "#/getDefinitions/volume"
52573 VPLS Provider Edge routers.
52574 ###### Related Nodes
52575 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
52576 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
52577 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
52578 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
52580 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
52588 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52591 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
52594 description: Client should send valid enumerated value, e.g., VPLS-PE.
52598 description: Temporary location for stag to get to VCE
52601 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52605 $ref: "#/getDefinitions/relationship"
52609 $ref: "#/getDefinitions/p-interface"
52613 $ref: "#/getDefinitions/lag-interface"
52616 Collection of VPLS Provider Edge routers
52621 $ref: "#/getDefinitions/vpls-pe"
52625 ###### Related Nodes
52626 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
52628 -VPN-BINDING cannot be deleted if related to L3-NETWORK
52633 - global-route-target
52637 description: VPN ID, globally unique within A&AI
52640 description: VPN Name
52641 global-route-target:
52643 description: Number used to identify a VPN, globally unique in the network
52646 description: the platform associated with the VPN example AVPN, Mobility
52649 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52653 $ref: "#/getDefinitions/relationship"
52654 description: l3-networks relate to vpn-bindings
52660 $ref: "#/getDefinitions/vpn-binding"
52663 Virtual Servers, aka virtual machine or VM.
52664 ###### Related Nodes
52665 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
52666 - TO flavor( vserver Uses flavor, MANY2ONE)
52667 - TO image( vserver Uses image, MANY2ONE)
52668 - TO pserver( vserver HostedOn pserver, MANY2ONE)
52669 - TO snapshot( vserver Uses snapshot, ONE2ONE)
52670 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
52671 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
52672 - FROM vce( vce HostedOn vserver, ONE2MANY)
52673 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
52674 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
52675 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
52677 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
52678 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
52684 - is-closed-loop-disabled
52688 description: Unique identifier for this vserver relative to its tenant
52691 description: Name of vserver
52694 description: Alternative name of vserver
52697 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52700 description: URL to endpoint where AAI can get more details
52703 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
52704 is-closed-loop-disabled:
52706 description: Used to indicate whether closed loop function is enabled on this node
52709 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52713 $ref: "#/getDefinitions/volume"
52717 $ref: "#/getDefinitions/relationship"
52721 $ref: "#/getDefinitions/l-interface"
52724 Collection of virtual Servers, aka virtual machines or VMs.
52729 $ref: "#/getDefinitions/vserver"
52732 A zone is a grouping of assets in a location homing to the same connections into the CBB
52733 ###### Related Nodes
52734 - TO complex( zone LocatedIn complex, MANY2ONE)
52735 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
52736 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
52737 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
52747 description: Code assigned by AIC to the zone
52750 description: English name associated with the zone
52753 description: Design of zone [Medium/Large?]
52756 description: Context of zone [production/test]
52759 description: Status of a zone.
52762 description: Concurrency value
52766 $ref: "#/getDefinitions/relationship"
52769 Collection of zones
52774 $ref: "#/getDefinitions/zone"