5 [Differences versus the previous schema version](apidocs/aai_swagger_v11.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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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 - name: tenant-context
4495 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
4498 - CloudInfrastructure
4499 summary: see node definition for valid relationships
4500 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4509 description: Response codes found in [response codes](https://wiki.onap.org/).
4513 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4516 example: __CLOUD-OWNER__
4517 - name: cloud-region-id
4519 description: Identifier used by the vendor for the region. Second part of composite key
4522 example: __CLOUD-REGION-ID__
4525 description: Flavor id, expected to be unique across cloud-region.
4528 example: __FLAVOR-ID__
4531 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4534 $ref: "#/definitions/relationship"
4537 - CloudInfrastructure
4538 summary: delete an existing relationship
4539 description: delete an existing relationship
4540 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4549 description: Response codes found in [response codes](https://wiki.onap.org/).
4553 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4556 example: __CLOUD-OWNER__
4557 - name: cloud-region-id
4559 description: Identifier used by the vendor for the region. Second part of composite key
4562 example: __CLOUD-REGION-ID__
4565 description: Flavor id, expected to be unique across cloud-region.
4568 example: __FLAVOR-ID__
4569 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
4572 - CloudInfrastructure
4573 summary: returns flavor
4574 description: returns flavor
4575 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4581 description: successful operation
4583 $ref: "#/getDefinitions/flavor"
4585 description: Response codes found in [response codes](https://wiki.onap.org/).
4589 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4592 example: __CLOUD-OWNER__
4593 - name: cloud-region-id
4595 description: Identifier used by the vendor for the region. Second part of composite key
4598 example: __CLOUD-REGION-ID__
4601 description: Flavor id, expected to be unique across cloud-region.
4604 example: __FLAVOR-ID__
4607 - CloudInfrastructure
4608 summary: create or update an existing flavor
4610 Create or update an existing flavor.
4612 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4613 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4622 description: Response codes found in [response codes](https://wiki.onap.org/).
4626 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4629 example: __CLOUD-OWNER__
4630 - name: cloud-region-id
4632 description: Identifier used by the vendor for the region. Second part of composite key
4635 example: __CLOUD-REGION-ID__
4638 description: Flavor id, expected to be unique across cloud-region.
4641 example: __FLAVOR-ID__
4644 description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4647 $ref: "#/definitions/flavor"
4650 - CloudInfrastructure
4651 summary: update an existing flavor
4653 Update an existing flavor
4655 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4656 The PUT operation will entirely replace an existing object.
4657 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4659 Other differences between PUT and PATCH are:
4661 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4662 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4663 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4664 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4673 description: Response codes found in [response codes](https://wiki.onap.org/).
4677 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4680 example: __CLOUD-OWNER__
4681 - name: cloud-region-id
4683 description: Identifier used by the vendor for the region. Second part of composite key
4686 example: __CLOUD-REGION-ID__
4689 description: Flavor id, expected to be unique across cloud-region.
4692 example: __FLAVOR-ID__
4695 description: flavor object that needs to be updated.
4698 $ref: "#/patchDefinitions/flavor"
4701 - CloudInfrastructure
4702 summary: delete an existing flavor
4703 description: delete an existing flavor
4704 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4713 description: Response codes found in [response codes](https://wiki.onap.org/).
4717 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4720 example: __CLOUD-OWNER__
4721 - name: cloud-region-id
4723 description: Identifier used by the vendor for the region. Second part of composite key
4726 example: __CLOUD-REGION-ID__
4729 description: Flavor id, expected to be unique across cloud-region.
4732 example: __FLAVOR-ID__
4733 - name: resource-version
4735 description: resource-version for concurrency
4738 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
4741 - CloudInfrastructure
4742 summary: returns flavors
4743 description: returns flavors
4744 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
4750 description: successful operation
4752 $ref: "#/getDefinitions/flavors"
4754 description: Response codes found in [response codes](https://wiki.onap.org/).
4758 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4761 example: __CLOUD-OWNER__
4762 - name: cloud-region-id
4764 description: Identifier used by the vendor for the region. Second part of composite key
4767 example: __CLOUD-REGION-ID__
4778 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
4781 - CloudInfrastructure
4782 summary: see node definition for valid relationships
4783 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4792 description: Response codes found in [response codes](https://wiki.onap.org/).
4796 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4799 example: __CLOUD-OWNER__
4800 - name: cloud-region-id
4802 description: Identifier used by the vendor for the region. Second part of composite key
4805 example: __CLOUD-REGION-ID__
4808 description: Group id, expected to be unique across cloud-region.
4811 example: __GROUP-ID__
4814 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4817 $ref: "#/definitions/relationship"
4820 - CloudInfrastructure
4821 summary: delete an existing relationship
4822 description: delete an existing relationship
4823 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4832 description: Response codes found in [response codes](https://wiki.onap.org/).
4836 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4839 example: __CLOUD-OWNER__
4840 - name: cloud-region-id
4842 description: Identifier used by the vendor for the region. Second part of composite key
4845 example: __CLOUD-REGION-ID__
4848 description: Group id, expected to be unique across cloud-region.
4851 example: __GROUP-ID__
4852 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
4855 - CloudInfrastructure
4856 summary: returns group-assignment
4857 description: returns group-assignment
4858 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4864 description: successful operation
4866 $ref: "#/getDefinitions/group-assignment"
4868 description: Response codes found in [response codes](https://wiki.onap.org/).
4872 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4875 example: __CLOUD-OWNER__
4876 - name: cloud-region-id
4878 description: Identifier used by the vendor for the region. Second part of composite key
4881 example: __CLOUD-REGION-ID__
4884 description: Group id, expected to be unique across cloud-region.
4887 example: __GROUP-ID__
4890 - CloudInfrastructure
4891 summary: create or update an existing group-assignment
4893 Create or update an existing group-assignment.
4895 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4896 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4905 description: Response codes found in [response codes](https://wiki.onap.org/).
4909 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4912 example: __CLOUD-OWNER__
4913 - name: cloud-region-id
4915 description: Identifier used by the vendor for the region. Second part of composite key
4918 example: __CLOUD-REGION-ID__
4921 description: Group id, expected to be unique across cloud-region.
4924 example: __GROUP-ID__
4927 description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4930 $ref: "#/definitions/group-assignment"
4933 - CloudInfrastructure
4934 summary: update an existing group-assignment
4936 Update an existing group-assignment
4938 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4939 The PUT operation will entirely replace an existing object.
4940 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4942 Other differences between PUT and PATCH are:
4944 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4945 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4946 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4947 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4956 description: Response codes found in [response codes](https://wiki.onap.org/).
4960 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4963 example: __CLOUD-OWNER__
4964 - name: cloud-region-id
4966 description: Identifier used by the vendor for the region. Second part of composite key
4969 example: __CLOUD-REGION-ID__
4972 description: Group id, expected to be unique across cloud-region.
4975 example: __GROUP-ID__
4978 description: group-assignment object that needs to be updated.
4981 $ref: "#/patchDefinitions/group-assignment"
4984 - CloudInfrastructure
4985 summary: delete an existing group-assignment
4986 description: delete an existing group-assignment
4987 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4996 description: Response codes found in [response codes](https://wiki.onap.org/).
5000 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5003 example: __CLOUD-OWNER__
5004 - name: cloud-region-id
5006 description: Identifier used by the vendor for the region. Second part of composite key
5009 example: __CLOUD-REGION-ID__
5012 description: Group id, expected to be unique across cloud-region.
5015 example: __GROUP-ID__
5016 - name: resource-version
5018 description: resource-version for concurrency
5021 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5024 - CloudInfrastructure
5025 summary: returns group-assignments
5026 description: returns group-assignments
5027 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5033 description: successful operation
5035 $ref: "#/getDefinitions/group-assignments"
5037 description: Response codes found in [response codes](https://wiki.onap.org/).
5041 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5044 example: __CLOUD-OWNER__
5045 - name: cloud-region-id
5047 description: Identifier used by the vendor for the region. Second part of composite key
5050 example: __CLOUD-REGION-ID__
5066 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5069 - CloudInfrastructure
5070 summary: see node definition for valid relationships
5071 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5080 description: Response codes found in [response codes](https://wiki.onap.org/).
5084 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5087 example: __CLOUD-OWNER__
5088 - name: cloud-region-id
5090 description: Identifier used by the vendor for the region. Second part of composite key
5093 example: __CLOUD-REGION-ID__
5096 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5099 example: __SNAPSHOT-ID__
5102 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5105 $ref: "#/definitions/relationship"
5108 - CloudInfrastructure
5109 summary: delete an existing relationship
5110 description: delete an existing relationship
5111 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5120 description: Response codes found in [response codes](https://wiki.onap.org/).
5124 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5127 example: __CLOUD-OWNER__
5128 - name: cloud-region-id
5130 description: Identifier used by the vendor for the region. Second part of composite key
5133 example: __CLOUD-REGION-ID__
5136 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5139 example: __SNAPSHOT-ID__
5140 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5143 - CloudInfrastructure
5144 summary: returns snapshot
5145 description: returns snapshot
5146 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5152 description: successful operation
5154 $ref: "#/getDefinitions/snapshot"
5156 description: Response codes found in [response codes](https://wiki.onap.org/).
5160 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5163 example: __CLOUD-OWNER__
5164 - name: cloud-region-id
5166 description: Identifier used by the vendor for the region. Second part of composite key
5169 example: __CLOUD-REGION-ID__
5172 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5175 example: __SNAPSHOT-ID__
5178 - CloudInfrastructure
5179 summary: create or update an existing snapshot
5181 Create or update an existing snapshot.
5183 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5184 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5193 description: Response codes found in [response codes](https://wiki.onap.org/).
5197 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5200 example: __CLOUD-OWNER__
5201 - name: cloud-region-id
5203 description: Identifier used by the vendor for the region. Second part of composite key
5206 example: __CLOUD-REGION-ID__
5209 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5212 example: __SNAPSHOT-ID__
5215 description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5218 $ref: "#/definitions/snapshot"
5221 - CloudInfrastructure
5222 summary: update an existing snapshot
5224 Update an existing snapshot
5226 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5227 The PUT operation will entirely replace an existing object.
5228 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5230 Other differences between PUT and PATCH are:
5232 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5233 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5234 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5235 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5244 description: Response codes found in [response codes](https://wiki.onap.org/).
5248 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5251 example: __CLOUD-OWNER__
5252 - name: cloud-region-id
5254 description: Identifier used by the vendor for the region. Second part of composite key
5257 example: __CLOUD-REGION-ID__
5260 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5263 example: __SNAPSHOT-ID__
5266 description: snapshot object that needs to be updated.
5269 $ref: "#/patchDefinitions/snapshot"
5272 - CloudInfrastructure
5273 summary: delete an existing snapshot
5274 description: delete an existing snapshot
5275 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5284 description: Response codes found in [response codes](https://wiki.onap.org/).
5288 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5291 example: __CLOUD-OWNER__
5292 - name: cloud-region-id
5294 description: Identifier used by the vendor for the region. Second part of composite key
5297 example: __CLOUD-REGION-ID__
5300 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5303 example: __SNAPSHOT-ID__
5304 - name: resource-version
5306 description: resource-version for concurrency
5309 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5312 - CloudInfrastructure
5313 summary: returns snapshots
5314 description: returns snapshots
5315 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5321 description: successful operation
5323 $ref: "#/getDefinitions/snapshots"
5325 description: Response codes found in [response codes](https://wiki.onap.org/).
5329 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5332 example: __CLOUD-OWNER__
5333 - name: cloud-region-id
5335 description: Identifier used by the vendor for the region. Second part of composite key
5338 example: __CLOUD-REGION-ID__
5344 - name: snapshot-name
5354 - name: application-vendor
5359 - name: application-version
5364 - name: prev-snapshot-id
5369 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
5372 - CloudInfrastructure
5373 summary: see node definition for valid relationships
5374 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5383 description: Response codes found in [response codes](https://wiki.onap.org/).
5387 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5390 example: __CLOUD-OWNER__
5391 - name: cloud-region-id
5393 description: Identifier used by the vendor for the region. Second part of composite key
5396 example: __CLOUD-REGION-ID__
5399 description: Image id, expected to be unique across cloud region
5402 example: __IMAGE-ID__
5405 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5408 $ref: "#/definitions/relationship"
5411 - CloudInfrastructure
5412 summary: delete an existing relationship
5413 description: delete an existing relationship
5414 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5423 description: Response codes found in [response codes](https://wiki.onap.org/).
5427 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5430 example: __CLOUD-OWNER__
5431 - name: cloud-region-id
5433 description: Identifier used by the vendor for the region. Second part of composite key
5436 example: __CLOUD-REGION-ID__
5439 description: Image id, expected to be unique across cloud region
5442 example: __IMAGE-ID__
5443 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
5446 - CloudInfrastructure
5447 summary: returns metadatum
5448 description: returns metadatum
5449 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5455 description: successful operation
5457 $ref: "#/getDefinitions/metadatum"
5459 description: Response codes found in [response codes](https://wiki.onap.org/).
5463 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5466 example: __CLOUD-OWNER__
5467 - name: cloud-region-id
5469 description: Identifier used by the vendor for the region. Second part of composite key
5472 example: __CLOUD-REGION-ID__
5475 description: Image id, expected to be unique across cloud region
5478 example: __IMAGE-ID__
5483 example: __METANAME__
5486 - CloudInfrastructure
5487 summary: create or update an existing metadatum
5489 Create or update an existing metadatum.
5491 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5492 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5501 description: Response codes found in [response codes](https://wiki.onap.org/).
5505 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5508 example: __CLOUD-OWNER__
5509 - name: cloud-region-id
5511 description: Identifier used by the vendor for the region. Second part of composite key
5514 example: __CLOUD-REGION-ID__
5517 description: Image id, expected to be unique across cloud region
5520 example: __IMAGE-ID__
5525 example: __METANAME__
5528 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
5531 $ref: "#/definitions/metadatum"
5534 - CloudInfrastructure
5535 summary: update an existing metadatum
5537 Update an existing metadatum
5539 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5540 The PUT operation will entirely replace an existing object.
5541 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5543 Other differences between PUT and PATCH are:
5545 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5546 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5547 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5548 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5557 description: Response codes found in [response codes](https://wiki.onap.org/).
5561 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5564 example: __CLOUD-OWNER__
5565 - name: cloud-region-id
5567 description: Identifier used by the vendor for the region. Second part of composite key
5570 example: __CLOUD-REGION-ID__
5573 description: Image id, expected to be unique across cloud region
5576 example: __IMAGE-ID__
5581 example: __METANAME__
5584 description: metadatum object that needs to be updated.
5587 $ref: "#/patchDefinitions/metadatum"
5590 - CloudInfrastructure
5591 summary: delete an existing metadatum
5592 description: delete an existing metadatum
5593 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5602 description: Response codes found in [response codes](https://wiki.onap.org/).
5606 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5609 example: __CLOUD-OWNER__
5610 - name: cloud-region-id
5612 description: Identifier used by the vendor for the region. Second part of composite key
5615 example: __CLOUD-REGION-ID__
5618 description: Image id, expected to be unique across cloud region
5621 example: __IMAGE-ID__
5626 example: __METANAME__
5627 - name: resource-version
5629 description: resource-version for concurrency
5632 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
5635 - CloudInfrastructure
5636 summary: returns metadata
5637 description: returns metadata
5638 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
5644 description: successful operation
5646 $ref: "#/getDefinitions/metadata"
5648 description: Response codes found in [response codes](https://wiki.onap.org/).
5652 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5655 example: __CLOUD-OWNER__
5656 - name: cloud-region-id
5658 description: Identifier used by the vendor for the region. Second part of composite key
5661 example: __CLOUD-REGION-ID__
5664 description: Image id, expected to be unique across cloud region
5667 example: __IMAGE-ID__
5673 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
5676 - CloudInfrastructure
5677 summary: returns image
5678 description: returns image
5679 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
5685 description: successful operation
5687 $ref: "#/getDefinitions/image"
5689 description: Response codes found in [response codes](https://wiki.onap.org/).
5693 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5696 example: __CLOUD-OWNER__
5697 - name: cloud-region-id
5699 description: Identifier used by the vendor for the region. Second part of composite key
5702 example: __CLOUD-REGION-ID__
5705 description: Image id, expected to be unique across cloud region
5708 example: __IMAGE-ID__
5711 - CloudInfrastructure
5712 summary: create or update an existing image
5714 Create or update an existing image.
5716 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5717 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5726 description: Response codes found in [response codes](https://wiki.onap.org/).
5730 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5733 example: __CLOUD-OWNER__
5734 - name: cloud-region-id
5736 description: Identifier used by the vendor for the region. Second part of composite key
5739 example: __CLOUD-REGION-ID__
5742 description: Image id, expected to be unique across cloud region
5745 example: __IMAGE-ID__
5748 description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5751 $ref: "#/definitions/image"
5754 - CloudInfrastructure
5755 summary: update an existing image
5757 Update an existing image
5759 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5760 The PUT operation will entirely replace an existing object.
5761 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5763 Other differences between PUT and PATCH are:
5765 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5766 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5767 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5768 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5777 description: Response codes found in [response codes](https://wiki.onap.org/).
5781 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5784 example: __CLOUD-OWNER__
5785 - name: cloud-region-id
5787 description: Identifier used by the vendor for the region. Second part of composite key
5790 example: __CLOUD-REGION-ID__
5793 description: Image id, expected to be unique across cloud region
5796 example: __IMAGE-ID__
5799 description: image object that needs to be updated.
5802 $ref: "#/patchDefinitions/image"
5805 - CloudInfrastructure
5806 summary: delete an existing image
5807 description: delete an existing image
5808 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
5817 description: Response codes found in [response codes](https://wiki.onap.org/).
5821 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5824 example: __CLOUD-OWNER__
5825 - name: cloud-region-id
5827 description: Identifier used by the vendor for the region. Second part of composite key
5830 example: __CLOUD-REGION-ID__
5833 description: Image id, expected to be unique across cloud region
5836 example: __IMAGE-ID__
5837 - name: resource-version
5839 description: resource-version for concurrency
5842 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
5845 - CloudInfrastructure
5846 summary: returns images
5847 description: returns images
5848 operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
5854 description: successful operation
5856 $ref: "#/getDefinitions/images"
5858 description: Response codes found in [response codes](https://wiki.onap.org/).
5862 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5865 example: __CLOUD-OWNER__
5866 - name: cloud-region-id
5868 description: Identifier used by the vendor for the region. Second part of composite key
5871 example: __CLOUD-REGION-ID__
5887 - name: application-vendor
5892 - name: application-version
5897 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
5900 - CloudInfrastructure
5901 summary: see node definition for valid relationships
5902 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5911 description: Response codes found in [response codes](https://wiki.onap.org/).
5915 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5918 example: __CLOUD-OWNER__
5919 - name: cloud-region-id
5921 description: Identifier used by the vendor for the region. Second part of composite key
5924 example: __CLOUD-REGION-ID__
5927 description: DVS switch name
5930 example: __SWITCH-NAME__
5933 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
5936 $ref: "#/definitions/relationship"
5939 - CloudInfrastructure
5940 summary: delete an existing relationship
5941 description: delete an existing relationship
5942 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5951 description: Response codes found in [response codes](https://wiki.onap.org/).
5955 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5958 example: __CLOUD-OWNER__
5959 - name: cloud-region-id
5961 description: Identifier used by the vendor for the region. Second part of composite key
5964 example: __CLOUD-REGION-ID__
5967 description: DVS switch name
5970 example: __SWITCH-NAME__
5971 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
5974 - CloudInfrastructure
5975 summary: returns dvs-switch
5976 description: returns dvs-switch
5977 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
5983 description: successful operation
5985 $ref: "#/getDefinitions/dvs-switch"
5987 description: Response codes found in [response codes](https://wiki.onap.org/).
5991 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5994 example: __CLOUD-OWNER__
5995 - name: cloud-region-id
5997 description: Identifier used by the vendor for the region. Second part of composite key
6000 example: __CLOUD-REGION-ID__
6003 description: DVS switch name
6006 example: __SWITCH-NAME__
6009 - CloudInfrastructure
6010 summary: create or update an existing dvs-switch
6012 Create or update an existing dvs-switch.
6014 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6015 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6024 description: Response codes found in [response codes](https://wiki.onap.org/).
6028 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6031 example: __CLOUD-OWNER__
6032 - name: cloud-region-id
6034 description: Identifier used by the vendor for the region. Second part of composite key
6037 example: __CLOUD-REGION-ID__
6040 description: DVS switch name
6043 example: __SWITCH-NAME__
6046 description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6049 $ref: "#/definitions/dvs-switch"
6052 - CloudInfrastructure
6053 summary: update an existing dvs-switch
6055 Update an existing dvs-switch
6057 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6058 The PUT operation will entirely replace an existing object.
6059 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6061 Other differences between PUT and PATCH are:
6063 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6064 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6065 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6066 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6075 description: Response codes found in [response codes](https://wiki.onap.org/).
6079 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6082 example: __CLOUD-OWNER__
6083 - name: cloud-region-id
6085 description: Identifier used by the vendor for the region. Second part of composite key
6088 example: __CLOUD-REGION-ID__
6091 description: DVS switch name
6094 example: __SWITCH-NAME__
6097 description: dvs-switch object that needs to be updated.
6100 $ref: "#/patchDefinitions/dvs-switch"
6103 - CloudInfrastructure
6104 summary: delete an existing dvs-switch
6105 description: delete an existing dvs-switch
6106 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6115 description: Response codes found in [response codes](https://wiki.onap.org/).
6119 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6122 example: __CLOUD-OWNER__
6123 - name: cloud-region-id
6125 description: Identifier used by the vendor for the region. Second part of composite key
6128 example: __CLOUD-REGION-ID__
6131 description: DVS switch name
6134 example: __SWITCH-NAME__
6135 - name: resource-version
6137 description: resource-version for concurrency
6140 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6143 - CloudInfrastructure
6144 summary: returns dvs-switches
6145 description: returns dvs-switches
6146 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6152 description: successful operation
6154 $ref: "#/getDefinitions/dvs-switches"
6156 description: Response codes found in [response codes](https://wiki.onap.org/).
6160 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6163 example: __CLOUD-OWNER__
6164 - name: cloud-region-id
6166 description: Identifier used by the vendor for the region. Second part of composite key
6169 example: __CLOUD-REGION-ID__
6180 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6183 - CloudInfrastructure
6184 summary: see node definition for valid relationships
6185 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6194 description: Response codes found in [response codes](https://wiki.onap.org/).
6198 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6201 example: __CLOUD-OWNER__
6202 - name: cloud-region-id
6204 description: Identifier used by the vendor for the region. Second part of composite key
6207 example: __CLOUD-REGION-ID__
6208 - name: network-uuid
6210 description: UUID of the network. Unique across a cloud-region
6213 example: __NETWORK-UUID__
6216 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6219 $ref: "#/definitions/relationship"
6222 - CloudInfrastructure
6223 summary: delete an existing relationship
6224 description: delete an existing relationship
6225 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6234 description: Response codes found in [response codes](https://wiki.onap.org/).
6238 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6241 example: __CLOUD-OWNER__
6242 - name: cloud-region-id
6244 description: Identifier used by the vendor for the region. Second part of composite key
6247 example: __CLOUD-REGION-ID__
6248 - name: network-uuid
6250 description: UUID of the network. Unique across a cloud-region
6253 example: __NETWORK-UUID__
6254 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6257 - CloudInfrastructure
6258 summary: returns oam-network
6259 description: returns oam-network
6260 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6266 description: successful operation
6268 $ref: "#/getDefinitions/oam-network"
6270 description: Response codes found in [response codes](https://wiki.onap.org/).
6274 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6277 example: __CLOUD-OWNER__
6278 - name: cloud-region-id
6280 description: Identifier used by the vendor for the region. Second part of composite key
6283 example: __CLOUD-REGION-ID__
6284 - name: network-uuid
6286 description: UUID of the network. Unique across a cloud-region
6289 example: __NETWORK-UUID__
6292 - CloudInfrastructure
6293 summary: create or update an existing oam-network
6295 Create or update an existing oam-network.
6297 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6298 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6307 description: Response codes found in [response codes](https://wiki.onap.org/).
6311 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6314 example: __CLOUD-OWNER__
6315 - name: cloud-region-id
6317 description: Identifier used by the vendor for the region. Second part of composite key
6320 example: __CLOUD-REGION-ID__
6321 - name: network-uuid
6323 description: UUID of the network. Unique across a cloud-region
6326 example: __NETWORK-UUID__
6329 description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6332 $ref: "#/definitions/oam-network"
6335 - CloudInfrastructure
6336 summary: update an existing oam-network
6338 Update an existing oam-network
6340 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6341 The PUT operation will entirely replace an existing object.
6342 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6344 Other differences between PUT and PATCH are:
6346 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6347 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6348 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6349 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6358 description: Response codes found in [response codes](https://wiki.onap.org/).
6362 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6365 example: __CLOUD-OWNER__
6366 - name: cloud-region-id
6368 description: Identifier used by the vendor for the region. Second part of composite key
6371 example: __CLOUD-REGION-ID__
6372 - name: network-uuid
6374 description: UUID of the network. Unique across a cloud-region
6377 example: __NETWORK-UUID__
6380 description: oam-network object that needs to be updated.
6383 $ref: "#/patchDefinitions/oam-network"
6386 - CloudInfrastructure
6387 summary: delete an existing oam-network
6388 description: delete an existing oam-network
6389 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6398 description: Response codes found in [response codes](https://wiki.onap.org/).
6402 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6405 example: __CLOUD-OWNER__
6406 - name: cloud-region-id
6408 description: Identifier used by the vendor for the region. Second part of composite key
6411 example: __CLOUD-REGION-ID__
6412 - name: network-uuid
6414 description: UUID of the network. Unique across a cloud-region
6417 example: __NETWORK-UUID__
6418 - name: resource-version
6420 description: resource-version for concurrency
6423 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
6426 - CloudInfrastructure
6427 summary: returns oam-networks
6428 description: returns oam-networks
6429 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
6435 description: successful operation
6437 $ref: "#/getDefinitions/oam-networks"
6439 description: Response codes found in [response codes](https://wiki.onap.org/).
6443 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6446 example: __CLOUD-OWNER__
6447 - name: cloud-region-id
6449 description: Identifier used by the vendor for the region. Second part of composite key
6452 example: __CLOUD-REGION-ID__
6453 - name: network-uuid
6458 - name: network-name
6469 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
6472 - CloudInfrastructure
6473 summary: see node definition for valid relationships
6474 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6483 description: Response codes found in [response codes](https://wiki.onap.org/).
6487 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6490 example: __CLOUD-OWNER__
6491 - name: cloud-region-id
6493 description: Identifier used by the vendor for the region. Second part of composite key
6496 example: __CLOUD-REGION-ID__
6497 - name: availability-zone-name
6499 description: Name of the availability zone. Unique across a cloud region
6502 example: __AVAILABILITY-ZONE-NAME__
6505 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6508 $ref: "#/definitions/relationship"
6511 - CloudInfrastructure
6512 summary: delete an existing relationship
6513 description: delete an existing relationship
6514 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6523 description: Response codes found in [response codes](https://wiki.onap.org/).
6527 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6530 example: __CLOUD-OWNER__
6531 - name: cloud-region-id
6533 description: Identifier used by the vendor for the region. Second part of composite key
6536 example: __CLOUD-REGION-ID__
6537 - name: availability-zone-name
6539 description: Name of the availability zone. Unique across a cloud region
6542 example: __AVAILABILITY-ZONE-NAME__
6543 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
6546 - CloudInfrastructure
6547 summary: returns availability-zone
6548 description: returns availability-zone
6549 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6555 description: successful operation
6557 $ref: "#/getDefinitions/availability-zone"
6559 description: Response codes found in [response codes](https://wiki.onap.org/).
6563 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6566 example: __CLOUD-OWNER__
6567 - name: cloud-region-id
6569 description: Identifier used by the vendor for the region. Second part of composite key
6572 example: __CLOUD-REGION-ID__
6573 - name: availability-zone-name
6575 description: Name of the availability zone. Unique across a cloud region
6578 example: __AVAILABILITY-ZONE-NAME__
6581 - CloudInfrastructure
6582 summary: create or update an existing availability-zone
6584 Create or update an existing availability-zone.
6586 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6587 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6596 description: Response codes found in [response codes](https://wiki.onap.org/).
6600 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6603 example: __CLOUD-OWNER__
6604 - name: cloud-region-id
6606 description: Identifier used by the vendor for the region. Second part of composite key
6609 example: __CLOUD-REGION-ID__
6610 - name: availability-zone-name
6612 description: Name of the availability zone. Unique across a cloud region
6615 example: __AVAILABILITY-ZONE-NAME__
6618 description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6621 $ref: "#/definitions/availability-zone"
6624 - CloudInfrastructure
6625 summary: update an existing availability-zone
6627 Update an existing availability-zone
6629 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6630 The PUT operation will entirely replace an existing object.
6631 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6633 Other differences between PUT and PATCH are:
6635 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6636 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6637 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6638 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6647 description: Response codes found in [response codes](https://wiki.onap.org/).
6651 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6654 example: __CLOUD-OWNER__
6655 - name: cloud-region-id
6657 description: Identifier used by the vendor for the region. Second part of composite key
6660 example: __CLOUD-REGION-ID__
6661 - name: availability-zone-name
6663 description: Name of the availability zone. Unique across a cloud region
6666 example: __AVAILABILITY-ZONE-NAME__
6669 description: availability-zone object that needs to be updated.
6672 $ref: "#/patchDefinitions/availability-zone"
6675 - CloudInfrastructure
6676 summary: delete an existing availability-zone
6677 description: delete an existing availability-zone
6678 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6687 description: Response codes found in [response codes](https://wiki.onap.org/).
6691 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6694 example: __CLOUD-OWNER__
6695 - name: cloud-region-id
6697 description: Identifier used by the vendor for the region. Second part of composite key
6700 example: __CLOUD-REGION-ID__
6701 - name: availability-zone-name
6703 description: Name of the availability zone. Unique across a cloud region
6706 example: __AVAILABILITY-ZONE-NAME__
6707 - name: resource-version
6709 description: resource-version for concurrency
6712 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
6715 - CloudInfrastructure
6716 summary: returns availability-zones
6717 description: returns availability-zones
6718 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
6724 description: successful operation
6726 $ref: "#/getDefinitions/availability-zones"
6728 description: Response codes found in [response codes](https://wiki.onap.org/).
6732 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6735 example: __CLOUD-OWNER__
6736 - name: cloud-region-id
6738 description: Identifier used by the vendor for the region. Second part of composite key
6741 example: __CLOUD-REGION-ID__
6742 - name: availability-zone-name
6747 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
6750 - CloudInfrastructure
6751 summary: see node definition for valid relationships
6752 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6761 description: Response codes found in [response codes](https://wiki.onap.org/).
6765 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6768 example: __CLOUD-OWNER__
6769 - name: cloud-region-id
6771 description: Identifier used by the vendor for the region. Second part of composite key
6774 example: __CLOUD-REGION-ID__
6777 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)
6780 $ref: "#/definitions/relationship"
6783 - CloudInfrastructure
6784 summary: delete an existing relationship
6785 description: delete an existing relationship
6786 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6795 description: Response codes found in [response codes](https://wiki.onap.org/).
6799 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6802 example: __CLOUD-OWNER__
6803 - name: cloud-region-id
6805 description: Identifier used by the vendor for the region. Second part of composite key
6808 example: __CLOUD-REGION-ID__
6809 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
6812 - CloudInfrastructure
6813 summary: see node definition for valid relationships
6814 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
6823 description: Response codes found in [response codes](https://wiki.onap.org/).
6827 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6830 example: __CLOUD-OWNER__
6831 - name: cloud-region-id
6833 description: Identifier used by the vendor for the region. Second part of composite key
6836 example: __CLOUD-REGION-ID__
6837 - name: esr-system-info-id
6839 description: Unique ID of esr system info.
6842 example: __ESR-SYSTEM-INFO-ID__
6845 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
6848 $ref: "#/definitions/relationship"
6851 - CloudInfrastructure
6852 summary: delete an existing relationship
6853 description: delete an existing relationship
6854 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
6863 description: Response codes found in [response codes](https://wiki.onap.org/).
6867 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6870 example: __CLOUD-OWNER__
6871 - name: cloud-region-id
6873 description: Identifier used by the vendor for the region. Second part of composite key
6876 example: __CLOUD-REGION-ID__
6877 - name: esr-system-info-id
6879 description: Unique ID of esr system info.
6882 example: __ESR-SYSTEM-INFO-ID__
6883 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
6886 - CloudInfrastructure
6887 summary: returns esr-system-info
6888 description: returns esr-system-info
6889 operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
6895 description: successful operation
6897 $ref: "#/getDefinitions/esr-system-info"
6899 description: Response codes found in [response codes](https://wiki.onap.org/).
6903 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6906 example: __CLOUD-OWNER__
6907 - name: cloud-region-id
6909 description: Identifier used by the vendor for the region. Second part of composite key
6912 example: __CLOUD-REGION-ID__
6913 - name: esr-system-info-id
6915 description: Unique ID of esr system info.
6918 example: __ESR-SYSTEM-INFO-ID__
6921 - CloudInfrastructure
6922 summary: create or update an existing esr-system-info
6924 Create or update an existing esr-system-info.
6926 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6927 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
6936 description: Response codes found in [response codes](https://wiki.onap.org/).
6940 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6943 example: __CLOUD-OWNER__
6944 - name: cloud-region-id
6946 description: Identifier used by the vendor for the region. Second part of composite key
6949 example: __CLOUD-REGION-ID__
6950 - name: esr-system-info-id
6952 description: Unique ID of esr system info.
6955 example: __ESR-SYSTEM-INFO-ID__
6958 description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
6961 $ref: "#/definitions/esr-system-info"
6964 - CloudInfrastructure
6965 summary: update an existing esr-system-info
6967 Update an existing esr-system-info
6969 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6970 The PUT operation will entirely replace an existing object.
6971 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6973 Other differences between PUT and PATCH are:
6975 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6976 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6977 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6978 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
6987 description: Response codes found in [response codes](https://wiki.onap.org/).
6991 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6994 example: __CLOUD-OWNER__
6995 - name: cloud-region-id
6997 description: Identifier used by the vendor for the region. Second part of composite key
7000 example: __CLOUD-REGION-ID__
7001 - name: esr-system-info-id
7003 description: Unique ID of esr system info.
7006 example: __ESR-SYSTEM-INFO-ID__
7009 description: esr-system-info object that needs to be updated.
7012 $ref: "#/patchDefinitions/esr-system-info"
7015 - CloudInfrastructure
7016 summary: delete an existing esr-system-info
7017 description: delete an existing esr-system-info
7018 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7027 description: Response codes found in [response codes](https://wiki.onap.org/).
7031 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7034 example: __CLOUD-OWNER__
7035 - name: cloud-region-id
7037 description: Identifier used by the vendor for the region. Second part of composite key
7040 example: __CLOUD-REGION-ID__
7041 - name: esr-system-info-id
7043 description: Unique ID of esr system info.
7046 example: __ESR-SYSTEM-INFO-ID__
7047 - name: resource-version
7049 description: resource-version for concurrency
7052 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
7055 - CloudInfrastructure
7056 summary: returns esr-system-info-list
7057 description: returns esr-system-info-list
7058 operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
7064 description: successful operation
7066 $ref: "#/getDefinitions/esr-system-info-list"
7068 description: Response codes found in [response codes](https://wiki.onap.org/).
7072 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7075 example: __CLOUD-OWNER__
7076 - name: cloud-region-id
7078 description: Identifier used by the vendor for the region. Second part of composite key
7081 example: __CLOUD-REGION-ID__
7082 - name: esr-system-info-id
7097 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
7100 - CloudInfrastructure
7101 summary: see node definition for valid relationships
7102 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7111 description: Response codes found in [response codes](https://wiki.onap.org/).
7115 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7118 example: __CLOUD-OWNER__
7119 - name: cloud-region-id
7121 description: Identifier used by the vendor for the region. Second part of composite key
7124 example: __CLOUD-REGION-ID__
7125 - name: vip-ipv4-address
7127 description: IP address
7130 example: __VIP-IPV4-ADDRESS__
7133 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7136 $ref: "#/definitions/relationship"
7139 - CloudInfrastructure
7140 summary: delete an existing relationship
7141 description: delete an existing relationship
7142 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7151 description: Response codes found in [response codes](https://wiki.onap.org/).
7155 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7158 example: __CLOUD-OWNER__
7159 - name: cloud-region-id
7161 description: Identifier used by the vendor for the region. Second part of composite key
7164 example: __CLOUD-REGION-ID__
7165 - name: vip-ipv4-address
7167 description: IP address
7170 example: __VIP-IPV4-ADDRESS__
7171 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
7174 - CloudInfrastructure
7175 summary: returns vip-ipv4-address-list
7176 description: returns vip-ipv4-address-list
7177 operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7183 description: successful operation
7185 $ref: "#/getDefinitions/vip-ipv4-address-list"
7187 description: Response codes found in [response codes](https://wiki.onap.org/).
7191 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7194 example: __CLOUD-OWNER__
7195 - name: cloud-region-id
7197 description: Identifier used by the vendor for the region. Second part of composite key
7200 example: __CLOUD-REGION-ID__
7201 - name: vip-ipv4-address
7203 description: IP address
7206 example: __VIP-IPV4-ADDRESS__
7209 - CloudInfrastructure
7210 summary: create or update an existing vip-ipv4-address-list
7212 Create or update an existing vip-ipv4-address-list.
7214 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7215 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7224 description: Response codes found in [response codes](https://wiki.onap.org/).
7228 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7231 example: __CLOUD-OWNER__
7232 - name: cloud-region-id
7234 description: Identifier used by the vendor for the region. Second part of composite key
7237 example: __CLOUD-REGION-ID__
7238 - name: vip-ipv4-address
7240 description: IP address
7243 example: __VIP-IPV4-ADDRESS__
7246 description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7249 $ref: "#/definitions/vip-ipv4-address-list"
7252 - CloudInfrastructure
7253 summary: update an existing vip-ipv4-address-list
7255 Update an existing vip-ipv4-address-list
7257 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7258 The PUT operation will entirely replace an existing object.
7259 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7261 Other differences between PUT and PATCH are:
7263 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7264 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7265 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7266 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7275 description: Response codes found in [response codes](https://wiki.onap.org/).
7279 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7282 example: __CLOUD-OWNER__
7283 - name: cloud-region-id
7285 description: Identifier used by the vendor for the region. Second part of composite key
7288 example: __CLOUD-REGION-ID__
7289 - name: vip-ipv4-address
7291 description: IP address
7294 example: __VIP-IPV4-ADDRESS__
7297 description: vip-ipv4-address-list object that needs to be updated.
7300 $ref: "#/patchDefinitions/vip-ipv4-address-list"
7303 - CloudInfrastructure
7304 summary: delete an existing vip-ipv4-address-list
7305 description: delete an existing vip-ipv4-address-list
7306 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7315 description: Response codes found in [response codes](https://wiki.onap.org/).
7319 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7322 example: __CLOUD-OWNER__
7323 - name: cloud-region-id
7325 description: Identifier used by the vendor for the region. Second part of composite key
7328 example: __CLOUD-REGION-ID__
7329 - name: vip-ipv4-address
7331 description: IP address
7334 example: __VIP-IPV4-ADDRESS__
7335 - name: resource-version
7337 description: resource-version for concurrency
7340 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
7343 - CloudInfrastructure
7344 summary: see node definition for valid relationships
7345 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7354 description: Response codes found in [response codes](https://wiki.onap.org/).
7358 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7361 example: __CLOUD-OWNER__
7362 - name: cloud-region-id
7364 description: Identifier used by the vendor for the region. Second part of composite key
7367 example: __CLOUD-REGION-ID__
7368 - name: vip-ipv6-address
7370 description: IP address
7373 example: __VIP-IPV6-ADDRESS__
7376 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7379 $ref: "#/definitions/relationship"
7382 - CloudInfrastructure
7383 summary: delete an existing relationship
7384 description: delete an existing relationship
7385 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7394 description: Response codes found in [response codes](https://wiki.onap.org/).
7398 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7401 example: __CLOUD-OWNER__
7402 - name: cloud-region-id
7404 description: Identifier used by the vendor for the region. Second part of composite key
7407 example: __CLOUD-REGION-ID__
7408 - name: vip-ipv6-address
7410 description: IP address
7413 example: __VIP-IPV6-ADDRESS__
7414 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
7417 - CloudInfrastructure
7418 summary: returns vip-ipv6-address-list
7419 description: returns vip-ipv6-address-list
7420 operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7426 description: successful operation
7428 $ref: "#/getDefinitions/vip-ipv6-address-list"
7430 description: Response codes found in [response codes](https://wiki.onap.org/).
7434 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7437 example: __CLOUD-OWNER__
7438 - name: cloud-region-id
7440 description: Identifier used by the vendor for the region. Second part of composite key
7443 example: __CLOUD-REGION-ID__
7444 - name: vip-ipv6-address
7446 description: IP address
7449 example: __VIP-IPV6-ADDRESS__
7452 - CloudInfrastructure
7453 summary: create or update an existing vip-ipv6-address-list
7455 Create or update an existing vip-ipv6-address-list.
7457 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7458 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7467 description: Response codes found in [response codes](https://wiki.onap.org/).
7471 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7474 example: __CLOUD-OWNER__
7475 - name: cloud-region-id
7477 description: Identifier used by the vendor for the region. Second part of composite key
7480 example: __CLOUD-REGION-ID__
7481 - name: vip-ipv6-address
7483 description: IP address
7486 example: __VIP-IPV6-ADDRESS__
7489 description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7492 $ref: "#/definitions/vip-ipv6-address-list"
7495 - CloudInfrastructure
7496 summary: update an existing vip-ipv6-address-list
7498 Update an existing vip-ipv6-address-list
7500 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7501 The PUT operation will entirely replace an existing object.
7502 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7504 Other differences between PUT and PATCH are:
7506 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7507 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7508 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7509 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7518 description: Response codes found in [response codes](https://wiki.onap.org/).
7522 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7525 example: __CLOUD-OWNER__
7526 - name: cloud-region-id
7528 description: Identifier used by the vendor for the region. Second part of composite key
7531 example: __CLOUD-REGION-ID__
7532 - name: vip-ipv6-address
7534 description: IP address
7537 example: __VIP-IPV6-ADDRESS__
7540 description: vip-ipv6-address-list object that needs to be updated.
7543 $ref: "#/patchDefinitions/vip-ipv6-address-list"
7546 - CloudInfrastructure
7547 summary: delete an existing vip-ipv6-address-list
7548 description: delete an existing vip-ipv6-address-list
7549 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7558 description: Response codes found in [response codes](https://wiki.onap.org/).
7562 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7565 example: __CLOUD-OWNER__
7566 - name: cloud-region-id
7568 description: Identifier used by the vendor for the region. Second part of composite key
7571 example: __CLOUD-REGION-ID__
7572 - name: vip-ipv6-address
7574 description: IP address
7577 example: __VIP-IPV6-ADDRESS__
7578 - name: resource-version
7580 description: resource-version for concurrency
7583 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
7586 - CloudInfrastructure
7587 summary: returns cloud-region
7588 description: returns cloud-region
7589 operationId: getCloudInfrastructureCloudRegionsCloudRegion
7595 description: successful operation
7597 $ref: "#/getDefinitions/cloud-region"
7599 description: Response codes found in [response codes](https://wiki.onap.org/).
7603 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7606 example: __CLOUD-OWNER__
7607 - name: cloud-region-id
7609 description: Identifier used by the vendor for the region. Second part of composite key
7612 example: __CLOUD-REGION-ID__
7615 - CloudInfrastructure
7616 summary: create or update an existing cloud-region
7618 Create or update an existing cloud-region.
7620 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7621 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
7630 description: Response codes found in [response codes](https://wiki.onap.org/).
7634 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7637 example: __CLOUD-OWNER__
7638 - name: cloud-region-id
7640 description: Identifier used by the vendor for the region. Second part of composite key
7643 example: __CLOUD-REGION-ID__
7646 description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)
7649 $ref: "#/definitions/cloud-region"
7652 - CloudInfrastructure
7653 summary: update an existing cloud-region
7655 Update an existing cloud-region
7657 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7658 The PUT operation will entirely replace an existing object.
7659 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7661 Other differences between PUT and PATCH are:
7663 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7664 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7665 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7666 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
7675 description: Response codes found in [response codes](https://wiki.onap.org/).
7679 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7682 example: __CLOUD-OWNER__
7683 - name: cloud-region-id
7685 description: Identifier used by the vendor for the region. Second part of composite key
7688 example: __CLOUD-REGION-ID__
7691 description: cloud-region object that needs to be updated.
7694 $ref: "#/patchDefinitions/cloud-region"
7697 - CloudInfrastructure
7698 summary: delete an existing cloud-region
7699 description: delete an existing cloud-region
7700 operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
7709 description: Response codes found in [response codes](https://wiki.onap.org/).
7713 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7716 example: __CLOUD-OWNER__
7717 - name: cloud-region-id
7719 description: Identifier used by the vendor for the region. Second part of composite key
7722 example: __CLOUD-REGION-ID__
7723 - name: resource-version
7725 description: resource-version for concurrency
7728 /cloud-infrastructure/cloud-regions:
7731 - CloudInfrastructure
7732 summary: returns cloud-regions
7733 description: returns cloud-regions
7734 operationId: getCloudInfrastructureCloudRegions
7740 description: successful operation
7742 $ref: "#/getDefinitions/cloud-regions"
7744 description: Response codes found in [response codes](https://wiki.onap.org/).
7751 - name: cloud-region-id
7761 - name: owner-defined-type
7766 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
7769 - CloudInfrastructure
7770 summary: see node definition for valid relationships
7771 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7780 description: Response codes found in [response codes](https://wiki.onap.org/).
7782 - name: nm-profile-name
7784 description: Unique name of network profile.
7787 example: __NM-PROFILE-NAME__
7790 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7793 $ref: "#/definitions/relationship"
7796 - CloudInfrastructure
7797 summary: delete an existing relationship
7798 description: delete an existing relationship
7799 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7808 description: Response codes found in [response codes](https://wiki.onap.org/).
7810 - name: nm-profile-name
7812 description: Unique name of network profile.
7815 example: __NM-PROFILE-NAME__
7816 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7819 - CloudInfrastructure
7820 summary: returns network-profile
7821 description: returns network-profile
7822 operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7828 description: successful operation
7830 $ref: "#/getDefinitions/network-profile"
7832 description: Response codes found in [response codes](https://wiki.onap.org/).
7834 - name: nm-profile-name
7836 description: Unique name of network profile.
7839 example: __NM-PROFILE-NAME__
7842 - CloudInfrastructure
7843 summary: create or update an existing network-profile
7845 Create or update an existing network-profile.
7847 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7848 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
7857 description: Response codes found in [response codes](https://wiki.onap.org/).
7859 - name: nm-profile-name
7861 description: Unique name of network profile.
7864 example: __NM-PROFILE-NAME__
7867 description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7870 $ref: "#/definitions/network-profile"
7873 - CloudInfrastructure
7874 summary: update an existing network-profile
7876 Update an existing network-profile
7878 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7879 The PUT operation will entirely replace an existing object.
7880 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7882 Other differences between PUT and PATCH are:
7884 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7885 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7886 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7887 operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7896 description: Response codes found in [response codes](https://wiki.onap.org/).
7898 - name: nm-profile-name
7900 description: Unique name of network profile.
7903 example: __NM-PROFILE-NAME__
7906 description: network-profile object that needs to be updated.
7909 $ref: "#/patchDefinitions/network-profile"
7912 - CloudInfrastructure
7913 summary: delete an existing network-profile
7914 description: delete an existing network-profile
7915 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
7924 description: Response codes found in [response codes](https://wiki.onap.org/).
7926 - name: nm-profile-name
7928 description: Unique name of network profile.
7931 example: __NM-PROFILE-NAME__
7932 - name: resource-version
7934 description: resource-version for concurrency
7937 /cloud-infrastructure/network-profiles:
7940 - CloudInfrastructure
7941 summary: returns network-profiles
7942 description: returns network-profiles
7943 operationId: getCloudInfrastructureNetworkProfiles
7949 description: successful operation
7951 $ref: "#/getDefinitions/network-profiles"
7953 description: Response codes found in [response codes](https://wiki.onap.org/).
7955 - name: nm-profile-name
7960 /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
7963 - CloudInfrastructure
7964 summary: see node definition for valid relationships
7965 operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
7974 description: Response codes found in [response codes](https://wiki.onap.org/).
7978 description: Value from executing hostname on the compute node.
7981 example: __HOSTNAME__
7984 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)
7987 $ref: "#/definitions/relationship"
7990 - CloudInfrastructure
7991 summary: delete an existing relationship
7992 description: delete an existing relationship
7993 operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
8002 description: Response codes found in [response codes](https://wiki.onap.org/).
8006 description: Value from executing hostname on the compute node.
8009 example: __HOSTNAME__
8010 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
8013 - CloudInfrastructure
8014 summary: see node definition for valid relationships
8015 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8024 description: Response codes found in [response codes](https://wiki.onap.org/).
8028 description: Value from executing hostname on the compute node.
8031 example: __HOSTNAME__
8032 - name: interface-name
8034 description: Name that identifies the physical interface
8037 example: __INTERFACE-NAME__
8040 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
8043 $ref: "#/definitions/relationship"
8046 - CloudInfrastructure
8047 summary: delete an existing relationship
8048 description: delete an existing relationship
8049 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8058 description: Response codes found in [response codes](https://wiki.onap.org/).
8062 description: Value from executing hostname on the compute node.
8065 example: __HOSTNAME__
8066 - name: interface-name
8068 description: Name that identifies the physical interface
8071 example: __INTERFACE-NAME__
8072 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
8075 - CloudInfrastructure
8076 summary: see node definition for valid relationships
8077 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
8086 description: Response codes found in [response codes](https://wiki.onap.org/).
8090 description: Value from executing hostname on the compute node.
8093 example: __HOSTNAME__
8094 - name: interface-name
8096 description: Name that identifies the physical interface
8099 example: __INTERFACE-NAME__
8102 description: Identifier for the sriov-pf
8105 example: __PF-PCI-ID__
8108 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
8111 $ref: "#/definitions/relationship"
8114 - CloudInfrastructure
8115 summary: delete an existing relationship
8116 description: delete an existing relationship
8117 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
8126 description: Response codes found in [response codes](https://wiki.onap.org/).
8130 description: Value from executing hostname on the compute node.
8133 example: __HOSTNAME__
8134 - name: interface-name
8136 description: Name that identifies the physical interface
8139 example: __INTERFACE-NAME__
8142 description: Identifier for the sriov-pf
8145 example: __PF-PCI-ID__
8146 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
8149 - CloudInfrastructure
8150 summary: returns sriov-pf
8151 description: returns sriov-pf
8152 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8158 description: successful operation
8160 $ref: "#/getDefinitions/sriov-pf"
8162 description: Response codes found in [response codes](https://wiki.onap.org/).
8166 description: Value from executing hostname on the compute node.
8169 example: __HOSTNAME__
8170 - name: interface-name
8172 description: Name that identifies the physical interface
8175 example: __INTERFACE-NAME__
8178 description: Identifier for the sriov-pf
8181 example: __PF-PCI-ID__
8184 - CloudInfrastructure
8185 summary: create or update an existing sriov-pf
8187 Create or update an existing sriov-pf.
8189 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8190 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8199 description: Response codes found in [response codes](https://wiki.onap.org/).
8203 description: Value from executing hostname on the compute node.
8206 example: __HOSTNAME__
8207 - name: interface-name
8209 description: Name that identifies the physical interface
8212 example: __INTERFACE-NAME__
8215 description: Identifier for the sriov-pf
8218 example: __PF-PCI-ID__
8221 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
8224 $ref: "#/definitions/sriov-pf"
8227 - CloudInfrastructure
8228 summary: update an existing sriov-pf
8230 Update an existing sriov-pf
8232 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8233 The PUT operation will entirely replace an existing object.
8234 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8236 Other differences between PUT and PATCH are:
8238 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8239 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8240 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8241 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8250 description: Response codes found in [response codes](https://wiki.onap.org/).
8254 description: Value from executing hostname on the compute node.
8257 example: __HOSTNAME__
8258 - name: interface-name
8260 description: Name that identifies the physical interface
8263 example: __INTERFACE-NAME__
8266 description: Identifier for the sriov-pf
8269 example: __PF-PCI-ID__
8272 description: sriov-pf object that needs to be updated.
8275 $ref: "#/patchDefinitions/sriov-pf"
8278 - CloudInfrastructure
8279 summary: delete an existing sriov-pf
8280 description: delete an existing sriov-pf
8281 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
8290 description: Response codes found in [response codes](https://wiki.onap.org/).
8294 description: Value from executing hostname on the compute node.
8297 example: __HOSTNAME__
8298 - name: interface-name
8300 description: Name that identifies the physical interface
8303 example: __INTERFACE-NAME__
8306 description: Identifier for the sriov-pf
8309 example: __PF-PCI-ID__
8310 - name: resource-version
8312 description: resource-version for concurrency
8315 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
8318 - CloudInfrastructure
8319 summary: returns sriov-pfs
8320 description: returns sriov-pfs
8321 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
8327 description: successful operation
8329 $ref: "#/getDefinitions/sriov-pfs"
8331 description: Response codes found in [response codes](https://wiki.onap.org/).
8335 description: Value from executing hostname on the compute node.
8338 example: __HOSTNAME__
8339 - name: interface-name
8341 description: Name that identifies the physical interface
8344 example: __INTERFACE-NAME__
8350 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
8353 - CloudInfrastructure
8354 summary: see node definition for valid relationships
8355 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
8364 description: Response codes found in [response codes](https://wiki.onap.org/).
8368 description: Value from executing hostname on the compute node.
8371 example: __HOSTNAME__
8372 - name: interface-name
8374 description: Name that identifies the physical interface
8377 example: __INTERFACE-NAME__
8378 - name: interface-name
8380 description: Name given to the interface
8383 example: __INTERFACE-NAME__
8384 - name: vlan-interface
8386 description: String that identifies the interface
8389 example: __VLAN-INTERFACE__
8392 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8395 $ref: "#/definitions/relationship"
8398 - CloudInfrastructure
8399 summary: delete an existing relationship
8400 description: delete an existing relationship
8401 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
8410 description: Response codes found in [response codes](https://wiki.onap.org/).
8414 description: Value from executing hostname on the compute node.
8417 example: __HOSTNAME__
8418 - name: interface-name
8420 description: Name that identifies the physical interface
8423 example: __INTERFACE-NAME__
8424 - name: interface-name
8426 description: Name given to the interface
8429 example: __INTERFACE-NAME__
8430 - name: vlan-interface
8432 description: String that identifies the interface
8435 example: __VLAN-INTERFACE__
8436 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
8439 - CloudInfrastructure
8440 summary: see node definition for valid relationships
8441 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
8450 description: Response codes found in [response codes](https://wiki.onap.org/).
8454 description: Value from executing hostname on the compute node.
8457 example: __HOSTNAME__
8458 - name: interface-name
8460 description: Name that identifies the physical interface
8463 example: __INTERFACE-NAME__
8464 - name: interface-name
8466 description: Name given to the interface
8469 example: __INTERFACE-NAME__
8470 - name: vlan-interface
8472 description: String that identifies the interface
8475 example: __VLAN-INTERFACE__
8476 - name: l3-interface-ipv4-address
8478 description: IP address
8481 example: __L3-INTERFACE-IPV4-ADDRESS__
8484 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8487 $ref: "#/definitions/relationship"
8490 - CloudInfrastructure
8491 summary: delete an existing relationship
8492 description: delete an existing relationship
8493 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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__
8522 - name: vlan-interface
8524 description: String that identifies the interface
8527 example: __VLAN-INTERFACE__
8528 - name: l3-interface-ipv4-address
8530 description: IP address
8533 example: __L3-INTERFACE-IPV4-ADDRESS__
8534 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
8537 - CloudInfrastructure
8538 summary: returns l3-interface-ipv4-address-list
8539 description: returns l3-interface-ipv4-address-list
8540 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8546 description: successful operation
8548 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8550 description: Response codes found in [response codes](https://wiki.onap.org/).
8554 description: Value from executing hostname on the compute node.
8557 example: __HOSTNAME__
8558 - name: interface-name
8560 description: Name that identifies the physical interface
8563 example: __INTERFACE-NAME__
8564 - name: interface-name
8566 description: Name given to the interface
8569 example: __INTERFACE-NAME__
8570 - name: vlan-interface
8572 description: String that identifies the interface
8575 example: __VLAN-INTERFACE__
8576 - name: l3-interface-ipv4-address
8578 description: IP address
8581 example: __L3-INTERFACE-IPV4-ADDRESS__
8584 - CloudInfrastructure
8585 summary: create or update an existing l3-interface-ipv4-address-list
8587 Create or update an existing l3-interface-ipv4-address-list.
8589 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8590 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8599 description: Response codes found in [response codes](https://wiki.onap.org/).
8603 description: Value from executing hostname on the compute node.
8606 example: __HOSTNAME__
8607 - name: interface-name
8609 description: Name that identifies the physical interface
8612 example: __INTERFACE-NAME__
8613 - name: interface-name
8615 description: Name given to the interface
8618 example: __INTERFACE-NAME__
8619 - name: vlan-interface
8621 description: String that identifies the interface
8624 example: __VLAN-INTERFACE__
8625 - name: l3-interface-ipv4-address
8627 description: IP address
8630 example: __L3-INTERFACE-IPV4-ADDRESS__
8633 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8636 $ref: "#/definitions/l3-interface-ipv4-address-list"
8639 - CloudInfrastructure
8640 summary: update an existing l3-interface-ipv4-address-list
8642 Update an existing l3-interface-ipv4-address-list
8644 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8645 The PUT operation will entirely replace an existing object.
8646 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8648 Other differences between PUT and PATCH are:
8650 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8651 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8652 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8653 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8662 description: Response codes found in [response codes](https://wiki.onap.org/).
8666 description: Value from executing hostname on the compute node.
8669 example: __HOSTNAME__
8670 - name: interface-name
8672 description: Name that identifies the physical interface
8675 example: __INTERFACE-NAME__
8676 - name: interface-name
8678 description: Name given to the interface
8681 example: __INTERFACE-NAME__
8682 - name: vlan-interface
8684 description: String that identifies the interface
8687 example: __VLAN-INTERFACE__
8688 - name: l3-interface-ipv4-address
8690 description: IP address
8693 example: __L3-INTERFACE-IPV4-ADDRESS__
8696 description: l3-interface-ipv4-address-list object that needs to be updated.
8699 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8702 - CloudInfrastructure
8703 summary: delete an existing l3-interface-ipv4-address-list
8704 description: delete an existing l3-interface-ipv4-address-list
8705 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8714 description: Response codes found in [response codes](https://wiki.onap.org/).
8718 description: Value from executing hostname on the compute node.
8721 example: __HOSTNAME__
8722 - name: interface-name
8724 description: Name that identifies the physical interface
8727 example: __INTERFACE-NAME__
8728 - name: interface-name
8730 description: Name given to the interface
8733 example: __INTERFACE-NAME__
8734 - name: vlan-interface
8736 description: String that identifies the interface
8739 example: __VLAN-INTERFACE__
8740 - name: l3-interface-ipv4-address
8742 description: IP address
8745 example: __L3-INTERFACE-IPV4-ADDRESS__
8746 - name: resource-version
8748 description: resource-version for concurrency
8751 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
8754 - CloudInfrastructure
8755 summary: see node definition for valid relationships
8756 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8765 description: Response codes found in [response codes](https://wiki.onap.org/).
8769 description: Value from executing hostname on the compute node.
8772 example: __HOSTNAME__
8773 - name: interface-name
8775 description: Name that identifies the physical interface
8778 example: __INTERFACE-NAME__
8779 - name: interface-name
8781 description: Name given to the interface
8784 example: __INTERFACE-NAME__
8785 - name: vlan-interface
8787 description: String that identifies the interface
8790 example: __VLAN-INTERFACE__
8791 - name: l3-interface-ipv6-address
8793 description: IP address
8796 example: __L3-INTERFACE-IPV6-ADDRESS__
8799 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8802 $ref: "#/definitions/relationship"
8805 - CloudInfrastructure
8806 summary: delete an existing relationship
8807 description: delete an existing relationship
8808 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8817 description: Response codes found in [response codes](https://wiki.onap.org/).
8821 description: Value from executing hostname on the compute node.
8824 example: __HOSTNAME__
8825 - name: interface-name
8827 description: Name that identifies the physical interface
8830 example: __INTERFACE-NAME__
8831 - name: interface-name
8833 description: Name given to the interface
8836 example: __INTERFACE-NAME__
8837 - name: vlan-interface
8839 description: String that identifies the interface
8842 example: __VLAN-INTERFACE__
8843 - name: l3-interface-ipv6-address
8845 description: IP address
8848 example: __L3-INTERFACE-IPV6-ADDRESS__
8849 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
8852 - CloudInfrastructure
8853 summary: returns l3-interface-ipv6-address-list
8854 description: returns l3-interface-ipv6-address-list
8855 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8861 description: successful operation
8863 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
8865 description: Response codes found in [response codes](https://wiki.onap.org/).
8869 description: Value from executing hostname on the compute node.
8872 example: __HOSTNAME__
8873 - name: interface-name
8875 description: Name that identifies the physical interface
8878 example: __INTERFACE-NAME__
8879 - name: interface-name
8881 description: Name given to the interface
8884 example: __INTERFACE-NAME__
8885 - name: vlan-interface
8887 description: String that identifies the interface
8890 example: __VLAN-INTERFACE__
8891 - name: l3-interface-ipv6-address
8893 description: IP address
8896 example: __L3-INTERFACE-IPV6-ADDRESS__
8899 - CloudInfrastructure
8900 summary: create or update an existing l3-interface-ipv6-address-list
8902 Create or update an existing l3-interface-ipv6-address-list.
8904 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8905 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8914 description: Response codes found in [response codes](https://wiki.onap.org/).
8918 description: Value from executing hostname on the compute node.
8921 example: __HOSTNAME__
8922 - name: interface-name
8924 description: Name that identifies the physical interface
8927 example: __INTERFACE-NAME__
8928 - name: interface-name
8930 description: Name given to the interface
8933 example: __INTERFACE-NAME__
8934 - name: vlan-interface
8936 description: String that identifies the interface
8939 example: __VLAN-INTERFACE__
8940 - name: l3-interface-ipv6-address
8942 description: IP address
8945 example: __L3-INTERFACE-IPV6-ADDRESS__
8948 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8951 $ref: "#/definitions/l3-interface-ipv6-address-list"
8954 - CloudInfrastructure
8955 summary: update an existing l3-interface-ipv6-address-list
8957 Update an existing l3-interface-ipv6-address-list
8959 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8960 The PUT operation will entirely replace an existing object.
8961 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8963 Other differences between PUT and PATCH are:
8965 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8966 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8967 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8968 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8977 description: Response codes found in [response codes](https://wiki.onap.org/).
8981 description: Value from executing hostname on the compute node.
8984 example: __HOSTNAME__
8985 - name: interface-name
8987 description: Name that identifies the physical interface
8990 example: __INTERFACE-NAME__
8991 - name: interface-name
8993 description: Name given to the interface
8996 example: __INTERFACE-NAME__
8997 - name: vlan-interface
8999 description: String that identifies the interface
9002 example: __VLAN-INTERFACE__
9003 - name: l3-interface-ipv6-address
9005 description: IP address
9008 example: __L3-INTERFACE-IPV6-ADDRESS__
9011 description: l3-interface-ipv6-address-list object that needs to be updated.
9014 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9017 - CloudInfrastructure
9018 summary: delete an existing l3-interface-ipv6-address-list
9019 description: delete an existing l3-interface-ipv6-address-list
9020 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9029 description: Response codes found in [response codes](https://wiki.onap.org/).
9033 description: Value from executing hostname on the compute node.
9036 example: __HOSTNAME__
9037 - name: interface-name
9039 description: Name that identifies the physical interface
9042 example: __INTERFACE-NAME__
9043 - name: interface-name
9045 description: Name given to the interface
9048 example: __INTERFACE-NAME__
9049 - name: vlan-interface
9051 description: String that identifies the interface
9054 example: __VLAN-INTERFACE__
9055 - name: l3-interface-ipv6-address
9057 description: IP address
9060 example: __L3-INTERFACE-IPV6-ADDRESS__
9061 - name: resource-version
9063 description: resource-version for concurrency
9066 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
9069 - CloudInfrastructure
9070 summary: returns vlan
9071 description: returns vlan
9072 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9078 description: successful operation
9080 $ref: "#/getDefinitions/vlan"
9082 description: Response codes found in [response codes](https://wiki.onap.org/).
9086 description: Value from executing hostname on the compute node.
9089 example: __HOSTNAME__
9090 - name: interface-name
9092 description: Name that identifies the physical interface
9095 example: __INTERFACE-NAME__
9096 - name: interface-name
9098 description: Name given to the interface
9101 example: __INTERFACE-NAME__
9102 - name: vlan-interface
9104 description: String that identifies the interface
9107 example: __VLAN-INTERFACE__
9110 - CloudInfrastructure
9111 summary: create or update an existing vlan
9113 Create or update an existing vlan.
9115 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9116 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9125 description: Response codes found in [response codes](https://wiki.onap.org/).
9129 description: Value from executing hostname on the compute node.
9132 example: __HOSTNAME__
9133 - name: interface-name
9135 description: Name that identifies the physical interface
9138 example: __INTERFACE-NAME__
9139 - name: interface-name
9141 description: Name given to the interface
9144 example: __INTERFACE-NAME__
9145 - name: vlan-interface
9147 description: String that identifies the interface
9150 example: __VLAN-INTERFACE__
9153 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9156 $ref: "#/definitions/vlan"
9159 - CloudInfrastructure
9160 summary: update an existing vlan
9162 Update an existing vlan
9164 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9165 The PUT operation will entirely replace an existing object.
9166 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9168 Other differences between PUT and PATCH are:
9170 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9171 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9172 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9173 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9182 description: Response codes found in [response codes](https://wiki.onap.org/).
9186 description: Value from executing hostname on the compute node.
9189 example: __HOSTNAME__
9190 - name: interface-name
9192 description: Name that identifies the physical interface
9195 example: __INTERFACE-NAME__
9196 - name: interface-name
9198 description: Name given to the interface
9201 example: __INTERFACE-NAME__
9202 - name: vlan-interface
9204 description: String that identifies the interface
9207 example: __VLAN-INTERFACE__
9210 description: vlan object that needs to be updated.
9213 $ref: "#/patchDefinitions/vlan"
9216 - CloudInfrastructure
9217 summary: delete an existing vlan
9218 description: delete an existing vlan
9219 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9228 description: Response codes found in [response codes](https://wiki.onap.org/).
9232 description: Value from executing hostname on the compute node.
9235 example: __HOSTNAME__
9236 - name: interface-name
9238 description: Name that identifies the physical interface
9241 example: __INTERFACE-NAME__
9242 - name: interface-name
9244 description: Name given to the interface
9247 example: __INTERFACE-NAME__
9248 - name: vlan-interface
9250 description: String that identifies the interface
9253 example: __VLAN-INTERFACE__
9254 - name: resource-version
9256 description: resource-version for concurrency
9259 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
9262 - CloudInfrastructure
9263 summary: returns vlans
9264 description: returns vlans
9265 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
9271 description: successful operation
9273 $ref: "#/getDefinitions/vlans"
9275 description: Response codes found in [response codes](https://wiki.onap.org/).
9279 description: Value from executing hostname on the compute node.
9282 example: __HOSTNAME__
9283 - name: interface-name
9285 description: Name that identifies the physical interface
9288 example: __INTERFACE-NAME__
9289 - name: interface-name
9291 description: Name given to the interface
9294 example: __INTERFACE-NAME__
9295 - name: vlan-interface
9300 - name: vlan-id-inner
9311 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
9314 - CloudInfrastructure
9315 summary: see node definition for valid relationships
9316 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9325 description: Response codes found in [response codes](https://wiki.onap.org/).
9329 description: Value from executing hostname on the compute node.
9332 example: __HOSTNAME__
9333 - name: interface-name
9335 description: Name that identifies the physical interface
9338 example: __INTERFACE-NAME__
9339 - name: interface-name
9341 description: Name given to the interface
9344 example: __INTERFACE-NAME__
9347 description: PCI ID used to identify the sriov-vf
9353 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9356 $ref: "#/definitions/relationship"
9359 - CloudInfrastructure
9360 summary: delete an existing relationship
9361 description: delete an existing relationship
9362 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9371 description: Response codes found in [response codes](https://wiki.onap.org/).
9375 description: Value from executing hostname on the compute node.
9378 example: __HOSTNAME__
9379 - name: interface-name
9381 description: Name that identifies the physical interface
9384 example: __INTERFACE-NAME__
9385 - name: interface-name
9387 description: Name given to the interface
9390 example: __INTERFACE-NAME__
9393 description: PCI ID used to identify the sriov-vf
9397 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
9400 - CloudInfrastructure
9401 summary: returns sriov-vf
9402 description: returns sriov-vf
9403 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9409 description: successful operation
9411 $ref: "#/getDefinitions/sriov-vf"
9413 description: Response codes found in [response codes](https://wiki.onap.org/).
9417 description: Value from executing hostname on the compute node.
9420 example: __HOSTNAME__
9421 - name: interface-name
9423 description: Name that identifies the physical interface
9426 example: __INTERFACE-NAME__
9427 - name: interface-name
9429 description: Name given to the interface
9432 example: __INTERFACE-NAME__
9435 description: PCI ID used to identify the sriov-vf
9441 - CloudInfrastructure
9442 summary: create or update an existing sriov-vf
9444 Create or update an existing sriov-vf.
9446 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9447 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9456 description: Response codes found in [response codes](https://wiki.onap.org/).
9460 description: Value from executing hostname on the compute node.
9463 example: __HOSTNAME__
9464 - name: interface-name
9466 description: Name that identifies the physical interface
9469 example: __INTERFACE-NAME__
9470 - name: interface-name
9472 description: Name given to the interface
9475 example: __INTERFACE-NAME__
9478 description: PCI ID used to identify the sriov-vf
9484 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9487 $ref: "#/definitions/sriov-vf"
9490 - CloudInfrastructure
9491 summary: update an existing sriov-vf
9493 Update an existing sriov-vf
9495 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9496 The PUT operation will entirely replace an existing object.
9497 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9499 Other differences between PUT and PATCH are:
9501 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9502 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9503 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9504 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9513 description: Response codes found in [response codes](https://wiki.onap.org/).
9517 description: Value from executing hostname on the compute node.
9520 example: __HOSTNAME__
9521 - name: interface-name
9523 description: Name that identifies the physical interface
9526 example: __INTERFACE-NAME__
9527 - name: interface-name
9529 description: Name given to the interface
9532 example: __INTERFACE-NAME__
9535 description: PCI ID used to identify the sriov-vf
9541 description: sriov-vf object that needs to be updated.
9544 $ref: "#/patchDefinitions/sriov-vf"
9547 - CloudInfrastructure
9548 summary: delete an existing sriov-vf
9549 description: delete an existing sriov-vf
9550 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9559 description: Response codes found in [response codes](https://wiki.onap.org/).
9563 description: Value from executing hostname on the compute node.
9566 example: __HOSTNAME__
9567 - name: interface-name
9569 description: Name that identifies the physical interface
9572 example: __INTERFACE-NAME__
9573 - name: interface-name
9575 description: Name given to the interface
9578 example: __INTERFACE-NAME__
9581 description: PCI ID used to identify the sriov-vf
9585 - name: resource-version
9587 description: resource-version for concurrency
9590 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
9593 - CloudInfrastructure
9594 summary: returns sriov-vfs
9595 description: returns sriov-vfs
9596 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
9602 description: successful operation
9604 $ref: "#/getDefinitions/sriov-vfs"
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
9616 description: Name that identifies the physical interface
9619 example: __INTERFACE-NAME__
9620 - name: interface-name
9622 description: Name given to the interface
9625 example: __INTERFACE-NAME__
9631 - name: vf-vlan-filter
9636 - name: vf-mac-filter
9641 - name: vf-vlan-strip
9646 - name: neutron-network-id
9651 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
9654 - CloudInfrastructure
9655 summary: see node definition for valid relationships
9656 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9665 description: Response codes found in [response codes](https://wiki.onap.org/).
9669 description: Value from executing hostname on the compute node.
9672 example: __HOSTNAME__
9673 - name: interface-name
9675 description: Name that identifies the physical interface
9678 example: __INTERFACE-NAME__
9679 - name: interface-name
9681 description: Name given to the interface
9684 example: __INTERFACE-NAME__
9687 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9690 $ref: "#/definitions/relationship"
9693 - CloudInfrastructure
9694 summary: delete an existing relationship
9695 description: delete an existing relationship
9696 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9705 description: Response codes found in [response codes](https://wiki.onap.org/).
9709 description: Value from executing hostname on the compute node.
9712 example: __HOSTNAME__
9713 - name: interface-name
9715 description: Name that identifies the physical interface
9718 example: __INTERFACE-NAME__
9719 - name: interface-name
9721 description: Name given to the interface
9724 example: __INTERFACE-NAME__
9725 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9728 - CloudInfrastructure
9729 summary: see node definition for valid relationships
9730 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9739 description: Response codes found in [response codes](https://wiki.onap.org/).
9743 description: Value from executing hostname on the compute node.
9746 example: __HOSTNAME__
9747 - name: interface-name
9749 description: Name that identifies the physical interface
9752 example: __INTERFACE-NAME__
9753 - name: interface-name
9755 description: Name given to the interface
9758 example: __INTERFACE-NAME__
9759 - name: l3-interface-ipv4-address
9761 description: IP address
9764 example: __L3-INTERFACE-IPV4-ADDRESS__
9767 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9770 $ref: "#/definitions/relationship"
9773 - CloudInfrastructure
9774 summary: delete an existing relationship
9775 description: delete an existing relationship
9776 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9785 description: Response codes found in [response codes](https://wiki.onap.org/).
9789 description: Value from executing hostname on the compute node.
9792 example: __HOSTNAME__
9793 - name: interface-name
9795 description: Name that identifies the physical interface
9798 example: __INTERFACE-NAME__
9799 - name: interface-name
9801 description: Name given to the interface
9804 example: __INTERFACE-NAME__
9805 - name: l3-interface-ipv4-address
9807 description: IP address
9810 example: __L3-INTERFACE-IPV4-ADDRESS__
9811 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9814 - CloudInfrastructure
9815 summary: returns l3-interface-ipv4-address-list
9816 description: returns l3-interface-ipv4-address-list
9817 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9823 description: successful operation
9825 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9827 description: Response codes found in [response codes](https://wiki.onap.org/).
9831 description: Value from executing hostname on the compute node.
9834 example: __HOSTNAME__
9835 - name: interface-name
9837 description: Name that identifies the physical interface
9840 example: __INTERFACE-NAME__
9841 - name: interface-name
9843 description: Name given to the interface
9846 example: __INTERFACE-NAME__
9847 - name: l3-interface-ipv4-address
9849 description: IP address
9852 example: __L3-INTERFACE-IPV4-ADDRESS__
9855 - CloudInfrastructure
9856 summary: create or update an existing l3-interface-ipv4-address-list
9858 Create or update an existing l3-interface-ipv4-address-list.
9860 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9861 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9870 description: Response codes found in [response codes](https://wiki.onap.org/).
9874 description: Value from executing hostname on the compute node.
9877 example: __HOSTNAME__
9878 - name: interface-name
9880 description: Name that identifies the physical interface
9883 example: __INTERFACE-NAME__
9884 - name: interface-name
9886 description: Name given to the interface
9889 example: __INTERFACE-NAME__
9890 - name: l3-interface-ipv4-address
9892 description: IP address
9895 example: __L3-INTERFACE-IPV4-ADDRESS__
9898 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9901 $ref: "#/definitions/l3-interface-ipv4-address-list"
9904 - CloudInfrastructure
9905 summary: update an existing l3-interface-ipv4-address-list
9907 Update an existing l3-interface-ipv4-address-list
9909 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9910 The PUT operation will entirely replace an existing object.
9911 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9913 Other differences between PUT and PATCH are:
9915 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9916 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9917 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9918 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9927 description: Response codes found in [response codes](https://wiki.onap.org/).
9931 description: Value from executing hostname on the compute node.
9934 example: __HOSTNAME__
9935 - name: interface-name
9937 description: Name that identifies the physical interface
9940 example: __INTERFACE-NAME__
9941 - name: interface-name
9943 description: Name given to the interface
9946 example: __INTERFACE-NAME__
9947 - name: l3-interface-ipv4-address
9949 description: IP address
9952 example: __L3-INTERFACE-IPV4-ADDRESS__
9955 description: l3-interface-ipv4-address-list object that needs to be updated.
9958 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9961 - CloudInfrastructure
9962 summary: delete an existing l3-interface-ipv4-address-list
9963 description: delete an existing l3-interface-ipv4-address-list
9964 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9973 description: Response codes found in [response codes](https://wiki.onap.org/).
9977 description: Value from executing hostname on the compute node.
9980 example: __HOSTNAME__
9981 - name: interface-name
9983 description: Name that identifies the physical interface
9986 example: __INTERFACE-NAME__
9987 - name: interface-name
9989 description: Name given to the interface
9992 example: __INTERFACE-NAME__
9993 - name: l3-interface-ipv4-address
9995 description: IP address
9998 example: __L3-INTERFACE-IPV4-ADDRESS__
9999 - name: resource-version
10001 description: resource-version for concurrency
10004 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10007 - CloudInfrastructure
10008 summary: see node definition for valid relationships
10009 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10018 description: Response codes found in [response codes](https://wiki.onap.org/).
10022 description: Value from executing hostname on the compute node.
10025 example: __HOSTNAME__
10026 - name: interface-name
10028 description: Name that identifies the physical interface
10031 example: __INTERFACE-NAME__
10032 - name: interface-name
10034 description: Name given to the interface
10037 example: __INTERFACE-NAME__
10038 - name: l3-interface-ipv6-address
10040 description: IP address
10043 example: __L3-INTERFACE-IPV6-ADDRESS__
10046 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10049 $ref: "#/definitions/relationship"
10052 - CloudInfrastructure
10053 summary: delete an existing relationship
10054 description: delete an existing relationship
10055 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10064 description: Response codes found in [response codes](https://wiki.onap.org/).
10068 description: Value from executing hostname on the compute node.
10071 example: __HOSTNAME__
10072 - name: interface-name
10074 description: Name that identifies the physical interface
10077 example: __INTERFACE-NAME__
10078 - name: interface-name
10080 description: Name given to the interface
10083 example: __INTERFACE-NAME__
10084 - name: l3-interface-ipv6-address
10086 description: IP address
10089 example: __L3-INTERFACE-IPV6-ADDRESS__
10090 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10093 - CloudInfrastructure
10094 summary: returns l3-interface-ipv6-address-list
10095 description: returns l3-interface-ipv6-address-list
10096 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10102 description: successful operation
10104 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10106 description: Response codes found in [response codes](https://wiki.onap.org/).
10110 description: Value from executing hostname on the compute node.
10113 example: __HOSTNAME__
10114 - name: interface-name
10116 description: Name that identifies the physical interface
10119 example: __INTERFACE-NAME__
10120 - name: interface-name
10122 description: Name given to the interface
10125 example: __INTERFACE-NAME__
10126 - name: l3-interface-ipv6-address
10128 description: IP address
10131 example: __L3-INTERFACE-IPV6-ADDRESS__
10134 - CloudInfrastructure
10135 summary: create or update an existing l3-interface-ipv6-address-list
10137 Create or update an existing l3-interface-ipv6-address-list.
10139 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10140 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10149 description: Response codes found in [response codes](https://wiki.onap.org/).
10153 description: Value from executing hostname on the compute node.
10156 example: __HOSTNAME__
10157 - name: interface-name
10159 description: Name that identifies the physical interface
10162 example: __INTERFACE-NAME__
10163 - name: interface-name
10165 description: Name given to the interface
10168 example: __INTERFACE-NAME__
10169 - name: l3-interface-ipv6-address
10171 description: IP address
10174 example: __L3-INTERFACE-IPV6-ADDRESS__
10177 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10180 $ref: "#/definitions/l3-interface-ipv6-address-list"
10183 - CloudInfrastructure
10184 summary: update an existing l3-interface-ipv6-address-list
10186 Update an existing l3-interface-ipv6-address-list
10188 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10189 The PUT operation will entirely replace an existing object.
10190 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10192 Other differences between PUT and PATCH are:
10194 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10195 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10196 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10197 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10206 description: Response codes found in [response codes](https://wiki.onap.org/).
10210 description: Value from executing hostname on the compute node.
10213 example: __HOSTNAME__
10214 - name: interface-name
10216 description: Name that identifies the physical interface
10219 example: __INTERFACE-NAME__
10220 - name: interface-name
10222 description: Name given to the interface
10225 example: __INTERFACE-NAME__
10226 - name: l3-interface-ipv6-address
10228 description: IP address
10231 example: __L3-INTERFACE-IPV6-ADDRESS__
10234 description: l3-interface-ipv6-address-list object that needs to be updated.
10237 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10240 - CloudInfrastructure
10241 summary: delete an existing l3-interface-ipv6-address-list
10242 description: delete an existing l3-interface-ipv6-address-list
10243 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10252 description: Response codes found in [response codes](https://wiki.onap.org/).
10256 description: Value from executing hostname on the compute node.
10259 example: __HOSTNAME__
10260 - name: interface-name
10262 description: Name that identifies the physical interface
10265 example: __INTERFACE-NAME__
10266 - name: interface-name
10268 description: Name given to the interface
10271 example: __INTERFACE-NAME__
10272 - name: l3-interface-ipv6-address
10274 description: IP address
10277 example: __L3-INTERFACE-IPV6-ADDRESS__
10278 - name: resource-version
10280 description: resource-version for concurrency
10283 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
10286 - CloudInfrastructure
10287 summary: returns l-interface
10288 description: returns l-interface
10289 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10295 description: successful operation
10297 $ref: "#/getDefinitions/l-interface"
10299 description: Response codes found in [response codes](https://wiki.onap.org/).
10303 description: Value from executing hostname on the compute node.
10306 example: __HOSTNAME__
10307 - name: interface-name
10309 description: Name that identifies the physical interface
10312 example: __INTERFACE-NAME__
10313 - name: interface-name
10315 description: Name given to the interface
10318 example: __INTERFACE-NAME__
10321 - CloudInfrastructure
10322 summary: create or update an existing l-interface
10324 Create or update an existing l-interface.
10326 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10327 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10336 description: Response codes found in [response codes](https://wiki.onap.org/).
10340 description: Value from executing hostname on the compute node.
10343 example: __HOSTNAME__
10344 - name: interface-name
10346 description: Name that identifies the physical interface
10349 example: __INTERFACE-NAME__
10350 - name: interface-name
10352 description: Name given to the interface
10355 example: __INTERFACE-NAME__
10358 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10361 $ref: "#/definitions/l-interface"
10364 - CloudInfrastructure
10365 summary: update an existing l-interface
10367 Update an existing l-interface
10369 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10370 The PUT operation will entirely replace an existing object.
10371 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10373 Other differences between PUT and PATCH are:
10375 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10376 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10377 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10378 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10387 description: Response codes found in [response codes](https://wiki.onap.org/).
10391 description: Value from executing hostname on the compute node.
10394 example: __HOSTNAME__
10395 - name: interface-name
10397 description: Name that identifies the physical interface
10400 example: __INTERFACE-NAME__
10401 - name: interface-name
10403 description: Name given to the interface
10406 example: __INTERFACE-NAME__
10409 description: l-interface object that needs to be updated.
10412 $ref: "#/patchDefinitions/l-interface"
10415 - CloudInfrastructure
10416 summary: delete an existing l-interface
10417 description: delete an existing l-interface
10418 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10427 description: Response codes found in [response codes](https://wiki.onap.org/).
10431 description: Value from executing hostname on the compute node.
10434 example: __HOSTNAME__
10435 - name: interface-name
10437 description: Name that identifies the physical interface
10440 example: __INTERFACE-NAME__
10441 - name: interface-name
10443 description: Name given to the interface
10446 example: __INTERFACE-NAME__
10447 - name: resource-version
10449 description: resource-version for concurrency
10452 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
10455 - CloudInfrastructure
10456 summary: returns l-interfaces
10457 description: returns l-interfaces
10458 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
10464 description: successful operation
10466 $ref: "#/getDefinitions/l-interfaces"
10468 description: Response codes found in [response codes](https://wiki.onap.org/).
10472 description: Value from executing hostname on the compute node.
10475 example: __HOSTNAME__
10476 - name: interface-name
10478 description: Name that identifies the physical interface
10481 example: __INTERFACE-NAME__
10482 - name: interface-name
10487 - name: interface-id
10497 - name: network-name
10502 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
10505 - CloudInfrastructure
10506 summary: returns p-interface
10507 description: returns p-interface
10508 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
10514 description: successful operation
10516 $ref: "#/getDefinitions/p-interface"
10518 description: Response codes found in [response codes](https://wiki.onap.org/).
10522 description: Value from executing hostname on the compute node.
10525 example: __HOSTNAME__
10526 - name: interface-name
10528 description: Name that identifies the physical interface
10531 example: __INTERFACE-NAME__
10534 - CloudInfrastructure
10535 summary: create or update an existing p-interface
10537 Create or update an existing p-interface.
10539 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10540 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10549 description: Response codes found in [response codes](https://wiki.onap.org/).
10553 description: Value from executing hostname on the compute node.
10556 example: __HOSTNAME__
10557 - name: interface-name
10559 description: Name that identifies the physical interface
10562 example: __INTERFACE-NAME__
10565 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10568 $ref: "#/definitions/p-interface"
10571 - CloudInfrastructure
10572 summary: update an existing p-interface
10574 Update an existing p-interface
10576 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10577 The PUT operation will entirely replace an existing object.
10578 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10580 Other differences between PUT and PATCH are:
10582 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10583 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10584 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10585 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10594 description: Response codes found in [response codes](https://wiki.onap.org/).
10598 description: Value from executing hostname on the compute node.
10601 example: __HOSTNAME__
10602 - name: interface-name
10604 description: Name that identifies the physical interface
10607 example: __INTERFACE-NAME__
10610 description: p-interface object that needs to be updated.
10613 $ref: "#/patchDefinitions/p-interface"
10616 - CloudInfrastructure
10617 summary: delete an existing p-interface
10618 description: delete an existing p-interface
10619 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
10628 description: Response codes found in [response codes](https://wiki.onap.org/).
10632 description: Value from executing hostname on the compute node.
10635 example: __HOSTNAME__
10636 - name: interface-name
10638 description: Name that identifies the physical interface
10641 example: __INTERFACE-NAME__
10642 - name: resource-version
10644 description: resource-version for concurrency
10647 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
10650 - CloudInfrastructure
10651 summary: returns p-interfaces
10652 description: returns p-interfaces
10653 operationId: getCloudInfrastructurePserversPserverPInterfaces
10659 description: successful operation
10661 $ref: "#/getDefinitions/p-interfaces"
10663 description: Response codes found in [response codes](https://wiki.onap.org/).
10667 description: Value from executing hostname on the compute node.
10670 example: __HOSTNAME__
10671 - name: interface-name
10676 - name: prov-status
10681 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
10684 - CloudInfrastructure
10685 summary: see node definition for valid relationships
10686 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10695 description: Response codes found in [response codes](https://wiki.onap.org/).
10699 description: Value from executing hostname on the compute node.
10702 example: __HOSTNAME__
10703 - name: interface-name
10705 description: Name that identifies the link aggregate interface
10708 example: __INTERFACE-NAME__
10711 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
10714 $ref: "#/definitions/relationship"
10717 - CloudInfrastructure
10718 summary: delete an existing relationship
10719 description: delete an existing relationship
10720 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10729 description: Response codes found in [response codes](https://wiki.onap.org/).
10733 description: Value from executing hostname on the compute node.
10736 example: __HOSTNAME__
10737 - name: interface-name
10739 description: Name that identifies the link aggregate interface
10742 example: __INTERFACE-NAME__
10743 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
10746 - CloudInfrastructure
10747 summary: see node definition for valid relationships
10748 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10757 description: Response codes found in [response codes](https://wiki.onap.org/).
10761 description: Value from executing hostname on the compute node.
10764 example: __HOSTNAME__
10765 - name: interface-name
10767 description: Name that identifies the link aggregate interface
10770 example: __INTERFACE-NAME__
10771 - name: interface-name
10773 description: Name given to the interface
10776 example: __INTERFACE-NAME__
10777 - name: vlan-interface
10779 description: String that identifies the interface
10782 example: __VLAN-INTERFACE__
10785 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10788 $ref: "#/definitions/relationship"
10791 - CloudInfrastructure
10792 summary: delete an existing relationship
10793 description: delete an existing relationship
10794 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10803 description: Response codes found in [response codes](https://wiki.onap.org/).
10807 description: Value from executing hostname on the compute node.
10810 example: __HOSTNAME__
10811 - name: interface-name
10813 description: Name that identifies the link aggregate interface
10816 example: __INTERFACE-NAME__
10817 - name: interface-name
10819 description: Name given to the interface
10822 example: __INTERFACE-NAME__
10823 - name: vlan-interface
10825 description: String that identifies the interface
10828 example: __VLAN-INTERFACE__
10829 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
10832 - CloudInfrastructure
10833 summary: see node definition for valid relationships
10834 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10843 description: Response codes found in [response codes](https://wiki.onap.org/).
10847 description: Value from executing hostname on the compute node.
10850 example: __HOSTNAME__
10851 - name: interface-name
10853 description: Name that identifies the link aggregate interface
10856 example: __INTERFACE-NAME__
10857 - name: interface-name
10859 description: Name given to the interface
10862 example: __INTERFACE-NAME__
10863 - name: vlan-interface
10865 description: String that identifies the interface
10868 example: __VLAN-INTERFACE__
10869 - name: l3-interface-ipv4-address
10871 description: IP address
10874 example: __L3-INTERFACE-IPV4-ADDRESS__
10877 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
10880 $ref: "#/definitions/relationship"
10883 - CloudInfrastructure
10884 summary: delete an existing relationship
10885 description: delete an existing relationship
10886 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10895 description: Response codes found in [response codes](https://wiki.onap.org/).
10899 description: Value from executing hostname on the compute node.
10902 example: __HOSTNAME__
10903 - name: interface-name
10905 description: Name that identifies the link aggregate interface
10908 example: __INTERFACE-NAME__
10909 - name: interface-name
10911 description: Name given to the interface
10914 example: __INTERFACE-NAME__
10915 - name: vlan-interface
10917 description: String that identifies the interface
10920 example: __VLAN-INTERFACE__
10921 - name: l3-interface-ipv4-address
10923 description: IP address
10926 example: __L3-INTERFACE-IPV4-ADDRESS__
10927 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
10930 - CloudInfrastructure
10931 summary: returns l3-interface-ipv4-address-list
10932 description: returns l3-interface-ipv4-address-list
10933 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10939 description: successful operation
10941 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
10943 description: Response codes found in [response codes](https://wiki.onap.org/).
10947 description: Value from executing hostname on the compute node.
10950 example: __HOSTNAME__
10951 - name: interface-name
10953 description: Name that identifies the link aggregate interface
10956 example: __INTERFACE-NAME__
10957 - name: interface-name
10959 description: Name given to the interface
10962 example: __INTERFACE-NAME__
10963 - name: vlan-interface
10965 description: String that identifies the interface
10968 example: __VLAN-INTERFACE__
10969 - name: l3-interface-ipv4-address
10971 description: IP address
10974 example: __L3-INTERFACE-IPV4-ADDRESS__
10977 - CloudInfrastructure
10978 summary: create or update an existing l3-interface-ipv4-address-list
10980 Create or update an existing l3-interface-ipv4-address-list.
10982 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10983 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10992 description: Response codes found in [response codes](https://wiki.onap.org/).
10996 description: Value from executing hostname on the compute node.
10999 example: __HOSTNAME__
11000 - name: interface-name
11002 description: Name that identifies the link aggregate interface
11005 example: __INTERFACE-NAME__
11006 - name: interface-name
11008 description: Name given to the interface
11011 example: __INTERFACE-NAME__
11012 - name: vlan-interface
11014 description: String that identifies the interface
11017 example: __VLAN-INTERFACE__
11018 - name: l3-interface-ipv4-address
11020 description: IP address
11023 example: __L3-INTERFACE-IPV4-ADDRESS__
11026 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11029 $ref: "#/definitions/l3-interface-ipv4-address-list"
11032 - CloudInfrastructure
11033 summary: update an existing l3-interface-ipv4-address-list
11035 Update an existing l3-interface-ipv4-address-list
11037 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11038 The PUT operation will entirely replace an existing object.
11039 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11041 Other differences between PUT and PATCH are:
11043 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11044 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11045 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11046 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11055 description: Response codes found in [response codes](https://wiki.onap.org/).
11059 description: Value from executing hostname on the compute node.
11062 example: __HOSTNAME__
11063 - name: interface-name
11065 description: Name that identifies the link aggregate interface
11068 example: __INTERFACE-NAME__
11069 - name: interface-name
11071 description: Name given to the interface
11074 example: __INTERFACE-NAME__
11075 - name: vlan-interface
11077 description: String that identifies the interface
11080 example: __VLAN-INTERFACE__
11081 - name: l3-interface-ipv4-address
11083 description: IP address
11086 example: __L3-INTERFACE-IPV4-ADDRESS__
11089 description: l3-interface-ipv4-address-list object that needs to be updated.
11092 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11095 - CloudInfrastructure
11096 summary: delete an existing l3-interface-ipv4-address-list
11097 description: delete an existing l3-interface-ipv4-address-list
11098 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11107 description: Response codes found in [response codes](https://wiki.onap.org/).
11111 description: Value from executing hostname on the compute node.
11114 example: __HOSTNAME__
11115 - name: interface-name
11117 description: Name that identifies the link aggregate interface
11120 example: __INTERFACE-NAME__
11121 - name: interface-name
11123 description: Name given to the interface
11126 example: __INTERFACE-NAME__
11127 - name: vlan-interface
11129 description: String that identifies the interface
11132 example: __VLAN-INTERFACE__
11133 - name: l3-interface-ipv4-address
11135 description: IP address
11138 example: __L3-INTERFACE-IPV4-ADDRESS__
11139 - name: resource-version
11141 description: resource-version for concurrency
11144 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11147 - CloudInfrastructure
11148 summary: see node definition for valid relationships
11149 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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: vlan-interface
11180 description: String that identifies the interface
11183 example: __VLAN-INTERFACE__
11184 - name: l3-interface-ipv6-address
11186 description: IP address
11189 example: __L3-INTERFACE-IPV6-ADDRESS__
11192 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11195 $ref: "#/definitions/relationship"
11198 - CloudInfrastructure
11199 summary: delete an existing relationship
11200 description: delete an existing relationship
11201 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11210 description: Response codes found in [response codes](https://wiki.onap.org/).
11214 description: Value from executing hostname on the compute node.
11217 example: __HOSTNAME__
11218 - name: interface-name
11220 description: Name that identifies the link aggregate interface
11223 example: __INTERFACE-NAME__
11224 - name: interface-name
11226 description: Name given to the interface
11229 example: __INTERFACE-NAME__
11230 - name: vlan-interface
11232 description: String that identifies the interface
11235 example: __VLAN-INTERFACE__
11236 - name: l3-interface-ipv6-address
11238 description: IP address
11241 example: __L3-INTERFACE-IPV6-ADDRESS__
11242 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11245 - CloudInfrastructure
11246 summary: returns l3-interface-ipv6-address-list
11247 description: returns l3-interface-ipv6-address-list
11248 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11254 description: successful operation
11256 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
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: vlan-interface
11280 description: String that identifies the interface
11283 example: __VLAN-INTERFACE__
11284 - name: l3-interface-ipv6-address
11286 description: IP address
11289 example: __L3-INTERFACE-IPV6-ADDRESS__
11292 - CloudInfrastructure
11293 summary: create or update an existing l3-interface-ipv6-address-list
11295 Create or update an existing l3-interface-ipv6-address-list.
11297 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11298 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11307 description: Response codes found in [response codes](https://wiki.onap.org/).
11311 description: Value from executing hostname on the compute node.
11314 example: __HOSTNAME__
11315 - name: interface-name
11317 description: Name that identifies the link aggregate interface
11320 example: __INTERFACE-NAME__
11321 - name: interface-name
11323 description: Name given to the interface
11326 example: __INTERFACE-NAME__
11327 - name: vlan-interface
11329 description: String that identifies the interface
11332 example: __VLAN-INTERFACE__
11333 - name: l3-interface-ipv6-address
11335 description: IP address
11338 example: __L3-INTERFACE-IPV6-ADDRESS__
11341 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11344 $ref: "#/definitions/l3-interface-ipv6-address-list"
11347 - CloudInfrastructure
11348 summary: update an existing l3-interface-ipv6-address-list
11350 Update an existing l3-interface-ipv6-address-list
11352 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11353 The PUT operation will entirely replace an existing object.
11354 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11356 Other differences between PUT and PATCH are:
11358 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11359 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11360 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11361 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11370 description: Response codes found in [response codes](https://wiki.onap.org/).
11374 description: Value from executing hostname on the compute node.
11377 example: __HOSTNAME__
11378 - name: interface-name
11380 description: Name that identifies the link aggregate interface
11383 example: __INTERFACE-NAME__
11384 - name: interface-name
11386 description: Name given to the interface
11389 example: __INTERFACE-NAME__
11390 - name: vlan-interface
11392 description: String that identifies the interface
11395 example: __VLAN-INTERFACE__
11396 - name: l3-interface-ipv6-address
11398 description: IP address
11401 example: __L3-INTERFACE-IPV6-ADDRESS__
11404 description: l3-interface-ipv6-address-list object that needs to be updated.
11407 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11410 - CloudInfrastructure
11411 summary: delete an existing l3-interface-ipv6-address-list
11412 description: delete an existing l3-interface-ipv6-address-list
11413 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11422 description: Response codes found in [response codes](https://wiki.onap.org/).
11426 description: Value from executing hostname on the compute node.
11429 example: __HOSTNAME__
11430 - name: interface-name
11432 description: Name that identifies the link aggregate interface
11435 example: __INTERFACE-NAME__
11436 - name: interface-name
11438 description: Name given to the interface
11441 example: __INTERFACE-NAME__
11442 - name: vlan-interface
11444 description: String that identifies the interface
11447 example: __VLAN-INTERFACE__
11448 - name: l3-interface-ipv6-address
11450 description: IP address
11453 example: __L3-INTERFACE-IPV6-ADDRESS__
11454 - name: resource-version
11456 description: resource-version for concurrency
11459 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11462 - CloudInfrastructure
11463 summary: returns vlan
11464 description: returns vlan
11465 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11471 description: successful operation
11473 $ref: "#/getDefinitions/vlan"
11475 description: Response codes found in [response codes](https://wiki.onap.org/).
11479 description: Value from executing hostname on the compute node.
11482 example: __HOSTNAME__
11483 - name: interface-name
11485 description: Name that identifies the link aggregate interface
11488 example: __INTERFACE-NAME__
11489 - name: interface-name
11491 description: Name given to the interface
11494 example: __INTERFACE-NAME__
11495 - name: vlan-interface
11497 description: String that identifies the interface
11500 example: __VLAN-INTERFACE__
11503 - CloudInfrastructure
11504 summary: create or update an existing vlan
11506 Create or update an existing vlan.
11508 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11509 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11518 description: Response codes found in [response codes](https://wiki.onap.org/).
11522 description: Value from executing hostname on the compute node.
11525 example: __HOSTNAME__
11526 - name: interface-name
11528 description: Name that identifies the link aggregate interface
11531 example: __INTERFACE-NAME__
11532 - name: interface-name
11534 description: Name given to the interface
11537 example: __INTERFACE-NAME__
11538 - name: vlan-interface
11540 description: String that identifies the interface
11543 example: __VLAN-INTERFACE__
11546 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11549 $ref: "#/definitions/vlan"
11552 - CloudInfrastructure
11553 summary: update an existing vlan
11555 Update an existing vlan
11557 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11558 The PUT operation will entirely replace an existing object.
11559 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11561 Other differences between PUT and PATCH are:
11563 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11564 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11565 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11566 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11575 description: Response codes found in [response codes](https://wiki.onap.org/).
11579 description: Value from executing hostname on the compute node.
11582 example: __HOSTNAME__
11583 - name: interface-name
11585 description: Name that identifies the link aggregate interface
11588 example: __INTERFACE-NAME__
11589 - name: interface-name
11591 description: Name given to the interface
11594 example: __INTERFACE-NAME__
11595 - name: vlan-interface
11597 description: String that identifies the interface
11600 example: __VLAN-INTERFACE__
11603 description: vlan object that needs to be updated.
11606 $ref: "#/patchDefinitions/vlan"
11609 - CloudInfrastructure
11610 summary: delete an existing vlan
11611 description: delete an existing vlan
11612 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11621 description: Response codes found in [response codes](https://wiki.onap.org/).
11625 description: Value from executing hostname on the compute node.
11628 example: __HOSTNAME__
11629 - name: interface-name
11631 description: Name that identifies the link aggregate interface
11634 example: __INTERFACE-NAME__
11635 - name: interface-name
11637 description: Name given to the interface
11640 example: __INTERFACE-NAME__
11641 - name: vlan-interface
11643 description: String that identifies the interface
11646 example: __VLAN-INTERFACE__
11647 - name: resource-version
11649 description: resource-version for concurrency
11652 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
11655 - CloudInfrastructure
11656 summary: returns vlans
11657 description: returns vlans
11658 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
11664 description: successful operation
11666 $ref: "#/getDefinitions/vlans"
11668 description: Response codes found in [response codes](https://wiki.onap.org/).
11672 description: Value from executing hostname on the compute node.
11675 example: __HOSTNAME__
11676 - name: interface-name
11678 description: Name that identifies the link aggregate interface
11681 example: __INTERFACE-NAME__
11682 - name: interface-name
11684 description: Name given to the interface
11687 example: __INTERFACE-NAME__
11688 - name: vlan-interface
11693 - name: vlan-id-inner
11704 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
11707 - CloudInfrastructure
11708 summary: see node definition for valid relationships
11709 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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: PCI ID used to identify the sriov-vf
11743 example: __PCI-ID__
11746 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
11749 $ref: "#/definitions/relationship"
11752 - CloudInfrastructure
11753 summary: delete an existing relationship
11754 description: delete an existing relationship
11755 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
11764 description: Response codes found in [response codes](https://wiki.onap.org/).
11768 description: Value from executing hostname on the compute node.
11771 example: __HOSTNAME__
11772 - name: interface-name
11774 description: Name that identifies the link aggregate interface
11777 example: __INTERFACE-NAME__
11778 - name: interface-name
11780 description: Name given to the interface
11783 example: __INTERFACE-NAME__
11786 description: PCI ID used to identify the sriov-vf
11789 example: __PCI-ID__
11790 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
11793 - CloudInfrastructure
11794 summary: returns sriov-vf
11795 description: returns sriov-vf
11796 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11802 description: successful operation
11804 $ref: "#/getDefinitions/sriov-vf"
11806 description: Response codes found in [response codes](https://wiki.onap.org/).
11810 description: Value from executing hostname on the compute node.
11813 example: __HOSTNAME__
11814 - name: interface-name
11816 description: Name that identifies the link aggregate interface
11819 example: __INTERFACE-NAME__
11820 - name: interface-name
11822 description: Name given to the interface
11825 example: __INTERFACE-NAME__
11828 description: PCI ID used to identify the sriov-vf
11831 example: __PCI-ID__
11834 - CloudInfrastructure
11835 summary: create or update an existing sriov-vf
11837 Create or update an existing sriov-vf.
11839 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11840 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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__
11863 - name: interface-name
11865 description: Name given to the interface
11868 example: __INTERFACE-NAME__
11871 description: PCI ID used to identify the sriov-vf
11874 example: __PCI-ID__
11877 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
11880 $ref: "#/definitions/sriov-vf"
11883 - CloudInfrastructure
11884 summary: update an existing sriov-vf
11886 Update an existing sriov-vf
11888 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11889 The PUT operation will entirely replace an existing object.
11890 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11892 Other differences between PUT and PATCH are:
11894 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11895 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11896 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11897 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11906 description: Response codes found in [response codes](https://wiki.onap.org/).
11910 description: Value from executing hostname on the compute node.
11913 example: __HOSTNAME__
11914 - name: interface-name
11916 description: Name that identifies the link aggregate interface
11919 example: __INTERFACE-NAME__
11920 - name: interface-name
11922 description: Name given to the interface
11925 example: __INTERFACE-NAME__
11928 description: PCI ID used to identify the sriov-vf
11931 example: __PCI-ID__
11934 description: sriov-vf object that needs to be updated.
11937 $ref: "#/patchDefinitions/sriov-vf"
11940 - CloudInfrastructure
11941 summary: delete an existing sriov-vf
11942 description: delete an existing sriov-vf
11943 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11952 description: Response codes found in [response codes](https://wiki.onap.org/).
11956 description: Value from executing hostname on the compute node.
11959 example: __HOSTNAME__
11960 - name: interface-name
11962 description: Name that identifies the link aggregate interface
11965 example: __INTERFACE-NAME__
11966 - name: interface-name
11968 description: Name given to the interface
11971 example: __INTERFACE-NAME__
11974 description: PCI ID used to identify the sriov-vf
11977 example: __PCI-ID__
11978 - name: resource-version
11980 description: resource-version for concurrency
11983 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
11986 - CloudInfrastructure
11987 summary: returns sriov-vfs
11988 description: returns sriov-vfs
11989 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
11995 description: successful operation
11997 $ref: "#/getDefinitions/sriov-vfs"
11999 description: Response codes found in [response codes](https://wiki.onap.org/).
12003 description: Value from executing hostname on the compute node.
12006 example: __HOSTNAME__
12007 - name: interface-name
12009 description: Name that identifies the link aggregate interface
12012 example: __INTERFACE-NAME__
12013 - name: interface-name
12015 description: Name given to the interface
12018 example: __INTERFACE-NAME__
12024 - name: vf-vlan-filter
12029 - name: vf-mac-filter
12034 - name: vf-vlan-strip
12039 - name: neutron-network-id
12044 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12047 - CloudInfrastructure
12048 summary: see node definition for valid relationships
12049 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12058 description: Response codes found in [response codes](https://wiki.onap.org/).
12062 description: Value from executing hostname on the compute node.
12065 example: __HOSTNAME__
12066 - name: interface-name
12068 description: Name that identifies the link aggregate interface
12071 example: __INTERFACE-NAME__
12072 - name: interface-name
12074 description: Name given to the interface
12077 example: __INTERFACE-NAME__
12080 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12083 $ref: "#/definitions/relationship"
12086 - CloudInfrastructure
12087 summary: delete an existing relationship
12088 description: delete an existing relationship
12089 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12098 description: Response codes found in [response codes](https://wiki.onap.org/).
12102 description: Value from executing hostname on the compute node.
12105 example: __HOSTNAME__
12106 - name: interface-name
12108 description: Name that identifies the link aggregate interface
12111 example: __INTERFACE-NAME__
12112 - name: interface-name
12114 description: Name given to the interface
12117 example: __INTERFACE-NAME__
12118 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
12121 - CloudInfrastructure
12122 summary: see node definition for valid relationships
12123 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12132 description: Response codes found in [response codes](https://wiki.onap.org/).
12136 description: Value from executing hostname on the compute node.
12139 example: __HOSTNAME__
12140 - name: interface-name
12142 description: Name that identifies the link aggregate interface
12145 example: __INTERFACE-NAME__
12146 - name: interface-name
12148 description: Name given to the interface
12151 example: __INTERFACE-NAME__
12152 - name: l3-interface-ipv4-address
12154 description: IP address
12157 example: __L3-INTERFACE-IPV4-ADDRESS__
12160 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12163 $ref: "#/definitions/relationship"
12166 - CloudInfrastructure
12167 summary: delete an existing relationship
12168 description: delete an existing relationship
12169 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12178 description: Response codes found in [response codes](https://wiki.onap.org/).
12182 description: Value from executing hostname on the compute node.
12185 example: __HOSTNAME__
12186 - name: interface-name
12188 description: Name that identifies the link aggregate interface
12191 example: __INTERFACE-NAME__
12192 - name: interface-name
12194 description: Name given to the interface
12197 example: __INTERFACE-NAME__
12198 - name: l3-interface-ipv4-address
12200 description: IP address
12203 example: __L3-INTERFACE-IPV4-ADDRESS__
12204 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
12207 - CloudInfrastructure
12208 summary: returns l3-interface-ipv4-address-list
12209 description: returns l3-interface-ipv4-address-list
12210 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12216 description: successful operation
12218 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12220 description: Response codes found in [response codes](https://wiki.onap.org/).
12224 description: Value from executing hostname on the compute node.
12227 example: __HOSTNAME__
12228 - name: interface-name
12230 description: Name that identifies the link aggregate interface
12233 example: __INTERFACE-NAME__
12234 - name: interface-name
12236 description: Name given to the interface
12239 example: __INTERFACE-NAME__
12240 - name: l3-interface-ipv4-address
12242 description: IP address
12245 example: __L3-INTERFACE-IPV4-ADDRESS__
12248 - CloudInfrastructure
12249 summary: create or update an existing l3-interface-ipv4-address-list
12251 Create or update an existing l3-interface-ipv4-address-list.
12253 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12254 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12263 description: Response codes found in [response codes](https://wiki.onap.org/).
12267 description: Value from executing hostname on the compute node.
12270 example: __HOSTNAME__
12271 - name: interface-name
12273 description: Name that identifies the link aggregate interface
12276 example: __INTERFACE-NAME__
12277 - name: interface-name
12279 description: Name given to the interface
12282 example: __INTERFACE-NAME__
12283 - name: l3-interface-ipv4-address
12285 description: IP address
12288 example: __L3-INTERFACE-IPV4-ADDRESS__
12291 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12294 $ref: "#/definitions/l3-interface-ipv4-address-list"
12297 - CloudInfrastructure
12298 summary: update an existing l3-interface-ipv4-address-list
12300 Update an existing l3-interface-ipv4-address-list
12302 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12303 The PUT operation will entirely replace an existing object.
12304 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12306 Other differences between PUT and PATCH are:
12308 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12309 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12310 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12311 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12320 description: Response codes found in [response codes](https://wiki.onap.org/).
12324 description: Value from executing hostname on the compute node.
12327 example: __HOSTNAME__
12328 - name: interface-name
12330 description: Name that identifies the link aggregate interface
12333 example: __INTERFACE-NAME__
12334 - name: interface-name
12336 description: Name given to the interface
12339 example: __INTERFACE-NAME__
12340 - name: l3-interface-ipv4-address
12342 description: IP address
12345 example: __L3-INTERFACE-IPV4-ADDRESS__
12348 description: l3-interface-ipv4-address-list object that needs to be updated.
12351 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12354 - CloudInfrastructure
12355 summary: delete an existing l3-interface-ipv4-address-list
12356 description: delete an existing l3-interface-ipv4-address-list
12357 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12366 description: Response codes found in [response codes](https://wiki.onap.org/).
12370 description: Value from executing hostname on the compute node.
12373 example: __HOSTNAME__
12374 - name: interface-name
12376 description: Name that identifies the link aggregate interface
12379 example: __INTERFACE-NAME__
12380 - name: interface-name
12382 description: Name given to the interface
12385 example: __INTERFACE-NAME__
12386 - name: l3-interface-ipv4-address
12388 description: IP address
12391 example: __L3-INTERFACE-IPV4-ADDRESS__
12392 - name: resource-version
12394 description: resource-version for concurrency
12397 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
12400 - CloudInfrastructure
12401 summary: see node definition for valid relationships
12402 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12411 description: Response codes found in [response codes](https://wiki.onap.org/).
12415 description: Value from executing hostname on the compute node.
12418 example: __HOSTNAME__
12419 - name: interface-name
12421 description: Name that identifies the link aggregate interface
12424 example: __INTERFACE-NAME__
12425 - name: interface-name
12427 description: Name given to the interface
12430 example: __INTERFACE-NAME__
12431 - name: l3-interface-ipv6-address
12433 description: IP address
12436 example: __L3-INTERFACE-IPV6-ADDRESS__
12439 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12442 $ref: "#/definitions/relationship"
12445 - CloudInfrastructure
12446 summary: delete an existing relationship
12447 description: delete an existing relationship
12448 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12457 description: Response codes found in [response codes](https://wiki.onap.org/).
12461 description: Value from executing hostname on the compute node.
12464 example: __HOSTNAME__
12465 - name: interface-name
12467 description: Name that identifies the link aggregate interface
12470 example: __INTERFACE-NAME__
12471 - name: interface-name
12473 description: Name given to the interface
12476 example: __INTERFACE-NAME__
12477 - name: l3-interface-ipv6-address
12479 description: IP address
12482 example: __L3-INTERFACE-IPV6-ADDRESS__
12483 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
12486 - CloudInfrastructure
12487 summary: returns l3-interface-ipv6-address-list
12488 description: returns l3-interface-ipv6-address-list
12489 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12495 description: successful operation
12497 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12499 description: Response codes found in [response codes](https://wiki.onap.org/).
12503 description: Value from executing hostname on the compute node.
12506 example: __HOSTNAME__
12507 - name: interface-name
12509 description: Name that identifies the link aggregate interface
12512 example: __INTERFACE-NAME__
12513 - name: interface-name
12515 description: Name given to the interface
12518 example: __INTERFACE-NAME__
12519 - name: l3-interface-ipv6-address
12521 description: IP address
12524 example: __L3-INTERFACE-IPV6-ADDRESS__
12527 - CloudInfrastructure
12528 summary: create or update an existing l3-interface-ipv6-address-list
12530 Create or update an existing l3-interface-ipv6-address-list.
12532 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12533 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12542 description: Response codes found in [response codes](https://wiki.onap.org/).
12546 description: Value from executing hostname on the compute node.
12549 example: __HOSTNAME__
12550 - name: interface-name
12552 description: Name that identifies the link aggregate interface
12555 example: __INTERFACE-NAME__
12556 - name: interface-name
12558 description: Name given to the interface
12561 example: __INTERFACE-NAME__
12562 - name: l3-interface-ipv6-address
12564 description: IP address
12567 example: __L3-INTERFACE-IPV6-ADDRESS__
12570 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12573 $ref: "#/definitions/l3-interface-ipv6-address-list"
12576 - CloudInfrastructure
12577 summary: update an existing l3-interface-ipv6-address-list
12579 Update an existing l3-interface-ipv6-address-list
12581 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12582 The PUT operation will entirely replace an existing object.
12583 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12585 Other differences between PUT and PATCH are:
12587 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12588 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12589 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12590 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12599 description: Response codes found in [response codes](https://wiki.onap.org/).
12603 description: Value from executing hostname on the compute node.
12606 example: __HOSTNAME__
12607 - name: interface-name
12609 description: Name that identifies the link aggregate interface
12612 example: __INTERFACE-NAME__
12613 - name: interface-name
12615 description: Name given to the interface
12618 example: __INTERFACE-NAME__
12619 - name: l3-interface-ipv6-address
12621 description: IP address
12624 example: __L3-INTERFACE-IPV6-ADDRESS__
12627 description: l3-interface-ipv6-address-list object that needs to be updated.
12630 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12633 - CloudInfrastructure
12634 summary: delete an existing l3-interface-ipv6-address-list
12635 description: delete an existing l3-interface-ipv6-address-list
12636 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12645 description: Response codes found in [response codes](https://wiki.onap.org/).
12649 description: Value from executing hostname on the compute node.
12652 example: __HOSTNAME__
12653 - name: interface-name
12655 description: Name that identifies the link aggregate interface
12658 example: __INTERFACE-NAME__
12659 - name: interface-name
12661 description: Name given to the interface
12664 example: __INTERFACE-NAME__
12665 - name: l3-interface-ipv6-address
12667 description: IP address
12670 example: __L3-INTERFACE-IPV6-ADDRESS__
12671 - name: resource-version
12673 description: resource-version for concurrency
12676 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
12679 - CloudInfrastructure
12680 summary: returns l-interface
12681 description: returns l-interface
12682 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
12688 description: successful operation
12690 $ref: "#/getDefinitions/l-interface"
12692 description: Response codes found in [response codes](https://wiki.onap.org/).
12696 description: Value from executing hostname on the compute node.
12699 example: __HOSTNAME__
12700 - name: interface-name
12702 description: Name that identifies the link aggregate interface
12705 example: __INTERFACE-NAME__
12706 - name: interface-name
12708 description: Name given to the interface
12711 example: __INTERFACE-NAME__
12714 - CloudInfrastructure
12715 summary: create or update an existing l-interface
12717 Create or update an existing l-interface.
12719 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12720 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
12729 description: Response codes found in [response codes](https://wiki.onap.org/).
12733 description: Value from executing hostname on the compute node.
12736 example: __HOSTNAME__
12737 - name: interface-name
12739 description: Name that identifies the link aggregate interface
12742 example: __INTERFACE-NAME__
12743 - name: interface-name
12745 description: Name given to the interface
12748 example: __INTERFACE-NAME__
12751 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12754 $ref: "#/definitions/l-interface"
12757 - CloudInfrastructure
12758 summary: update an existing l-interface
12760 Update an existing l-interface
12762 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12763 The PUT operation will entirely replace an existing object.
12764 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12766 Other differences between PUT and PATCH are:
12768 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12769 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12770 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12771 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
12780 description: Response codes found in [response codes](https://wiki.onap.org/).
12784 description: Value from executing hostname on the compute node.
12787 example: __HOSTNAME__
12788 - name: interface-name
12790 description: Name that identifies the link aggregate interface
12793 example: __INTERFACE-NAME__
12794 - name: interface-name
12796 description: Name given to the interface
12799 example: __INTERFACE-NAME__
12802 description: l-interface object that needs to be updated.
12805 $ref: "#/patchDefinitions/l-interface"
12808 - CloudInfrastructure
12809 summary: delete an existing l-interface
12810 description: delete an existing l-interface
12811 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
12820 description: Response codes found in [response codes](https://wiki.onap.org/).
12824 description: Value from executing hostname on the compute node.
12827 example: __HOSTNAME__
12828 - name: interface-name
12830 description: Name that identifies the link aggregate interface
12833 example: __INTERFACE-NAME__
12834 - name: interface-name
12836 description: Name given to the interface
12839 example: __INTERFACE-NAME__
12840 - name: resource-version
12842 description: resource-version for concurrency
12845 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
12848 - CloudInfrastructure
12849 summary: returns l-interfaces
12850 description: returns l-interfaces
12851 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
12857 description: successful operation
12859 $ref: "#/getDefinitions/l-interfaces"
12861 description: Response codes found in [response codes](https://wiki.onap.org/).
12865 description: Value from executing hostname on the compute node.
12868 example: __HOSTNAME__
12869 - name: interface-name
12871 description: Name that identifies the link aggregate interface
12874 example: __INTERFACE-NAME__
12875 - name: interface-name
12880 - name: interface-id
12890 - name: network-name
12895 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
12898 - CloudInfrastructure
12899 summary: returns lag-interface
12900 description: returns lag-interface
12901 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
12907 description: successful operation
12909 $ref: "#/getDefinitions/lag-interface"
12911 description: Response codes found in [response codes](https://wiki.onap.org/).
12915 description: Value from executing hostname on the compute node.
12918 example: __HOSTNAME__
12919 - name: interface-name
12921 description: Name that identifies the link aggregate interface
12924 example: __INTERFACE-NAME__
12927 - CloudInfrastructure
12928 summary: create or update an existing lag-interface
12930 Create or update an existing lag-interface.
12932 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12933 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
12942 description: Response codes found in [response codes](https://wiki.onap.org/).
12946 description: Value from executing hostname on the compute node.
12949 example: __HOSTNAME__
12950 - name: interface-name
12952 description: Name that identifies the link aggregate interface
12955 example: __INTERFACE-NAME__
12958 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
12961 $ref: "#/definitions/lag-interface"
12964 - CloudInfrastructure
12965 summary: update an existing lag-interface
12967 Update an existing lag-interface
12969 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12970 The PUT operation will entirely replace an existing object.
12971 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12973 Other differences between PUT and PATCH are:
12975 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12976 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12977 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12978 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
12987 description: Response codes found in [response codes](https://wiki.onap.org/).
12991 description: Value from executing hostname on the compute node.
12994 example: __HOSTNAME__
12995 - name: interface-name
12997 description: Name that identifies the link aggregate interface
13000 example: __INTERFACE-NAME__
13003 description: lag-interface object that needs to be updated.
13006 $ref: "#/patchDefinitions/lag-interface"
13009 - CloudInfrastructure
13010 summary: delete an existing lag-interface
13011 description: delete an existing lag-interface
13012 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13021 description: Response codes found in [response codes](https://wiki.onap.org/).
13025 description: Value from executing hostname on the compute node.
13028 example: __HOSTNAME__
13029 - name: interface-name
13031 description: Name that identifies the link aggregate interface
13034 example: __INTERFACE-NAME__
13035 - name: resource-version
13037 description: resource-version for concurrency
13040 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13043 - CloudInfrastructure
13044 summary: returns lag-interfaces
13045 description: returns lag-interfaces
13046 operationId: getCloudInfrastructurePserversPserverLagInterfaces
13052 description: successful operation
13054 $ref: "#/getDefinitions/lag-interfaces"
13056 description: Response codes found in [response codes](https://wiki.onap.org/).
13060 description: Value from executing hostname on the compute node.
13063 example: __HOSTNAME__
13064 - name: interface-name
13069 - name: interface-id
13074 - name: interface-role
13079 /cloud-infrastructure/pservers/pserver/{hostname}:
13082 - CloudInfrastructure
13083 summary: returns pserver
13084 description: returns pserver
13085 operationId: getCloudInfrastructurePserversPserver
13091 description: successful operation
13093 $ref: "#/getDefinitions/pserver"
13095 description: Response codes found in [response codes](https://wiki.onap.org/).
13099 description: Value from executing hostname on the compute node.
13102 example: __HOSTNAME__
13105 - CloudInfrastructure
13106 summary: create or update an existing pserver
13108 Create or update an existing pserver.
13110 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13111 operationId: createOrUpdateCloudInfrastructurePserversPserver
13120 description: Response codes found in [response codes](https://wiki.onap.org/).
13124 description: Value from executing hostname on the compute node.
13127 example: __HOSTNAME__
13130 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)
13133 $ref: "#/definitions/pserver"
13136 - CloudInfrastructure
13137 summary: update an existing pserver
13139 Update an existing pserver
13141 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13142 The PUT operation will entirely replace an existing object.
13143 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13145 Other differences between PUT and PATCH are:
13147 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13148 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13149 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13150 operationId: UpdateCloudInfrastructurePserversPserver
13159 description: Response codes found in [response codes](https://wiki.onap.org/).
13163 description: Value from executing hostname on the compute node.
13166 example: __HOSTNAME__
13169 description: pserver object that needs to be updated.
13172 $ref: "#/patchDefinitions/pserver"
13175 - CloudInfrastructure
13176 summary: delete an existing pserver
13177 description: delete an existing pserver
13178 operationId: deleteCloudInfrastructurePserversPserver
13187 description: Response codes found in [response codes](https://wiki.onap.org/).
13191 description: Value from executing hostname on the compute node.
13194 example: __HOSTNAME__
13195 - name: resource-version
13197 description: resource-version for concurrency
13200 /cloud-infrastructure/pservers:
13203 - CloudInfrastructure
13204 summary: returns pservers
13205 description: returns pservers
13206 operationId: getCloudInfrastructurePservers
13212 description: successful operation
13214 $ref: "#/getDefinitions/pservers"
13216 description: Response codes found in [response codes](https://wiki.onap.org/).
13238 - name: pserver-name2
13243 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
13246 - CloudInfrastructure
13247 summary: see node definition for valid relationships
13248 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
13257 description: Response codes found in [response codes](https://wiki.onap.org/).
13261 description: Unique ID of the vdc
13264 example: __VDC-ID__
13267 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
13270 $ref: "#/definitions/relationship"
13273 - CloudInfrastructure
13274 summary: delete an existing relationship
13275 description: delete an existing relationship
13276 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
13285 description: Response codes found in [response codes](https://wiki.onap.org/).
13289 description: Unique ID of the vdc
13292 example: __VDC-ID__
13293 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
13296 - CloudInfrastructure
13297 summary: returns virtual-data-center
13298 description: returns virtual-data-center
13299 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
13305 description: successful operation
13307 $ref: "#/getDefinitions/virtual-data-center"
13309 description: Response codes found in [response codes](https://wiki.onap.org/).
13313 description: Unique ID of the vdc
13316 example: __VDC-ID__
13319 - CloudInfrastructure
13320 summary: create or update an existing virtual-data-center
13322 Create or update an existing virtual-data-center.
13324 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13325 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
13334 description: Response codes found in [response codes](https://wiki.onap.org/).
13338 description: Unique ID of the vdc
13341 example: __VDC-ID__
13344 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
13347 $ref: "#/definitions/virtual-data-center"
13350 - CloudInfrastructure
13351 summary: update an existing virtual-data-center
13353 Update an existing virtual-data-center
13355 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13356 The PUT operation will entirely replace an existing object.
13357 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13359 Other differences between PUT and PATCH are:
13361 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13362 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13363 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13364 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
13373 description: Response codes found in [response codes](https://wiki.onap.org/).
13377 description: Unique ID of the vdc
13380 example: __VDC-ID__
13383 description: virtual-data-center object that needs to be updated.
13386 $ref: "#/patchDefinitions/virtual-data-center"
13389 - CloudInfrastructure
13390 summary: delete an existing virtual-data-center
13391 description: delete an existing virtual-data-center
13392 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
13401 description: Response codes found in [response codes](https://wiki.onap.org/).
13405 description: Unique ID of the vdc
13408 example: __VDC-ID__
13409 - name: resource-version
13411 description: resource-version for concurrency
13414 /cloud-infrastructure/virtual-data-centers:
13417 - CloudInfrastructure
13418 summary: returns virtual-data-centers
13419 description: returns virtual-data-centers
13420 operationId: getCloudInfrastructureVirtualDataCenters
13426 description: successful operation
13428 $ref: "#/getDefinitions/virtual-data-centers"
13430 description: Response codes found in [response codes](https://wiki.onap.org/).
13442 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
13446 summary: see node definition for valid relationships
13447 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
13456 description: Response codes found in [response codes](https://wiki.onap.org/).
13458 - name: resource-instance-id
13460 description: Unique id of resource instance.
13463 example: __RESOURCE-INSTANCE-ID__
13466 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)
13469 $ref: "#/definitions/relationship"
13473 summary: delete an existing relationship
13474 description: delete an existing relationship
13475 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
13484 description: Response codes found in [response codes](https://wiki.onap.org/).
13486 - name: resource-instance-id
13488 description: Unique id of resource instance.
13491 example: __RESOURCE-INSTANCE-ID__
13492 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
13496 summary: returns metadatum
13497 description: returns metadatum
13498 operationId: getBusinessConnectorsConnectorMetadataMetadatum
13504 description: successful operation
13506 $ref: "#/getDefinitions/metadatum"
13508 description: Response codes found in [response codes](https://wiki.onap.org/).
13510 - name: resource-instance-id
13512 description: Unique id of resource instance.
13515 example: __RESOURCE-INSTANCE-ID__
13520 example: __METANAME__
13524 summary: create or update an existing metadatum
13526 Create or update an existing metadatum.
13528 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13529 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
13538 description: Response codes found in [response codes](https://wiki.onap.org/).
13540 - name: resource-instance-id
13542 description: Unique id of resource instance.
13545 example: __RESOURCE-INSTANCE-ID__
13550 example: __METANAME__
13553 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnectorMetadataMetadatum.json)
13556 $ref: "#/definitions/metadatum"
13560 summary: update an existing metadatum
13562 Update an existing metadatum
13564 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13565 The PUT operation will entirely replace an existing object.
13566 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13568 Other differences between PUT and PATCH are:
13570 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13571 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13572 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13573 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
13582 description: Response codes found in [response codes](https://wiki.onap.org/).
13584 - name: resource-instance-id
13586 description: Unique id of resource instance.
13589 example: __RESOURCE-INSTANCE-ID__
13594 example: __METANAME__
13597 description: metadatum object that needs to be updated.
13600 $ref: "#/patchDefinitions/metadatum"
13604 summary: delete an existing metadatum
13605 description: delete an existing metadatum
13606 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
13615 description: Response codes found in [response codes](https://wiki.onap.org/).
13617 - name: resource-instance-id
13619 description: Unique id of resource instance.
13622 example: __RESOURCE-INSTANCE-ID__
13627 example: __METANAME__
13628 - name: resource-version
13630 description: resource-version for concurrency
13633 /business/connectors/connector/{resource-instance-id}/metadata:
13637 summary: returns metadata
13638 description: returns metadata
13639 operationId: getBusinessConnectorsConnectorMetadata
13645 description: successful operation
13647 $ref: "#/getDefinitions/metadata"
13649 description: Response codes found in [response codes](https://wiki.onap.org/).
13651 - name: resource-instance-id
13653 description: Unique id of resource instance.
13656 example: __RESOURCE-INSTANCE-ID__
13662 /business/connectors/connector/{resource-instance-id}:
13666 summary: returns connector
13667 description: returns connector
13668 operationId: getBusinessConnectorsConnector
13674 description: successful operation
13676 $ref: "#/getDefinitions/connector"
13678 description: Response codes found in [response codes](https://wiki.onap.org/).
13680 - name: resource-instance-id
13682 description: Unique id of resource instance.
13685 example: __RESOURCE-INSTANCE-ID__
13689 summary: create or update an existing connector
13691 Create or update an existing connector.
13693 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13694 operationId: createOrUpdateBusinessConnectorsConnector
13703 description: Response codes found in [response codes](https://wiki.onap.org/).
13705 - name: resource-instance-id
13707 description: Unique id of resource instance.
13710 example: __RESOURCE-INSTANCE-ID__
13713 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)
13716 $ref: "#/definitions/connector"
13720 summary: update an existing connector
13722 Update an existing connector
13724 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13725 The PUT operation will entirely replace an existing object.
13726 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13728 Other differences between PUT and PATCH are:
13730 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13731 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13732 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13733 operationId: UpdateBusinessConnectorsConnector
13742 description: Response codes found in [response codes](https://wiki.onap.org/).
13744 - name: resource-instance-id
13746 description: Unique id of resource instance.
13749 example: __RESOURCE-INSTANCE-ID__
13752 description: connector object that needs to be updated.
13755 $ref: "#/patchDefinitions/connector"
13759 summary: delete an existing connector
13760 description: delete an existing connector
13761 operationId: deleteBusinessConnectorsConnector
13770 description: Response codes found in [response codes](https://wiki.onap.org/).
13772 - name: resource-instance-id
13774 description: Unique id of resource instance.
13777 example: __RESOURCE-INSTANCE-ID__
13778 - name: resource-version
13780 description: resource-version for concurrency
13783 /business/connectors:
13787 summary: returns connectors
13788 description: returns connectors
13789 operationId: getBusinessConnectors
13795 description: successful operation
13797 $ref: "#/getDefinitions/connectors"
13799 description: Response codes found in [response codes](https://wiki.onap.org/).
13801 - name: resource-instance-id
13806 - name: model-invariant-id
13811 - name: model-version-id
13816 - name: widget-model-id
13821 - name: widget-model-version
13826 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
13830 summary: see node definition for valid relationships
13831 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
13840 description: Response codes found in [response codes](https://wiki.onap.org/).
13842 - name: global-customer-id
13844 description: Global customer id used across ECOMP to uniquely identify customer.
13847 example: __GLOBAL-CUSTOMER-ID__
13848 - name: service-type
13850 description: Value defined by orchestration to identify this service across ECOMP.
13853 example: __SERVICE-TYPE__
13854 - name: service-instance-id
13856 description: Uniquely identifies this instance of a service
13859 example: __SERVICE-INSTANCE-ID__
13862 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
13865 $ref: "#/definitions/relationship"
13869 summary: delete an existing relationship
13870 description: delete an existing relationship
13871 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
13880 description: Response codes found in [response codes](https://wiki.onap.org/).
13882 - name: global-customer-id
13884 description: Global customer id used across ECOMP to uniquely identify customer.
13887 example: __GLOBAL-CUSTOMER-ID__
13888 - name: service-type
13890 description: Value defined by orchestration to identify this service across ECOMP.
13893 example: __SERVICE-TYPE__
13894 - name: service-instance-id
13896 description: Uniquely identifies this instance of a service
13899 example: __SERVICE-INSTANCE-ID__
13900 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
13904 summary: returns metadatum
13905 description: returns metadatum
13906 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
13912 description: successful operation
13914 $ref: "#/getDefinitions/metadatum"
13916 description: Response codes found in [response codes](https://wiki.onap.org/).
13918 - name: global-customer-id
13920 description: Global customer id used across ECOMP to uniquely identify customer.
13923 example: __GLOBAL-CUSTOMER-ID__
13924 - name: service-type
13926 description: Value defined by orchestration to identify this service across ECOMP.
13929 example: __SERVICE-TYPE__
13930 - name: service-instance-id
13932 description: Uniquely identifies this instance of a service
13935 example: __SERVICE-INSTANCE-ID__
13940 example: __METANAME__
13944 summary: create or update an existing metadatum
13946 Create or update an existing metadatum.
13948 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13949 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
13958 description: Response codes found in [response codes](https://wiki.onap.org/).
13960 - name: global-customer-id
13962 description: Global customer id used across ECOMP to uniquely identify customer.
13965 example: __GLOBAL-CUSTOMER-ID__
13966 - name: service-type
13968 description: Value defined by orchestration to identify this service across ECOMP.
13971 example: __SERVICE-TYPE__
13972 - name: service-instance-id
13974 description: Uniquely identifies this instance of a service
13977 example: __SERVICE-INSTANCE-ID__
13982 example: __METANAME__
13985 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
13988 $ref: "#/definitions/metadatum"
13992 summary: update an existing metadatum
13994 Update an existing metadatum
13996 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13997 The PUT operation will entirely replace an existing object.
13998 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14000 Other differences between PUT and PATCH are:
14002 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14003 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14004 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14005 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14014 description: Response codes found in [response codes](https://wiki.onap.org/).
14016 - name: global-customer-id
14018 description: Global customer id used across ECOMP to uniquely identify customer.
14021 example: __GLOBAL-CUSTOMER-ID__
14022 - name: service-type
14024 description: Value defined by orchestration to identify this service across ECOMP.
14027 example: __SERVICE-TYPE__
14028 - name: service-instance-id
14030 description: Uniquely identifies this instance of a service
14033 example: __SERVICE-INSTANCE-ID__
14038 example: __METANAME__
14041 description: metadatum object that needs to be updated.
14044 $ref: "#/patchDefinitions/metadatum"
14048 summary: delete an existing metadatum
14049 description: delete an existing metadatum
14050 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14059 description: Response codes found in [response codes](https://wiki.onap.org/).
14061 - name: global-customer-id
14063 description: Global customer id used across ECOMP to uniquely identify customer.
14066 example: __GLOBAL-CUSTOMER-ID__
14067 - name: service-type
14069 description: Value defined by orchestration to identify this service across ECOMP.
14072 example: __SERVICE-TYPE__
14073 - name: service-instance-id
14075 description: Uniquely identifies this instance of a service
14078 example: __SERVICE-INSTANCE-ID__
14083 example: __METANAME__
14084 - name: resource-version
14086 description: resource-version for concurrency
14089 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
14093 summary: returns metadata
14094 description: returns metadata
14095 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
14101 description: successful operation
14103 $ref: "#/getDefinitions/metadata"
14105 description: Response codes found in [response codes](https://wiki.onap.org/).
14107 - name: global-customer-id
14109 description: Global customer id used across ECOMP to uniquely identify customer.
14112 example: __GLOBAL-CUSTOMER-ID__
14113 - name: service-type
14115 description: Value defined by orchestration to identify this service across ECOMP.
14118 example: __SERVICE-TYPE__
14119 - name: service-instance-id
14121 description: Uniquely identifies this instance of a service
14124 example: __SERVICE-INSTANCE-ID__
14130 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
14134 summary: see node definition for valid relationships
14135 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
14144 description: Response codes found in [response codes](https://wiki.onap.org/).
14146 - name: global-customer-id
14148 description: Global customer id used across ECOMP to uniquely identify customer.
14151 example: __GLOBAL-CUSTOMER-ID__
14152 - name: service-type
14154 description: Value defined by orchestration to identify this service across ECOMP.
14157 example: __SERVICE-TYPE__
14158 - name: service-instance-id
14160 description: Uniquely identifies this instance of a service
14163 example: __SERVICE-INSTANCE-ID__
14166 description: Allotted Resource id UUID assigned to this instance.
14172 description: Allotted Resource id UUID assigned to this instance.
14178 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
14181 $ref: "#/definitions/relationship"
14185 summary: delete an existing relationship
14186 description: delete an existing relationship
14187 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
14196 description: Response codes found in [response codes](https://wiki.onap.org/).
14198 - name: global-customer-id
14200 description: Global customer id used across ECOMP to uniquely identify customer.
14203 example: __GLOBAL-CUSTOMER-ID__
14204 - name: service-type
14206 description: Value defined by orchestration to identify this service across ECOMP.
14209 example: __SERVICE-TYPE__
14210 - name: service-instance-id
14212 description: Uniquely identifies this instance of a service
14215 example: __SERVICE-INSTANCE-ID__
14218 description: Allotted Resource id UUID assigned to this instance.
14224 description: Allotted Resource id UUID assigned to this instance.
14228 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
14232 summary: returns tunnel-xconnect
14233 description: returns tunnel-xconnect
14234 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
14240 description: successful operation
14242 $ref: "#/getDefinitions/tunnel-xconnect"
14244 description: Response codes found in [response codes](https://wiki.onap.org/).
14246 - name: global-customer-id
14248 description: Global customer id used across ECOMP to uniquely identify customer.
14251 example: __GLOBAL-CUSTOMER-ID__
14252 - name: service-type
14254 description: Value defined by orchestration to identify this service across ECOMP.
14257 example: __SERVICE-TYPE__
14258 - name: service-instance-id
14260 description: Uniquely identifies this instance of a service
14263 example: __SERVICE-INSTANCE-ID__
14266 description: Allotted Resource id UUID assigned to this instance.
14272 description: Allotted Resource id UUID assigned to this instance.
14279 summary: create or update an existing tunnel-xconnect
14281 Create or update an existing tunnel-xconnect.
14283 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14284 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
14293 description: Response codes found in [response codes](https://wiki.onap.org/).
14295 - name: global-customer-id
14297 description: Global customer id used across ECOMP to uniquely identify customer.
14300 example: __GLOBAL-CUSTOMER-ID__
14301 - name: service-type
14303 description: Value defined by orchestration to identify this service across ECOMP.
14306 example: __SERVICE-TYPE__
14307 - name: service-instance-id
14309 description: Uniquely identifies this instance of a service
14312 example: __SERVICE-INSTANCE-ID__
14315 description: Allotted Resource id UUID assigned to this instance.
14321 description: Allotted Resource id UUID assigned to this instance.
14327 description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
14330 $ref: "#/definitions/tunnel-xconnect"
14334 summary: update an existing tunnel-xconnect
14336 Update an existing tunnel-xconnect
14338 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14339 The PUT operation will entirely replace an existing object.
14340 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14342 Other differences between PUT and PATCH are:
14344 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14345 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14346 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14347 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
14356 description: Response codes found in [response codes](https://wiki.onap.org/).
14358 - name: global-customer-id
14360 description: Global customer id used across ECOMP to uniquely identify customer.
14363 example: __GLOBAL-CUSTOMER-ID__
14364 - name: service-type
14366 description: Value defined by orchestration to identify this service across ECOMP.
14369 example: __SERVICE-TYPE__
14370 - name: service-instance-id
14372 description: Uniquely identifies this instance of a service
14375 example: __SERVICE-INSTANCE-ID__
14378 description: Allotted Resource id UUID assigned to this instance.
14384 description: Allotted Resource id UUID assigned to this instance.
14390 description: tunnel-xconnect object that needs to be updated.
14393 $ref: "#/patchDefinitions/tunnel-xconnect"
14397 summary: delete an existing tunnel-xconnect
14398 description: delete an existing tunnel-xconnect
14399 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
14408 description: Response codes found in [response codes](https://wiki.onap.org/).
14410 - name: global-customer-id
14412 description: Global customer id used across ECOMP to uniquely identify customer.
14415 example: __GLOBAL-CUSTOMER-ID__
14416 - name: service-type
14418 description: Value defined by orchestration to identify this service across ECOMP.
14421 example: __SERVICE-TYPE__
14422 - name: service-instance-id
14424 description: Uniquely identifies this instance of a service
14427 example: __SERVICE-INSTANCE-ID__
14430 description: Allotted Resource id UUID assigned to this instance.
14436 description: Allotted Resource id UUID assigned to this instance.
14440 - name: resource-version
14442 description: resource-version for concurrency
14445 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
14449 summary: returns tunnel-xconnects
14450 description: returns tunnel-xconnects
14451 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
14457 description: successful operation
14459 $ref: "#/getDefinitions/tunnel-xconnects"
14461 description: Response codes found in [response codes](https://wiki.onap.org/).
14463 - name: global-customer-id
14465 description: Global customer id used across ECOMP to uniquely identify customer.
14468 example: __GLOBAL-CUSTOMER-ID__
14469 - name: service-type
14471 description: Value defined by orchestration to identify this service across ECOMP.
14474 example: __SERVICE-TYPE__
14475 - name: service-instance-id
14477 description: Uniquely identifies this instance of a service
14480 example: __SERVICE-INSTANCE-ID__
14483 description: Allotted Resource id UUID assigned to this instance.
14492 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
14496 summary: see node definition for valid relationships
14497 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
14506 description: Response codes found in [response codes](https://wiki.onap.org/).
14508 - name: global-customer-id
14510 description: Global customer id used across ECOMP to uniquely identify customer.
14513 example: __GLOBAL-CUSTOMER-ID__
14514 - name: service-type
14516 description: Value defined by orchestration to identify this service across ECOMP.
14519 example: __SERVICE-TYPE__
14520 - name: service-instance-id
14522 description: Uniquely identifies this instance of a service
14525 example: __SERVICE-INSTANCE-ID__
14528 description: Allotted Resource id UUID assigned to this instance.
14534 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
14537 $ref: "#/definitions/relationship"
14541 summary: delete an existing relationship
14542 description: delete an existing relationship
14543 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
14552 description: Response codes found in [response codes](https://wiki.onap.org/).
14554 - name: global-customer-id
14556 description: Global customer id used across ECOMP to uniquely identify customer.
14559 example: __GLOBAL-CUSTOMER-ID__
14560 - name: service-type
14562 description: Value defined by orchestration to identify this service across ECOMP.
14565 example: __SERVICE-TYPE__
14566 - name: service-instance-id
14568 description: Uniquely identifies this instance of a service
14571 example: __SERVICE-INSTANCE-ID__
14574 description: Allotted Resource id UUID assigned to this instance.
14578 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
14582 summary: returns allotted-resource
14583 description: returns allotted-resource
14584 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
14590 description: successful operation
14592 $ref: "#/getDefinitions/allotted-resource"
14594 description: Response codes found in [response codes](https://wiki.onap.org/).
14596 - name: global-customer-id
14598 description: Global customer id used across ECOMP to uniquely identify customer.
14601 example: __GLOBAL-CUSTOMER-ID__
14602 - name: service-type
14604 description: Value defined by orchestration to identify this service across ECOMP.
14607 example: __SERVICE-TYPE__
14608 - name: service-instance-id
14610 description: Uniquely identifies this instance of a service
14613 example: __SERVICE-INSTANCE-ID__
14616 description: Allotted Resource id UUID assigned to this instance.
14623 summary: create or update an existing allotted-resource
14625 Create or update an existing allotted-resource.
14627 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14628 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
14637 description: Response codes found in [response codes](https://wiki.onap.org/).
14639 - name: global-customer-id
14641 description: Global customer id used across ECOMP to uniquely identify customer.
14644 example: __GLOBAL-CUSTOMER-ID__
14645 - name: service-type
14647 description: Value defined by orchestration to identify this service across ECOMP.
14650 example: __SERVICE-TYPE__
14651 - name: service-instance-id
14653 description: Uniquely identifies this instance of a service
14656 example: __SERVICE-INSTANCE-ID__
14659 description: Allotted Resource id UUID assigned to this instance.
14665 description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
14668 $ref: "#/definitions/allotted-resource"
14672 summary: update an existing allotted-resource
14674 Update an existing allotted-resource
14676 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14677 The PUT operation will entirely replace an existing object.
14678 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14680 Other differences between PUT and PATCH are:
14682 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14683 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14684 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14685 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
14694 description: Response codes found in [response codes](https://wiki.onap.org/).
14696 - name: global-customer-id
14698 description: Global customer id used across ECOMP to uniquely identify customer.
14701 example: __GLOBAL-CUSTOMER-ID__
14702 - name: service-type
14704 description: Value defined by orchestration to identify this service across ECOMP.
14707 example: __SERVICE-TYPE__
14708 - name: service-instance-id
14710 description: Uniquely identifies this instance of a service
14713 example: __SERVICE-INSTANCE-ID__
14716 description: Allotted Resource id UUID assigned to this instance.
14722 description: allotted-resource object that needs to be updated.
14725 $ref: "#/patchDefinitions/allotted-resource"
14729 summary: delete an existing allotted-resource
14730 description: delete an existing allotted-resource
14731 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
14740 description: Response codes found in [response codes](https://wiki.onap.org/).
14742 - name: global-customer-id
14744 description: Global customer id used across ECOMP to uniquely identify customer.
14747 example: __GLOBAL-CUSTOMER-ID__
14748 - name: service-type
14750 description: Value defined by orchestration to identify this service across ECOMP.
14753 example: __SERVICE-TYPE__
14754 - name: service-instance-id
14756 description: Uniquely identifies this instance of a service
14759 example: __SERVICE-INSTANCE-ID__
14762 description: Allotted Resource id UUID assigned to this instance.
14766 - name: resource-version
14768 description: resource-version for concurrency
14771 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
14775 summary: returns allotted-resources
14776 description: returns allotted-resources
14777 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
14783 description: successful operation
14785 $ref: "#/getDefinitions/allotted-resources"
14787 description: Response codes found in [response codes](https://wiki.onap.org/).
14789 - name: global-customer-id
14791 description: Global customer id used across ECOMP to uniquely identify customer.
14794 example: __GLOBAL-CUSTOMER-ID__
14795 - name: service-type
14797 description: Value defined by orchestration to identify this service across ECOMP.
14800 example: __SERVICE-TYPE__
14801 - name: service-instance-id
14803 description: Uniquely identifies this instance of a service
14806 example: __SERVICE-INSTANCE-ID__
14812 - name: model-invariant-id
14817 - name: model-version-id
14832 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
14836 summary: returns service-instance
14837 description: returns service-instance
14838 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14844 description: successful operation
14846 $ref: "#/getDefinitions/service-instance"
14848 description: Response codes found in [response codes](https://wiki.onap.org/).
14850 - name: global-customer-id
14852 description: Global customer id used across ECOMP to uniquely identify customer.
14855 example: __GLOBAL-CUSTOMER-ID__
14856 - name: service-type
14858 description: Value defined by orchestration to identify this service across ECOMP.
14861 example: __SERVICE-TYPE__
14862 - name: service-instance-id
14864 description: Uniquely identifies this instance of a service
14867 example: __SERVICE-INSTANCE-ID__
14871 summary: create or update an existing service-instance
14873 Create or update an existing service-instance.
14875 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14876 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14885 description: Response codes found in [response codes](https://wiki.onap.org/).
14887 - name: global-customer-id
14889 description: Global customer id used across ECOMP to uniquely identify customer.
14892 example: __GLOBAL-CUSTOMER-ID__
14893 - name: service-type
14895 description: Value defined by orchestration to identify this service across ECOMP.
14898 example: __SERVICE-TYPE__
14899 - name: service-instance-id
14901 description: Uniquely identifies this instance of a service
14904 example: __SERVICE-INSTANCE-ID__
14907 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14910 $ref: "#/definitions/service-instance"
14914 summary: update an existing service-instance
14916 Update an existing service-instance
14918 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14919 The PUT operation will entirely replace an existing object.
14920 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14922 Other differences between PUT and PATCH are:
14924 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14925 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14926 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14927 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14936 description: Response codes found in [response codes](https://wiki.onap.org/).
14938 - name: global-customer-id
14940 description: Global customer id used across ECOMP to uniquely identify customer.
14943 example: __GLOBAL-CUSTOMER-ID__
14944 - name: service-type
14946 description: Value defined by orchestration to identify this service across ECOMP.
14949 example: __SERVICE-TYPE__
14950 - name: service-instance-id
14952 description: Uniquely identifies this instance of a service
14955 example: __SERVICE-INSTANCE-ID__
14958 description: service-instance object that needs to be updated.
14961 $ref: "#/patchDefinitions/service-instance"
14965 summary: delete an existing service-instance
14966 description: delete an existing service-instance
14967 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14976 description: Response codes found in [response codes](https://wiki.onap.org/).
14978 - name: global-customer-id
14980 description: Global customer id used across ECOMP to uniquely identify customer.
14983 example: __GLOBAL-CUSTOMER-ID__
14984 - name: service-type
14986 description: Value defined by orchestration to identify this service across ECOMP.
14989 example: __SERVICE-TYPE__
14990 - name: service-instance-id
14992 description: Uniquely identifies this instance of a service
14995 example: __SERVICE-INSTANCE-ID__
14996 - name: resource-version
14998 description: resource-version for concurrency
15001 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
15005 summary: returns service-instances
15006 description: returns service-instances
15007 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
15013 description: successful operation
15015 $ref: "#/getDefinitions/service-instances"
15017 description: Response codes found in [response codes](https://wiki.onap.org/).
15019 - name: global-customer-id
15021 description: Global customer id used across ECOMP to uniquely identify customer.
15024 example: __GLOBAL-CUSTOMER-ID__
15025 - name: service-type
15027 description: Value defined by orchestration to identify this service across ECOMP.
15030 example: __SERVICE-TYPE__
15031 - name: service-instance-id
15036 - name: service-instance-name
15041 - name: environment-context
15046 - name: workload-context
15051 - name: model-invariant-id
15056 - name: model-version-id
15061 - name: widget-model-id
15066 - name: widget-model-version
15071 - name: service-instance-location-id
15076 - name: orchestration-status
15081 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
15085 summary: see node definition for valid relationships
15086 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
15095 description: Response codes found in [response codes](https://wiki.onap.org/).
15097 - name: global-customer-id
15099 description: Global customer id used across ECOMP to uniquely identify customer.
15102 example: __GLOBAL-CUSTOMER-ID__
15103 - name: service-type
15105 description: Value defined by orchestration to identify this service across ECOMP.
15108 example: __SERVICE-TYPE__
15111 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
15114 $ref: "#/definitions/relationship"
15118 summary: delete an existing relationship
15119 description: delete an existing relationship
15120 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
15129 description: Response codes found in [response codes](https://wiki.onap.org/).
15131 - name: global-customer-id
15133 description: Global customer id used across ECOMP to uniquely identify customer.
15136 example: __GLOBAL-CUSTOMER-ID__
15137 - name: service-type
15139 description: Value defined by orchestration to identify this service across ECOMP.
15142 example: __SERVICE-TYPE__
15143 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
15147 summary: returns service-subscription
15148 description: returns service-subscription
15149 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15155 description: successful operation
15157 $ref: "#/getDefinitions/service-subscription"
15159 description: Response codes found in [response codes](https://wiki.onap.org/).
15161 - name: global-customer-id
15163 description: Global customer id used across ECOMP to uniquely identify customer.
15166 example: __GLOBAL-CUSTOMER-ID__
15167 - name: service-type
15169 description: Value defined by orchestration to identify this service across ECOMP.
15172 example: __SERVICE-TYPE__
15176 summary: create or update an existing service-subscription
15178 Create or update an existing service-subscription.
15180 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15181 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15190 description: Response codes found in [response codes](https://wiki.onap.org/).
15192 - name: global-customer-id
15194 description: Global customer id used across ECOMP to uniquely identify customer.
15197 example: __GLOBAL-CUSTOMER-ID__
15198 - name: service-type
15200 description: Value defined by orchestration to identify this service across ECOMP.
15203 example: __SERVICE-TYPE__
15206 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
15209 $ref: "#/definitions/service-subscription"
15213 summary: update an existing service-subscription
15215 Update an existing service-subscription
15217 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15218 The PUT operation will entirely replace an existing object.
15219 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15221 Other differences between PUT and PATCH are:
15223 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15224 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15225 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15226 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15235 description: Response codes found in [response codes](https://wiki.onap.org/).
15237 - name: global-customer-id
15239 description: Global customer id used across ECOMP to uniquely identify customer.
15242 example: __GLOBAL-CUSTOMER-ID__
15243 - name: service-type
15245 description: Value defined by orchestration to identify this service across ECOMP.
15248 example: __SERVICE-TYPE__
15251 description: service-subscription object that needs to be updated.
15254 $ref: "#/patchDefinitions/service-subscription"
15258 summary: delete an existing service-subscription
15259 description: delete an existing service-subscription
15260 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15269 description: Response codes found in [response codes](https://wiki.onap.org/).
15271 - name: global-customer-id
15273 description: Global customer id used across ECOMP to uniquely identify customer.
15276 example: __GLOBAL-CUSTOMER-ID__
15277 - name: service-type
15279 description: Value defined by orchestration to identify this service across ECOMP.
15282 example: __SERVICE-TYPE__
15283 - name: resource-version
15285 description: resource-version for concurrency
15288 /business/customers/customer/{global-customer-id}/service-subscriptions:
15292 summary: returns service-subscriptions
15293 description: returns service-subscriptions
15294 operationId: getBusinessCustomersCustomerServiceSubscriptions
15300 description: successful operation
15302 $ref: "#/getDefinitions/service-subscriptions"
15304 description: Response codes found in [response codes](https://wiki.onap.org/).
15306 - name: global-customer-id
15308 description: Global customer id used across ECOMP to uniquely identify customer.
15311 example: __GLOBAL-CUSTOMER-ID__
15312 - name: service-type
15317 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
15321 summary: see node definition for valid relationships
15322 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
15331 description: Response codes found in [response codes](https://wiki.onap.org/).
15333 - name: global-customer-id
15335 description: Global customer id used across ECOMP to uniquely identify customer.
15338 example: __GLOBAL-CUSTOMER-ID__
15341 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)
15344 $ref: "#/definitions/relationship"
15348 summary: delete an existing relationship
15349 description: delete an existing relationship
15350 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
15359 description: Response codes found in [response codes](https://wiki.onap.org/).
15361 - name: global-customer-id
15363 description: Global customer id used across ECOMP to uniquely identify customer.
15366 example: __GLOBAL-CUSTOMER-ID__
15367 /business/customers/customer/{global-customer-id}:
15371 summary: returns customer
15372 description: returns customer
15373 operationId: getBusinessCustomersCustomer
15379 description: successful operation
15381 $ref: "#/getDefinitions/customer"
15383 description: Response codes found in [response codes](https://wiki.onap.org/).
15385 - name: global-customer-id
15387 description: Global customer id used across ECOMP to uniquely identify customer.
15390 example: __GLOBAL-CUSTOMER-ID__
15394 summary: create or update an existing customer
15396 Create or update an existing customer.
15398 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15399 operationId: createOrUpdateBusinessCustomersCustomer
15408 description: Response codes found in [response codes](https://wiki.onap.org/).
15410 - name: global-customer-id
15412 description: Global customer id used across ECOMP to uniquely identify customer.
15415 example: __GLOBAL-CUSTOMER-ID__
15418 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)
15421 $ref: "#/definitions/customer"
15425 summary: update an existing customer
15427 Update an existing customer
15429 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15430 The PUT operation will entirely replace an existing object.
15431 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15433 Other differences between PUT and PATCH are:
15435 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15436 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15437 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15438 operationId: UpdateBusinessCustomersCustomer
15447 description: Response codes found in [response codes](https://wiki.onap.org/).
15449 - name: global-customer-id
15451 description: Global customer id used across ECOMP to uniquely identify customer.
15454 example: __GLOBAL-CUSTOMER-ID__
15457 description: customer object that needs to be updated.
15460 $ref: "#/patchDefinitions/customer"
15464 summary: delete an existing customer
15465 description: delete an existing customer
15466 operationId: deleteBusinessCustomersCustomer
15475 description: Response codes found in [response codes](https://wiki.onap.org/).
15477 - name: global-customer-id
15479 description: Global customer id used across ECOMP to uniquely identify customer.
15482 example: __GLOBAL-CUSTOMER-ID__
15483 - name: resource-version
15485 description: resource-version for concurrency
15488 /business/customers:
15492 summary: returns customers
15493 description: returns customers
15494 operationId: getBusinessCustomers
15500 description: successful operation
15502 $ref: "#/getDefinitions/customers"
15504 description: Response codes found in [response codes](https://wiki.onap.org/).
15506 - name: global-customer-id
15511 - name: subscriber-name
15516 - name: subscriber-type
15521 /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
15525 summary: see node definition for valid relationships
15526 operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
15535 description: Response codes found in [response codes](https://wiki.onap.org/).
15537 - name: line-of-business-name
15539 description: Name of the line-of-business (product)
15542 example: __LINE-OF-BUSINESS-NAME__
15545 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
15548 $ref: "#/definitions/relationship"
15552 summary: delete an existing relationship
15553 description: delete an existing relationship
15554 operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
15563 description: Response codes found in [response codes](https://wiki.onap.org/).
15565 - name: line-of-business-name
15567 description: Name of the line-of-business (product)
15570 example: __LINE-OF-BUSINESS-NAME__
15571 /business/lines-of-business/line-of-business/{line-of-business-name}:
15575 summary: returns line-of-business
15576 description: returns line-of-business
15577 operationId: getBusinessLinesOfBusinessLineOfBusiness
15583 description: successful operation
15585 $ref: "#/getDefinitions/line-of-business"
15587 description: Response codes found in [response codes](https://wiki.onap.org/).
15589 - name: line-of-business-name
15591 description: Name of the line-of-business (product)
15594 example: __LINE-OF-BUSINESS-NAME__
15598 summary: create or update an existing line-of-business
15600 Create or update an existing line-of-business.
15602 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15603 operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
15612 description: Response codes found in [response codes](https://wiki.onap.org/).
15614 - name: line-of-business-name
15616 description: Name of the line-of-business (product)
15619 example: __LINE-OF-BUSINESS-NAME__
15622 description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
15625 $ref: "#/definitions/line-of-business"
15629 summary: update an existing line-of-business
15631 Update an existing line-of-business
15633 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15634 The PUT operation will entirely replace an existing object.
15635 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15637 Other differences between PUT and PATCH are:
15639 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15640 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15641 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15642 operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
15651 description: Response codes found in [response codes](https://wiki.onap.org/).
15653 - name: line-of-business-name
15655 description: Name of the line-of-business (product)
15658 example: __LINE-OF-BUSINESS-NAME__
15661 description: line-of-business object that needs to be updated.
15664 $ref: "#/patchDefinitions/line-of-business"
15668 summary: delete an existing line-of-business
15669 description: delete an existing line-of-business
15670 operationId: deleteBusinessLinesOfBusinessLineOfBusiness
15679 description: Response codes found in [response codes](https://wiki.onap.org/).
15681 - name: line-of-business-name
15683 description: Name of the line-of-business (product)
15686 example: __LINE-OF-BUSINESS-NAME__
15687 - name: resource-version
15689 description: resource-version for concurrency
15692 /business/lines-of-business:
15696 summary: returns lines-of-business
15697 description: returns lines-of-business
15698 operationId: getBusinessLinesOfBusiness
15704 description: successful operation
15706 $ref: "#/getDefinitions/lines-of-business"
15708 description: Response codes found in [response codes](https://wiki.onap.org/).
15710 - name: line-of-business-name
15715 /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
15719 summary: see node definition for valid relationships
15720 operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
15729 description: Response codes found in [response codes](https://wiki.onap.org/).
15731 - name: owning-entity-id
15733 description: UUID of an owning entity
15736 example: __OWNING-ENTITY-ID__
15739 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
15742 $ref: "#/definitions/relationship"
15746 summary: delete an existing relationship
15747 description: delete an existing relationship
15748 operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
15757 description: Response codes found in [response codes](https://wiki.onap.org/).
15759 - name: owning-entity-id
15761 description: UUID of an owning entity
15764 example: __OWNING-ENTITY-ID__
15765 /business/owning-entities/owning-entity/{owning-entity-id}:
15769 summary: returns owning-entity
15770 description: returns owning-entity
15771 operationId: getBusinessOwningEntitiesOwningEntity
15777 description: successful operation
15779 $ref: "#/getDefinitions/owning-entity"
15781 description: Response codes found in [response codes](https://wiki.onap.org/).
15783 - name: owning-entity-id
15785 description: UUID of an owning entity
15788 example: __OWNING-ENTITY-ID__
15792 summary: create or update an existing owning-entity
15794 Create or update an existing owning-entity.
15796 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15797 operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
15806 description: Response codes found in [response codes](https://wiki.onap.org/).
15808 - name: owning-entity-id
15810 description: UUID of an owning entity
15813 example: __OWNING-ENTITY-ID__
15816 description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
15819 $ref: "#/definitions/owning-entity"
15823 summary: update an existing owning-entity
15825 Update an existing owning-entity
15827 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15828 The PUT operation will entirely replace an existing object.
15829 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15831 Other differences between PUT and PATCH are:
15833 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15834 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15835 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15836 operationId: UpdateBusinessOwningEntitiesOwningEntity
15845 description: Response codes found in [response codes](https://wiki.onap.org/).
15847 - name: owning-entity-id
15849 description: UUID of an owning entity
15852 example: __OWNING-ENTITY-ID__
15855 description: owning-entity object that needs to be updated.
15858 $ref: "#/patchDefinitions/owning-entity"
15862 summary: delete an existing owning-entity
15863 description: delete an existing owning-entity
15864 operationId: deleteBusinessOwningEntitiesOwningEntity
15873 description: Response codes found in [response codes](https://wiki.onap.org/).
15875 - name: owning-entity-id
15877 description: UUID of an owning entity
15880 example: __OWNING-ENTITY-ID__
15881 - name: resource-version
15883 description: resource-version for concurrency
15886 /business/owning-entities:
15890 summary: returns owning-entities
15891 description: returns owning-entities
15892 operationId: getBusinessOwningEntities
15898 description: successful operation
15900 $ref: "#/getDefinitions/owning-entities"
15902 description: Response codes found in [response codes](https://wiki.onap.org/).
15904 - name: owning-entity-id
15909 /business/platforms/platform/{platform-name}/relationship-list/relationship:
15913 summary: see node definition for valid relationships
15914 operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
15923 description: Response codes found in [response codes](https://wiki.onap.org/).
15925 - name: platform-name
15927 description: Name of the platform
15930 example: __PLATFORM-NAME__
15933 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
15936 $ref: "#/definitions/relationship"
15940 summary: delete an existing relationship
15941 description: delete an existing relationship
15942 operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
15951 description: Response codes found in [response codes](https://wiki.onap.org/).
15953 - name: platform-name
15955 description: Name of the platform
15958 example: __PLATFORM-NAME__
15959 /business/platforms/platform/{platform-name}:
15963 summary: returns platform
15964 description: returns platform
15965 operationId: getBusinessPlatformsPlatform
15971 description: successful operation
15973 $ref: "#/getDefinitions/platform"
15975 description: Response codes found in [response codes](https://wiki.onap.org/).
15977 - name: platform-name
15979 description: Name of the platform
15982 example: __PLATFORM-NAME__
15986 summary: create or update an existing platform
15988 Create or update an existing platform.
15990 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15991 operationId: createOrUpdateBusinessPlatformsPlatform
16000 description: Response codes found in [response codes](https://wiki.onap.org/).
16002 - name: platform-name
16004 description: Name of the platform
16007 example: __PLATFORM-NAME__
16010 description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
16013 $ref: "#/definitions/platform"
16017 summary: update an existing platform
16019 Update an existing platform
16021 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16022 The PUT operation will entirely replace an existing object.
16023 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16025 Other differences between PUT and PATCH are:
16027 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16028 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16029 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16030 operationId: UpdateBusinessPlatformsPlatform
16039 description: Response codes found in [response codes](https://wiki.onap.org/).
16041 - name: platform-name
16043 description: Name of the platform
16046 example: __PLATFORM-NAME__
16049 description: platform object that needs to be updated.
16052 $ref: "#/patchDefinitions/platform"
16056 summary: delete an existing platform
16057 description: delete an existing platform
16058 operationId: deleteBusinessPlatformsPlatform
16067 description: Response codes found in [response codes](https://wiki.onap.org/).
16069 - name: platform-name
16071 description: Name of the platform
16074 example: __PLATFORM-NAME__
16075 - name: resource-version
16077 description: resource-version for concurrency
16080 /business/platforms:
16084 summary: returns platforms
16085 description: returns platforms
16086 operationId: getBusinessPlatforms
16092 description: successful operation
16094 $ref: "#/getDefinitions/platforms"
16096 description: Response codes found in [response codes](https://wiki.onap.org/).
16098 - name: platform-name
16103 /business/projects/project/{project-name}/relationship-list/relationship:
16107 summary: see node definition for valid relationships
16108 operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
16117 description: Response codes found in [response codes](https://wiki.onap.org/).
16119 - name: project-name
16121 description: Name of the project deploying a service
16124 example: __PROJECT-NAME__
16127 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
16130 $ref: "#/definitions/relationship"
16134 summary: delete an existing relationship
16135 description: delete an existing relationship
16136 operationId: deleteBusinessProjectsProjectRelationshipListRelationship
16145 description: Response codes found in [response codes](https://wiki.onap.org/).
16147 - name: project-name
16149 description: Name of the project deploying a service
16152 example: __PROJECT-NAME__
16153 /business/projects/project/{project-name}:
16157 summary: returns project
16158 description: returns project
16159 operationId: getBusinessProjectsProject
16165 description: successful operation
16167 $ref: "#/getDefinitions/project"
16169 description: Response codes found in [response codes](https://wiki.onap.org/).
16171 - name: project-name
16173 description: Name of the project deploying a service
16176 example: __PROJECT-NAME__
16180 summary: create or update an existing project
16182 Create or update an existing project.
16184 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16185 operationId: createOrUpdateBusinessProjectsProject
16194 description: Response codes found in [response codes](https://wiki.onap.org/).
16196 - name: project-name
16198 description: Name of the project deploying a service
16201 example: __PROJECT-NAME__
16204 description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
16207 $ref: "#/definitions/project"
16211 summary: update an existing project
16213 Update an existing project
16215 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16216 The PUT operation will entirely replace an existing object.
16217 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16219 Other differences between PUT and PATCH are:
16221 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16222 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16223 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16224 operationId: UpdateBusinessProjectsProject
16233 description: Response codes found in [response codes](https://wiki.onap.org/).
16235 - name: project-name
16237 description: Name of the project deploying a service
16240 example: __PROJECT-NAME__
16243 description: project object that needs to be updated.
16246 $ref: "#/patchDefinitions/project"
16250 summary: delete an existing project
16251 description: delete an existing project
16252 operationId: deleteBusinessProjectsProject
16261 description: Response codes found in [response codes](https://wiki.onap.org/).
16263 - name: project-name
16265 description: Name of the project deploying a service
16268 example: __PROJECT-NAME__
16269 - name: resource-version
16271 description: resource-version for concurrency
16274 /business/projects:
16278 summary: returns projects
16279 description: returns projects
16280 operationId: getBusinessProjects
16286 description: successful operation
16288 $ref: "#/getDefinitions/projects"
16290 description: Response codes found in [response codes](https://wiki.onap.org/).
16292 - name: project-name
16297 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
16300 - ServiceDesignAndCreation
16301 summary: see node definition for valid relationships
16302 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16311 description: Response codes found in [response codes](https://wiki.onap.org/).
16313 - name: vnf-image-uuid
16315 description: Unique ID of this asset
16318 example: __VNF-IMAGE-UUID__
16321 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)
16324 $ref: "#/definitions/relationship"
16327 - ServiceDesignAndCreation
16328 summary: delete an existing relationship
16329 description: delete an existing relationship
16330 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16339 description: Response codes found in [response codes](https://wiki.onap.org/).
16341 - name: vnf-image-uuid
16343 description: Unique ID of this asset
16346 example: __VNF-IMAGE-UUID__
16347 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
16350 - ServiceDesignAndCreation
16351 summary: returns vnf-image
16352 description: returns vnf-image
16353 operationId: getServiceDesignAndCreationVnfImagesVnfImage
16359 description: successful operation
16361 $ref: "#/getDefinitions/vnf-image"
16363 description: Response codes found in [response codes](https://wiki.onap.org/).
16365 - name: vnf-image-uuid
16367 description: Unique ID of this asset
16370 example: __VNF-IMAGE-UUID__
16373 - ServiceDesignAndCreation
16374 summary: create or update an existing vnf-image
16376 Create or update an existing vnf-image.
16378 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16379 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
16388 description: Response codes found in [response codes](https://wiki.onap.org/).
16390 - name: vnf-image-uuid
16392 description: Unique ID of this asset
16395 example: __VNF-IMAGE-UUID__
16398 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)
16401 $ref: "#/definitions/vnf-image"
16404 - ServiceDesignAndCreation
16405 summary: update an existing vnf-image
16407 Update an existing vnf-image
16409 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16410 The PUT operation will entirely replace an existing object.
16411 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16413 Other differences between PUT and PATCH are:
16415 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16416 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16417 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16418 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
16427 description: Response codes found in [response codes](https://wiki.onap.org/).
16429 - name: vnf-image-uuid
16431 description: Unique ID of this asset
16434 example: __VNF-IMAGE-UUID__
16437 description: vnf-image object that needs to be updated.
16440 $ref: "#/patchDefinitions/vnf-image"
16443 - ServiceDesignAndCreation
16444 summary: delete an existing vnf-image
16445 description: delete an existing vnf-image
16446 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
16455 description: Response codes found in [response codes](https://wiki.onap.org/).
16457 - name: vnf-image-uuid
16459 description: Unique ID of this asset
16462 example: __VNF-IMAGE-UUID__
16463 - name: resource-version
16465 description: resource-version for concurrency
16468 /service-design-and-creation/vnf-images:
16471 - ServiceDesignAndCreation
16472 summary: returns vnf-images
16473 description: returns vnf-images
16474 operationId: getServiceDesignAndCreationVnfImages
16480 description: successful operation
16482 $ref: "#/getDefinitions/vnf-images"
16484 description: Response codes found in [response codes](https://wiki.onap.org/).
16486 - name: vnf-image-uuid
16491 - name: application
16496 - name: application-vendor
16501 - name: application-version
16506 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
16509 - ServiceDesignAndCreation
16510 summary: see node definition for valid relationships
16511 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
16520 description: Response codes found in [response codes](https://wiki.onap.org/).
16524 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16527 example: __SERVICE-ID__
16530 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)
16533 $ref: "#/definitions/relationship"
16536 - ServiceDesignAndCreation
16537 summary: delete an existing relationship
16538 description: delete an existing relationship
16539 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
16548 description: Response codes found in [response codes](https://wiki.onap.org/).
16552 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16555 example: __SERVICE-ID__
16556 /service-design-and-creation/services/service/{service-id}:
16559 - ServiceDesignAndCreation
16560 summary: returns service
16561 description: returns service
16562 operationId: getServiceDesignAndCreationServicesService
16568 description: successful operation
16570 $ref: "#/getDefinitions/service"
16572 description: Response codes found in [response codes](https://wiki.onap.org/).
16576 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16579 example: __SERVICE-ID__
16582 - ServiceDesignAndCreation
16583 summary: create or update an existing service
16585 Create or update an existing service.
16587 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16588 operationId: createOrUpdateServiceDesignAndCreationServicesService
16597 description: Response codes found in [response codes](https://wiki.onap.org/).
16601 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16604 example: __SERVICE-ID__
16607 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)
16610 $ref: "#/definitions/service"
16613 - ServiceDesignAndCreation
16614 summary: update an existing service
16616 Update an existing service
16618 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16619 The PUT operation will entirely replace an existing object.
16620 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16622 Other differences between PUT and PATCH are:
16624 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16625 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16626 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16627 operationId: UpdateServiceDesignAndCreationServicesService
16636 description: Response codes found in [response codes](https://wiki.onap.org/).
16640 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16643 example: __SERVICE-ID__
16646 description: service object that needs to be updated.
16649 $ref: "#/patchDefinitions/service"
16652 - ServiceDesignAndCreation
16653 summary: delete an existing service
16654 description: delete an existing service
16655 operationId: deleteServiceDesignAndCreationServicesService
16664 description: Response codes found in [response codes](https://wiki.onap.org/).
16668 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16671 example: __SERVICE-ID__
16672 - name: resource-version
16674 description: resource-version for concurrency
16677 /service-design-and-creation/services:
16680 - ServiceDesignAndCreation
16681 summary: returns services
16682 description: returns services
16683 operationId: getServiceDesignAndCreationServices
16689 description: successful operation
16691 $ref: "#/getDefinitions/services"
16693 description: Response codes found in [response codes](https://wiki.onap.org/).
16700 - name: service-description
16705 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
16708 - ServiceDesignAndCreation
16709 summary: see node definition for valid relationships
16710 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
16719 description: Response codes found in [response codes](https://wiki.onap.org/).
16721 - name: service-type
16723 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16726 example: __SERVICE-TYPE__
16729 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
16732 example: __VNF-TYPE__
16735 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
16738 $ref: "#/definitions/relationship"
16741 - ServiceDesignAndCreation
16742 summary: delete an existing relationship
16743 description: delete an existing relationship
16744 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
16753 description: Response codes found in [response codes](https://wiki.onap.org/).
16755 - name: service-type
16757 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16760 example: __SERVICE-TYPE__
16763 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
16766 example: __VNF-TYPE__
16767 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
16770 - ServiceDesignAndCreation
16771 summary: returns service-capability
16772 description: returns service-capability
16773 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
16779 description: successful operation
16781 $ref: "#/getDefinitions/service-capability"
16783 description: Response codes found in [response codes](https://wiki.onap.org/).
16785 - name: service-type
16787 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16790 example: __SERVICE-TYPE__
16793 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
16796 example: __VNF-TYPE__
16799 - ServiceDesignAndCreation
16800 summary: create or update an existing service-capability
16802 Create or update an existing service-capability.
16804 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16805 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
16814 description: Response codes found in [response codes](https://wiki.onap.org/).
16816 - name: service-type
16818 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16821 example: __SERVICE-TYPE__
16824 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
16827 example: __VNF-TYPE__
16830 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
16833 $ref: "#/definitions/service-capability"
16836 - ServiceDesignAndCreation
16837 summary: update an existing service-capability
16839 Update an existing service-capability
16841 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16842 The PUT operation will entirely replace an existing object.
16843 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16845 Other differences between PUT and PATCH are:
16847 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16848 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16849 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16850 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
16859 description: Response codes found in [response codes](https://wiki.onap.org/).
16861 - name: service-type
16863 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16866 example: __SERVICE-TYPE__
16869 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
16872 example: __VNF-TYPE__
16875 description: service-capability object that needs to be updated.
16878 $ref: "#/patchDefinitions/service-capability"
16881 - ServiceDesignAndCreation
16882 summary: delete an existing service-capability
16883 description: delete an existing service-capability
16884 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
16893 description: Response codes found in [response codes](https://wiki.onap.org/).
16895 - name: service-type
16897 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16900 example: __SERVICE-TYPE__
16903 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
16906 example: __VNF-TYPE__
16907 - name: resource-version
16909 description: resource-version for concurrency
16912 /service-design-and-creation/service-capabilities:
16915 - ServiceDesignAndCreation
16916 summary: returns service-capabilities
16917 description: returns service-capabilities
16918 operationId: getServiceDesignAndCreationServiceCapabilities
16924 description: successful operation
16926 $ref: "#/getDefinitions/service-capabilities"
16928 description: Response codes found in [response codes](https://wiki.onap.org/).
16930 - name: service-type
16940 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
16943 - ServiceDesignAndCreation
16944 summary: see node definition for valid relationships
16945 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
16954 description: Response codes found in [response codes](https://wiki.onap.org/).
16956 - name: model-invariant-id
16958 description: Unique identifier corresponding to the main definition of a model in ASDC
16961 example: __MODEL-INVARIANT-ID__
16962 - name: model-version-id
16964 description: Unique identifier corresponding to one version of a model in ASDC
16967 example: __MODEL-VERSION-ID__
16968 - name: model-element-uuid
16972 example: __MODEL-ELEMENT-UUID__
16973 - name: model-constraint-uuid
16977 example: __MODEL-CONSTRAINT-UUID__
16978 - name: constrained-element-set-uuid
16982 example: __CONSTRAINED-ELEMENT-SET-UUID__
16983 - name: element-choice-set-uuid
16987 example: __ELEMENT-CHOICE-SET-UUID__
16990 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
16993 $ref: "#/definitions/relationship"
16996 - ServiceDesignAndCreation
16997 summary: delete an existing relationship
16998 description: delete an existing relationship
16999 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17008 description: Response codes found in [response codes](https://wiki.onap.org/).
17010 - name: model-invariant-id
17012 description: Unique identifier corresponding to the main definition of a model in ASDC
17015 example: __MODEL-INVARIANT-ID__
17016 - name: model-version-id
17018 description: Unique identifier corresponding to one version of a model in ASDC
17021 example: __MODEL-VERSION-ID__
17022 - name: model-element-uuid
17026 example: __MODEL-ELEMENT-UUID__
17027 - name: model-constraint-uuid
17031 example: __MODEL-CONSTRAINT-UUID__
17032 - name: constrained-element-set-uuid
17036 example: __CONSTRAINED-ELEMENT-SET-UUID__
17037 - name: element-choice-set-uuid
17041 example: __ELEMENT-CHOICE-SET-UUID__
17042 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
17045 - ServiceDesignAndCreation
17046 summary: returns element-choice-set
17047 description: returns element-choice-set
17048 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17054 description: successful operation
17056 $ref: "#/getDefinitions/element-choice-set"
17058 description: Response codes found in [response codes](https://wiki.onap.org/).
17060 - name: model-invariant-id
17062 description: Unique identifier corresponding to the main definition of a model in ASDC
17065 example: __MODEL-INVARIANT-ID__
17066 - name: model-version-id
17068 description: Unique identifier corresponding to one version of a model in ASDC
17071 example: __MODEL-VERSION-ID__
17072 - name: model-element-uuid
17076 example: __MODEL-ELEMENT-UUID__
17077 - name: model-constraint-uuid
17081 example: __MODEL-CONSTRAINT-UUID__
17082 - name: constrained-element-set-uuid
17086 example: __CONSTRAINED-ELEMENT-SET-UUID__
17087 - name: element-choice-set-uuid
17091 example: __ELEMENT-CHOICE-SET-UUID__
17094 - ServiceDesignAndCreation
17095 summary: create or update an existing element-choice-set
17097 Create or update an existing element-choice-set.
17099 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17100 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17109 description: Response codes found in [response codes](https://wiki.onap.org/).
17111 - name: model-invariant-id
17113 description: Unique identifier corresponding to the main definition of a model in ASDC
17116 example: __MODEL-INVARIANT-ID__
17117 - name: model-version-id
17119 description: Unique identifier corresponding to one version of a model in ASDC
17122 example: __MODEL-VERSION-ID__
17123 - name: model-element-uuid
17127 example: __MODEL-ELEMENT-UUID__
17128 - name: model-constraint-uuid
17132 example: __MODEL-CONSTRAINT-UUID__
17133 - name: constrained-element-set-uuid
17137 example: __CONSTRAINED-ELEMENT-SET-UUID__
17138 - name: element-choice-set-uuid
17142 example: __ELEMENT-CHOICE-SET-UUID__
17145 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17148 $ref: "#/definitions/element-choice-set"
17151 - ServiceDesignAndCreation
17152 summary: update an existing element-choice-set
17154 Update an existing element-choice-set
17156 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17157 The PUT operation will entirely replace an existing object.
17158 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17160 Other differences between PUT and PATCH are:
17162 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17163 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17164 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17165 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17174 description: Response codes found in [response codes](https://wiki.onap.org/).
17176 - name: model-invariant-id
17178 description: Unique identifier corresponding to the main definition of a model in ASDC
17181 example: __MODEL-INVARIANT-ID__
17182 - name: model-version-id
17184 description: Unique identifier corresponding to one version of a model in ASDC
17187 example: __MODEL-VERSION-ID__
17188 - name: model-element-uuid
17192 example: __MODEL-ELEMENT-UUID__
17193 - name: model-constraint-uuid
17197 example: __MODEL-CONSTRAINT-UUID__
17198 - name: constrained-element-set-uuid
17202 example: __CONSTRAINED-ELEMENT-SET-UUID__
17203 - name: element-choice-set-uuid
17207 example: __ELEMENT-CHOICE-SET-UUID__
17210 description: element-choice-set object that needs to be updated.
17213 $ref: "#/patchDefinitions/element-choice-set"
17216 - ServiceDesignAndCreation
17217 summary: delete an existing element-choice-set
17218 description: delete an existing element-choice-set
17219 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17228 description: Response codes found in [response codes](https://wiki.onap.org/).
17230 - name: model-invariant-id
17232 description: Unique identifier corresponding to the main definition of a model in ASDC
17235 example: __MODEL-INVARIANT-ID__
17236 - name: model-version-id
17238 description: Unique identifier corresponding to one version of a model in ASDC
17241 example: __MODEL-VERSION-ID__
17242 - name: model-element-uuid
17246 example: __MODEL-ELEMENT-UUID__
17247 - name: model-constraint-uuid
17251 example: __MODEL-CONSTRAINT-UUID__
17252 - name: constrained-element-set-uuid
17256 example: __CONSTRAINED-ELEMENT-SET-UUID__
17257 - name: element-choice-set-uuid
17261 example: __ELEMENT-CHOICE-SET-UUID__
17262 - name: resource-version
17264 description: resource-version for concurrency
17267 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
17270 - ServiceDesignAndCreation
17271 summary: returns element-choice-sets
17272 description: returns element-choice-sets
17273 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
17279 description: successful operation
17281 $ref: "#/getDefinitions/element-choice-sets"
17283 description: Response codes found in [response codes](https://wiki.onap.org/).
17285 - name: model-invariant-id
17287 description: Unique identifier corresponding to the main definition of a model in ASDC
17290 example: __MODEL-INVARIANT-ID__
17291 - name: model-version-id
17293 description: Unique identifier corresponding to one version of a model in ASDC
17296 example: __MODEL-VERSION-ID__
17297 - name: model-element-uuid
17301 example: __MODEL-ELEMENT-UUID__
17302 - name: model-constraint-uuid
17306 example: __MODEL-CONSTRAINT-UUID__
17307 - name: constrained-element-set-uuid
17311 example: __CONSTRAINED-ELEMENT-SET-UUID__
17312 - name: element-choice-set-uuid
17317 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
17320 - ServiceDesignAndCreation
17321 summary: see node definition for valid relationships
17322 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17331 description: Response codes found in [response codes](https://wiki.onap.org/).
17333 - name: model-invariant-id
17335 description: Unique identifier corresponding to the main definition of a model in ASDC
17338 example: __MODEL-INVARIANT-ID__
17339 - name: model-version-id
17341 description: Unique identifier corresponding to one version of a model in ASDC
17344 example: __MODEL-VERSION-ID__
17345 - name: model-element-uuid
17349 example: __MODEL-ELEMENT-UUID__
17350 - name: model-constraint-uuid
17354 example: __MODEL-CONSTRAINT-UUID__
17355 - name: constrained-element-set-uuid
17359 example: __CONSTRAINED-ELEMENT-SET-UUID__
17362 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17365 $ref: "#/definitions/relationship"
17368 - ServiceDesignAndCreation
17369 summary: delete an existing relationship
17370 description: delete an existing relationship
17371 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17380 description: Response codes found in [response codes](https://wiki.onap.org/).
17382 - name: model-invariant-id
17384 description: Unique identifier corresponding to the main definition of a model in ASDC
17387 example: __MODEL-INVARIANT-ID__
17388 - name: model-version-id
17390 description: Unique identifier corresponding to one version of a model in ASDC
17393 example: __MODEL-VERSION-ID__
17394 - name: model-element-uuid
17398 example: __MODEL-ELEMENT-UUID__
17399 - name: model-constraint-uuid
17403 example: __MODEL-CONSTRAINT-UUID__
17404 - name: constrained-element-set-uuid
17408 example: __CONSTRAINED-ELEMENT-SET-UUID__
17409 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
17412 - ServiceDesignAndCreation
17413 summary: returns constrained-element-set
17414 description: returns constrained-element-set
17415 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17421 description: successful operation
17423 $ref: "#/getDefinitions/constrained-element-set"
17425 description: Response codes found in [response codes](https://wiki.onap.org/).
17427 - name: model-invariant-id
17429 description: Unique identifier corresponding to the main definition of a model in ASDC
17432 example: __MODEL-INVARIANT-ID__
17433 - name: model-version-id
17435 description: Unique identifier corresponding to one version of a model in ASDC
17438 example: __MODEL-VERSION-ID__
17439 - name: model-element-uuid
17443 example: __MODEL-ELEMENT-UUID__
17444 - name: model-constraint-uuid
17448 example: __MODEL-CONSTRAINT-UUID__
17449 - name: constrained-element-set-uuid
17453 example: __CONSTRAINED-ELEMENT-SET-UUID__
17456 - ServiceDesignAndCreation
17457 summary: create or update an existing constrained-element-set
17459 Create or update an existing constrained-element-set.
17461 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17462 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17471 description: Response codes found in [response codes](https://wiki.onap.org/).
17473 - name: model-invariant-id
17475 description: Unique identifier corresponding to the main definition of a model in ASDC
17478 example: __MODEL-INVARIANT-ID__
17479 - name: model-version-id
17481 description: Unique identifier corresponding to one version of a model in ASDC
17484 example: __MODEL-VERSION-ID__
17485 - name: model-element-uuid
17489 example: __MODEL-ELEMENT-UUID__
17490 - name: model-constraint-uuid
17494 example: __MODEL-CONSTRAINT-UUID__
17495 - name: constrained-element-set-uuid
17499 example: __CONSTRAINED-ELEMENT-SET-UUID__
17502 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17505 $ref: "#/definitions/constrained-element-set"
17508 - ServiceDesignAndCreation
17509 summary: update an existing constrained-element-set
17511 Update an existing constrained-element-set
17513 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17514 The PUT operation will entirely replace an existing object.
17515 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17517 Other differences between PUT and PATCH are:
17519 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17520 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17521 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17522 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17531 description: Response codes found in [response codes](https://wiki.onap.org/).
17533 - name: model-invariant-id
17535 description: Unique identifier corresponding to the main definition of a model in ASDC
17538 example: __MODEL-INVARIANT-ID__
17539 - name: model-version-id
17541 description: Unique identifier corresponding to one version of a model in ASDC
17544 example: __MODEL-VERSION-ID__
17545 - name: model-element-uuid
17549 example: __MODEL-ELEMENT-UUID__
17550 - name: model-constraint-uuid
17554 example: __MODEL-CONSTRAINT-UUID__
17555 - name: constrained-element-set-uuid
17559 example: __CONSTRAINED-ELEMENT-SET-UUID__
17562 description: constrained-element-set object that needs to be updated.
17565 $ref: "#/patchDefinitions/constrained-element-set"
17568 - ServiceDesignAndCreation
17569 summary: delete an existing constrained-element-set
17570 description: delete an existing constrained-element-set
17571 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17580 description: Response codes found in [response codes](https://wiki.onap.org/).
17582 - name: model-invariant-id
17584 description: Unique identifier corresponding to the main definition of a model in ASDC
17587 example: __MODEL-INVARIANT-ID__
17588 - name: model-version-id
17590 description: Unique identifier corresponding to one version of a model in ASDC
17593 example: __MODEL-VERSION-ID__
17594 - name: model-element-uuid
17598 example: __MODEL-ELEMENT-UUID__
17599 - name: model-constraint-uuid
17603 example: __MODEL-CONSTRAINT-UUID__
17604 - name: constrained-element-set-uuid
17608 example: __CONSTRAINED-ELEMENT-SET-UUID__
17609 - name: resource-version
17611 description: resource-version for concurrency
17614 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
17617 - ServiceDesignAndCreation
17618 summary: returns constrained-element-sets
17619 description: returns constrained-element-sets
17620 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
17626 description: successful operation
17628 $ref: "#/getDefinitions/constrained-element-sets"
17630 description: Response codes found in [response codes](https://wiki.onap.org/).
17632 - name: model-invariant-id
17634 description: Unique identifier corresponding to the main definition of a model in ASDC
17637 example: __MODEL-INVARIANT-ID__
17638 - name: model-version-id
17640 description: Unique identifier corresponding to one version of a model in ASDC
17643 example: __MODEL-VERSION-ID__
17644 - name: model-element-uuid
17648 example: __MODEL-ELEMENT-UUID__
17649 - name: model-constraint-uuid
17653 example: __MODEL-CONSTRAINT-UUID__
17654 - name: constrained-element-set-uuid
17659 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
17662 - ServiceDesignAndCreation
17663 summary: returns model-constraint
17664 description: returns model-constraint
17665 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17671 description: successful operation
17673 $ref: "#/getDefinitions/model-constraint"
17675 description: Response codes found in [response codes](https://wiki.onap.org/).
17677 - name: model-invariant-id
17679 description: Unique identifier corresponding to the main definition of a model in ASDC
17682 example: __MODEL-INVARIANT-ID__
17683 - name: model-version-id
17685 description: Unique identifier corresponding to one version of a model in ASDC
17688 example: __MODEL-VERSION-ID__
17689 - name: model-element-uuid
17693 example: __MODEL-ELEMENT-UUID__
17694 - name: model-constraint-uuid
17698 example: __MODEL-CONSTRAINT-UUID__
17701 - ServiceDesignAndCreation
17702 summary: create or update an existing model-constraint
17704 Create or update an existing model-constraint.
17706 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17707 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17716 description: Response codes found in [response codes](https://wiki.onap.org/).
17718 - name: model-invariant-id
17720 description: Unique identifier corresponding to the main definition of a model in ASDC
17723 example: __MODEL-INVARIANT-ID__
17724 - name: model-version-id
17726 description: Unique identifier corresponding to one version of a model in ASDC
17729 example: __MODEL-VERSION-ID__
17730 - name: model-element-uuid
17734 example: __MODEL-ELEMENT-UUID__
17735 - name: model-constraint-uuid
17739 example: __MODEL-CONSTRAINT-UUID__
17742 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
17745 $ref: "#/definitions/model-constraint"
17748 - ServiceDesignAndCreation
17749 summary: update an existing model-constraint
17751 Update an existing model-constraint
17753 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17754 The PUT operation will entirely replace an existing object.
17755 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17757 Other differences between PUT and PATCH are:
17759 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17760 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17761 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17762 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17771 description: Response codes found in [response codes](https://wiki.onap.org/).
17773 - name: model-invariant-id
17775 description: Unique identifier corresponding to the main definition of a model in ASDC
17778 example: __MODEL-INVARIANT-ID__
17779 - name: model-version-id
17781 description: Unique identifier corresponding to one version of a model in ASDC
17784 example: __MODEL-VERSION-ID__
17785 - name: model-element-uuid
17789 example: __MODEL-ELEMENT-UUID__
17790 - name: model-constraint-uuid
17794 example: __MODEL-CONSTRAINT-UUID__
17797 description: model-constraint object that needs to be updated.
17800 $ref: "#/patchDefinitions/model-constraint"
17803 - ServiceDesignAndCreation
17804 summary: delete an existing model-constraint
17805 description: delete an existing model-constraint
17806 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17815 description: Response codes found in [response codes](https://wiki.onap.org/).
17817 - name: model-invariant-id
17819 description: Unique identifier corresponding to the main definition of a model in ASDC
17822 example: __MODEL-INVARIANT-ID__
17823 - name: model-version-id
17825 description: Unique identifier corresponding to one version of a model in ASDC
17828 example: __MODEL-VERSION-ID__
17829 - name: model-element-uuid
17833 example: __MODEL-ELEMENT-UUID__
17834 - name: model-constraint-uuid
17838 example: __MODEL-CONSTRAINT-UUID__
17839 - name: resource-version
17841 description: resource-version for concurrency
17844 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
17847 - ServiceDesignAndCreation
17848 summary: returns model-constraints
17849 description: returns model-constraints
17850 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
17856 description: successful operation
17858 $ref: "#/getDefinitions/model-constraints"
17860 description: Response codes found in [response codes](https://wiki.onap.org/).
17862 - name: model-invariant-id
17864 description: Unique identifier corresponding to the main definition of a model in ASDC
17867 example: __MODEL-INVARIANT-ID__
17868 - name: model-version-id
17870 description: Unique identifier corresponding to one version of a model in ASDC
17873 example: __MODEL-VERSION-ID__
17874 - name: model-element-uuid
17878 example: __MODEL-ELEMENT-UUID__
17879 - name: model-constraint-uuid
17884 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
17887 - ServiceDesignAndCreation
17888 summary: see node definition for valid relationships
17889 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
17898 description: Response codes found in [response codes](https://wiki.onap.org/).
17900 - name: model-invariant-id
17902 description: Unique identifier corresponding to the main definition of a model in ASDC
17905 example: __MODEL-INVARIANT-ID__
17906 - name: model-version-id
17908 description: Unique identifier corresponding to one version of a model in ASDC
17911 example: __MODEL-VERSION-ID__
17912 - name: model-element-uuid
17916 example: __MODEL-ELEMENT-UUID__
17919 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
17922 $ref: "#/definitions/relationship"
17925 - ServiceDesignAndCreation
17926 summary: delete an existing relationship
17927 description: delete an existing relationship
17928 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
17937 description: Response codes found in [response codes](https://wiki.onap.org/).
17939 - name: model-invariant-id
17941 description: Unique identifier corresponding to the main definition of a model in ASDC
17944 example: __MODEL-INVARIANT-ID__
17945 - name: model-version-id
17947 description: Unique identifier corresponding to one version of a model in ASDC
17950 example: __MODEL-VERSION-ID__
17951 - name: model-element-uuid
17955 example: __MODEL-ELEMENT-UUID__
17956 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
17959 - ServiceDesignAndCreation
17960 summary: returns model-element
17961 description: returns model-element
17962 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
17968 description: successful operation
17970 $ref: "#/getDefinitions/model-element"
17972 description: Response codes found in [response codes](https://wiki.onap.org/).
17974 - name: model-invariant-id
17976 description: Unique identifier corresponding to the main definition of a model in ASDC
17979 example: __MODEL-INVARIANT-ID__
17980 - name: model-version-id
17982 description: Unique identifier corresponding to one version of a model in ASDC
17985 example: __MODEL-VERSION-ID__
17986 - name: model-element-uuid
17990 example: __MODEL-ELEMENT-UUID__
17993 - ServiceDesignAndCreation
17994 summary: create or update an existing model-element
17996 Create or update an existing model-element.
17998 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17999 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18008 description: Response codes found in [response codes](https://wiki.onap.org/).
18010 - name: model-invariant-id
18012 description: Unique identifier corresponding to the main definition of a model in ASDC
18015 example: __MODEL-INVARIANT-ID__
18016 - name: model-version-id
18018 description: Unique identifier corresponding to one version of a model in ASDC
18021 example: __MODEL-VERSION-ID__
18022 - name: model-element-uuid
18026 example: __MODEL-ELEMENT-UUID__
18029 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18032 $ref: "#/definitions/model-element"
18035 - ServiceDesignAndCreation
18036 summary: update an existing model-element
18038 Update an existing model-element
18040 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18041 The PUT operation will entirely replace an existing object.
18042 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18044 Other differences between PUT and PATCH are:
18046 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18047 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18048 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18049 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18058 description: Response codes found in [response codes](https://wiki.onap.org/).
18060 - name: model-invariant-id
18062 description: Unique identifier corresponding to the main definition of a model in ASDC
18065 example: __MODEL-INVARIANT-ID__
18066 - name: model-version-id
18068 description: Unique identifier corresponding to one version of a model in ASDC
18071 example: __MODEL-VERSION-ID__
18072 - name: model-element-uuid
18076 example: __MODEL-ELEMENT-UUID__
18079 description: model-element object that needs to be updated.
18082 $ref: "#/patchDefinitions/model-element"
18085 - ServiceDesignAndCreation
18086 summary: delete an existing model-element
18087 description: delete an existing model-element
18088 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18097 description: Response codes found in [response codes](https://wiki.onap.org/).
18099 - name: model-invariant-id
18101 description: Unique identifier corresponding to the main definition of a model in ASDC
18104 example: __MODEL-INVARIANT-ID__
18105 - name: model-version-id
18107 description: Unique identifier corresponding to one version of a model in ASDC
18110 example: __MODEL-VERSION-ID__
18111 - name: model-element-uuid
18115 example: __MODEL-ELEMENT-UUID__
18116 - name: resource-version
18118 description: resource-version for concurrency
18121 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
18124 - ServiceDesignAndCreation
18125 summary: returns model-elements
18126 description: returns model-elements
18127 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
18133 description: successful operation
18135 $ref: "#/getDefinitions/model-elements"
18137 description: Response codes found in [response codes](https://wiki.onap.org/).
18139 - name: model-invariant-id
18141 description: Unique identifier corresponding to the main definition of a model in ASDC
18144 example: __MODEL-INVARIANT-ID__
18145 - name: model-version-id
18147 description: Unique identifier corresponding to one version of a model in ASDC
18150 example: __MODEL-VERSION-ID__
18151 - name: model-element-uuid
18156 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
18159 - ServiceDesignAndCreation
18160 summary: returns metadatum
18161 description: returns metadatum
18162 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18168 description: successful operation
18170 $ref: "#/getDefinitions/metadatum"
18172 description: Response codes found in [response codes](https://wiki.onap.org/).
18174 - name: model-invariant-id
18176 description: Unique identifier corresponding to the main definition of a model in ASDC
18179 example: __MODEL-INVARIANT-ID__
18180 - name: model-version-id
18182 description: Unique identifier corresponding to one version of a model in ASDC
18185 example: __MODEL-VERSION-ID__
18190 example: __METANAME__
18193 - ServiceDesignAndCreation
18194 summary: create or update an existing metadatum
18196 Create or update an existing metadatum.
18198 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18199 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18208 description: Response codes found in [response codes](https://wiki.onap.org/).
18210 - name: model-invariant-id
18212 description: Unique identifier corresponding to the main definition of a model in ASDC
18215 example: __MODEL-INVARIANT-ID__
18216 - name: model-version-id
18218 description: Unique identifier corresponding to one version of a model in ASDC
18221 example: __MODEL-VERSION-ID__
18226 example: __METANAME__
18229 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
18232 $ref: "#/definitions/metadatum"
18235 - ServiceDesignAndCreation
18236 summary: update an existing metadatum
18238 Update an existing metadatum
18240 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18241 The PUT operation will entirely replace an existing object.
18242 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18244 Other differences between PUT and PATCH are:
18246 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18247 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18248 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18249 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18258 description: Response codes found in [response codes](https://wiki.onap.org/).
18260 - name: model-invariant-id
18262 description: Unique identifier corresponding to the main definition of a model in ASDC
18265 example: __MODEL-INVARIANT-ID__
18266 - name: model-version-id
18268 description: Unique identifier corresponding to one version of a model in ASDC
18271 example: __MODEL-VERSION-ID__
18276 example: __METANAME__
18279 description: metadatum object that needs to be updated.
18282 $ref: "#/patchDefinitions/metadatum"
18285 - ServiceDesignAndCreation
18286 summary: delete an existing metadatum
18287 description: delete an existing metadatum
18288 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18297 description: Response codes found in [response codes](https://wiki.onap.org/).
18299 - name: model-invariant-id
18301 description: Unique identifier corresponding to the main definition of a model in ASDC
18304 example: __MODEL-INVARIANT-ID__
18305 - name: model-version-id
18307 description: Unique identifier corresponding to one version of a model in ASDC
18310 example: __MODEL-VERSION-ID__
18315 example: __METANAME__
18316 - name: resource-version
18318 description: resource-version for concurrency
18321 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
18324 - ServiceDesignAndCreation
18325 summary: returns metadata
18326 description: returns metadata
18327 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
18333 description: successful operation
18335 $ref: "#/getDefinitions/metadata"
18337 description: Response codes found in [response codes](https://wiki.onap.org/).
18339 - name: model-invariant-id
18341 description: Unique identifier corresponding to the main definition of a model in ASDC
18344 example: __MODEL-INVARIANT-ID__
18345 - name: model-version-id
18347 description: Unique identifier corresponding to one version of a model in ASDC
18350 example: __MODEL-VERSION-ID__
18356 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
18359 - ServiceDesignAndCreation
18360 summary: see node definition for valid relationships
18361 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18370 description: Response codes found in [response codes](https://wiki.onap.org/).
18372 - name: model-invariant-id
18374 description: Unique identifier corresponding to the main definition of a model in ASDC
18377 example: __MODEL-INVARIANT-ID__
18378 - name: model-version-id
18380 description: Unique identifier corresponding to one version of a model in ASDC
18383 example: __MODEL-VERSION-ID__
18386 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18389 $ref: "#/definitions/relationship"
18392 - ServiceDesignAndCreation
18393 summary: delete an existing relationship
18394 description: delete an existing relationship
18395 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18404 description: Response codes found in [response codes](https://wiki.onap.org/).
18406 - name: model-invariant-id
18408 description: Unique identifier corresponding to the main definition of a model in ASDC
18411 example: __MODEL-INVARIANT-ID__
18412 - name: model-version-id
18414 description: Unique identifier corresponding to one version of a model in ASDC
18417 example: __MODEL-VERSION-ID__
18418 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
18421 - ServiceDesignAndCreation
18422 summary: returns model-ver
18423 description: returns model-ver
18424 operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
18430 description: successful operation
18432 $ref: "#/getDefinitions/model-ver"
18434 description: Response codes found in [response codes](https://wiki.onap.org/).
18436 - name: model-invariant-id
18438 description: Unique identifier corresponding to the main definition of a model in ASDC
18441 example: __MODEL-INVARIANT-ID__
18442 - name: model-version-id
18444 description: Unique identifier corresponding to one version of a model in ASDC
18447 example: __MODEL-VERSION-ID__
18450 - ServiceDesignAndCreation
18451 summary: create or update an existing model-ver
18453 Create or update an existing model-ver.
18455 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18456 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
18465 description: Response codes found in [response codes](https://wiki.onap.org/).
18467 - name: model-invariant-id
18469 description: Unique identifier corresponding to the main definition of a model in ASDC
18472 example: __MODEL-INVARIANT-ID__
18473 - name: model-version-id
18475 description: Unique identifier corresponding to one version of a model in ASDC
18478 example: __MODEL-VERSION-ID__
18481 description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18484 $ref: "#/definitions/model-ver"
18487 - ServiceDesignAndCreation
18488 summary: update an existing model-ver
18490 Update an existing model-ver
18492 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18493 The PUT operation will entirely replace an existing object.
18494 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18496 Other differences between PUT and PATCH are:
18498 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18499 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18500 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18501 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
18510 description: Response codes found in [response codes](https://wiki.onap.org/).
18512 - name: model-invariant-id
18514 description: Unique identifier corresponding to the main definition of a model in ASDC
18517 example: __MODEL-INVARIANT-ID__
18518 - name: model-version-id
18520 description: Unique identifier corresponding to one version of a model in ASDC
18523 example: __MODEL-VERSION-ID__
18526 description: model-ver object that needs to be updated.
18529 $ref: "#/patchDefinitions/model-ver"
18532 - ServiceDesignAndCreation
18533 summary: delete an existing model-ver
18534 description: delete an existing model-ver
18535 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
18544 description: Response codes found in [response codes](https://wiki.onap.org/).
18546 - name: model-invariant-id
18548 description: Unique identifier corresponding to the main definition of a model in ASDC
18551 example: __MODEL-INVARIANT-ID__
18552 - name: model-version-id
18554 description: Unique identifier corresponding to one version of a model in ASDC
18557 example: __MODEL-VERSION-ID__
18558 - name: resource-version
18560 description: resource-version for concurrency
18563 /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
18566 - ServiceDesignAndCreation
18567 summary: returns model-vers
18568 description: returns model-vers
18569 operationId: getServiceDesignAndCreationModelsModelModelVers
18575 description: successful operation
18577 $ref: "#/getDefinitions/model-vers"
18579 description: Response codes found in [response codes](https://wiki.onap.org/).
18581 - name: model-invariant-id
18583 description: Unique identifier corresponding to the main definition of a model in ASDC
18586 example: __MODEL-INVARIANT-ID__
18587 - name: model-version-id
18597 - name: model-version
18602 /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
18605 - ServiceDesignAndCreation
18606 summary: see node definition for valid relationships
18607 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
18616 description: Response codes found in [response codes](https://wiki.onap.org/).
18618 - name: model-invariant-id
18620 description: Unique identifier corresponding to the main definition of a model in ASDC
18623 example: __MODEL-INVARIANT-ID__
18626 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)
18629 $ref: "#/definitions/relationship"
18632 - ServiceDesignAndCreation
18633 summary: delete an existing relationship
18634 description: delete an existing relationship
18635 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
18644 description: Response codes found in [response codes](https://wiki.onap.org/).
18646 - name: model-invariant-id
18648 description: Unique identifier corresponding to the main definition of a model in ASDC
18651 example: __MODEL-INVARIANT-ID__
18652 /service-design-and-creation/models/model/{model-invariant-id}:
18655 - ServiceDesignAndCreation
18656 summary: returns model
18657 description: returns model
18658 operationId: getServiceDesignAndCreationModelsModel
18664 description: successful operation
18666 $ref: "#/getDefinitions/model"
18668 description: Response codes found in [response codes](https://wiki.onap.org/).
18670 - name: model-invariant-id
18672 description: Unique identifier corresponding to the main definition of a model in ASDC
18675 example: __MODEL-INVARIANT-ID__
18678 - ServiceDesignAndCreation
18679 summary: create or update an existing model
18681 Create or update an existing model.
18683 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18684 operationId: createOrUpdateServiceDesignAndCreationModelsModel
18693 description: Response codes found in [response codes](https://wiki.onap.org/).
18695 - name: model-invariant-id
18697 description: Unique identifier corresponding to the main definition of a model in ASDC
18700 example: __MODEL-INVARIANT-ID__
18703 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)
18706 $ref: "#/definitions/model"
18709 - ServiceDesignAndCreation
18710 summary: update an existing model
18712 Update an existing model
18714 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18715 The PUT operation will entirely replace an existing object.
18716 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18718 Other differences between PUT and PATCH are:
18720 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18721 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18722 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18723 operationId: UpdateServiceDesignAndCreationModelsModel
18732 description: Response codes found in [response codes](https://wiki.onap.org/).
18734 - name: model-invariant-id
18736 description: Unique identifier corresponding to the main definition of a model in ASDC
18739 example: __MODEL-INVARIANT-ID__
18742 description: model object that needs to be updated.
18745 $ref: "#/patchDefinitions/model"
18748 - ServiceDesignAndCreation
18749 summary: delete an existing model
18750 description: delete an existing model
18751 operationId: deleteServiceDesignAndCreationModelsModel
18760 description: Response codes found in [response codes](https://wiki.onap.org/).
18762 - name: model-invariant-id
18764 description: Unique identifier corresponding to the main definition of a model in ASDC
18767 example: __MODEL-INVARIANT-ID__
18768 - name: resource-version
18770 description: resource-version for concurrency
18773 /service-design-and-creation/models:
18776 - ServiceDesignAndCreation
18777 summary: returns models
18778 description: returns models
18779 operationId: getServiceDesignAndCreationModels
18785 description: successful operation
18787 $ref: "#/getDefinitions/models"
18789 description: Response codes found in [response codes](https://wiki.onap.org/).
18791 - name: model-invariant-id
18801 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship:
18804 - ServiceDesignAndCreation
18805 summary: see node definition for valid relationships
18806 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
18815 description: Response codes found in [response codes](https://wiki.onap.org/).
18817 - name: named-query-uuid
18821 example: __NAMED-QUERY-UUID__
18822 - name: named-query-element-uuid
18826 example: __NAMED-QUERY-ELEMENT-UUID__
18827 - name: related-lookup-uuid
18831 example: __RELATED-LOOKUP-UUID__
18834 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
18837 $ref: "#/definitions/relationship"
18840 - ServiceDesignAndCreation
18841 summary: delete an existing relationship
18842 description: delete an existing relationship
18843 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
18852 description: Response codes found in [response codes](https://wiki.onap.org/).
18854 - name: named-query-uuid
18858 example: __NAMED-QUERY-UUID__
18859 - name: named-query-element-uuid
18863 example: __NAMED-QUERY-ELEMENT-UUID__
18864 - name: related-lookup-uuid
18868 example: __RELATED-LOOKUP-UUID__
18869 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}:
18872 - ServiceDesignAndCreation
18873 summary: returns related-lookup
18874 description: returns related-lookup
18875 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
18881 description: successful operation
18883 $ref: "#/getDefinitions/related-lookup"
18885 description: Response codes found in [response codes](https://wiki.onap.org/).
18887 - name: named-query-uuid
18891 example: __NAMED-QUERY-UUID__
18892 - name: named-query-element-uuid
18896 example: __NAMED-QUERY-ELEMENT-UUID__
18897 - name: related-lookup-uuid
18901 example: __RELATED-LOOKUP-UUID__
18904 - ServiceDesignAndCreation
18905 summary: create or update an existing related-lookup
18907 Create or update an existing related-lookup.
18909 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18910 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
18919 description: Response codes found in [response codes](https://wiki.onap.org/).
18921 - name: named-query-uuid
18925 example: __NAMED-QUERY-UUID__
18926 - name: named-query-element-uuid
18930 example: __NAMED-QUERY-ELEMENT-UUID__
18931 - name: related-lookup-uuid
18935 example: __RELATED-LOOKUP-UUID__
18938 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
18941 $ref: "#/definitions/related-lookup"
18944 - ServiceDesignAndCreation
18945 summary: update an existing related-lookup
18947 Update an existing related-lookup
18949 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18950 The PUT operation will entirely replace an existing object.
18951 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18953 Other differences between PUT and PATCH are:
18955 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18956 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18957 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18958 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
18967 description: Response codes found in [response codes](https://wiki.onap.org/).
18969 - name: named-query-uuid
18973 example: __NAMED-QUERY-UUID__
18974 - name: named-query-element-uuid
18978 example: __NAMED-QUERY-ELEMENT-UUID__
18979 - name: related-lookup-uuid
18983 example: __RELATED-LOOKUP-UUID__
18986 description: related-lookup object that needs to be updated.
18989 $ref: "#/patchDefinitions/related-lookup"
18992 - ServiceDesignAndCreation
18993 summary: delete an existing related-lookup
18994 description: delete an existing related-lookup
18995 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19004 description: Response codes found in [response codes](https://wiki.onap.org/).
19006 - name: named-query-uuid
19010 example: __NAMED-QUERY-UUID__
19011 - name: named-query-element-uuid
19015 example: __NAMED-QUERY-ELEMENT-UUID__
19016 - name: related-lookup-uuid
19020 example: __RELATED-LOOKUP-UUID__
19021 - name: resource-version
19023 description: resource-version for concurrency
19026 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
19029 - ServiceDesignAndCreation
19030 summary: returns related-lookups
19031 description: returns related-lookups
19032 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
19038 description: successful operation
19040 $ref: "#/getDefinitions/related-lookups"
19042 description: Response codes found in [response codes](https://wiki.onap.org/).
19044 - name: named-query-uuid
19048 example: __NAMED-QUERY-UUID__
19049 - name: named-query-element-uuid
19053 example: __NAMED-QUERY-ELEMENT-UUID__
19054 - name: related-lookup-uuid
19059 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}:
19062 - ServiceDesignAndCreation
19063 summary: returns property-constraint
19064 description: returns property-constraint
19065 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19071 description: successful operation
19073 $ref: "#/getDefinitions/property-constraint"
19075 description: Response codes found in [response codes](https://wiki.onap.org/).
19077 - name: named-query-uuid
19081 example: __NAMED-QUERY-UUID__
19082 - name: named-query-element-uuid
19086 example: __NAMED-QUERY-ELEMENT-UUID__
19087 - name: property-constraint-uuid
19091 example: __PROPERTY-CONSTRAINT-UUID__
19094 - ServiceDesignAndCreation
19095 summary: create or update an existing property-constraint
19097 Create or update an existing property-constraint.
19099 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19100 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19109 description: Response codes found in [response codes](https://wiki.onap.org/).
19111 - name: named-query-uuid
19115 example: __NAMED-QUERY-UUID__
19116 - name: named-query-element-uuid
19120 example: __NAMED-QUERY-ELEMENT-UUID__
19121 - name: property-constraint-uuid
19125 example: __PROPERTY-CONSTRAINT-UUID__
19128 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
19131 $ref: "#/definitions/property-constraint"
19134 - ServiceDesignAndCreation
19135 summary: update an existing property-constraint
19137 Update an existing property-constraint
19139 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19140 The PUT operation will entirely replace an existing object.
19141 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19143 Other differences between PUT and PATCH are:
19145 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19146 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19147 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19148 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19157 description: Response codes found in [response codes](https://wiki.onap.org/).
19159 - name: named-query-uuid
19163 example: __NAMED-QUERY-UUID__
19164 - name: named-query-element-uuid
19168 example: __NAMED-QUERY-ELEMENT-UUID__
19169 - name: property-constraint-uuid
19173 example: __PROPERTY-CONSTRAINT-UUID__
19176 description: property-constraint object that needs to be updated.
19179 $ref: "#/patchDefinitions/property-constraint"
19182 - ServiceDesignAndCreation
19183 summary: delete an existing property-constraint
19184 description: delete an existing property-constraint
19185 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19194 description: Response codes found in [response codes](https://wiki.onap.org/).
19196 - name: named-query-uuid
19200 example: __NAMED-QUERY-UUID__
19201 - name: named-query-element-uuid
19205 example: __NAMED-QUERY-ELEMENT-UUID__
19206 - name: property-constraint-uuid
19210 example: __PROPERTY-CONSTRAINT-UUID__
19211 - name: resource-version
19213 description: resource-version for concurrency
19216 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
19219 - ServiceDesignAndCreation
19220 summary: returns property-constraints
19221 description: returns property-constraints
19222 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
19228 description: successful operation
19230 $ref: "#/getDefinitions/property-constraints"
19232 description: Response codes found in [response codes](https://wiki.onap.org/).
19234 - name: named-query-uuid
19238 example: __NAMED-QUERY-UUID__
19239 - name: named-query-element-uuid
19243 example: __NAMED-QUERY-ELEMENT-UUID__
19244 - name: property-constraint-uuid
19249 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
19252 - ServiceDesignAndCreation
19253 summary: see node definition for valid relationships
19254 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19263 description: Response codes found in [response codes](https://wiki.onap.org/).
19265 - name: named-query-uuid
19269 example: __NAMED-QUERY-UUID__
19270 - name: named-query-element-uuid
19274 example: __NAMED-QUERY-ELEMENT-UUID__
19277 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19280 $ref: "#/definitions/relationship"
19283 - ServiceDesignAndCreation
19284 summary: delete an existing relationship
19285 description: delete an existing relationship
19286 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19295 description: Response codes found in [response codes](https://wiki.onap.org/).
19297 - name: named-query-uuid
19301 example: __NAMED-QUERY-UUID__
19302 - name: named-query-element-uuid
19306 example: __NAMED-QUERY-ELEMENT-UUID__
19307 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
19310 - ServiceDesignAndCreation
19311 summary: returns named-query-element
19312 description: returns named-query-element
19313 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19319 description: successful operation
19321 $ref: "#/getDefinitions/named-query-element"
19323 description: Response codes found in [response codes](https://wiki.onap.org/).
19325 - name: named-query-uuid
19329 example: __NAMED-QUERY-UUID__
19330 - name: named-query-element-uuid
19334 example: __NAMED-QUERY-ELEMENT-UUID__
19337 - ServiceDesignAndCreation
19338 summary: create or update an existing named-query-element
19340 Create or update an existing named-query-element.
19342 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19343 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19352 description: Response codes found in [response codes](https://wiki.onap.org/).
19354 - name: named-query-uuid
19358 example: __NAMED-QUERY-UUID__
19359 - name: named-query-element-uuid
19363 example: __NAMED-QUERY-ELEMENT-UUID__
19366 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19369 $ref: "#/definitions/named-query-element"
19372 - ServiceDesignAndCreation
19373 summary: update an existing named-query-element
19375 Update an existing named-query-element
19377 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19378 The PUT operation will entirely replace an existing object.
19379 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19381 Other differences between PUT and PATCH are:
19383 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19384 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19385 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19386 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19395 description: Response codes found in [response codes](https://wiki.onap.org/).
19397 - name: named-query-uuid
19401 example: __NAMED-QUERY-UUID__
19402 - name: named-query-element-uuid
19406 example: __NAMED-QUERY-ELEMENT-UUID__
19409 description: named-query-element object that needs to be updated.
19412 $ref: "#/patchDefinitions/named-query-element"
19415 - ServiceDesignAndCreation
19416 summary: delete an existing named-query-element
19417 description: delete an existing named-query-element
19418 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19427 description: Response codes found in [response codes](https://wiki.onap.org/).
19429 - name: named-query-uuid
19433 example: __NAMED-QUERY-UUID__
19434 - name: named-query-element-uuid
19438 example: __NAMED-QUERY-ELEMENT-UUID__
19439 - name: resource-version
19441 description: resource-version for concurrency
19444 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
19447 - ServiceDesignAndCreation
19448 summary: returns named-query-elements
19449 description: returns named-query-elements
19450 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
19456 description: successful operation
19458 $ref: "#/getDefinitions/named-query-elements"
19460 description: Response codes found in [response codes](https://wiki.onap.org/).
19462 - name: named-query-uuid
19466 example: __NAMED-QUERY-UUID__
19467 - name: named-query-element-uuid
19472 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
19475 - ServiceDesignAndCreation
19476 summary: see node definition for valid relationships
19477 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19486 description: Response codes found in [response codes](https://wiki.onap.org/).
19488 - name: named-query-uuid
19492 example: __NAMED-QUERY-UUID__
19495 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19498 $ref: "#/definitions/relationship"
19501 - ServiceDesignAndCreation
19502 summary: delete an existing relationship
19503 description: delete an existing relationship
19504 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19513 description: Response codes found in [response codes](https://wiki.onap.org/).
19515 - name: named-query-uuid
19519 example: __NAMED-QUERY-UUID__
19520 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
19523 - ServiceDesignAndCreation
19524 summary: returns named-query
19525 description: returns named-query
19526 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
19532 description: successful operation
19534 $ref: "#/getDefinitions/named-query"
19536 description: Response codes found in [response codes](https://wiki.onap.org/).
19538 - name: named-query-uuid
19542 example: __NAMED-QUERY-UUID__
19545 - ServiceDesignAndCreation
19546 summary: create or update an existing named-query
19548 Create or update an existing named-query.
19550 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19551 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
19560 description: Response codes found in [response codes](https://wiki.onap.org/).
19562 - name: named-query-uuid
19566 example: __NAMED-QUERY-UUID__
19569 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19572 $ref: "#/definitions/named-query"
19575 - ServiceDesignAndCreation
19576 summary: update an existing named-query
19578 Update an existing named-query
19580 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19581 The PUT operation will entirely replace an existing object.
19582 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19584 Other differences between PUT and PATCH are:
19586 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19587 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19588 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19589 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
19598 description: Response codes found in [response codes](https://wiki.onap.org/).
19600 - name: named-query-uuid
19604 example: __NAMED-QUERY-UUID__
19607 description: named-query object that needs to be updated.
19610 $ref: "#/patchDefinitions/named-query"
19613 - ServiceDesignAndCreation
19614 summary: delete an existing named-query
19615 description: delete an existing named-query
19616 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
19625 description: Response codes found in [response codes](https://wiki.onap.org/).
19627 - name: named-query-uuid
19631 example: __NAMED-QUERY-UUID__
19632 - name: resource-version
19634 description: resource-version for concurrency
19637 /service-design-and-creation/named-queries:
19640 - ServiceDesignAndCreation
19641 summary: returns named-queries
19642 description: returns named-queries
19643 operationId: getServiceDesignAndCreationNamedQueries
19649 description: successful operation
19651 $ref: "#/getDefinitions/named-queries"
19653 description: Response codes found in [response codes](https://wiki.onap.org/).
19655 - name: named-query-uuid
19660 - name: named-query-name
19665 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
19669 summary: see node definition for valid relationships
19670 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
19679 description: Response codes found in [response codes](https://wiki.onap.org/).
19683 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19686 example: __LINK-NAME__
19689 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)
19692 $ref: "#/definitions/relationship"
19696 summary: delete an existing relationship
19697 description: delete an existing relationship
19698 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
19707 description: Response codes found in [response codes](https://wiki.onap.org/).
19711 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19714 example: __LINK-NAME__
19715 /network/logical-links/logical-link/{link-name}:
19719 summary: returns logical-link
19720 description: returns logical-link
19721 operationId: getNetworkLogicalLinksLogicalLink
19727 description: successful operation
19729 $ref: "#/getDefinitions/logical-link"
19731 description: Response codes found in [response codes](https://wiki.onap.org/).
19735 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19738 example: __LINK-NAME__
19742 summary: create or update an existing logical-link
19744 Create or update an existing logical-link.
19746 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19747 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
19756 description: Response codes found in [response codes](https://wiki.onap.org/).
19760 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19763 example: __LINK-NAME__
19766 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)
19769 $ref: "#/definitions/logical-link"
19773 summary: update an existing logical-link
19775 Update an existing logical-link
19777 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19778 The PUT operation will entirely replace an existing object.
19779 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19781 Other differences between PUT and PATCH are:
19783 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19784 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19785 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19786 operationId: UpdateNetworkLogicalLinksLogicalLink
19795 description: Response codes found in [response codes](https://wiki.onap.org/).
19799 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19802 example: __LINK-NAME__
19805 description: logical-link object that needs to be updated.
19808 $ref: "#/patchDefinitions/logical-link"
19812 summary: delete an existing logical-link
19813 description: delete an existing logical-link
19814 operationId: deleteNetworkLogicalLinksLogicalLink
19823 description: Response codes found in [response codes](https://wiki.onap.org/).
19827 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
19830 example: __LINK-NAME__
19831 - name: resource-version
19833 description: resource-version for concurrency
19836 /network/logical-links:
19840 summary: returns logical-links
19841 description: returns logical-links
19842 operationId: getNetworkLogicalLinks
19848 description: successful operation
19850 $ref: "#/getDefinitions/logical-links"
19852 description: Response codes found in [response codes](https://wiki.onap.org/).
19859 - name: model-invariant-id
19864 - name: model-version-id
19869 - name: widget-model-id
19874 - name: widget-model-version
19879 - name: prov-status
19899 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship:
19903 summary: see node definition for valid relationships
19904 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
19913 description: Response codes found in [response codes](https://wiki.onap.org/).
19915 - name: site-pair-set-id
19917 description: Unique id of site pair set.
19920 example: __SITE-PAIR-SET-ID__
19921 - name: routing-instance-id
19923 description: Unique id of routing instance
19926 example: __ROUTING-INSTANCE-ID__
19927 - name: site-pair-id
19929 description: unique identifier of probe
19932 example: __SITE-PAIR-ID__
19935 description: unique identifier of probe
19941 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
19944 $ref: "#/definitions/relationship"
19948 summary: delete an existing relationship
19949 description: delete an existing relationship
19950 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
19959 description: Response codes found in [response codes](https://wiki.onap.org/).
19961 - name: site-pair-set-id
19963 description: Unique id of site pair set.
19966 example: __SITE-PAIR-SET-ID__
19967 - name: routing-instance-id
19969 description: Unique id of routing instance
19972 example: __ROUTING-INSTANCE-ID__
19973 - name: site-pair-id
19975 description: unique identifier of probe
19978 example: __SITE-PAIR-ID__
19981 description: unique identifier of probe
19985 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}:
19989 summary: returns class-of-service
19990 description: returns class-of-service
19991 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
19997 description: successful operation
19999 $ref: "#/getDefinitions/class-of-service"
20001 description: Response codes found in [response codes](https://wiki.onap.org/).
20003 - name: site-pair-set-id
20005 description: Unique id of site pair set.
20008 example: __SITE-PAIR-SET-ID__
20009 - name: routing-instance-id
20011 description: Unique id of routing instance
20014 example: __ROUTING-INSTANCE-ID__
20015 - name: site-pair-id
20017 description: unique identifier of probe
20020 example: __SITE-PAIR-ID__
20023 description: unique identifier of probe
20030 summary: create or update an existing class-of-service
20032 Create or update an existing class-of-service.
20034 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20035 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20044 description: Response codes found in [response codes](https://wiki.onap.org/).
20046 - name: site-pair-set-id
20048 description: Unique id of site pair set.
20051 example: __SITE-PAIR-SET-ID__
20052 - name: routing-instance-id
20054 description: Unique id of routing instance
20057 example: __ROUTING-INSTANCE-ID__
20058 - name: site-pair-id
20060 description: unique identifier of probe
20063 example: __SITE-PAIR-ID__
20066 description: unique identifier of probe
20072 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20075 $ref: "#/definitions/class-of-service"
20079 summary: update an existing class-of-service
20081 Update an existing class-of-service
20083 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20084 The PUT operation will entirely replace an existing object.
20085 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20087 Other differences between PUT and PATCH are:
20089 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20090 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20091 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20092 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20101 description: Response codes found in [response codes](https://wiki.onap.org/).
20103 - name: site-pair-set-id
20105 description: Unique id of site pair set.
20108 example: __SITE-PAIR-SET-ID__
20109 - name: routing-instance-id
20111 description: Unique id of routing instance
20114 example: __ROUTING-INSTANCE-ID__
20115 - name: site-pair-id
20117 description: unique identifier of probe
20120 example: __SITE-PAIR-ID__
20123 description: unique identifier of probe
20129 description: class-of-service object that needs to be updated.
20132 $ref: "#/patchDefinitions/class-of-service"
20136 summary: delete an existing class-of-service
20137 description: delete an existing class-of-service
20138 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20147 description: Response codes found in [response codes](https://wiki.onap.org/).
20149 - name: site-pair-set-id
20151 description: Unique id of site pair set.
20154 example: __SITE-PAIR-SET-ID__
20155 - name: routing-instance-id
20157 description: Unique id of routing instance
20160 example: __ROUTING-INSTANCE-ID__
20161 - name: site-pair-id
20163 description: unique identifier of probe
20166 example: __SITE-PAIR-ID__
20169 description: unique identifier of probe
20173 - name: resource-version
20175 description: resource-version for concurrency
20178 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service:
20182 summary: returns classes-of-service
20183 description: returns classes-of-service
20184 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
20190 description: successful operation
20192 $ref: "#/getDefinitions/classes-of-service"
20194 description: Response codes found in [response codes](https://wiki.onap.org/).
20196 - name: site-pair-set-id
20198 description: Unique id of site pair set.
20201 example: __SITE-PAIR-SET-ID__
20202 - name: routing-instance-id
20204 description: Unique id of routing instance
20207 example: __ROUTING-INSTANCE-ID__
20208 - name: site-pair-id
20210 description: unique identifier of probe
20213 example: __SITE-PAIR-ID__
20219 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship:
20223 summary: see node definition for valid relationships
20224 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20233 description: Response codes found in [response codes](https://wiki.onap.org/).
20235 - name: site-pair-set-id
20237 description: Unique id of site pair set.
20240 example: __SITE-PAIR-SET-ID__
20241 - name: routing-instance-id
20243 description: Unique id of routing instance
20246 example: __ROUTING-INSTANCE-ID__
20247 - name: site-pair-id
20249 description: unique identifier of probe
20252 example: __SITE-PAIR-ID__
20255 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20258 $ref: "#/definitions/relationship"
20262 summary: delete an existing relationship
20263 description: delete an existing relationship
20264 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20273 description: Response codes found in [response codes](https://wiki.onap.org/).
20275 - name: site-pair-set-id
20277 description: Unique id of site pair set.
20280 example: __SITE-PAIR-SET-ID__
20281 - name: routing-instance-id
20283 description: Unique id of routing instance
20286 example: __ROUTING-INSTANCE-ID__
20287 - name: site-pair-id
20289 description: unique identifier of probe
20292 example: __SITE-PAIR-ID__
20293 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}:
20297 summary: returns site-pair
20298 description: returns site-pair
20299 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20305 description: successful operation
20307 $ref: "#/getDefinitions/site-pair"
20309 description: Response codes found in [response codes](https://wiki.onap.org/).
20311 - name: site-pair-set-id
20313 description: Unique id of site pair set.
20316 example: __SITE-PAIR-SET-ID__
20317 - name: routing-instance-id
20319 description: Unique id of routing instance
20322 example: __ROUTING-INSTANCE-ID__
20323 - name: site-pair-id
20325 description: unique identifier of probe
20328 example: __SITE-PAIR-ID__
20332 summary: create or update an existing site-pair
20334 Create or update an existing site-pair.
20336 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20337 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20346 description: Response codes found in [response codes](https://wiki.onap.org/).
20348 - name: site-pair-set-id
20350 description: Unique id of site pair set.
20353 example: __SITE-PAIR-SET-ID__
20354 - name: routing-instance-id
20356 description: Unique id of routing instance
20359 example: __ROUTING-INSTANCE-ID__
20360 - name: site-pair-id
20362 description: unique identifier of probe
20365 example: __SITE-PAIR-ID__
20368 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20371 $ref: "#/definitions/site-pair"
20375 summary: update an existing site-pair
20377 Update an existing site-pair
20379 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20380 The PUT operation will entirely replace an existing object.
20381 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20383 Other differences between PUT and PATCH are:
20385 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20386 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20387 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20388 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20397 description: Response codes found in [response codes](https://wiki.onap.org/).
20399 - name: site-pair-set-id
20401 description: Unique id of site pair set.
20404 example: __SITE-PAIR-SET-ID__
20405 - name: routing-instance-id
20407 description: Unique id of routing instance
20410 example: __ROUTING-INSTANCE-ID__
20411 - name: site-pair-id
20413 description: unique identifier of probe
20416 example: __SITE-PAIR-ID__
20419 description: site-pair object that needs to be updated.
20422 $ref: "#/patchDefinitions/site-pair"
20426 summary: delete an existing site-pair
20427 description: delete an existing site-pair
20428 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20437 description: Response codes found in [response codes](https://wiki.onap.org/).
20439 - name: site-pair-set-id
20441 description: Unique id of site pair set.
20444 example: __SITE-PAIR-SET-ID__
20445 - name: routing-instance-id
20447 description: Unique id of routing instance
20450 example: __ROUTING-INSTANCE-ID__
20451 - name: site-pair-id
20453 description: unique identifier of probe
20456 example: __SITE-PAIR-ID__
20457 - name: resource-version
20459 description: resource-version for concurrency
20462 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
20466 summary: returns site-pairs
20467 description: returns site-pairs
20468 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
20474 description: successful operation
20476 $ref: "#/getDefinitions/site-pairs"
20478 description: Response codes found in [response codes](https://wiki.onap.org/).
20480 - name: site-pair-set-id
20482 description: Unique id of site pair set.
20485 example: __SITE-PAIR-SET-ID__
20486 - name: routing-instance-id
20488 description: Unique id of routing instance
20491 example: __ROUTING-INSTANCE-ID__
20492 - name: site-pair-id
20497 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
20501 summary: see node definition for valid relationships
20502 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20511 description: Response codes found in [response codes](https://wiki.onap.org/).
20513 - name: site-pair-set-id
20515 description: Unique id of site pair set.
20518 example: __SITE-PAIR-SET-ID__
20519 - name: routing-instance-id
20521 description: Unique id of routing instance
20524 example: __ROUTING-INSTANCE-ID__
20527 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
20530 $ref: "#/definitions/relationship"
20534 summary: delete an existing relationship
20535 description: delete an existing relationship
20536 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20545 description: Response codes found in [response codes](https://wiki.onap.org/).
20547 - name: site-pair-set-id
20549 description: Unique id of site pair set.
20552 example: __SITE-PAIR-SET-ID__
20553 - name: routing-instance-id
20555 description: Unique id of routing instance
20558 example: __ROUTING-INSTANCE-ID__
20559 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
20563 summary: returns routing-instance
20564 description: returns routing-instance
20565 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20571 description: successful operation
20573 $ref: "#/getDefinitions/routing-instance"
20575 description: Response codes found in [response codes](https://wiki.onap.org/).
20577 - name: site-pair-set-id
20579 description: Unique id of site pair set.
20582 example: __SITE-PAIR-SET-ID__
20583 - name: routing-instance-id
20585 description: Unique id of routing instance
20588 example: __ROUTING-INSTANCE-ID__
20592 summary: create or update an existing routing-instance
20594 Create or update an existing routing-instance.
20596 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20597 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20606 description: Response codes found in [response codes](https://wiki.onap.org/).
20608 - name: site-pair-set-id
20610 description: Unique id of site pair set.
20613 example: __SITE-PAIR-SET-ID__
20614 - name: routing-instance-id
20616 description: Unique id of routing instance
20619 example: __ROUTING-INSTANCE-ID__
20622 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
20625 $ref: "#/definitions/routing-instance"
20629 summary: update an existing routing-instance
20631 Update an existing routing-instance
20633 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20634 The PUT operation will entirely replace an existing object.
20635 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20637 Other differences between PUT and PATCH are:
20639 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20640 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20641 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20642 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20651 description: Response codes found in [response codes](https://wiki.onap.org/).
20653 - name: site-pair-set-id
20655 description: Unique id of site pair set.
20658 example: __SITE-PAIR-SET-ID__
20659 - name: routing-instance-id
20661 description: Unique id of routing instance
20664 example: __ROUTING-INSTANCE-ID__
20667 description: routing-instance object that needs to be updated.
20670 $ref: "#/patchDefinitions/routing-instance"
20674 summary: delete an existing routing-instance
20675 description: delete an existing routing-instance
20676 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20685 description: Response codes found in [response codes](https://wiki.onap.org/).
20687 - name: site-pair-set-id
20689 description: Unique id of site pair set.
20692 example: __SITE-PAIR-SET-ID__
20693 - name: routing-instance-id
20695 description: Unique id of routing instance
20698 example: __ROUTING-INSTANCE-ID__
20699 - name: resource-version
20701 description: resource-version for concurrency
20704 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
20708 summary: returns routing-instances
20709 description: returns routing-instances
20710 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
20716 description: successful operation
20718 $ref: "#/getDefinitions/routing-instances"
20720 description: Response codes found in [response codes](https://wiki.onap.org/).
20722 - name: site-pair-set-id
20724 description: Unique id of site pair set.
20727 example: __SITE-PAIR-SET-ID__
20728 - name: routing-instance-id
20733 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
20737 summary: see node definition for valid relationships
20738 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
20747 description: Response codes found in [response codes](https://wiki.onap.org/).
20749 - name: site-pair-set-id
20751 description: Unique id of site pair set.
20754 example: __SITE-PAIR-SET-ID__
20757 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)
20760 $ref: "#/definitions/relationship"
20764 summary: delete an existing relationship
20765 description: delete an existing relationship
20766 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
20775 description: Response codes found in [response codes](https://wiki.onap.org/).
20777 - name: site-pair-set-id
20779 description: Unique id of site pair set.
20782 example: __SITE-PAIR-SET-ID__
20783 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
20787 summary: returns site-pair-set
20788 description: returns site-pair-set
20789 operationId: getNetworkSitePairSetsSitePairSet
20795 description: successful operation
20797 $ref: "#/getDefinitions/site-pair-set"
20799 description: Response codes found in [response codes](https://wiki.onap.org/).
20801 - name: site-pair-set-id
20803 description: Unique id of site pair set.
20806 example: __SITE-PAIR-SET-ID__
20810 summary: create or update an existing site-pair-set
20812 Create or update an existing site-pair-set.
20814 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20815 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
20824 description: Response codes found in [response codes](https://wiki.onap.org/).
20826 - name: site-pair-set-id
20828 description: Unique id of site pair set.
20831 example: __SITE-PAIR-SET-ID__
20834 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)
20837 $ref: "#/definitions/site-pair-set"
20841 summary: update an existing site-pair-set
20843 Update an existing site-pair-set
20845 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20846 The PUT operation will entirely replace an existing object.
20847 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20849 Other differences between PUT and PATCH are:
20851 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20852 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20853 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20854 operationId: UpdateNetworkSitePairSetsSitePairSet
20863 description: Response codes found in [response codes](https://wiki.onap.org/).
20865 - name: site-pair-set-id
20867 description: Unique id of site pair set.
20870 example: __SITE-PAIR-SET-ID__
20873 description: site-pair-set object that needs to be updated.
20876 $ref: "#/patchDefinitions/site-pair-set"
20880 summary: delete an existing site-pair-set
20881 description: delete an existing site-pair-set
20882 operationId: deleteNetworkSitePairSetsSitePairSet
20891 description: Response codes found in [response codes](https://wiki.onap.org/).
20893 - name: site-pair-set-id
20895 description: Unique id of site pair set.
20898 example: __SITE-PAIR-SET-ID__
20899 - name: resource-version
20901 description: resource-version for concurrency
20904 /network/site-pair-sets:
20908 summary: returns site-pair-sets
20909 description: returns site-pair-sets
20910 operationId: getNetworkSitePairSets
20916 description: successful operation
20918 $ref: "#/getDefinitions/site-pair-sets"
20920 description: Response codes found in [response codes](https://wiki.onap.org/).
20922 - name: site-pair-set-id
20927 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
20931 summary: see node definition for valid relationships
20932 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
20941 description: Response codes found in [response codes](https://wiki.onap.org/).
20945 description: VPN ID, globally unique within A&AI
20948 example: __VPN-ID__
20949 - name: global-route-target
20951 description: Number used to identify an RT, globally unique in the network
20954 example: __GLOBAL-ROUTE-TARGET__
20955 - name: route-target-role
20957 description: Role assigned to this route target
20960 example: __ROUTE-TARGET-ROLE__
20963 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
20966 $ref: "#/definitions/relationship"
20970 summary: delete an existing relationship
20971 description: delete an existing relationship
20972 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
20981 description: Response codes found in [response codes](https://wiki.onap.org/).
20985 description: VPN ID, globally unique within A&AI
20988 example: __VPN-ID__
20989 - name: global-route-target
20991 description: Number used to identify an RT, globally unique in the network
20994 example: __GLOBAL-ROUTE-TARGET__
20995 - name: route-target-role
20997 description: Role assigned to this route target
21000 example: __ROUTE-TARGET-ROLE__
21001 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
21005 summary: returns route-target
21006 description: returns route-target
21007 operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21013 description: successful operation
21015 $ref: "#/getDefinitions/route-target"
21017 description: Response codes found in [response codes](https://wiki.onap.org/).
21021 description: VPN ID, globally unique within A&AI
21024 example: __VPN-ID__
21025 - name: global-route-target
21027 description: Number used to identify an RT, globally unique in the network
21030 example: __GLOBAL-ROUTE-TARGET__
21031 - name: route-target-role
21033 description: Role assigned to this route target
21036 example: __ROUTE-TARGET-ROLE__
21040 summary: create or update an existing route-target
21042 Create or update an existing route-target.
21044 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21045 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21054 description: Response codes found in [response codes](https://wiki.onap.org/).
21058 description: VPN ID, globally unique within A&AI
21061 example: __VPN-ID__
21062 - name: global-route-target
21064 description: Number used to identify an RT, globally unique in the network
21067 example: __GLOBAL-ROUTE-TARGET__
21068 - name: route-target-role
21070 description: Role assigned to this route target
21073 example: __ROUTE-TARGET-ROLE__
21076 description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
21079 $ref: "#/definitions/route-target"
21083 summary: update an existing route-target
21085 Update an existing route-target
21087 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21088 The PUT operation will entirely replace an existing object.
21089 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21091 Other differences between PUT and PATCH are:
21093 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21094 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21095 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21096 operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21105 description: Response codes found in [response codes](https://wiki.onap.org/).
21109 description: VPN ID, globally unique within A&AI
21112 example: __VPN-ID__
21113 - name: global-route-target
21115 description: Number used to identify an RT, globally unique in the network
21118 example: __GLOBAL-ROUTE-TARGET__
21119 - name: route-target-role
21121 description: Role assigned to this route target
21124 example: __ROUTE-TARGET-ROLE__
21127 description: route-target object that needs to be updated.
21130 $ref: "#/patchDefinitions/route-target"
21134 summary: delete an existing route-target
21135 description: delete an existing route-target
21136 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21145 description: Response codes found in [response codes](https://wiki.onap.org/).
21149 description: VPN ID, globally unique within A&AI
21152 example: __VPN-ID__
21153 - name: global-route-target
21155 description: Number used to identify an RT, globally unique in the network
21158 example: __GLOBAL-ROUTE-TARGET__
21159 - name: route-target-role
21161 description: Role assigned to this route target
21164 example: __ROUTE-TARGET-ROLE__
21165 - name: resource-version
21167 description: resource-version for concurrency
21170 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
21174 summary: returns route-targets
21175 description: returns route-targets
21176 operationId: getNetworkVpnBindingsVpnBindingRouteTargets
21182 description: successful operation
21184 $ref: "#/getDefinitions/route-targets"
21186 description: Response codes found in [response codes](https://wiki.onap.org/).
21190 description: VPN ID, globally unique within A&AI
21193 example: __VPN-ID__
21194 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
21198 summary: see node definition for valid relationships
21199 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
21208 description: Response codes found in [response codes](https://wiki.onap.org/).
21212 description: VPN ID, globally unique within A&AI
21215 example: __VPN-ID__
21218 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)
21221 $ref: "#/definitions/relationship"
21225 summary: delete an existing relationship
21226 description: delete an existing relationship
21227 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
21236 description: Response codes found in [response codes](https://wiki.onap.org/).
21240 description: VPN ID, globally unique within A&AI
21243 example: __VPN-ID__
21244 /network/vpn-bindings/vpn-binding/{vpn-id}:
21248 summary: returns vpn-binding
21249 description: returns vpn-binding
21250 operationId: getNetworkVpnBindingsVpnBinding
21256 description: successful operation
21258 $ref: "#/getDefinitions/vpn-binding"
21260 description: Response codes found in [response codes](https://wiki.onap.org/).
21264 description: VPN ID, globally unique within A&AI
21267 example: __VPN-ID__
21271 summary: create or update an existing vpn-binding
21273 Create or update an existing vpn-binding.
21275 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21276 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
21285 description: Response codes found in [response codes](https://wiki.onap.org/).
21289 description: VPN ID, globally unique within A&AI
21292 example: __VPN-ID__
21295 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)
21298 $ref: "#/definitions/vpn-binding"
21302 summary: update an existing vpn-binding
21304 Update an existing vpn-binding
21306 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21307 The PUT operation will entirely replace an existing object.
21308 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21310 Other differences between PUT and PATCH are:
21312 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21313 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21314 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21315 operationId: UpdateNetworkVpnBindingsVpnBinding
21324 description: Response codes found in [response codes](https://wiki.onap.org/).
21328 description: VPN ID, globally unique within A&AI
21331 example: __VPN-ID__
21334 description: vpn-binding object that needs to be updated.
21337 $ref: "#/patchDefinitions/vpn-binding"
21341 summary: delete an existing vpn-binding
21342 description: delete an existing vpn-binding
21343 operationId: deleteNetworkVpnBindingsVpnBinding
21352 description: Response codes found in [response codes](https://wiki.onap.org/).
21356 description: VPN ID, globally unique within A&AI
21359 example: __VPN-ID__
21360 - name: resource-version
21362 description: resource-version for concurrency
21365 /network/vpn-bindings:
21369 summary: returns vpn-bindings
21370 description: returns vpn-bindings
21371 operationId: getNetworkVpnBindings
21377 description: successful operation
21379 $ref: "#/getDefinitions/vpn-bindings"
21381 description: Response codes found in [response codes](https://wiki.onap.org/).
21398 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
21402 summary: see node definition for valid relationships
21403 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
21412 description: Response codes found in [response codes](https://wiki.onap.org/).
21414 - name: equipment-name
21418 example: __EQUIPMENT-NAME__
21421 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)
21424 $ref: "#/definitions/relationship"
21428 summary: delete an existing relationship
21429 description: delete an existing relationship
21430 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
21439 description: Response codes found in [response codes](https://wiki.onap.org/).
21441 - name: equipment-name
21445 example: __EQUIPMENT-NAME__
21446 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
21450 summary: see node definition for valid relationships
21451 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21460 description: Response codes found in [response codes](https://wiki.onap.org/).
21462 - name: equipment-name
21466 example: __EQUIPMENT-NAME__
21467 - name: interface-name
21469 description: Name that identifies the physical interface
21472 example: __INTERFACE-NAME__
21475 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)
21478 $ref: "#/definitions/relationship"
21482 summary: delete an existing relationship
21483 description: delete an existing relationship
21484 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21493 description: Response codes found in [response codes](https://wiki.onap.org/).
21495 - name: equipment-name
21499 example: __EQUIPMENT-NAME__
21500 - name: interface-name
21502 description: Name that identifies the physical interface
21505 example: __INTERFACE-NAME__
21506 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
21510 summary: see node definition for valid relationships
21511 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
21520 description: Response codes found in [response codes](https://wiki.onap.org/).
21522 - name: equipment-name
21526 example: __EQUIPMENT-NAME__
21527 - name: interface-name
21529 description: Name that identifies the physical interface
21532 example: __INTERFACE-NAME__
21535 description: Identifier for the sriov-pf
21538 example: __PF-PCI-ID__
21541 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
21544 $ref: "#/definitions/relationship"
21548 summary: delete an existing relationship
21549 description: delete an existing relationship
21550 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
21559 description: Response codes found in [response codes](https://wiki.onap.org/).
21561 - name: equipment-name
21565 example: __EQUIPMENT-NAME__
21566 - name: interface-name
21568 description: Name that identifies the physical interface
21571 example: __INTERFACE-NAME__
21574 description: Identifier for the sriov-pf
21577 example: __PF-PCI-ID__
21578 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
21582 summary: returns sriov-pf
21583 description: returns sriov-pf
21584 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
21590 description: successful operation
21592 $ref: "#/getDefinitions/sriov-pf"
21594 description: Response codes found in [response codes](https://wiki.onap.org/).
21596 - name: equipment-name
21600 example: __EQUIPMENT-NAME__
21601 - name: interface-name
21603 description: Name that identifies the physical interface
21606 example: __INTERFACE-NAME__
21609 description: Identifier for the sriov-pf
21612 example: __PF-PCI-ID__
21616 summary: create or update an existing sriov-pf
21618 Create or update an existing sriov-pf.
21620 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21621 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
21630 description: Response codes found in [response codes](https://wiki.onap.org/).
21632 - name: equipment-name
21636 example: __EQUIPMENT-NAME__
21637 - name: interface-name
21639 description: Name that identifies the physical interface
21642 example: __INTERFACE-NAME__
21645 description: Identifier for the sriov-pf
21648 example: __PF-PCI-ID__
21651 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
21654 $ref: "#/definitions/sriov-pf"
21658 summary: update an existing sriov-pf
21660 Update an existing sriov-pf
21662 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21663 The PUT operation will entirely replace an existing object.
21664 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21666 Other differences between PUT and PATCH are:
21668 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21669 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21670 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21671 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
21680 description: Response codes found in [response codes](https://wiki.onap.org/).
21682 - name: equipment-name
21686 example: __EQUIPMENT-NAME__
21687 - name: interface-name
21689 description: Name that identifies the physical interface
21692 example: __INTERFACE-NAME__
21695 description: Identifier for the sriov-pf
21698 example: __PF-PCI-ID__
21701 description: sriov-pf object that needs to be updated.
21704 $ref: "#/patchDefinitions/sriov-pf"
21708 summary: delete an existing sriov-pf
21709 description: delete an existing sriov-pf
21710 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
21719 description: Response codes found in [response codes](https://wiki.onap.org/).
21721 - name: equipment-name
21725 example: __EQUIPMENT-NAME__
21726 - name: interface-name
21728 description: Name that identifies the physical interface
21731 example: __INTERFACE-NAME__
21734 description: Identifier for the sriov-pf
21737 example: __PF-PCI-ID__
21738 - name: resource-version
21740 description: resource-version for concurrency
21743 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
21747 summary: returns sriov-pfs
21748 description: returns sriov-pfs
21749 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
21755 description: successful operation
21757 $ref: "#/getDefinitions/sriov-pfs"
21759 description: Response codes found in [response codes](https://wiki.onap.org/).
21761 - name: equipment-name
21765 example: __EQUIPMENT-NAME__
21766 - name: interface-name
21768 description: Name that identifies the physical interface
21771 example: __INTERFACE-NAME__
21777 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
21781 summary: see node definition for valid relationships
21782 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21791 description: Response codes found in [response codes](https://wiki.onap.org/).
21793 - name: equipment-name
21797 example: __EQUIPMENT-NAME__
21798 - name: interface-name
21800 description: Name that identifies the physical interface
21803 example: __INTERFACE-NAME__
21804 - name: interface-name
21806 description: Name given to the interface
21809 example: __INTERFACE-NAME__
21810 - name: vlan-interface
21812 description: String that identifies the interface
21815 example: __VLAN-INTERFACE__
21818 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
21821 $ref: "#/definitions/relationship"
21825 summary: delete an existing relationship
21826 description: delete an existing relationship
21827 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21836 description: Response codes found in [response codes](https://wiki.onap.org/).
21838 - name: equipment-name
21842 example: __EQUIPMENT-NAME__
21843 - name: interface-name
21845 description: Name that identifies the physical interface
21848 example: __INTERFACE-NAME__
21849 - name: interface-name
21851 description: Name given to the interface
21854 example: __INTERFACE-NAME__
21855 - name: vlan-interface
21857 description: String that identifies the interface
21860 example: __VLAN-INTERFACE__
21861 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
21865 summary: see node definition for valid relationships
21866 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21875 description: Response codes found in [response codes](https://wiki.onap.org/).
21877 - name: equipment-name
21881 example: __EQUIPMENT-NAME__
21882 - name: interface-name
21884 description: Name that identifies the physical interface
21887 example: __INTERFACE-NAME__
21888 - name: interface-name
21890 description: Name given to the interface
21893 example: __INTERFACE-NAME__
21894 - name: vlan-interface
21896 description: String that identifies the interface
21899 example: __VLAN-INTERFACE__
21900 - name: l3-interface-ipv4-address
21902 description: IP address
21905 example: __L3-INTERFACE-IPV4-ADDRESS__
21908 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
21911 $ref: "#/definitions/relationship"
21915 summary: delete an existing relationship
21916 description: delete an existing relationship
21917 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21926 description: Response codes found in [response codes](https://wiki.onap.org/).
21928 - name: equipment-name
21932 example: __EQUIPMENT-NAME__
21933 - name: interface-name
21935 description: Name that identifies the physical interface
21938 example: __INTERFACE-NAME__
21939 - name: interface-name
21941 description: Name given to the interface
21944 example: __INTERFACE-NAME__
21945 - name: vlan-interface
21947 description: String that identifies the interface
21950 example: __VLAN-INTERFACE__
21951 - name: l3-interface-ipv4-address
21953 description: IP address
21956 example: __L3-INTERFACE-IPV4-ADDRESS__
21957 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
21961 summary: returns l3-interface-ipv4-address-list
21962 description: returns l3-interface-ipv4-address-list
21963 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21969 description: successful operation
21971 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21973 description: Response codes found in [response codes](https://wiki.onap.org/).
21975 - name: equipment-name
21979 example: __EQUIPMENT-NAME__
21980 - name: interface-name
21982 description: Name that identifies the physical interface
21985 example: __INTERFACE-NAME__
21986 - name: interface-name
21988 description: Name given to the interface
21991 example: __INTERFACE-NAME__
21992 - name: vlan-interface
21994 description: String that identifies the interface
21997 example: __VLAN-INTERFACE__
21998 - name: l3-interface-ipv4-address
22000 description: IP address
22003 example: __L3-INTERFACE-IPV4-ADDRESS__
22007 summary: create or update an existing l3-interface-ipv4-address-list
22009 Create or update an existing l3-interface-ipv4-address-list.
22011 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22012 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22021 description: Response codes found in [response codes](https://wiki.onap.org/).
22023 - name: equipment-name
22027 example: __EQUIPMENT-NAME__
22028 - name: interface-name
22030 description: Name that identifies the physical interface
22033 example: __INTERFACE-NAME__
22034 - name: interface-name
22036 description: Name given to the interface
22039 example: __INTERFACE-NAME__
22040 - name: vlan-interface
22042 description: String that identifies the interface
22045 example: __VLAN-INTERFACE__
22046 - name: l3-interface-ipv4-address
22048 description: IP address
22051 example: __L3-INTERFACE-IPV4-ADDRESS__
22054 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22057 $ref: "#/definitions/l3-interface-ipv4-address-list"
22061 summary: update an existing l3-interface-ipv4-address-list
22063 Update an existing l3-interface-ipv4-address-list
22065 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22066 The PUT operation will entirely replace an existing object.
22067 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22069 Other differences between PUT and PATCH are:
22071 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22072 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22073 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22074 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22083 description: Response codes found in [response codes](https://wiki.onap.org/).
22085 - name: equipment-name
22089 example: __EQUIPMENT-NAME__
22090 - name: interface-name
22092 description: Name that identifies the physical interface
22095 example: __INTERFACE-NAME__
22096 - name: interface-name
22098 description: Name given to the interface
22101 example: __INTERFACE-NAME__
22102 - name: vlan-interface
22104 description: String that identifies the interface
22107 example: __VLAN-INTERFACE__
22108 - name: l3-interface-ipv4-address
22110 description: IP address
22113 example: __L3-INTERFACE-IPV4-ADDRESS__
22116 description: l3-interface-ipv4-address-list object that needs to be updated.
22119 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22123 summary: delete an existing l3-interface-ipv4-address-list
22124 description: delete an existing l3-interface-ipv4-address-list
22125 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22134 description: Response codes found in [response codes](https://wiki.onap.org/).
22136 - name: equipment-name
22140 example: __EQUIPMENT-NAME__
22141 - name: interface-name
22143 description: Name that identifies the physical interface
22146 example: __INTERFACE-NAME__
22147 - name: interface-name
22149 description: Name given to the interface
22152 example: __INTERFACE-NAME__
22153 - name: vlan-interface
22155 description: String that identifies the interface
22158 example: __VLAN-INTERFACE__
22159 - name: l3-interface-ipv4-address
22161 description: IP address
22164 example: __L3-INTERFACE-IPV4-ADDRESS__
22165 - name: resource-version
22167 description: resource-version for concurrency
22170 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
22174 summary: see node definition for valid relationships
22175 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22184 description: Response codes found in [response codes](https://wiki.onap.org/).
22186 - name: equipment-name
22190 example: __EQUIPMENT-NAME__
22191 - name: interface-name
22193 description: Name that identifies the physical interface
22196 example: __INTERFACE-NAME__
22197 - name: interface-name
22199 description: Name given to the interface
22202 example: __INTERFACE-NAME__
22203 - name: vlan-interface
22205 description: String that identifies the interface
22208 example: __VLAN-INTERFACE__
22209 - name: l3-interface-ipv6-address
22211 description: IP address
22214 example: __L3-INTERFACE-IPV6-ADDRESS__
22217 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22220 $ref: "#/definitions/relationship"
22224 summary: delete an existing relationship
22225 description: delete an existing relationship
22226 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22235 description: Response codes found in [response codes](https://wiki.onap.org/).
22237 - name: equipment-name
22241 example: __EQUIPMENT-NAME__
22242 - name: interface-name
22244 description: Name that identifies the physical interface
22247 example: __INTERFACE-NAME__
22248 - name: interface-name
22250 description: Name given to the interface
22253 example: __INTERFACE-NAME__
22254 - name: vlan-interface
22256 description: String that identifies the interface
22259 example: __VLAN-INTERFACE__
22260 - name: l3-interface-ipv6-address
22262 description: IP address
22265 example: __L3-INTERFACE-IPV6-ADDRESS__
22266 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
22270 summary: returns l3-interface-ipv6-address-list
22271 description: returns l3-interface-ipv6-address-list
22272 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22278 description: successful operation
22280 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22282 description: Response codes found in [response codes](https://wiki.onap.org/).
22284 - name: equipment-name
22288 example: __EQUIPMENT-NAME__
22289 - name: interface-name
22291 description: Name that identifies the physical interface
22294 example: __INTERFACE-NAME__
22295 - name: interface-name
22297 description: Name given to the interface
22300 example: __INTERFACE-NAME__
22301 - name: vlan-interface
22303 description: String that identifies the interface
22306 example: __VLAN-INTERFACE__
22307 - name: l3-interface-ipv6-address
22309 description: IP address
22312 example: __L3-INTERFACE-IPV6-ADDRESS__
22316 summary: create or update an existing l3-interface-ipv6-address-list
22318 Create or update an existing l3-interface-ipv6-address-list.
22320 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22321 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22330 description: Response codes found in [response codes](https://wiki.onap.org/).
22332 - name: equipment-name
22336 example: __EQUIPMENT-NAME__
22337 - name: interface-name
22339 description: Name that identifies the physical interface
22342 example: __INTERFACE-NAME__
22343 - name: interface-name
22345 description: Name given to the interface
22348 example: __INTERFACE-NAME__
22349 - name: vlan-interface
22351 description: String that identifies the interface
22354 example: __VLAN-INTERFACE__
22355 - name: l3-interface-ipv6-address
22357 description: IP address
22360 example: __L3-INTERFACE-IPV6-ADDRESS__
22363 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22366 $ref: "#/definitions/l3-interface-ipv6-address-list"
22370 summary: update an existing l3-interface-ipv6-address-list
22372 Update an existing l3-interface-ipv6-address-list
22374 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22375 The PUT operation will entirely replace an existing object.
22376 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22378 Other differences between PUT and PATCH are:
22380 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22381 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22382 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22383 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22392 description: Response codes found in [response codes](https://wiki.onap.org/).
22394 - name: equipment-name
22398 example: __EQUIPMENT-NAME__
22399 - name: interface-name
22401 description: Name that identifies the physical interface
22404 example: __INTERFACE-NAME__
22405 - name: interface-name
22407 description: Name given to the interface
22410 example: __INTERFACE-NAME__
22411 - name: vlan-interface
22413 description: String that identifies the interface
22416 example: __VLAN-INTERFACE__
22417 - name: l3-interface-ipv6-address
22419 description: IP address
22422 example: __L3-INTERFACE-IPV6-ADDRESS__
22425 description: l3-interface-ipv6-address-list object that needs to be updated.
22428 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22432 summary: delete an existing l3-interface-ipv6-address-list
22433 description: delete an existing l3-interface-ipv6-address-list
22434 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22443 description: Response codes found in [response codes](https://wiki.onap.org/).
22445 - name: equipment-name
22449 example: __EQUIPMENT-NAME__
22450 - name: interface-name
22452 description: Name that identifies the physical interface
22455 example: __INTERFACE-NAME__
22456 - name: interface-name
22458 description: Name given to the interface
22461 example: __INTERFACE-NAME__
22462 - name: vlan-interface
22464 description: String that identifies the interface
22467 example: __VLAN-INTERFACE__
22468 - name: l3-interface-ipv6-address
22470 description: IP address
22473 example: __L3-INTERFACE-IPV6-ADDRESS__
22474 - name: resource-version
22476 description: resource-version for concurrency
22479 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22483 summary: returns vlan
22484 description: returns vlan
22485 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22491 description: successful operation
22493 $ref: "#/getDefinitions/vlan"
22495 description: Response codes found in [response codes](https://wiki.onap.org/).
22497 - name: equipment-name
22501 example: __EQUIPMENT-NAME__
22502 - name: interface-name
22504 description: Name that identifies the physical interface
22507 example: __INTERFACE-NAME__
22508 - name: interface-name
22510 description: Name given to the interface
22513 example: __INTERFACE-NAME__
22514 - name: vlan-interface
22516 description: String that identifies the interface
22519 example: __VLAN-INTERFACE__
22523 summary: create or update an existing vlan
22525 Create or update an existing vlan.
22527 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22528 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22537 description: Response codes found in [response codes](https://wiki.onap.org/).
22539 - name: equipment-name
22543 example: __EQUIPMENT-NAME__
22544 - name: interface-name
22546 description: Name that identifies the physical interface
22549 example: __INTERFACE-NAME__
22550 - name: interface-name
22552 description: Name given to the interface
22555 example: __INTERFACE-NAME__
22556 - name: vlan-interface
22558 description: String that identifies the interface
22561 example: __VLAN-INTERFACE__
22564 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
22567 $ref: "#/definitions/vlan"
22571 summary: update an existing vlan
22573 Update an existing vlan
22575 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22576 The PUT operation will entirely replace an existing object.
22577 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22579 Other differences between PUT and PATCH are:
22581 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22582 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22583 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22584 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22593 description: Response codes found in [response codes](https://wiki.onap.org/).
22595 - name: equipment-name
22599 example: __EQUIPMENT-NAME__
22600 - name: interface-name
22602 description: Name that identifies the physical interface
22605 example: __INTERFACE-NAME__
22606 - name: interface-name
22608 description: Name given to the interface
22611 example: __INTERFACE-NAME__
22612 - name: vlan-interface
22614 description: String that identifies the interface
22617 example: __VLAN-INTERFACE__
22620 description: vlan object that needs to be updated.
22623 $ref: "#/patchDefinitions/vlan"
22627 summary: delete an existing vlan
22628 description: delete an existing vlan
22629 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22638 description: Response codes found in [response codes](https://wiki.onap.org/).
22640 - name: equipment-name
22644 example: __EQUIPMENT-NAME__
22645 - name: interface-name
22647 description: Name that identifies the physical interface
22650 example: __INTERFACE-NAME__
22651 - name: interface-name
22653 description: Name given to the interface
22656 example: __INTERFACE-NAME__
22657 - name: vlan-interface
22659 description: String that identifies the interface
22662 example: __VLAN-INTERFACE__
22663 - name: resource-version
22665 description: resource-version for concurrency
22668 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22672 summary: returns vlans
22673 description: returns vlans
22674 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
22680 description: successful operation
22682 $ref: "#/getDefinitions/vlans"
22684 description: Response codes found in [response codes](https://wiki.onap.org/).
22686 - name: equipment-name
22690 example: __EQUIPMENT-NAME__
22691 - name: interface-name
22693 description: Name that identifies the physical interface
22696 example: __INTERFACE-NAME__
22697 - name: interface-name
22699 description: Name given to the interface
22702 example: __INTERFACE-NAME__
22703 - name: vlan-interface
22708 - name: vlan-id-inner
22719 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
22723 summary: see node definition for valid relationships
22724 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22733 description: Response codes found in [response codes](https://wiki.onap.org/).
22735 - name: equipment-name
22739 example: __EQUIPMENT-NAME__
22740 - name: interface-name
22742 description: Name that identifies the physical interface
22745 example: __INTERFACE-NAME__
22746 - name: interface-name
22748 description: Name given to the interface
22751 example: __INTERFACE-NAME__
22754 description: PCI ID used to identify the sriov-vf
22757 example: __PCI-ID__
22760 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22763 $ref: "#/definitions/relationship"
22767 summary: delete an existing relationship
22768 description: delete an existing relationship
22769 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22778 description: Response codes found in [response codes](https://wiki.onap.org/).
22780 - name: equipment-name
22784 example: __EQUIPMENT-NAME__
22785 - name: interface-name
22787 description: Name that identifies the physical interface
22790 example: __INTERFACE-NAME__
22791 - name: interface-name
22793 description: Name given to the interface
22796 example: __INTERFACE-NAME__
22799 description: PCI ID used to identify the sriov-vf
22802 example: __PCI-ID__
22803 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
22807 summary: returns sriov-vf
22808 description: returns sriov-vf
22809 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22815 description: successful operation
22817 $ref: "#/getDefinitions/sriov-vf"
22819 description: Response codes found in [response codes](https://wiki.onap.org/).
22821 - name: equipment-name
22825 example: __EQUIPMENT-NAME__
22826 - name: interface-name
22828 description: Name that identifies the physical interface
22831 example: __INTERFACE-NAME__
22832 - name: interface-name
22834 description: Name given to the interface
22837 example: __INTERFACE-NAME__
22840 description: PCI ID used to identify the sriov-vf
22843 example: __PCI-ID__
22847 summary: create or update an existing sriov-vf
22849 Create or update an existing sriov-vf.
22851 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22852 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22861 description: Response codes found in [response codes](https://wiki.onap.org/).
22863 - name: equipment-name
22867 example: __EQUIPMENT-NAME__
22868 - name: interface-name
22870 description: Name that identifies the physical interface
22873 example: __INTERFACE-NAME__
22874 - name: interface-name
22876 description: Name given to the interface
22879 example: __INTERFACE-NAME__
22882 description: PCI ID used to identify the sriov-vf
22885 example: __PCI-ID__
22888 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22891 $ref: "#/definitions/sriov-vf"
22895 summary: update an existing sriov-vf
22897 Update an existing sriov-vf
22899 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22900 The PUT operation will entirely replace an existing object.
22901 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22903 Other differences between PUT and PATCH are:
22905 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22906 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22907 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22908 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22917 description: Response codes found in [response codes](https://wiki.onap.org/).
22919 - name: equipment-name
22923 example: __EQUIPMENT-NAME__
22924 - name: interface-name
22926 description: Name that identifies the physical interface
22929 example: __INTERFACE-NAME__
22930 - name: interface-name
22932 description: Name given to the interface
22935 example: __INTERFACE-NAME__
22938 description: PCI ID used to identify the sriov-vf
22941 example: __PCI-ID__
22944 description: sriov-vf object that needs to be updated.
22947 $ref: "#/patchDefinitions/sriov-vf"
22951 summary: delete an existing sriov-vf
22952 description: delete an existing sriov-vf
22953 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22962 description: Response codes found in [response codes](https://wiki.onap.org/).
22964 - name: equipment-name
22968 example: __EQUIPMENT-NAME__
22969 - name: interface-name
22971 description: Name that identifies the physical interface
22974 example: __INTERFACE-NAME__
22975 - name: interface-name
22977 description: Name given to the interface
22980 example: __INTERFACE-NAME__
22983 description: PCI ID used to identify the sriov-vf
22986 example: __PCI-ID__
22987 - name: resource-version
22989 description: resource-version for concurrency
22992 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
22996 summary: returns sriov-vfs
22997 description: returns sriov-vfs
22998 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
23004 description: successful operation
23006 $ref: "#/getDefinitions/sriov-vfs"
23008 description: Response codes found in [response codes](https://wiki.onap.org/).
23010 - name: equipment-name
23014 example: __EQUIPMENT-NAME__
23015 - name: interface-name
23017 description: Name that identifies the physical interface
23020 example: __INTERFACE-NAME__
23021 - name: interface-name
23023 description: Name given to the interface
23026 example: __INTERFACE-NAME__
23032 - name: vf-vlan-filter
23037 - name: vf-mac-filter
23042 - name: vf-vlan-strip
23047 - name: neutron-network-id
23052 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23056 summary: see node definition for valid relationships
23057 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23066 description: Response codes found in [response codes](https://wiki.onap.org/).
23068 - name: equipment-name
23072 example: __EQUIPMENT-NAME__
23073 - name: interface-name
23075 description: Name that identifies the physical interface
23078 example: __INTERFACE-NAME__
23079 - name: interface-name
23081 description: Name given to the interface
23084 example: __INTERFACE-NAME__
23087 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23090 $ref: "#/definitions/relationship"
23094 summary: delete an existing relationship
23095 description: delete an existing relationship
23096 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23105 description: Response codes found in [response codes](https://wiki.onap.org/).
23107 - name: equipment-name
23111 example: __EQUIPMENT-NAME__
23112 - name: interface-name
23114 description: Name that identifies the physical interface
23117 example: __INTERFACE-NAME__
23118 - name: interface-name
23120 description: Name given to the interface
23123 example: __INTERFACE-NAME__
23124 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
23128 summary: see node definition for valid relationships
23129 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23138 description: Response codes found in [response codes](https://wiki.onap.org/).
23140 - name: equipment-name
23144 example: __EQUIPMENT-NAME__
23145 - name: interface-name
23147 description: Name that identifies the physical interface
23150 example: __INTERFACE-NAME__
23151 - name: interface-name
23153 description: Name given to the interface
23156 example: __INTERFACE-NAME__
23157 - name: l3-interface-ipv4-address
23159 description: IP address
23162 example: __L3-INTERFACE-IPV4-ADDRESS__
23165 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23168 $ref: "#/definitions/relationship"
23172 summary: delete an existing relationship
23173 description: delete an existing relationship
23174 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23183 description: Response codes found in [response codes](https://wiki.onap.org/).
23185 - name: equipment-name
23189 example: __EQUIPMENT-NAME__
23190 - name: interface-name
23192 description: Name that identifies the physical interface
23195 example: __INTERFACE-NAME__
23196 - name: interface-name
23198 description: Name given to the interface
23201 example: __INTERFACE-NAME__
23202 - name: l3-interface-ipv4-address
23204 description: IP address
23207 example: __L3-INTERFACE-IPV4-ADDRESS__
23208 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
23212 summary: returns l3-interface-ipv4-address-list
23213 description: returns l3-interface-ipv4-address-list
23214 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23220 description: successful operation
23222 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23224 description: Response codes found in [response codes](https://wiki.onap.org/).
23226 - name: equipment-name
23230 example: __EQUIPMENT-NAME__
23231 - name: interface-name
23233 description: Name that identifies the physical interface
23236 example: __INTERFACE-NAME__
23237 - name: interface-name
23239 description: Name given to the interface
23242 example: __INTERFACE-NAME__
23243 - name: l3-interface-ipv4-address
23245 description: IP address
23248 example: __L3-INTERFACE-IPV4-ADDRESS__
23252 summary: create or update an existing l3-interface-ipv4-address-list
23254 Create or update an existing l3-interface-ipv4-address-list.
23256 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23257 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23266 description: Response codes found in [response codes](https://wiki.onap.org/).
23268 - name: equipment-name
23272 example: __EQUIPMENT-NAME__
23273 - name: interface-name
23275 description: Name that identifies the physical interface
23278 example: __INTERFACE-NAME__
23279 - name: interface-name
23281 description: Name given to the interface
23284 example: __INTERFACE-NAME__
23285 - name: l3-interface-ipv4-address
23287 description: IP address
23290 example: __L3-INTERFACE-IPV4-ADDRESS__
23293 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23296 $ref: "#/definitions/l3-interface-ipv4-address-list"
23300 summary: update an existing l3-interface-ipv4-address-list
23302 Update an existing l3-interface-ipv4-address-list
23304 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23305 The PUT operation will entirely replace an existing object.
23306 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23308 Other differences between PUT and PATCH are:
23310 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23311 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23312 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23313 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23322 description: Response codes found in [response codes](https://wiki.onap.org/).
23324 - name: equipment-name
23328 example: __EQUIPMENT-NAME__
23329 - name: interface-name
23331 description: Name that identifies the physical interface
23334 example: __INTERFACE-NAME__
23335 - name: interface-name
23337 description: Name given to the interface
23340 example: __INTERFACE-NAME__
23341 - name: l3-interface-ipv4-address
23343 description: IP address
23346 example: __L3-INTERFACE-IPV4-ADDRESS__
23349 description: l3-interface-ipv4-address-list object that needs to be updated.
23352 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23356 summary: delete an existing l3-interface-ipv4-address-list
23357 description: delete an existing l3-interface-ipv4-address-list
23358 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23367 description: Response codes found in [response codes](https://wiki.onap.org/).
23369 - name: equipment-name
23373 example: __EQUIPMENT-NAME__
23374 - name: interface-name
23376 description: Name that identifies the physical interface
23379 example: __INTERFACE-NAME__
23380 - name: interface-name
23382 description: Name given to the interface
23385 example: __INTERFACE-NAME__
23386 - name: l3-interface-ipv4-address
23388 description: IP address
23391 example: __L3-INTERFACE-IPV4-ADDRESS__
23392 - name: resource-version
23394 description: resource-version for concurrency
23397 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
23401 summary: see node definition for valid relationships
23402 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23411 description: Response codes found in [response codes](https://wiki.onap.org/).
23413 - name: equipment-name
23417 example: __EQUIPMENT-NAME__
23418 - name: interface-name
23420 description: Name that identifies the physical interface
23423 example: __INTERFACE-NAME__
23424 - name: interface-name
23426 description: Name given to the interface
23429 example: __INTERFACE-NAME__
23430 - name: l3-interface-ipv6-address
23432 description: IP address
23435 example: __L3-INTERFACE-IPV6-ADDRESS__
23438 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23441 $ref: "#/definitions/relationship"
23445 summary: delete an existing relationship
23446 description: delete an existing relationship
23447 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23456 description: Response codes found in [response codes](https://wiki.onap.org/).
23458 - name: equipment-name
23462 example: __EQUIPMENT-NAME__
23463 - name: interface-name
23465 description: Name that identifies the physical interface
23468 example: __INTERFACE-NAME__
23469 - name: interface-name
23471 description: Name given to the interface
23474 example: __INTERFACE-NAME__
23475 - name: l3-interface-ipv6-address
23477 description: IP address
23480 example: __L3-INTERFACE-IPV6-ADDRESS__
23481 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
23485 summary: returns l3-interface-ipv6-address-list
23486 description: returns l3-interface-ipv6-address-list
23487 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23493 description: successful operation
23495 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23497 description: Response codes found in [response codes](https://wiki.onap.org/).
23499 - name: equipment-name
23503 example: __EQUIPMENT-NAME__
23504 - name: interface-name
23506 description: Name that identifies the physical interface
23509 example: __INTERFACE-NAME__
23510 - name: interface-name
23512 description: Name given to the interface
23515 example: __INTERFACE-NAME__
23516 - name: l3-interface-ipv6-address
23518 description: IP address
23521 example: __L3-INTERFACE-IPV6-ADDRESS__
23525 summary: create or update an existing l3-interface-ipv6-address-list
23527 Create or update an existing l3-interface-ipv6-address-list.
23529 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23530 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23539 description: Response codes found in [response codes](https://wiki.onap.org/).
23541 - name: equipment-name
23545 example: __EQUIPMENT-NAME__
23546 - name: interface-name
23548 description: Name that identifies the physical interface
23551 example: __INTERFACE-NAME__
23552 - name: interface-name
23554 description: Name given to the interface
23557 example: __INTERFACE-NAME__
23558 - name: l3-interface-ipv6-address
23560 description: IP address
23563 example: __L3-INTERFACE-IPV6-ADDRESS__
23566 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23569 $ref: "#/definitions/l3-interface-ipv6-address-list"
23573 summary: update an existing l3-interface-ipv6-address-list
23575 Update an existing l3-interface-ipv6-address-list
23577 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23578 The PUT operation will entirely replace an existing object.
23579 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23581 Other differences between PUT and PATCH are:
23583 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23584 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23585 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23586 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23595 description: Response codes found in [response codes](https://wiki.onap.org/).
23597 - name: equipment-name
23601 example: __EQUIPMENT-NAME__
23602 - name: interface-name
23604 description: Name that identifies the physical interface
23607 example: __INTERFACE-NAME__
23608 - name: interface-name
23610 description: Name given to the interface
23613 example: __INTERFACE-NAME__
23614 - name: l3-interface-ipv6-address
23616 description: IP address
23619 example: __L3-INTERFACE-IPV6-ADDRESS__
23622 description: l3-interface-ipv6-address-list object that needs to be updated.
23625 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23629 summary: delete an existing l3-interface-ipv6-address-list
23630 description: delete an existing l3-interface-ipv6-address-list
23631 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23640 description: Response codes found in [response codes](https://wiki.onap.org/).
23642 - name: equipment-name
23646 example: __EQUIPMENT-NAME__
23647 - name: interface-name
23649 description: Name that identifies the physical interface
23652 example: __INTERFACE-NAME__
23653 - name: interface-name
23655 description: Name given to the interface
23658 example: __INTERFACE-NAME__
23659 - name: l3-interface-ipv6-address
23661 description: IP address
23664 example: __L3-INTERFACE-IPV6-ADDRESS__
23665 - name: resource-version
23667 description: resource-version for concurrency
23670 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
23674 summary: returns l-interface
23675 description: returns l-interface
23676 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23682 description: successful operation
23684 $ref: "#/getDefinitions/l-interface"
23686 description: Response codes found in [response codes](https://wiki.onap.org/).
23688 - name: equipment-name
23692 example: __EQUIPMENT-NAME__
23693 - name: interface-name
23695 description: Name that identifies the physical interface
23698 example: __INTERFACE-NAME__
23699 - name: interface-name
23701 description: Name given to the interface
23704 example: __INTERFACE-NAME__
23708 summary: create or update an existing l-interface
23710 Create or update an existing l-interface.
23712 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23713 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23722 description: Response codes found in [response codes](https://wiki.onap.org/).
23724 - name: equipment-name
23728 example: __EQUIPMENT-NAME__
23729 - name: interface-name
23731 description: Name that identifies the physical interface
23734 example: __INTERFACE-NAME__
23735 - name: interface-name
23737 description: Name given to the interface
23740 example: __INTERFACE-NAME__
23743 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23746 $ref: "#/definitions/l-interface"
23750 summary: update an existing l-interface
23752 Update an existing l-interface
23754 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23755 The PUT operation will entirely replace an existing object.
23756 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23758 Other differences between PUT and PATCH are:
23760 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23761 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23762 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23763 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23772 description: Response codes found in [response codes](https://wiki.onap.org/).
23774 - name: equipment-name
23778 example: __EQUIPMENT-NAME__
23779 - name: interface-name
23781 description: Name that identifies the physical interface
23784 example: __INTERFACE-NAME__
23785 - name: interface-name
23787 description: Name given to the interface
23790 example: __INTERFACE-NAME__
23793 description: l-interface object that needs to be updated.
23796 $ref: "#/patchDefinitions/l-interface"
23800 summary: delete an existing l-interface
23801 description: delete an existing l-interface
23802 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23811 description: Response codes found in [response codes](https://wiki.onap.org/).
23813 - name: equipment-name
23817 example: __EQUIPMENT-NAME__
23818 - name: interface-name
23820 description: Name that identifies the physical interface
23823 example: __INTERFACE-NAME__
23824 - name: interface-name
23826 description: Name given to the interface
23829 example: __INTERFACE-NAME__
23830 - name: resource-version
23832 description: resource-version for concurrency
23835 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
23839 summary: returns l-interfaces
23840 description: returns l-interfaces
23841 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
23847 description: successful operation
23849 $ref: "#/getDefinitions/l-interfaces"
23851 description: Response codes found in [response codes](https://wiki.onap.org/).
23853 - name: equipment-name
23857 example: __EQUIPMENT-NAME__
23858 - name: interface-name
23860 description: Name that identifies the physical interface
23863 example: __INTERFACE-NAME__
23864 - name: interface-name
23869 - name: interface-id
23879 - name: network-name
23884 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
23888 summary: returns p-interface
23889 description: returns p-interface
23890 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
23896 description: successful operation
23898 $ref: "#/getDefinitions/p-interface"
23900 description: Response codes found in [response codes](https://wiki.onap.org/).
23902 - name: equipment-name
23906 example: __EQUIPMENT-NAME__
23907 - name: interface-name
23909 description: Name that identifies the physical interface
23912 example: __INTERFACE-NAME__
23916 summary: create or update an existing p-interface
23918 Create or update an existing p-interface.
23920 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23921 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
23930 description: Response codes found in [response codes](https://wiki.onap.org/).
23932 - name: equipment-name
23936 example: __EQUIPMENT-NAME__
23937 - name: interface-name
23939 description: Name that identifies the physical interface
23942 example: __INTERFACE-NAME__
23945 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)
23948 $ref: "#/definitions/p-interface"
23952 summary: update an existing p-interface
23954 Update an existing p-interface
23956 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23957 The PUT operation will entirely replace an existing object.
23958 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23960 Other differences between PUT and PATCH are:
23962 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23963 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23964 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23965 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
23974 description: Response codes found in [response codes](https://wiki.onap.org/).
23976 - name: equipment-name
23980 example: __EQUIPMENT-NAME__
23981 - name: interface-name
23983 description: Name that identifies the physical interface
23986 example: __INTERFACE-NAME__
23989 description: p-interface object that needs to be updated.
23992 $ref: "#/patchDefinitions/p-interface"
23996 summary: delete an existing p-interface
23997 description: delete an existing p-interface
23998 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
24007 description: Response codes found in [response codes](https://wiki.onap.org/).
24009 - name: equipment-name
24013 example: __EQUIPMENT-NAME__
24014 - name: interface-name
24016 description: Name that identifies the physical interface
24019 example: __INTERFACE-NAME__
24020 - name: resource-version
24022 description: resource-version for concurrency
24025 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
24029 summary: returns p-interfaces
24030 description: returns p-interfaces
24031 operationId: getNetworkVplsPesVplsPePInterfaces
24037 description: successful operation
24039 $ref: "#/getDefinitions/p-interfaces"
24041 description: Response codes found in [response codes](https://wiki.onap.org/).
24043 - name: equipment-name
24047 example: __EQUIPMENT-NAME__
24048 - name: interface-name
24053 - name: prov-status
24058 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
24062 summary: see node definition for valid relationships
24063 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24072 description: Response codes found in [response codes](https://wiki.onap.org/).
24074 - name: equipment-name
24078 example: __EQUIPMENT-NAME__
24079 - name: interface-name
24081 description: Name that identifies the link aggregate interface
24084 example: __INTERFACE-NAME__
24087 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
24090 $ref: "#/definitions/relationship"
24094 summary: delete an existing relationship
24095 description: delete an existing relationship
24096 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24105 description: Response codes found in [response codes](https://wiki.onap.org/).
24107 - name: equipment-name
24111 example: __EQUIPMENT-NAME__
24112 - name: interface-name
24114 description: Name that identifies the link aggregate interface
24117 example: __INTERFACE-NAME__
24118 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
24122 summary: see node definition for valid relationships
24123 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24132 description: Response codes found in [response codes](https://wiki.onap.org/).
24134 - name: equipment-name
24138 example: __EQUIPMENT-NAME__
24139 - name: interface-name
24141 description: Name that identifies the link aggregate interface
24144 example: __INTERFACE-NAME__
24145 - name: interface-name
24147 description: Name given to the interface
24150 example: __INTERFACE-NAME__
24151 - name: vlan-interface
24153 description: String that identifies the interface
24156 example: __VLAN-INTERFACE__
24159 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
24162 $ref: "#/definitions/relationship"
24166 summary: delete an existing relationship
24167 description: delete an existing relationship
24168 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24177 description: Response codes found in [response codes](https://wiki.onap.org/).
24179 - name: equipment-name
24183 example: __EQUIPMENT-NAME__
24184 - name: interface-name
24186 description: Name that identifies the link aggregate interface
24189 example: __INTERFACE-NAME__
24190 - name: interface-name
24192 description: Name given to the interface
24195 example: __INTERFACE-NAME__
24196 - name: vlan-interface
24198 description: String that identifies the interface
24201 example: __VLAN-INTERFACE__
24202 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
24206 summary: see node definition for valid relationships
24207 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24216 description: Response codes found in [response codes](https://wiki.onap.org/).
24218 - name: equipment-name
24222 example: __EQUIPMENT-NAME__
24223 - name: interface-name
24225 description: Name that identifies the link aggregate interface
24228 example: __INTERFACE-NAME__
24229 - name: interface-name
24231 description: Name given to the interface
24234 example: __INTERFACE-NAME__
24235 - name: vlan-interface
24237 description: String that identifies the interface
24240 example: __VLAN-INTERFACE__
24241 - name: l3-interface-ipv4-address
24243 description: IP address
24246 example: __L3-INTERFACE-IPV4-ADDRESS__
24249 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24252 $ref: "#/definitions/relationship"
24256 summary: delete an existing relationship
24257 description: delete an existing relationship
24258 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24267 description: Response codes found in [response codes](https://wiki.onap.org/).
24269 - name: equipment-name
24273 example: __EQUIPMENT-NAME__
24274 - name: interface-name
24276 description: Name that identifies the link aggregate interface
24279 example: __INTERFACE-NAME__
24280 - name: interface-name
24282 description: Name given to the interface
24285 example: __INTERFACE-NAME__
24286 - name: vlan-interface
24288 description: String that identifies the interface
24291 example: __VLAN-INTERFACE__
24292 - name: l3-interface-ipv4-address
24294 description: IP address
24297 example: __L3-INTERFACE-IPV4-ADDRESS__
24298 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
24302 summary: returns l3-interface-ipv4-address-list
24303 description: returns l3-interface-ipv4-address-list
24304 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24310 description: successful operation
24312 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24314 description: Response codes found in [response codes](https://wiki.onap.org/).
24316 - name: equipment-name
24320 example: __EQUIPMENT-NAME__
24321 - name: interface-name
24323 description: Name that identifies the link aggregate interface
24326 example: __INTERFACE-NAME__
24327 - name: interface-name
24329 description: Name given to the interface
24332 example: __INTERFACE-NAME__
24333 - name: vlan-interface
24335 description: String that identifies the interface
24338 example: __VLAN-INTERFACE__
24339 - name: l3-interface-ipv4-address
24341 description: IP address
24344 example: __L3-INTERFACE-IPV4-ADDRESS__
24348 summary: create or update an existing l3-interface-ipv4-address-list
24350 Create or update an existing l3-interface-ipv4-address-list.
24352 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24353 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24362 description: Response codes found in [response codes](https://wiki.onap.org/).
24364 - name: equipment-name
24368 example: __EQUIPMENT-NAME__
24369 - name: interface-name
24371 description: Name that identifies the link aggregate interface
24374 example: __INTERFACE-NAME__
24375 - name: interface-name
24377 description: Name given to the interface
24380 example: __INTERFACE-NAME__
24381 - name: vlan-interface
24383 description: String that identifies the interface
24386 example: __VLAN-INTERFACE__
24387 - name: l3-interface-ipv4-address
24389 description: IP address
24392 example: __L3-INTERFACE-IPV4-ADDRESS__
24395 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24398 $ref: "#/definitions/l3-interface-ipv4-address-list"
24402 summary: update an existing l3-interface-ipv4-address-list
24404 Update an existing l3-interface-ipv4-address-list
24406 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24407 The PUT operation will entirely replace an existing object.
24408 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24410 Other differences between PUT and PATCH are:
24412 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24413 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24414 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24415 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24424 description: Response codes found in [response codes](https://wiki.onap.org/).
24426 - name: equipment-name
24430 example: __EQUIPMENT-NAME__
24431 - name: interface-name
24433 description: Name that identifies the link aggregate interface
24436 example: __INTERFACE-NAME__
24437 - name: interface-name
24439 description: Name given to the interface
24442 example: __INTERFACE-NAME__
24443 - name: vlan-interface
24445 description: String that identifies the interface
24448 example: __VLAN-INTERFACE__
24449 - name: l3-interface-ipv4-address
24451 description: IP address
24454 example: __L3-INTERFACE-IPV4-ADDRESS__
24457 description: l3-interface-ipv4-address-list object that needs to be updated.
24460 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24464 summary: delete an existing l3-interface-ipv4-address-list
24465 description: delete an existing l3-interface-ipv4-address-list
24466 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24475 description: Response codes found in [response codes](https://wiki.onap.org/).
24477 - name: equipment-name
24481 example: __EQUIPMENT-NAME__
24482 - name: interface-name
24484 description: Name that identifies the link aggregate interface
24487 example: __INTERFACE-NAME__
24488 - name: interface-name
24490 description: Name given to the interface
24493 example: __INTERFACE-NAME__
24494 - name: vlan-interface
24496 description: String that identifies the interface
24499 example: __VLAN-INTERFACE__
24500 - name: l3-interface-ipv4-address
24502 description: IP address
24505 example: __L3-INTERFACE-IPV4-ADDRESS__
24506 - name: resource-version
24508 description: resource-version for concurrency
24511 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
24515 summary: see node definition for valid relationships
24516 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24525 description: Response codes found in [response codes](https://wiki.onap.org/).
24527 - name: equipment-name
24531 example: __EQUIPMENT-NAME__
24532 - name: interface-name
24534 description: Name that identifies the link aggregate interface
24537 example: __INTERFACE-NAME__
24538 - name: interface-name
24540 description: Name given to the interface
24543 example: __INTERFACE-NAME__
24544 - name: vlan-interface
24546 description: String that identifies the interface
24549 example: __VLAN-INTERFACE__
24550 - name: l3-interface-ipv6-address
24552 description: IP address
24555 example: __L3-INTERFACE-IPV6-ADDRESS__
24558 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24561 $ref: "#/definitions/relationship"
24565 summary: delete an existing relationship
24566 description: delete an existing relationship
24567 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24576 description: Response codes found in [response codes](https://wiki.onap.org/).
24578 - name: equipment-name
24582 example: __EQUIPMENT-NAME__
24583 - name: interface-name
24585 description: Name that identifies the link aggregate interface
24588 example: __INTERFACE-NAME__
24589 - name: interface-name
24591 description: Name given to the interface
24594 example: __INTERFACE-NAME__
24595 - name: vlan-interface
24597 description: String that identifies the interface
24600 example: __VLAN-INTERFACE__
24601 - name: l3-interface-ipv6-address
24603 description: IP address
24606 example: __L3-INTERFACE-IPV6-ADDRESS__
24607 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
24611 summary: returns l3-interface-ipv6-address-list
24612 description: returns l3-interface-ipv6-address-list
24613 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24619 description: successful operation
24621 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24623 description: Response codes found in [response codes](https://wiki.onap.org/).
24625 - name: equipment-name
24629 example: __EQUIPMENT-NAME__
24630 - name: interface-name
24632 description: Name that identifies the link aggregate interface
24635 example: __INTERFACE-NAME__
24636 - name: interface-name
24638 description: Name given to the interface
24641 example: __INTERFACE-NAME__
24642 - name: vlan-interface
24644 description: String that identifies the interface
24647 example: __VLAN-INTERFACE__
24648 - name: l3-interface-ipv6-address
24650 description: IP address
24653 example: __L3-INTERFACE-IPV6-ADDRESS__
24657 summary: create or update an existing l3-interface-ipv6-address-list
24659 Create or update an existing l3-interface-ipv6-address-list.
24661 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24662 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24671 description: Response codes found in [response codes](https://wiki.onap.org/).
24673 - name: equipment-name
24677 example: __EQUIPMENT-NAME__
24678 - name: interface-name
24680 description: Name that identifies the link aggregate interface
24683 example: __INTERFACE-NAME__
24684 - name: interface-name
24686 description: Name given to the interface
24689 example: __INTERFACE-NAME__
24690 - name: vlan-interface
24692 description: String that identifies the interface
24695 example: __VLAN-INTERFACE__
24696 - name: l3-interface-ipv6-address
24698 description: IP address
24701 example: __L3-INTERFACE-IPV6-ADDRESS__
24704 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24707 $ref: "#/definitions/l3-interface-ipv6-address-list"
24711 summary: update an existing l3-interface-ipv6-address-list
24713 Update an existing l3-interface-ipv6-address-list
24715 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24716 The PUT operation will entirely replace an existing object.
24717 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24719 Other differences between PUT and PATCH are:
24721 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24722 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24723 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24724 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24733 description: Response codes found in [response codes](https://wiki.onap.org/).
24735 - name: equipment-name
24739 example: __EQUIPMENT-NAME__
24740 - name: interface-name
24742 description: Name that identifies the link aggregate interface
24745 example: __INTERFACE-NAME__
24746 - name: interface-name
24748 description: Name given to the interface
24751 example: __INTERFACE-NAME__
24752 - name: vlan-interface
24754 description: String that identifies the interface
24757 example: __VLAN-INTERFACE__
24758 - name: l3-interface-ipv6-address
24760 description: IP address
24763 example: __L3-INTERFACE-IPV6-ADDRESS__
24766 description: l3-interface-ipv6-address-list object that needs to be updated.
24769 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24773 summary: delete an existing l3-interface-ipv6-address-list
24774 description: delete an existing l3-interface-ipv6-address-list
24775 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24784 description: Response codes found in [response codes](https://wiki.onap.org/).
24786 - name: equipment-name
24790 example: __EQUIPMENT-NAME__
24791 - name: interface-name
24793 description: Name that identifies the link aggregate interface
24796 example: __INTERFACE-NAME__
24797 - name: interface-name
24799 description: Name given to the interface
24802 example: __INTERFACE-NAME__
24803 - name: vlan-interface
24805 description: String that identifies the interface
24808 example: __VLAN-INTERFACE__
24809 - name: l3-interface-ipv6-address
24811 description: IP address
24814 example: __L3-INTERFACE-IPV6-ADDRESS__
24815 - name: resource-version
24817 description: resource-version for concurrency
24820 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
24824 summary: returns vlan
24825 description: returns vlan
24826 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
24832 description: successful operation
24834 $ref: "#/getDefinitions/vlan"
24836 description: Response codes found in [response codes](https://wiki.onap.org/).
24838 - name: equipment-name
24842 example: __EQUIPMENT-NAME__
24843 - name: interface-name
24845 description: Name that identifies the link aggregate interface
24848 example: __INTERFACE-NAME__
24849 - name: interface-name
24851 description: Name given to the interface
24854 example: __INTERFACE-NAME__
24855 - name: vlan-interface
24857 description: String that identifies the interface
24860 example: __VLAN-INTERFACE__
24864 summary: create or update an existing vlan
24866 Create or update an existing vlan.
24868 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24869 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
24878 description: Response codes found in [response codes](https://wiki.onap.org/).
24880 - name: equipment-name
24884 example: __EQUIPMENT-NAME__
24885 - name: interface-name
24887 description: Name that identifies the link aggregate interface
24890 example: __INTERFACE-NAME__
24891 - name: interface-name
24893 description: Name given to the interface
24896 example: __INTERFACE-NAME__
24897 - name: vlan-interface
24899 description: String that identifies the interface
24902 example: __VLAN-INTERFACE__
24905 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
24908 $ref: "#/definitions/vlan"
24912 summary: update an existing vlan
24914 Update an existing vlan
24916 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24917 The PUT operation will entirely replace an existing object.
24918 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24920 Other differences between PUT and PATCH are:
24922 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24923 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24924 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24925 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
24934 description: Response codes found in [response codes](https://wiki.onap.org/).
24936 - name: equipment-name
24940 example: __EQUIPMENT-NAME__
24941 - name: interface-name
24943 description: Name that identifies the link aggregate interface
24946 example: __INTERFACE-NAME__
24947 - name: interface-name
24949 description: Name given to the interface
24952 example: __INTERFACE-NAME__
24953 - name: vlan-interface
24955 description: String that identifies the interface
24958 example: __VLAN-INTERFACE__
24961 description: vlan object that needs to be updated.
24964 $ref: "#/patchDefinitions/vlan"
24968 summary: delete an existing vlan
24969 description: delete an existing vlan
24970 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
24979 description: Response codes found in [response codes](https://wiki.onap.org/).
24981 - name: equipment-name
24985 example: __EQUIPMENT-NAME__
24986 - name: interface-name
24988 description: Name that identifies the link aggregate interface
24991 example: __INTERFACE-NAME__
24992 - name: interface-name
24994 description: Name given to the interface
24997 example: __INTERFACE-NAME__
24998 - name: vlan-interface
25000 description: String that identifies the interface
25003 example: __VLAN-INTERFACE__
25004 - name: resource-version
25006 description: resource-version for concurrency
25009 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25013 summary: returns vlans
25014 description: returns vlans
25015 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
25021 description: successful operation
25023 $ref: "#/getDefinitions/vlans"
25025 description: Response codes found in [response codes](https://wiki.onap.org/).
25027 - name: equipment-name
25031 example: __EQUIPMENT-NAME__
25032 - name: interface-name
25034 description: Name that identifies the link aggregate interface
25037 example: __INTERFACE-NAME__
25038 - name: interface-name
25040 description: Name given to the interface
25043 example: __INTERFACE-NAME__
25044 - name: vlan-interface
25049 - name: vlan-id-inner
25060 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
25064 summary: see node definition for valid relationships
25065 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25074 description: Response codes found in [response codes](https://wiki.onap.org/).
25076 - name: equipment-name
25080 example: __EQUIPMENT-NAME__
25081 - name: interface-name
25083 description: Name that identifies the link aggregate interface
25086 example: __INTERFACE-NAME__
25087 - name: interface-name
25089 description: Name given to the interface
25092 example: __INTERFACE-NAME__
25095 description: PCI ID used to identify the sriov-vf
25098 example: __PCI-ID__
25101 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25104 $ref: "#/definitions/relationship"
25108 summary: delete an existing relationship
25109 description: delete an existing relationship
25110 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25119 description: Response codes found in [response codes](https://wiki.onap.org/).
25121 - name: equipment-name
25125 example: __EQUIPMENT-NAME__
25126 - name: interface-name
25128 description: Name that identifies the link aggregate interface
25131 example: __INTERFACE-NAME__
25132 - name: interface-name
25134 description: Name given to the interface
25137 example: __INTERFACE-NAME__
25140 description: PCI ID used to identify the sriov-vf
25143 example: __PCI-ID__
25144 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
25148 summary: returns sriov-vf
25149 description: returns sriov-vf
25150 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25156 description: successful operation
25158 $ref: "#/getDefinitions/sriov-vf"
25160 description: Response codes found in [response codes](https://wiki.onap.org/).
25162 - name: equipment-name
25166 example: __EQUIPMENT-NAME__
25167 - name: interface-name
25169 description: Name that identifies the link aggregate interface
25172 example: __INTERFACE-NAME__
25173 - name: interface-name
25175 description: Name given to the interface
25178 example: __INTERFACE-NAME__
25181 description: PCI ID used to identify the sriov-vf
25184 example: __PCI-ID__
25188 summary: create or update an existing sriov-vf
25190 Create or update an existing sriov-vf.
25192 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25193 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25202 description: Response codes found in [response codes](https://wiki.onap.org/).
25204 - name: equipment-name
25208 example: __EQUIPMENT-NAME__
25209 - name: interface-name
25211 description: Name that identifies the link aggregate interface
25214 example: __INTERFACE-NAME__
25215 - name: interface-name
25217 description: Name given to the interface
25220 example: __INTERFACE-NAME__
25223 description: PCI ID used to identify the sriov-vf
25226 example: __PCI-ID__
25229 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25232 $ref: "#/definitions/sriov-vf"
25236 summary: update an existing sriov-vf
25238 Update an existing sriov-vf
25240 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25241 The PUT operation will entirely replace an existing object.
25242 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25244 Other differences between PUT and PATCH are:
25246 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25247 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25248 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25249 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25258 description: Response codes found in [response codes](https://wiki.onap.org/).
25260 - name: equipment-name
25264 example: __EQUIPMENT-NAME__
25265 - name: interface-name
25267 description: Name that identifies the link aggregate interface
25270 example: __INTERFACE-NAME__
25271 - name: interface-name
25273 description: Name given to the interface
25276 example: __INTERFACE-NAME__
25279 description: PCI ID used to identify the sriov-vf
25282 example: __PCI-ID__
25285 description: sriov-vf object that needs to be updated.
25288 $ref: "#/patchDefinitions/sriov-vf"
25292 summary: delete an existing sriov-vf
25293 description: delete an existing sriov-vf
25294 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25303 description: Response codes found in [response codes](https://wiki.onap.org/).
25305 - name: equipment-name
25309 example: __EQUIPMENT-NAME__
25310 - name: interface-name
25312 description: Name that identifies the link aggregate interface
25315 example: __INTERFACE-NAME__
25316 - name: interface-name
25318 description: Name given to the interface
25321 example: __INTERFACE-NAME__
25324 description: PCI ID used to identify the sriov-vf
25327 example: __PCI-ID__
25328 - name: resource-version
25330 description: resource-version for concurrency
25333 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25337 summary: returns sriov-vfs
25338 description: returns sriov-vfs
25339 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
25345 description: successful operation
25347 $ref: "#/getDefinitions/sriov-vfs"
25349 description: Response codes found in [response codes](https://wiki.onap.org/).
25351 - name: equipment-name
25355 example: __EQUIPMENT-NAME__
25356 - name: interface-name
25358 description: Name that identifies the link aggregate interface
25361 example: __INTERFACE-NAME__
25362 - name: interface-name
25364 description: Name given to the interface
25367 example: __INTERFACE-NAME__
25373 - name: vf-vlan-filter
25378 - name: vf-mac-filter
25383 - name: vf-vlan-strip
25388 - name: neutron-network-id
25393 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
25397 summary: see node definition for valid relationships
25398 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
25407 description: Response codes found in [response codes](https://wiki.onap.org/).
25409 - name: equipment-name
25413 example: __EQUIPMENT-NAME__
25414 - name: interface-name
25416 description: Name that identifies the link aggregate interface
25419 example: __INTERFACE-NAME__
25420 - name: interface-name
25422 description: Name given to the interface
25425 example: __INTERFACE-NAME__
25428 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
25431 $ref: "#/definitions/relationship"
25435 summary: delete an existing relationship
25436 description: delete an existing relationship
25437 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
25446 description: Response codes found in [response codes](https://wiki.onap.org/).
25448 - name: equipment-name
25452 example: __EQUIPMENT-NAME__
25453 - name: interface-name
25455 description: Name that identifies the link aggregate interface
25458 example: __INTERFACE-NAME__
25459 - name: interface-name
25461 description: Name given to the interface
25464 example: __INTERFACE-NAME__
25465 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
25469 summary: see node definition for valid relationships
25470 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25479 description: Response codes found in [response codes](https://wiki.onap.org/).
25481 - name: equipment-name
25485 example: __EQUIPMENT-NAME__
25486 - name: interface-name
25488 description: Name that identifies the link aggregate interface
25491 example: __INTERFACE-NAME__
25492 - name: interface-name
25494 description: Name given to the interface
25497 example: __INTERFACE-NAME__
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/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25509 $ref: "#/definitions/relationship"
25513 summary: delete an existing relationship
25514 description: delete an existing relationship
25515 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25524 description: Response codes found in [response codes](https://wiki.onap.org/).
25526 - name: equipment-name
25530 example: __EQUIPMENT-NAME__
25531 - name: interface-name
25533 description: Name that identifies the link aggregate interface
25536 example: __INTERFACE-NAME__
25537 - name: interface-name
25539 description: Name given to the interface
25542 example: __INTERFACE-NAME__
25543 - name: l3-interface-ipv4-address
25545 description: IP address
25548 example: __L3-INTERFACE-IPV4-ADDRESS__
25549 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
25553 summary: returns l3-interface-ipv4-address-list
25554 description: returns l3-interface-ipv4-address-list
25555 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25561 description: successful operation
25563 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25565 description: Response codes found in [response codes](https://wiki.onap.org/).
25567 - name: equipment-name
25571 example: __EQUIPMENT-NAME__
25572 - name: interface-name
25574 description: Name that identifies the link aggregate interface
25577 example: __INTERFACE-NAME__
25578 - name: interface-name
25580 description: Name given to the interface
25583 example: __INTERFACE-NAME__
25584 - name: l3-interface-ipv4-address
25586 description: IP address
25589 example: __L3-INTERFACE-IPV4-ADDRESS__
25593 summary: create or update an existing l3-interface-ipv4-address-list
25595 Create or update an existing l3-interface-ipv4-address-list.
25597 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25598 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25607 description: Response codes found in [response codes](https://wiki.onap.org/).
25609 - name: equipment-name
25613 example: __EQUIPMENT-NAME__
25614 - name: interface-name
25616 description: Name that identifies the link aggregate interface
25619 example: __INTERFACE-NAME__
25620 - name: interface-name
25622 description: Name given to the interface
25625 example: __INTERFACE-NAME__
25626 - name: l3-interface-ipv4-address
25628 description: IP address
25631 example: __L3-INTERFACE-IPV4-ADDRESS__
25634 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25637 $ref: "#/definitions/l3-interface-ipv4-address-list"
25641 summary: update an existing l3-interface-ipv4-address-list
25643 Update an existing l3-interface-ipv4-address-list
25645 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25646 The PUT operation will entirely replace an existing object.
25647 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25649 Other differences between PUT and PATCH are:
25651 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25652 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25653 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25654 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25663 description: Response codes found in [response codes](https://wiki.onap.org/).
25665 - name: equipment-name
25669 example: __EQUIPMENT-NAME__
25670 - name: interface-name
25672 description: Name that identifies the link aggregate interface
25675 example: __INTERFACE-NAME__
25676 - name: interface-name
25678 description: Name given to the interface
25681 example: __INTERFACE-NAME__
25682 - name: l3-interface-ipv4-address
25684 description: IP address
25687 example: __L3-INTERFACE-IPV4-ADDRESS__
25690 description: l3-interface-ipv4-address-list object that needs to be updated.
25693 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25697 summary: delete an existing l3-interface-ipv4-address-list
25698 description: delete an existing l3-interface-ipv4-address-list
25699 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25708 description: Response codes found in [response codes](https://wiki.onap.org/).
25710 - name: equipment-name
25714 example: __EQUIPMENT-NAME__
25715 - name: interface-name
25717 description: Name that identifies the link aggregate interface
25720 example: __INTERFACE-NAME__
25721 - name: interface-name
25723 description: Name given to the interface
25726 example: __INTERFACE-NAME__
25727 - name: l3-interface-ipv4-address
25729 description: IP address
25732 example: __L3-INTERFACE-IPV4-ADDRESS__
25733 - name: resource-version
25735 description: resource-version for concurrency
25738 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
25742 summary: see node definition for valid relationships
25743 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
25752 description: Response codes found in [response codes](https://wiki.onap.org/).
25754 - name: equipment-name
25758 example: __EQUIPMENT-NAME__
25759 - name: interface-name
25761 description: Name that identifies the link aggregate interface
25764 example: __INTERFACE-NAME__
25765 - name: interface-name
25767 description: Name given to the interface
25770 example: __INTERFACE-NAME__
25771 - name: l3-interface-ipv6-address
25773 description: IP address
25776 example: __L3-INTERFACE-IPV6-ADDRESS__
25779 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
25782 $ref: "#/definitions/relationship"
25786 summary: delete an existing relationship
25787 description: delete an existing relationship
25788 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
25797 description: Response codes found in [response codes](https://wiki.onap.org/).
25799 - name: equipment-name
25803 example: __EQUIPMENT-NAME__
25804 - name: interface-name
25806 description: Name that identifies the link aggregate interface
25809 example: __INTERFACE-NAME__
25810 - name: interface-name
25812 description: Name given to the interface
25815 example: __INTERFACE-NAME__
25816 - name: l3-interface-ipv6-address
25818 description: IP address
25821 example: __L3-INTERFACE-IPV6-ADDRESS__
25822 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
25826 summary: returns l3-interface-ipv6-address-list
25827 description: returns l3-interface-ipv6-address-list
25828 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25834 description: successful operation
25836 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25838 description: Response codes found in [response codes](https://wiki.onap.org/).
25840 - name: equipment-name
25844 example: __EQUIPMENT-NAME__
25845 - name: interface-name
25847 description: Name that identifies the link aggregate interface
25850 example: __INTERFACE-NAME__
25851 - name: interface-name
25853 description: Name given to the interface
25856 example: __INTERFACE-NAME__
25857 - name: l3-interface-ipv6-address
25859 description: IP address
25862 example: __L3-INTERFACE-IPV6-ADDRESS__
25866 summary: create or update an existing l3-interface-ipv6-address-list
25868 Create or update an existing l3-interface-ipv6-address-list.
25870 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25871 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25880 description: Response codes found in [response codes](https://wiki.onap.org/).
25882 - name: equipment-name
25886 example: __EQUIPMENT-NAME__
25887 - name: interface-name
25889 description: Name that identifies the link aggregate interface
25892 example: __INTERFACE-NAME__
25893 - name: interface-name
25895 description: Name given to the interface
25898 example: __INTERFACE-NAME__
25899 - name: l3-interface-ipv6-address
25901 description: IP address
25904 example: __L3-INTERFACE-IPV6-ADDRESS__
25907 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
25910 $ref: "#/definitions/l3-interface-ipv6-address-list"
25914 summary: update an existing l3-interface-ipv6-address-list
25916 Update an existing l3-interface-ipv6-address-list
25918 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25919 The PUT operation will entirely replace an existing object.
25920 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25922 Other differences between PUT and PATCH are:
25924 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25925 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25926 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25927 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25936 description: Response codes found in [response codes](https://wiki.onap.org/).
25938 - name: equipment-name
25942 example: __EQUIPMENT-NAME__
25943 - name: interface-name
25945 description: Name that identifies the link aggregate interface
25948 example: __INTERFACE-NAME__
25949 - name: interface-name
25951 description: Name given to the interface
25954 example: __INTERFACE-NAME__
25955 - name: l3-interface-ipv6-address
25957 description: IP address
25960 example: __L3-INTERFACE-IPV6-ADDRESS__
25963 description: l3-interface-ipv6-address-list object that needs to be updated.
25966 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25970 summary: delete an existing l3-interface-ipv6-address-list
25971 description: delete an existing l3-interface-ipv6-address-list
25972 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25981 description: Response codes found in [response codes](https://wiki.onap.org/).
25983 - name: equipment-name
25987 example: __EQUIPMENT-NAME__
25988 - name: interface-name
25990 description: Name that identifies the link aggregate interface
25993 example: __INTERFACE-NAME__
25994 - name: interface-name
25996 description: Name given to the interface
25999 example: __INTERFACE-NAME__
26000 - name: l3-interface-ipv6-address
26002 description: IP address
26005 example: __L3-INTERFACE-IPV6-ADDRESS__
26006 - name: resource-version
26008 description: resource-version for concurrency
26011 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26015 summary: returns l-interface
26016 description: returns l-interface
26017 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26023 description: successful operation
26025 $ref: "#/getDefinitions/l-interface"
26027 description: Response codes found in [response codes](https://wiki.onap.org/).
26029 - name: equipment-name
26033 example: __EQUIPMENT-NAME__
26034 - name: interface-name
26036 description: Name that identifies the link aggregate interface
26039 example: __INTERFACE-NAME__
26040 - name: interface-name
26042 description: Name given to the interface
26045 example: __INTERFACE-NAME__
26049 summary: create or update an existing l-interface
26051 Create or update an existing l-interface.
26053 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26054 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26063 description: Response codes found in [response codes](https://wiki.onap.org/).
26065 - name: equipment-name
26069 example: __EQUIPMENT-NAME__
26070 - name: interface-name
26072 description: Name that identifies the link aggregate interface
26075 example: __INTERFACE-NAME__
26076 - name: interface-name
26078 description: Name given to the interface
26081 example: __INTERFACE-NAME__
26084 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26087 $ref: "#/definitions/l-interface"
26091 summary: update an existing l-interface
26093 Update an existing l-interface
26095 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26096 The PUT operation will entirely replace an existing object.
26097 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26099 Other differences between PUT and PATCH are:
26101 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26102 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26103 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26104 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26113 description: Response codes found in [response codes](https://wiki.onap.org/).
26115 - name: equipment-name
26119 example: __EQUIPMENT-NAME__
26120 - name: interface-name
26122 description: Name that identifies the link aggregate interface
26125 example: __INTERFACE-NAME__
26126 - name: interface-name
26128 description: Name given to the interface
26131 example: __INTERFACE-NAME__
26134 description: l-interface object that needs to be updated.
26137 $ref: "#/patchDefinitions/l-interface"
26141 summary: delete an existing l-interface
26142 description: delete an existing l-interface
26143 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26152 description: Response codes found in [response codes](https://wiki.onap.org/).
26154 - name: equipment-name
26158 example: __EQUIPMENT-NAME__
26159 - name: interface-name
26161 description: Name that identifies the link aggregate interface
26164 example: __INTERFACE-NAME__
26165 - name: interface-name
26167 description: Name given to the interface
26170 example: __INTERFACE-NAME__
26171 - name: resource-version
26173 description: resource-version for concurrency
26176 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
26180 summary: returns l-interfaces
26181 description: returns l-interfaces
26182 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
26188 description: successful operation
26190 $ref: "#/getDefinitions/l-interfaces"
26192 description: Response codes found in [response codes](https://wiki.onap.org/).
26194 - name: equipment-name
26198 example: __EQUIPMENT-NAME__
26199 - name: interface-name
26201 description: Name that identifies the link aggregate interface
26204 example: __INTERFACE-NAME__
26205 - name: interface-name
26210 - name: interface-id
26220 - name: network-name
26225 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
26229 summary: returns lag-interface
26230 description: returns lag-interface
26231 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
26237 description: successful operation
26239 $ref: "#/getDefinitions/lag-interface"
26241 description: Response codes found in [response codes](https://wiki.onap.org/).
26243 - name: equipment-name
26247 example: __EQUIPMENT-NAME__
26248 - name: interface-name
26250 description: Name that identifies the link aggregate interface
26253 example: __INTERFACE-NAME__
26257 summary: create or update an existing lag-interface
26259 Create or update an existing lag-interface.
26261 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26262 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
26271 description: Response codes found in [response codes](https://wiki.onap.org/).
26273 - name: equipment-name
26277 example: __EQUIPMENT-NAME__
26278 - name: interface-name
26280 description: Name that identifies the link aggregate interface
26283 example: __INTERFACE-NAME__
26286 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
26289 $ref: "#/definitions/lag-interface"
26293 summary: update an existing lag-interface
26295 Update an existing lag-interface
26297 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26298 The PUT operation will entirely replace an existing object.
26299 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26301 Other differences between PUT and PATCH are:
26303 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26304 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26305 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26306 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
26315 description: Response codes found in [response codes](https://wiki.onap.org/).
26317 - name: equipment-name
26321 example: __EQUIPMENT-NAME__
26322 - name: interface-name
26324 description: Name that identifies the link aggregate interface
26327 example: __INTERFACE-NAME__
26330 description: lag-interface object that needs to be updated.
26333 $ref: "#/patchDefinitions/lag-interface"
26337 summary: delete an existing lag-interface
26338 description: delete an existing lag-interface
26339 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
26348 description: Response codes found in [response codes](https://wiki.onap.org/).
26350 - name: equipment-name
26354 example: __EQUIPMENT-NAME__
26355 - name: interface-name
26357 description: Name that identifies the link aggregate interface
26360 example: __INTERFACE-NAME__
26361 - name: resource-version
26363 description: resource-version for concurrency
26366 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
26370 summary: returns lag-interfaces
26371 description: returns lag-interfaces
26372 operationId: getNetworkVplsPesVplsPeLagInterfaces
26378 description: successful operation
26380 $ref: "#/getDefinitions/lag-interfaces"
26382 description: Response codes found in [response codes](https://wiki.onap.org/).
26384 - name: equipment-name
26388 example: __EQUIPMENT-NAME__
26389 - name: interface-name
26394 - name: interface-id
26399 - name: interface-role
26404 /network/vpls-pes/vpls-pe/{equipment-name}:
26408 summary: returns vpls-pe
26409 description: returns vpls-pe
26410 operationId: getNetworkVplsPesVplsPe
26416 description: successful operation
26418 $ref: "#/getDefinitions/vpls-pe"
26420 description: Response codes found in [response codes](https://wiki.onap.org/).
26422 - name: equipment-name
26426 example: __EQUIPMENT-NAME__
26430 summary: create or update an existing vpls-pe
26432 Create or update an existing vpls-pe.
26434 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26435 operationId: createOrUpdateNetworkVplsPesVplsPe
26444 description: Response codes found in [response codes](https://wiki.onap.org/).
26446 - name: equipment-name
26450 example: __EQUIPMENT-NAME__
26453 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)
26456 $ref: "#/definitions/vpls-pe"
26460 summary: update an existing vpls-pe
26462 Update an existing vpls-pe
26464 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26465 The PUT operation will entirely replace an existing object.
26466 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26468 Other differences between PUT and PATCH are:
26470 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26471 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26472 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26473 operationId: UpdateNetworkVplsPesVplsPe
26482 description: Response codes found in [response codes](https://wiki.onap.org/).
26484 - name: equipment-name
26488 example: __EQUIPMENT-NAME__
26491 description: vpls-pe object that needs to be updated.
26494 $ref: "#/patchDefinitions/vpls-pe"
26498 summary: delete an existing vpls-pe
26499 description: delete an existing vpls-pe
26500 operationId: deleteNetworkVplsPesVplsPe
26509 description: Response codes found in [response codes](https://wiki.onap.org/).
26511 - name: equipment-name
26515 example: __EQUIPMENT-NAME__
26516 - name: resource-version
26518 description: resource-version for concurrency
26525 summary: returns vpls-pes
26526 description: returns vpls-pes
26527 operationId: getNetworkVplsPes
26533 description: successful operation
26535 $ref: "#/getDefinitions/vpls-pes"
26537 description: Response codes found in [response codes](https://wiki.onap.org/).
26539 - name: equipment-name
26544 - name: prov-status
26549 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
26553 summary: see node definition for valid relationships
26554 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
26563 description: Response codes found in [response codes](https://wiki.onap.org/).
26565 - name: multicast-configuration-id
26567 description: Unique id of multicast configuration.
26570 example: __MULTICAST-CONFIGURATION-ID__
26573 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)
26576 $ref: "#/definitions/relationship"
26580 summary: delete an existing relationship
26581 description: delete an existing relationship
26582 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
26591 description: Response codes found in [response codes](https://wiki.onap.org/).
26593 - name: multicast-configuration-id
26595 description: Unique id of multicast configuration.
26598 example: __MULTICAST-CONFIGURATION-ID__
26599 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
26603 summary: returns multicast-configuration
26604 description: returns multicast-configuration
26605 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
26611 description: successful operation
26613 $ref: "#/getDefinitions/multicast-configuration"
26615 description: Response codes found in [response codes](https://wiki.onap.org/).
26617 - name: multicast-configuration-id
26619 description: Unique id of multicast configuration.
26622 example: __MULTICAST-CONFIGURATION-ID__
26626 summary: create or update an existing multicast-configuration
26628 Create or update an existing multicast-configuration.
26630 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26631 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
26640 description: Response codes found in [response codes](https://wiki.onap.org/).
26642 - name: multicast-configuration-id
26644 description: Unique id of multicast configuration.
26647 example: __MULTICAST-CONFIGURATION-ID__
26650 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)
26653 $ref: "#/definitions/multicast-configuration"
26657 summary: update an existing multicast-configuration
26659 Update an existing multicast-configuration
26661 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26662 The PUT operation will entirely replace an existing object.
26663 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26665 Other differences between PUT and PATCH are:
26667 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26668 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26669 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26670 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
26679 description: Response codes found in [response codes](https://wiki.onap.org/).
26681 - name: multicast-configuration-id
26683 description: Unique id of multicast configuration.
26686 example: __MULTICAST-CONFIGURATION-ID__
26689 description: multicast-configuration object that needs to be updated.
26692 $ref: "#/patchDefinitions/multicast-configuration"
26696 summary: delete an existing multicast-configuration
26697 description: delete an existing multicast-configuration
26698 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
26707 description: Response codes found in [response codes](https://wiki.onap.org/).
26709 - name: multicast-configuration-id
26711 description: Unique id of multicast configuration.
26714 example: __MULTICAST-CONFIGURATION-ID__
26715 - name: resource-version
26717 description: resource-version for concurrency
26720 /network/multicast-configurations:
26724 summary: returns multicast-configurations
26725 description: returns multicast-configurations
26726 operationId: getNetworkMulticastConfigurations
26732 description: successful operation
26734 $ref: "#/getDefinitions/multicast-configurations"
26736 description: Response codes found in [response codes](https://wiki.onap.org/).
26738 - name: multicast-configuration-id
26743 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
26747 summary: see node definition for valid relationships
26748 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
26757 description: Response codes found in [response codes](https://wiki.onap.org/).
26761 description: Unique id of VNF. This is unique across the graph.
26764 example: __VNF-ID__
26765 - name: interface-id
26767 description: Unique ID of the interface
26770 example: __INTERFACE-ID__
26773 description: See mis-na-virtualization-platform.yang
26777 example: __CVLAN-TAG__
26780 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
26783 $ref: "#/definitions/relationship"
26787 summary: delete an existing relationship
26788 description: delete an existing relationship
26789 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
26798 description: Response codes found in [response codes](https://wiki.onap.org/).
26802 description: Unique id of VNF. This is unique across the graph.
26805 example: __VNF-ID__
26806 - name: interface-id
26808 description: Unique ID of the interface
26811 example: __INTERFACE-ID__
26814 description: See mis-na-virtualization-platform.yang
26818 example: __CVLAN-TAG__
26819 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
26823 summary: returns cvlan-tag-entry
26824 description: returns cvlan-tag-entry
26825 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
26831 description: successful operation
26833 $ref: "#/getDefinitions/cvlan-tag-entry"
26835 description: Response codes found in [response codes](https://wiki.onap.org/).
26839 description: Unique id of VNF. This is unique across the graph.
26842 example: __VNF-ID__
26843 - name: interface-id
26845 description: Unique ID of the interface
26848 example: __INTERFACE-ID__
26851 description: See mis-na-virtualization-platform.yang
26855 example: __CVLAN-TAG__
26859 summary: create or update an existing cvlan-tag-entry
26861 Create or update an existing cvlan-tag-entry.
26863 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26864 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
26873 description: Response codes found in [response codes](https://wiki.onap.org/).
26877 description: Unique id of VNF. This is unique across the graph.
26880 example: __VNF-ID__
26881 - name: interface-id
26883 description: Unique ID of the interface
26886 example: __INTERFACE-ID__
26889 description: See mis-na-virtualization-platform.yang
26893 example: __CVLAN-TAG__
26896 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
26899 $ref: "#/definitions/cvlan-tag-entry"
26903 summary: update an existing cvlan-tag-entry
26905 Update an existing cvlan-tag-entry
26907 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26908 The PUT operation will entirely replace an existing object.
26909 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26911 Other differences between PUT and PATCH are:
26913 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26914 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26915 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26916 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
26925 description: Response codes found in [response codes](https://wiki.onap.org/).
26929 description: Unique id of VNF. This is unique across the graph.
26932 example: __VNF-ID__
26933 - name: interface-id
26935 description: Unique ID of the interface
26938 example: __INTERFACE-ID__
26941 description: See mis-na-virtualization-platform.yang
26945 example: __CVLAN-TAG__
26948 description: cvlan-tag-entry object that needs to be updated.
26951 $ref: "#/patchDefinitions/cvlan-tag-entry"
26955 summary: delete an existing cvlan-tag-entry
26956 description: delete an existing cvlan-tag-entry
26957 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
26966 description: Response codes found in [response codes](https://wiki.onap.org/).
26970 description: Unique id of VNF. This is unique across the graph.
26973 example: __VNF-ID__
26974 - name: interface-id
26976 description: Unique ID of the interface
26979 example: __INTERFACE-ID__
26982 description: See mis-na-virtualization-platform.yang
26986 example: __CVLAN-TAG__
26987 - name: resource-version
26989 description: resource-version for concurrency
26992 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
26996 summary: returns cvlan-tags
26997 description: returns cvlan-tags
26998 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
27004 description: successful operation
27006 $ref: "#/getDefinitions/cvlan-tags"
27008 description: Response codes found in [response codes](https://wiki.onap.org/).
27012 description: Unique id of VNF. This is unique across the graph.
27015 example: __VNF-ID__
27016 - name: interface-id
27018 description: Unique ID of the interface
27021 example: __INTERFACE-ID__
27028 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
27032 summary: see node definition for valid relationships
27033 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27042 description: Response codes found in [response codes](https://wiki.onap.org/).
27046 description: Unique id of VNF. This is unique across the graph.
27049 example: __VNF-ID__
27050 - name: interface-id
27052 description: Unique ID of the interface
27055 example: __INTERFACE-ID__
27058 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
27061 $ref: "#/definitions/relationship"
27065 summary: delete an existing relationship
27066 description: delete an existing relationship
27067 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27076 description: Response codes found in [response codes](https://wiki.onap.org/).
27080 description: Unique id of VNF. This is unique across the graph.
27083 example: __VNF-ID__
27084 - name: interface-id
27086 description: Unique ID of the interface
27089 example: __INTERFACE-ID__
27090 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
27094 summary: returns port-group
27095 description: returns port-group
27096 operationId: getNetworkVcesVcePortGroupsPortGroup
27102 description: successful operation
27104 $ref: "#/getDefinitions/port-group"
27106 description: Response codes found in [response codes](https://wiki.onap.org/).
27110 description: Unique id of VNF. This is unique across the graph.
27113 example: __VNF-ID__
27114 - name: interface-id
27116 description: Unique ID of the interface
27119 example: __INTERFACE-ID__
27123 summary: create or update an existing port-group
27125 Create or update an existing port-group.
27127 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27128 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
27137 description: Response codes found in [response codes](https://wiki.onap.org/).
27141 description: Unique id of VNF. This is unique across the graph.
27144 example: __VNF-ID__
27145 - name: interface-id
27147 description: Unique ID of the interface
27150 example: __INTERFACE-ID__
27153 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
27156 $ref: "#/definitions/port-group"
27160 summary: update an existing port-group
27162 Update an existing port-group
27164 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27165 The PUT operation will entirely replace an existing object.
27166 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27168 Other differences between PUT and PATCH are:
27170 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27171 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27172 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27173 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
27182 description: Response codes found in [response codes](https://wiki.onap.org/).
27186 description: Unique id of VNF. This is unique across the graph.
27189 example: __VNF-ID__
27190 - name: interface-id
27192 description: Unique ID of the interface
27195 example: __INTERFACE-ID__
27198 description: port-group object that needs to be updated.
27201 $ref: "#/patchDefinitions/port-group"
27205 summary: delete an existing port-group
27206 description: delete an existing port-group
27207 operationId: deleteNetworkVcesVcePortGroupsPortGroup
27216 description: Response codes found in [response codes](https://wiki.onap.org/).
27220 description: Unique id of VNF. This is unique across the graph.
27223 example: __VNF-ID__
27224 - name: interface-id
27226 description: Unique ID of the interface
27229 example: __INTERFACE-ID__
27230 - name: resource-version
27232 description: resource-version for concurrency
27235 /network/vces/vce/{vnf-id}/port-groups:
27239 summary: returns port-groups
27240 description: returns port-groups
27241 operationId: getNetworkVcesVcePortGroups
27247 description: successful operation
27249 $ref: "#/getDefinitions/port-groups"
27251 description: Response codes found in [response codes](https://wiki.onap.org/).
27255 description: Unique id of VNF. This is unique across the graph.
27258 example: __VNF-ID__
27259 - name: interface-id
27264 - name: port-group-id
27269 - name: switch-name
27274 - name: heat-stack-id
27279 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
27283 summary: see node definition for valid relationships
27284 operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
27293 description: Response codes found in [response codes](https://wiki.onap.org/).
27297 description: Unique id of VNF. This is unique across the graph.
27300 example: __VNF-ID__
27303 description: Unique ID for the license group the resource belongs to, should be uuid.
27306 example: __GROUP-UUID__
27307 - name: resource-uuid
27309 description: Unique ID of a license resource.
27312 example: __RESOURCE-UUID__
27315 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
27318 $ref: "#/definitions/relationship"
27322 summary: delete an existing relationship
27323 description: delete an existing relationship
27324 operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
27333 description: Response codes found in [response codes](https://wiki.onap.org/).
27337 description: Unique id of VNF. This is unique across the graph.
27340 example: __VNF-ID__
27343 description: Unique ID for the license group the resource belongs to, should be uuid.
27346 example: __GROUP-UUID__
27347 - name: resource-uuid
27349 description: Unique ID of a license resource.
27352 example: __RESOURCE-UUID__
27353 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
27357 summary: returns license
27358 description: returns license
27359 operationId: getNetworkVcesVceLicensesLicense
27365 description: successful operation
27367 $ref: "#/getDefinitions/license"
27369 description: Response codes found in [response codes](https://wiki.onap.org/).
27373 description: Unique id of VNF. This is unique across the graph.
27376 example: __VNF-ID__
27379 description: Unique ID for the license group the resource belongs to, should be uuid.
27382 example: __GROUP-UUID__
27383 - name: resource-uuid
27385 description: Unique ID of a license resource.
27388 example: __RESOURCE-UUID__
27392 summary: create or update an existing license
27394 Create or update an existing license.
27396 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27397 operationId: createOrUpdateNetworkVcesVceLicensesLicense
27406 description: Response codes found in [response codes](https://wiki.onap.org/).
27410 description: Unique id of VNF. This is unique across the graph.
27413 example: __VNF-ID__
27416 description: Unique ID for the license group the resource belongs to, should be uuid.
27419 example: __GROUP-UUID__
27420 - name: resource-uuid
27422 description: Unique ID of a license resource.
27425 example: __RESOURCE-UUID__
27428 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
27431 $ref: "#/definitions/license"
27435 summary: update an existing license
27437 Update an existing license
27439 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27440 The PUT operation will entirely replace an existing object.
27441 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27443 Other differences between PUT and PATCH are:
27445 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27446 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27447 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27448 operationId: UpdateNetworkVcesVceLicensesLicense
27457 description: Response codes found in [response codes](https://wiki.onap.org/).
27461 description: Unique id of VNF. This is unique across the graph.
27464 example: __VNF-ID__
27467 description: Unique ID for the license group the resource belongs to, should be uuid.
27470 example: __GROUP-UUID__
27471 - name: resource-uuid
27473 description: Unique ID of a license resource.
27476 example: __RESOURCE-UUID__
27479 description: license object that needs to be updated.
27482 $ref: "#/patchDefinitions/license"
27486 summary: delete an existing license
27487 description: delete an existing license
27488 operationId: deleteNetworkVcesVceLicensesLicense
27497 description: Response codes found in [response codes](https://wiki.onap.org/).
27501 description: Unique id of VNF. This is unique across the graph.
27504 example: __VNF-ID__
27507 description: Unique ID for the license group the resource belongs to, should be uuid.
27510 example: __GROUP-UUID__
27511 - name: resource-uuid
27513 description: Unique ID of a license resource.
27516 example: __RESOURCE-UUID__
27517 - name: resource-version
27519 description: resource-version for concurrency
27522 /network/vces/vce/{vnf-id}/licenses:
27526 summary: returns licenses
27527 description: returns licenses
27528 operationId: getNetworkVcesVceLicenses
27534 description: successful operation
27536 $ref: "#/getDefinitions/licenses"
27538 description: Response codes found in [response codes](https://wiki.onap.org/).
27542 description: Unique id of VNF. This is unique across the graph.
27545 example: __VNF-ID__
27551 - name: resource-uuid
27556 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
27560 summary: see node definition for valid relationships
27561 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
27570 description: Response codes found in [response codes](https://wiki.onap.org/).
27574 description: Unique id of VNF. This is unique across the graph.
27577 example: __VNF-ID__
27580 description: Unique ID for the entitlement group the resource comes from, should be uuid.
27583 example: __GROUP-UUID__
27584 - name: resource-uuid
27586 description: Unique ID of an entitlement resource.
27589 example: __RESOURCE-UUID__
27592 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
27595 $ref: "#/definitions/relationship"
27599 summary: delete an existing relationship
27600 description: delete an existing relationship
27601 operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
27610 description: Response codes found in [response codes](https://wiki.onap.org/).
27614 description: Unique id of VNF. This is unique across the graph.
27617 example: __VNF-ID__
27620 description: Unique ID for the entitlement group the resource comes from, should be uuid.
27623 example: __GROUP-UUID__
27624 - name: resource-uuid
27626 description: Unique ID of an entitlement resource.
27629 example: __RESOURCE-UUID__
27630 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
27634 summary: returns entitlement
27635 description: returns entitlement
27636 operationId: getNetworkVcesVceEntitlementsEntitlement
27642 description: successful operation
27644 $ref: "#/getDefinitions/entitlement"
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__
27656 description: Unique ID for the entitlement group the resource comes from, should be uuid.
27659 example: __GROUP-UUID__
27660 - name: resource-uuid
27662 description: Unique ID of an entitlement resource.
27665 example: __RESOURCE-UUID__
27669 summary: create or update an existing entitlement
27671 Create or update an existing entitlement.
27673 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27674 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
27683 description: Response codes found in [response codes](https://wiki.onap.org/).
27687 description: Unique id of VNF. This is unique across the graph.
27690 example: __VNF-ID__
27693 description: Unique ID for the entitlement group the resource comes from, should be uuid.
27696 example: __GROUP-UUID__
27697 - name: resource-uuid
27699 description: Unique ID of an entitlement resource.
27702 example: __RESOURCE-UUID__
27705 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
27708 $ref: "#/definitions/entitlement"
27712 summary: update an existing entitlement
27714 Update an existing entitlement
27716 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27717 The PUT operation will entirely replace an existing object.
27718 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27720 Other differences between PUT and PATCH are:
27722 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27723 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27724 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27725 operationId: UpdateNetworkVcesVceEntitlementsEntitlement
27734 description: Response codes found in [response codes](https://wiki.onap.org/).
27738 description: Unique id of VNF. This is unique across the graph.
27741 example: __VNF-ID__
27744 description: Unique ID for the entitlement group the resource comes from, should be uuid.
27747 example: __GROUP-UUID__
27748 - name: resource-uuid
27750 description: Unique ID of an entitlement resource.
27753 example: __RESOURCE-UUID__
27756 description: entitlement object that needs to be updated.
27759 $ref: "#/patchDefinitions/entitlement"
27763 summary: delete an existing entitlement
27764 description: delete an existing entitlement
27765 operationId: deleteNetworkVcesVceEntitlementsEntitlement
27774 description: Response codes found in [response codes](https://wiki.onap.org/).
27778 description: Unique id of VNF. This is unique across the graph.
27781 example: __VNF-ID__
27784 description: Unique ID for the entitlement group the resource comes from, should be uuid.
27787 example: __GROUP-UUID__
27788 - name: resource-uuid
27790 description: Unique ID of an entitlement resource.
27793 example: __RESOURCE-UUID__
27794 - name: resource-version
27796 description: resource-version for concurrency
27799 /network/vces/vce/{vnf-id}/entitlements:
27803 summary: returns entitlements
27804 description: returns entitlements
27805 operationId: getNetworkVcesVceEntitlements
27811 description: successful operation
27813 $ref: "#/getDefinitions/entitlements"
27815 description: Response codes found in [response codes](https://wiki.onap.org/).
27819 description: Unique id of VNF. This is unique across the graph.
27822 example: __VNF-ID__
27828 - name: resource-uuid
27833 /network/vces/vce/{vnf-id}/relationship-list/relationship:
27837 summary: see node definition for valid relationships
27838 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
27847 description: Response codes found in [response codes](https://wiki.onap.org/).
27851 description: Unique id of VNF. This is unique across the graph.
27854 example: __VNF-ID__
27857 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)
27860 $ref: "#/definitions/relationship"
27864 summary: delete an existing relationship
27865 description: delete an existing relationship
27866 operationId: deleteNetworkVcesVceRelationshipListRelationship
27875 description: Response codes found in [response codes](https://wiki.onap.org/).
27879 description: Unique id of VNF. This is unique across the graph.
27882 example: __VNF-ID__
27883 /network/vces/vce/{vnf-id}:
27887 summary: returns vce
27888 description: returns vce
27889 operationId: getNetworkVcesVce
27895 description: successful operation
27897 $ref: "#/getDefinitions/vce"
27899 description: Response codes found in [response codes](https://wiki.onap.org/).
27903 description: Unique id of VNF. This is unique across the graph.
27906 example: __VNF-ID__
27910 summary: create or update an existing vce
27912 Create or update an existing vce.
27914 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27915 operationId: createOrUpdateNetworkVcesVce
27924 description: Response codes found in [response codes](https://wiki.onap.org/).
27928 description: Unique id of VNF. This is unique across the graph.
27931 example: __VNF-ID__
27934 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)
27937 $ref: "#/definitions/vce"
27941 summary: update an existing vce
27943 Update an existing vce
27945 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27946 The PUT operation will entirely replace an existing object.
27947 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27949 Other differences between PUT and PATCH are:
27951 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27952 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27953 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27954 operationId: UpdateNetworkVcesVce
27963 description: Response codes found in [response codes](https://wiki.onap.org/).
27967 description: Unique id of VNF. This is unique across the graph.
27970 example: __VNF-ID__
27973 description: vce object that needs to be updated.
27976 $ref: "#/patchDefinitions/vce"
27980 summary: delete an existing vce
27981 description: delete an existing vce
27982 operationId: deleteNetworkVcesVce
27991 description: Response codes found in [response codes](https://wiki.onap.org/).
27995 description: Unique id of VNF. This is unique across the graph.
27998 example: __VNF-ID__
27999 - name: resource-version
28001 description: resource-version for concurrency
28008 summary: returns vces
28009 description: returns vces
28010 operationId: getNetworkVces
28016 description: successful operation
28018 $ref: "#/getDefinitions/vces"
28020 description: Response codes found in [response codes](https://wiki.onap.org/).
28047 - name: regional-resource-zone
28052 - name: prov-status
28057 - name: heat-stack-id
28067 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
28071 summary: see node definition for valid relationships
28072 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
28081 description: Response codes found in [response codes](https://wiki.onap.org/).
28085 description: Unique ID of vnfc.
28088 example: __VNFC-NAME__
28091 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)
28094 $ref: "#/definitions/relationship"
28098 summary: delete an existing relationship
28099 description: delete an existing relationship
28100 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
28109 description: Response codes found in [response codes](https://wiki.onap.org/).
28113 description: Unique ID of vnfc.
28116 example: __VNFC-NAME__
28117 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
28121 summary: see node definition for valid relationships
28122 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
28131 description: Response codes found in [response codes](https://wiki.onap.org/).
28135 description: Unique ID of vnfc.
28138 example: __VNFC-NAME__
28139 - name: l3-interface-ipv4-address
28141 description: IP address
28144 example: __L3-INTERFACE-IPV4-ADDRESS__
28147 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
28150 $ref: "#/definitions/relationship"
28154 summary: delete an existing relationship
28155 description: delete an existing relationship
28156 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
28165 description: Response codes found in [response codes](https://wiki.onap.org/).
28169 description: Unique ID of vnfc.
28172 example: __VNFC-NAME__
28173 - name: l3-interface-ipv4-address
28175 description: IP address
28178 example: __L3-INTERFACE-IPV4-ADDRESS__
28179 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
28183 summary: returns l3-interface-ipv4-address-list
28184 description: returns l3-interface-ipv4-address-list
28185 operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
28191 description: successful operation
28193 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28195 description: Response codes found in [response codes](https://wiki.onap.org/).
28199 description: Unique ID of vnfc.
28202 example: __VNFC-NAME__
28203 - name: l3-interface-ipv4-address
28205 description: IP address
28208 example: __L3-INTERFACE-IPV4-ADDRESS__
28212 summary: create or update an existing l3-interface-ipv4-address-list
28214 Create or update an existing l3-interface-ipv4-address-list.
28216 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28217 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
28226 description: Response codes found in [response codes](https://wiki.onap.org/).
28230 description: Unique ID of vnfc.
28233 example: __VNFC-NAME__
28234 - name: l3-interface-ipv4-address
28236 description: IP address
28239 example: __L3-INTERFACE-IPV4-ADDRESS__
28242 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
28245 $ref: "#/definitions/l3-interface-ipv4-address-list"
28249 summary: update an existing l3-interface-ipv4-address-list
28251 Update an existing l3-interface-ipv4-address-list
28253 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28254 The PUT operation will entirely replace an existing object.
28255 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28257 Other differences between PUT and PATCH are:
28259 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28260 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28261 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28262 operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
28271 description: Response codes found in [response codes](https://wiki.onap.org/).
28275 description: Unique ID of vnfc.
28278 example: __VNFC-NAME__
28279 - name: l3-interface-ipv4-address
28281 description: IP address
28284 example: __L3-INTERFACE-IPV4-ADDRESS__
28287 description: l3-interface-ipv4-address-list object that needs to be updated.
28290 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28294 summary: delete an existing l3-interface-ipv4-address-list
28295 description: delete an existing l3-interface-ipv4-address-list
28296 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
28305 description: Response codes found in [response codes](https://wiki.onap.org/).
28309 description: Unique ID of vnfc.
28312 example: __VNFC-NAME__
28313 - name: l3-interface-ipv4-address
28315 description: IP address
28318 example: __L3-INTERFACE-IPV4-ADDRESS__
28319 - name: resource-version
28321 description: resource-version for concurrency
28324 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
28328 summary: see node definition for valid relationships
28329 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
28338 description: Response codes found in [response codes](https://wiki.onap.org/).
28342 description: Unique ID of vnfc.
28345 example: __VNFC-NAME__
28346 - name: l3-interface-ipv6-address
28348 description: IP address
28351 example: __L3-INTERFACE-IPV6-ADDRESS__
28354 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
28357 $ref: "#/definitions/relationship"
28361 summary: delete an existing relationship
28362 description: delete an existing relationship
28363 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
28372 description: Response codes found in [response codes](https://wiki.onap.org/).
28376 description: Unique ID of vnfc.
28379 example: __VNFC-NAME__
28380 - name: l3-interface-ipv6-address
28382 description: IP address
28385 example: __L3-INTERFACE-IPV6-ADDRESS__
28386 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
28390 summary: returns l3-interface-ipv6-address-list
28391 description: returns l3-interface-ipv6-address-list
28392 operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
28398 description: successful operation
28400 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28402 description: Response codes found in [response codes](https://wiki.onap.org/).
28406 description: Unique ID of vnfc.
28409 example: __VNFC-NAME__
28410 - name: l3-interface-ipv6-address
28412 description: IP address
28415 example: __L3-INTERFACE-IPV6-ADDRESS__
28419 summary: create or update an existing l3-interface-ipv6-address-list
28421 Create or update an existing l3-interface-ipv6-address-list.
28423 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28424 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
28433 description: Response codes found in [response codes](https://wiki.onap.org/).
28437 description: Unique ID of vnfc.
28440 example: __VNFC-NAME__
28441 - name: l3-interface-ipv6-address
28443 description: IP address
28446 example: __L3-INTERFACE-IPV6-ADDRESS__
28449 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
28452 $ref: "#/definitions/l3-interface-ipv6-address-list"
28456 summary: update an existing l3-interface-ipv6-address-list
28458 Update an existing l3-interface-ipv6-address-list
28460 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28461 The PUT operation will entirely replace an existing object.
28462 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28464 Other differences between PUT and PATCH are:
28466 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28467 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28468 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28469 operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
28478 description: Response codes found in [response codes](https://wiki.onap.org/).
28482 description: Unique ID of vnfc.
28485 example: __VNFC-NAME__
28486 - name: l3-interface-ipv6-address
28488 description: IP address
28491 example: __L3-INTERFACE-IPV6-ADDRESS__
28494 description: l3-interface-ipv6-address-list object that needs to be updated.
28497 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28501 summary: delete an existing l3-interface-ipv6-address-list
28502 description: delete an existing l3-interface-ipv6-address-list
28503 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
28512 description: Response codes found in [response codes](https://wiki.onap.org/).
28516 description: Unique ID of vnfc.
28519 example: __VNFC-NAME__
28520 - name: l3-interface-ipv6-address
28522 description: IP address
28525 example: __L3-INTERFACE-IPV6-ADDRESS__
28526 - name: resource-version
28528 description: resource-version for concurrency
28531 /network/vnfcs/vnfc/{vnfc-name}:
28535 summary: returns vnfc
28536 description: returns vnfc
28537 operationId: getNetworkVnfcsVnfc
28543 description: successful operation
28545 $ref: "#/getDefinitions/vnfc"
28547 description: Response codes found in [response codes](https://wiki.onap.org/).
28551 description: Unique ID of vnfc.
28554 example: __VNFC-NAME__
28558 summary: create or update an existing vnfc
28560 Create or update an existing vnfc.
28562 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28563 operationId: createOrUpdateNetworkVnfcsVnfc
28572 description: Response codes found in [response codes](https://wiki.onap.org/).
28576 description: Unique ID of vnfc.
28579 example: __VNFC-NAME__
28582 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)
28585 $ref: "#/definitions/vnfc"
28589 summary: update an existing vnfc
28591 Update an existing vnfc
28593 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28594 The PUT operation will entirely replace an existing object.
28595 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28597 Other differences between PUT and PATCH are:
28599 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28600 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28601 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28602 operationId: UpdateNetworkVnfcsVnfc
28611 description: Response codes found in [response codes](https://wiki.onap.org/).
28615 description: Unique ID of vnfc.
28618 example: __VNFC-NAME__
28621 description: vnfc object that needs to be updated.
28624 $ref: "#/patchDefinitions/vnfc"
28628 summary: delete an existing vnfc
28629 description: delete an existing vnfc
28630 operationId: deleteNetworkVnfcsVnfc
28639 description: Response codes found in [response codes](https://wiki.onap.org/).
28643 description: Unique ID of vnfc.
28646 example: __VNFC-NAME__
28647 - name: resource-version
28649 description: resource-version for concurrency
28656 summary: returns vnfcs
28657 description: returns vnfcs
28658 operationId: getNetworkVnfcs
28664 description: successful operation
28666 $ref: "#/getDefinitions/vnfcs"
28668 description: Response codes found in [response codes](https://wiki.onap.org/).
28675 - name: nfc-naming-code
28680 - name: nfc-function
28685 - name: prov-status
28690 - name: ipaddress-v4-oam-vip
28700 - name: is-closed-loop-disabled
28705 - name: group-notation
28710 - name: model-invariant-id
28715 - name: model-version-id
28720 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
28724 summary: see node definition for valid relationships
28725 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
28734 description: Response codes found in [response codes](https://wiki.onap.org/).
28738 description: Network ID, should be uuid. Unique across A&AI.
28741 example: __NETWORK-ID__
28744 description: Subnet ID, should be UUID.
28747 example: __SUBNET-ID__
28748 - name: host-route-id
28750 description: host-route id
28753 example: __HOST-ROUTE-ID__
28756 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
28759 $ref: "#/definitions/relationship"
28763 summary: delete an existing relationship
28764 description: delete an existing relationship
28765 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
28774 description: Response codes found in [response codes](https://wiki.onap.org/).
28778 description: Network ID, should be uuid. Unique across A&AI.
28781 example: __NETWORK-ID__
28784 description: Subnet ID, should be UUID.
28787 example: __SUBNET-ID__
28788 - name: host-route-id
28790 description: host-route id
28793 example: __HOST-ROUTE-ID__
28794 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
28798 summary: returns host-route
28799 description: returns host-route
28800 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
28806 description: successful operation
28808 $ref: "#/getDefinitions/host-route"
28810 description: Response codes found in [response codes](https://wiki.onap.org/).
28814 description: Network ID, should be uuid. Unique across A&AI.
28817 example: __NETWORK-ID__
28820 description: Subnet ID, should be UUID.
28823 example: __SUBNET-ID__
28824 - name: host-route-id
28826 description: host-route id
28829 example: __HOST-ROUTE-ID__
28833 summary: create or update an existing host-route
28835 Create or update an existing host-route.
28837 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28838 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
28847 description: Response codes found in [response codes](https://wiki.onap.org/).
28851 description: Network ID, should be uuid. Unique across A&AI.
28854 example: __NETWORK-ID__
28857 description: Subnet ID, should be UUID.
28860 example: __SUBNET-ID__
28861 - name: host-route-id
28863 description: host-route id
28866 example: __HOST-ROUTE-ID__
28869 description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
28872 $ref: "#/definitions/host-route"
28876 summary: update an existing host-route
28878 Update an existing host-route
28880 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28881 The PUT operation will entirely replace an existing object.
28882 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28884 Other differences between PUT and PATCH are:
28886 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28887 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28888 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28889 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
28898 description: Response codes found in [response codes](https://wiki.onap.org/).
28902 description: Network ID, should be uuid. Unique across A&AI.
28905 example: __NETWORK-ID__
28908 description: Subnet ID, should be UUID.
28911 example: __SUBNET-ID__
28912 - name: host-route-id
28914 description: host-route id
28917 example: __HOST-ROUTE-ID__
28920 description: host-route object that needs to be updated.
28923 $ref: "#/patchDefinitions/host-route"
28927 summary: delete an existing host-route
28928 description: delete an existing host-route
28929 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
28938 description: Response codes found in [response codes](https://wiki.onap.org/).
28942 description: Network ID, should be uuid. Unique across A&AI.
28945 example: __NETWORK-ID__
28948 description: Subnet ID, should be UUID.
28951 example: __SUBNET-ID__
28952 - name: host-route-id
28954 description: host-route id
28957 example: __HOST-ROUTE-ID__
28958 - name: resource-version
28960 description: resource-version for concurrency
28963 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
28967 summary: returns host-routes
28968 description: returns host-routes
28969 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
28975 description: successful operation
28977 $ref: "#/getDefinitions/host-routes"
28979 description: Response codes found in [response codes](https://wiki.onap.org/).
28983 description: Network ID, should be uuid. Unique across A&AI.
28986 example: __NETWORK-ID__
28989 description: Subnet ID, should be UUID.
28992 example: __SUBNET-ID__
28993 - name: host-route-id
28998 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
29002 summary: see node definition for valid relationships
29003 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29012 description: Response codes found in [response codes](https://wiki.onap.org/).
29016 description: Network ID, should be uuid. Unique across A&AI.
29019 example: __NETWORK-ID__
29022 description: Subnet ID, should be UUID.
29025 example: __SUBNET-ID__
29028 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29031 $ref: "#/definitions/relationship"
29035 summary: delete an existing relationship
29036 description: delete an existing relationship
29037 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29046 description: Response codes found in [response codes](https://wiki.onap.org/).
29050 description: Network ID, should be uuid. Unique across A&AI.
29053 example: __NETWORK-ID__
29056 description: Subnet ID, should be UUID.
29059 example: __SUBNET-ID__
29060 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
29064 summary: returns subnet
29065 description: returns subnet
29066 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
29072 description: successful operation
29074 $ref: "#/getDefinitions/subnet"
29076 description: Response codes found in [response codes](https://wiki.onap.org/).
29080 description: Network ID, should be uuid. Unique across A&AI.
29083 example: __NETWORK-ID__
29086 description: Subnet ID, should be UUID.
29089 example: __SUBNET-ID__
29093 summary: create or update an existing subnet
29095 Create or update an existing subnet.
29097 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29098 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29107 description: Response codes found in [response codes](https://wiki.onap.org/).
29111 description: Network ID, should be uuid. Unique across A&AI.
29114 example: __NETWORK-ID__
29117 description: Subnet ID, should be UUID.
29120 example: __SUBNET-ID__
29123 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29126 $ref: "#/definitions/subnet"
29130 summary: update an existing subnet
29132 Update an existing subnet
29134 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29135 The PUT operation will entirely replace an existing object.
29136 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29138 Other differences between PUT and PATCH are:
29140 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29141 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29142 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29143 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29152 description: Response codes found in [response codes](https://wiki.onap.org/).
29156 description: Network ID, should be uuid. Unique across A&AI.
29159 example: __NETWORK-ID__
29162 description: Subnet ID, should be UUID.
29165 example: __SUBNET-ID__
29168 description: subnet object that needs to be updated.
29171 $ref: "#/patchDefinitions/subnet"
29175 summary: delete an existing subnet
29176 description: delete an existing subnet
29177 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
29186 description: Response codes found in [response codes](https://wiki.onap.org/).
29190 description: Network ID, should be uuid. Unique across A&AI.
29193 example: __NETWORK-ID__
29196 description: Subnet ID, should be UUID.
29199 example: __SUBNET-ID__
29200 - name: resource-version
29202 description: resource-version for concurrency
29205 /network/l3-networks/l3-network/{network-id}/subnets:
29209 summary: returns subnets
29210 description: returns subnets
29211 operationId: getNetworkL3NetworksL3NetworkSubnets
29217 description: successful operation
29219 $ref: "#/getDefinitions/subnets"
29221 description: Response codes found in [response codes](https://wiki.onap.org/).
29225 description: Network ID, should be uuid. Unique across A&AI.
29228 example: __NETWORK-ID__
29234 - name: subnet-name
29239 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
29243 summary: see node definition for valid relationships
29244 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29253 description: Response codes found in [response codes](https://wiki.onap.org/).
29257 description: Network ID, should be uuid. Unique across A&AI.
29260 example: __NETWORK-ID__
29261 - name: vlan-id-inner
29267 example: __VLAN-ID-INNER__
29270 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29273 $ref: "#/definitions/relationship"
29277 summary: delete an existing relationship
29278 description: delete an existing relationship
29279 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29288 description: Response codes found in [response codes](https://wiki.onap.org/).
29292 description: Network ID, should be uuid. Unique across A&AI.
29295 example: __NETWORK-ID__
29296 - name: vlan-id-inner
29302 example: __VLAN-ID-INNER__
29303 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
29307 summary: returns ctag-assignment
29308 description: returns ctag-assignment
29309 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29315 description: successful operation
29317 $ref: "#/getDefinitions/ctag-assignment"
29319 description: Response codes found in [response codes](https://wiki.onap.org/).
29323 description: Network ID, should be uuid. Unique across A&AI.
29326 example: __NETWORK-ID__
29327 - name: vlan-id-inner
29333 example: __VLAN-ID-INNER__
29337 summary: create or update an existing ctag-assignment
29339 Create or update an existing ctag-assignment.
29341 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29342 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29351 description: Response codes found in [response codes](https://wiki.onap.org/).
29355 description: Network ID, should be uuid. Unique across A&AI.
29358 example: __NETWORK-ID__
29359 - name: vlan-id-inner
29365 example: __VLAN-ID-INNER__
29368 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29371 $ref: "#/definitions/ctag-assignment"
29375 summary: update an existing ctag-assignment
29377 Update an existing ctag-assignment
29379 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29380 The PUT operation will entirely replace an existing object.
29381 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29383 Other differences between PUT and PATCH are:
29385 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29386 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29387 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29388 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29397 description: Response codes found in [response codes](https://wiki.onap.org/).
29401 description: Network ID, should be uuid. Unique across A&AI.
29404 example: __NETWORK-ID__
29405 - name: vlan-id-inner
29411 example: __VLAN-ID-INNER__
29414 description: ctag-assignment object that needs to be updated.
29417 $ref: "#/patchDefinitions/ctag-assignment"
29421 summary: delete an existing ctag-assignment
29422 description: delete an existing ctag-assignment
29423 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29432 description: Response codes found in [response codes](https://wiki.onap.org/).
29436 description: Network ID, should be uuid. Unique across A&AI.
29439 example: __NETWORK-ID__
29440 - name: vlan-id-inner
29446 example: __VLAN-ID-INNER__
29447 - name: resource-version
29449 description: resource-version for concurrency
29452 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
29456 summary: returns ctag-assignments
29457 description: returns ctag-assignments
29458 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
29464 description: successful operation
29466 $ref: "#/getDefinitions/ctag-assignments"
29468 description: Response codes found in [response codes](https://wiki.onap.org/).
29472 description: Network ID, should be uuid. Unique across A&AI.
29475 example: __NETWORK-ID__
29476 - name: vlan-id-inner
29482 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
29486 summary: see node definition for valid relationships
29487 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
29496 description: Response codes found in [response codes](https://wiki.onap.org/).
29500 description: Network ID, should be uuid. Unique across A&AI.
29503 example: __NETWORK-ID__
29504 - name: segmentation-id
29506 description: Route Table Reference id, UUID assigned to this instance.
29509 example: __SEGMENTATION-ID__
29512 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
29515 $ref: "#/definitions/relationship"
29519 summary: delete an existing relationship
29520 description: delete an existing relationship
29521 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
29530 description: Response codes found in [response codes](https://wiki.onap.org/).
29534 description: Network ID, should be uuid. Unique across A&AI.
29537 example: __NETWORK-ID__
29538 - name: segmentation-id
29540 description: Route Table Reference id, UUID assigned to this instance.
29543 example: __SEGMENTATION-ID__
29544 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
29548 summary: returns segmentation-assignment
29549 description: returns segmentation-assignment
29550 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29556 description: successful operation
29558 $ref: "#/getDefinitions/segmentation-assignment"
29560 description: Response codes found in [response codes](https://wiki.onap.org/).
29564 description: Network ID, should be uuid. Unique across A&AI.
29567 example: __NETWORK-ID__
29568 - name: segmentation-id
29570 description: Route Table Reference id, UUID assigned to this instance.
29573 example: __SEGMENTATION-ID__
29577 summary: create or update an existing segmentation-assignment
29579 Create or update an existing segmentation-assignment.
29581 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29582 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29591 description: Response codes found in [response codes](https://wiki.onap.org/).
29595 description: Network ID, should be uuid. Unique across A&AI.
29598 example: __NETWORK-ID__
29599 - name: segmentation-id
29601 description: Route Table Reference id, UUID assigned to this instance.
29604 example: __SEGMENTATION-ID__
29607 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
29610 $ref: "#/definitions/segmentation-assignment"
29614 summary: update an existing segmentation-assignment
29616 Update an existing segmentation-assignment
29618 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29619 The PUT operation will entirely replace an existing object.
29620 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29622 Other differences between PUT and PATCH are:
29624 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29625 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29626 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29627 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29636 description: Response codes found in [response codes](https://wiki.onap.org/).
29640 description: Network ID, should be uuid. Unique across A&AI.
29643 example: __NETWORK-ID__
29644 - name: segmentation-id
29646 description: Route Table Reference id, UUID assigned to this instance.
29649 example: __SEGMENTATION-ID__
29652 description: segmentation-assignment object that needs to be updated.
29655 $ref: "#/patchDefinitions/segmentation-assignment"
29659 summary: delete an existing segmentation-assignment
29660 description: delete an existing segmentation-assignment
29661 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29670 description: Response codes found in [response codes](https://wiki.onap.org/).
29674 description: Network ID, should be uuid. Unique across A&AI.
29677 example: __NETWORK-ID__
29678 - name: segmentation-id
29680 description: Route Table Reference id, UUID assigned to this instance.
29683 example: __SEGMENTATION-ID__
29684 - name: resource-version
29686 description: resource-version for concurrency
29689 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
29693 summary: returns segmentation-assignments
29694 description: returns segmentation-assignments
29695 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
29701 description: successful operation
29703 $ref: "#/getDefinitions/segmentation-assignments"
29705 description: Response codes found in [response codes](https://wiki.onap.org/).
29709 description: Network ID, should be uuid. Unique across A&AI.
29712 example: __NETWORK-ID__
29713 - name: segmentation-id
29718 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
29722 summary: see node definition for valid relationships
29723 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
29732 description: Response codes found in [response codes](https://wiki.onap.org/).
29736 description: Network ID, should be uuid. Unique across A&AI.
29739 example: __NETWORK-ID__
29742 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)
29745 $ref: "#/definitions/relationship"
29749 summary: delete an existing relationship
29750 description: delete an existing relationship
29751 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
29760 description: Response codes found in [response codes](https://wiki.onap.org/).
29764 description: Network ID, should be uuid. Unique across A&AI.
29767 example: __NETWORK-ID__
29768 /network/l3-networks/l3-network/{network-id}:
29772 summary: returns l3-network
29773 description: returns l3-network
29774 operationId: getNetworkL3NetworksL3Network
29780 description: successful operation
29782 $ref: "#/getDefinitions/l3-network"
29784 description: Response codes found in [response codes](https://wiki.onap.org/).
29788 description: Network ID, should be uuid. Unique across A&AI.
29791 example: __NETWORK-ID__
29795 summary: create or update an existing l3-network
29797 Create or update an existing l3-network.
29799 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29800 operationId: createOrUpdateNetworkL3NetworksL3Network
29809 description: Response codes found in [response codes](https://wiki.onap.org/).
29813 description: Network ID, should be uuid. Unique across A&AI.
29816 example: __NETWORK-ID__
29819 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)
29822 $ref: "#/definitions/l3-network"
29826 summary: update an existing l3-network
29828 Update an existing l3-network
29830 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29831 The PUT operation will entirely replace an existing object.
29832 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29834 Other differences between PUT and PATCH are:
29836 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29837 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29838 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29839 operationId: UpdateNetworkL3NetworksL3Network
29848 description: Response codes found in [response codes](https://wiki.onap.org/).
29852 description: Network ID, should be uuid. Unique across A&AI.
29855 example: __NETWORK-ID__
29858 description: l3-network object that needs to be updated.
29861 $ref: "#/patchDefinitions/l3-network"
29865 summary: delete an existing l3-network
29866 description: delete an existing l3-network
29867 operationId: deleteNetworkL3NetworksL3Network
29876 description: Response codes found in [response codes](https://wiki.onap.org/).
29880 description: Network ID, should be uuid. Unique across A&AI.
29883 example: __NETWORK-ID__
29884 - name: resource-version
29886 description: resource-version for concurrency
29889 /network/l3-networks:
29893 summary: returns l3-networks
29894 description: returns l3-networks
29895 operationId: getNetworkL3Networks
29901 description: successful operation
29903 $ref: "#/getDefinitions/l3-networks"
29905 description: Response codes found in [response codes](https://wiki.onap.org/).
29912 - name: network-name
29917 - name: network-role
29927 - name: heat-stack-id
29932 - name: contrail-network-fqdn
29937 - name: model-invariant-id
29942 - name: model-version-id
29947 - name: widget-model-id
29952 - name: widget-model-version
29957 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
29961 summary: see node definition for valid relationships
29962 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
29971 description: Response codes found in [response codes](https://wiki.onap.org/).
29973 - name: network-policy-id
29975 description: UUID representing unique key to this instance
29978 example: __NETWORK-POLICY-ID__
29981 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)
29984 $ref: "#/definitions/relationship"
29988 summary: delete an existing relationship
29989 description: delete an existing relationship
29990 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
29999 description: Response codes found in [response codes](https://wiki.onap.org/).
30001 - name: network-policy-id
30003 description: UUID representing unique key to this instance
30006 example: __NETWORK-POLICY-ID__
30007 /network/network-policies/network-policy/{network-policy-id}:
30011 summary: returns network-policy
30012 description: returns network-policy
30013 operationId: getNetworkNetworkPoliciesNetworkPolicy
30019 description: successful operation
30021 $ref: "#/getDefinitions/network-policy"
30023 description: Response codes found in [response codes](https://wiki.onap.org/).
30025 - name: network-policy-id
30027 description: UUID representing unique key to this instance
30030 example: __NETWORK-POLICY-ID__
30034 summary: create or update an existing network-policy
30036 Create or update an existing network-policy.
30038 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30039 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
30048 description: Response codes found in [response codes](https://wiki.onap.org/).
30050 - name: network-policy-id
30052 description: UUID representing unique key to this instance
30055 example: __NETWORK-POLICY-ID__
30058 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)
30061 $ref: "#/definitions/network-policy"
30065 summary: update an existing network-policy
30067 Update an existing network-policy
30069 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30070 The PUT operation will entirely replace an existing object.
30071 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30073 Other differences between PUT and PATCH are:
30075 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30076 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30077 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30078 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
30087 description: Response codes found in [response codes](https://wiki.onap.org/).
30089 - name: network-policy-id
30091 description: UUID representing unique key to this instance
30094 example: __NETWORK-POLICY-ID__
30097 description: network-policy object that needs to be updated.
30100 $ref: "#/patchDefinitions/network-policy"
30104 summary: delete an existing network-policy
30105 description: delete an existing network-policy
30106 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
30115 description: Response codes found in [response codes](https://wiki.onap.org/).
30117 - name: network-policy-id
30119 description: UUID representing unique key to this instance
30122 example: __NETWORK-POLICY-ID__
30123 - name: resource-version
30125 description: resource-version for concurrency
30128 /network/network-policies:
30132 summary: returns network-policies
30133 description: returns network-policies
30134 operationId: getNetworkNetworkPolicies
30140 description: successful operation
30142 $ref: "#/getDefinitions/network-policies"
30144 description: Response codes found in [response codes](https://wiki.onap.org/).
30146 - name: network-policy-id
30151 - name: network-policy-fqdn
30156 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
30160 summary: see node definition for valid relationships
30161 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
30170 description: Response codes found in [response codes](https://wiki.onap.org/).
30174 description: Unique id of VNF. This is unique across the graph.
30177 example: __VNF-ID__
30180 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)
30183 $ref: "#/definitions/relationship"
30187 summary: delete an existing relationship
30188 description: delete an existing relationship
30189 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
30198 description: Response codes found in [response codes](https://wiki.onap.org/).
30202 description: Unique id of VNF. This is unique across the graph.
30205 example: __VNF-ID__
30206 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
30210 summary: see node definition for valid relationships
30211 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30220 description: Response codes found in [response codes](https://wiki.onap.org/).
30224 description: Unique id of VNF. This is unique across the graph.
30227 example: __VNF-ID__
30228 - name: interface-name
30230 description: Name given to the interface
30233 example: __INTERFACE-NAME__
30234 - name: vlan-interface
30236 description: String that identifies the interface
30239 example: __VLAN-INTERFACE__
30242 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
30245 $ref: "#/definitions/relationship"
30249 summary: delete an existing relationship
30250 description: delete an existing relationship
30251 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30260 description: Response codes found in [response codes](https://wiki.onap.org/).
30264 description: Unique id of VNF. This is unique across the graph.
30267 example: __VNF-ID__
30268 - name: interface-name
30270 description: Name given to the interface
30273 example: __INTERFACE-NAME__
30274 - name: vlan-interface
30276 description: String that identifies the interface
30279 example: __VLAN-INTERFACE__
30280 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
30284 summary: see node definition for valid relationships
30285 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30294 description: Response codes found in [response codes](https://wiki.onap.org/).
30298 description: Unique id of VNF. This is unique across the graph.
30301 example: __VNF-ID__
30302 - name: interface-name
30304 description: Name given to the interface
30307 example: __INTERFACE-NAME__
30308 - name: vlan-interface
30310 description: String that identifies the interface
30313 example: __VLAN-INTERFACE__
30314 - name: l3-interface-ipv4-address
30316 description: IP address
30319 example: __L3-INTERFACE-IPV4-ADDRESS__
30322 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30325 $ref: "#/definitions/relationship"
30329 summary: delete an existing relationship
30330 description: delete an existing relationship
30331 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30340 description: Response codes found in [response codes](https://wiki.onap.org/).
30344 description: Unique id of VNF. This is unique across the graph.
30347 example: __VNF-ID__
30348 - name: interface-name
30350 description: Name given to the interface
30353 example: __INTERFACE-NAME__
30354 - name: vlan-interface
30356 description: String that identifies the interface
30359 example: __VLAN-INTERFACE__
30360 - name: l3-interface-ipv4-address
30362 description: IP address
30365 example: __L3-INTERFACE-IPV4-ADDRESS__
30366 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
30370 summary: returns l3-interface-ipv4-address-list
30371 description: returns l3-interface-ipv4-address-list
30372 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30378 description: successful operation
30380 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30382 description: Response codes found in [response codes](https://wiki.onap.org/).
30386 description: Unique id of VNF. This is unique across the graph.
30389 example: __VNF-ID__
30390 - name: interface-name
30392 description: Name given to the interface
30395 example: __INTERFACE-NAME__
30396 - name: vlan-interface
30398 description: String that identifies the interface
30401 example: __VLAN-INTERFACE__
30402 - name: l3-interface-ipv4-address
30404 description: IP address
30407 example: __L3-INTERFACE-IPV4-ADDRESS__
30411 summary: create or update an existing l3-interface-ipv4-address-list
30413 Create or update an existing l3-interface-ipv4-address-list.
30415 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30416 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30425 description: Response codes found in [response codes](https://wiki.onap.org/).
30429 description: Unique id of VNF. This is unique across the graph.
30432 example: __VNF-ID__
30433 - name: interface-name
30435 description: Name given to the interface
30438 example: __INTERFACE-NAME__
30439 - name: vlan-interface
30441 description: String that identifies the interface
30444 example: __VLAN-INTERFACE__
30445 - name: l3-interface-ipv4-address
30447 description: IP address
30450 example: __L3-INTERFACE-IPV4-ADDRESS__
30453 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30456 $ref: "#/definitions/l3-interface-ipv4-address-list"
30460 summary: update an existing l3-interface-ipv4-address-list
30462 Update an existing l3-interface-ipv4-address-list
30464 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30465 The PUT operation will entirely replace an existing object.
30466 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30468 Other differences between PUT and PATCH are:
30470 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30471 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30472 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30473 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30482 description: Response codes found in [response codes](https://wiki.onap.org/).
30486 description: Unique id of VNF. This is unique across the graph.
30489 example: __VNF-ID__
30490 - name: interface-name
30492 description: Name given to the interface
30495 example: __INTERFACE-NAME__
30496 - name: vlan-interface
30498 description: String that identifies the interface
30501 example: __VLAN-INTERFACE__
30502 - name: l3-interface-ipv4-address
30504 description: IP address
30507 example: __L3-INTERFACE-IPV4-ADDRESS__
30510 description: l3-interface-ipv4-address-list object that needs to be updated.
30513 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30517 summary: delete an existing l3-interface-ipv4-address-list
30518 description: delete an existing l3-interface-ipv4-address-list
30519 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30528 description: Response codes found in [response codes](https://wiki.onap.org/).
30532 description: Unique id of VNF. This is unique across the graph.
30535 example: __VNF-ID__
30536 - name: interface-name
30538 description: Name given to the interface
30541 example: __INTERFACE-NAME__
30542 - name: vlan-interface
30544 description: String that identifies the interface
30547 example: __VLAN-INTERFACE__
30548 - name: l3-interface-ipv4-address
30550 description: IP address
30553 example: __L3-INTERFACE-IPV4-ADDRESS__
30554 - name: resource-version
30556 description: resource-version for concurrency
30559 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
30563 summary: see node definition for valid relationships
30564 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30573 description: Response codes found in [response codes](https://wiki.onap.org/).
30577 description: Unique id of VNF. This is unique across the graph.
30580 example: __VNF-ID__
30581 - name: interface-name
30583 description: Name given to the interface
30586 example: __INTERFACE-NAME__
30587 - name: vlan-interface
30589 description: String that identifies the interface
30592 example: __VLAN-INTERFACE__
30593 - name: l3-interface-ipv6-address
30595 description: IP address
30598 example: __L3-INTERFACE-IPV6-ADDRESS__
30601 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
30604 $ref: "#/definitions/relationship"
30608 summary: delete an existing relationship
30609 description: delete an existing relationship
30610 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30619 description: Response codes found in [response codes](https://wiki.onap.org/).
30623 description: Unique id of VNF. This is unique across the graph.
30626 example: __VNF-ID__
30627 - name: interface-name
30629 description: Name given to the interface
30632 example: __INTERFACE-NAME__
30633 - name: vlan-interface
30635 description: String that identifies the interface
30638 example: __VLAN-INTERFACE__
30639 - name: l3-interface-ipv6-address
30641 description: IP address
30644 example: __L3-INTERFACE-IPV6-ADDRESS__
30645 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
30649 summary: returns l3-interface-ipv6-address-list
30650 description: returns l3-interface-ipv6-address-list
30651 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30657 description: successful operation
30659 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30661 description: Response codes found in [response codes](https://wiki.onap.org/).
30665 description: Unique id of VNF. This is unique across the graph.
30668 example: __VNF-ID__
30669 - name: interface-name
30671 description: Name given to the interface
30674 example: __INTERFACE-NAME__
30675 - name: vlan-interface
30677 description: String that identifies the interface
30680 example: __VLAN-INTERFACE__
30681 - name: l3-interface-ipv6-address
30683 description: IP address
30686 example: __L3-INTERFACE-IPV6-ADDRESS__
30690 summary: create or update an existing l3-interface-ipv6-address-list
30692 Create or update an existing l3-interface-ipv6-address-list.
30694 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30695 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30704 description: Response codes found in [response codes](https://wiki.onap.org/).
30708 description: Unique id of VNF. This is unique across the graph.
30711 example: __VNF-ID__
30712 - name: interface-name
30714 description: Name given to the interface
30717 example: __INTERFACE-NAME__
30718 - name: vlan-interface
30720 description: String that identifies the interface
30723 example: __VLAN-INTERFACE__
30724 - name: l3-interface-ipv6-address
30726 description: IP address
30729 example: __L3-INTERFACE-IPV6-ADDRESS__
30732 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
30735 $ref: "#/definitions/l3-interface-ipv6-address-list"
30739 summary: update an existing l3-interface-ipv6-address-list
30741 Update an existing l3-interface-ipv6-address-list
30743 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30744 The PUT operation will entirely replace an existing object.
30745 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30747 Other differences between PUT and PATCH are:
30749 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30750 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30751 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30752 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30761 description: Response codes found in [response codes](https://wiki.onap.org/).
30765 description: Unique id of VNF. This is unique across the graph.
30768 example: __VNF-ID__
30769 - name: interface-name
30771 description: Name given to the interface
30774 example: __INTERFACE-NAME__
30775 - name: vlan-interface
30777 description: String that identifies the interface
30780 example: __VLAN-INTERFACE__
30781 - name: l3-interface-ipv6-address
30783 description: IP address
30786 example: __L3-INTERFACE-IPV6-ADDRESS__
30789 description: l3-interface-ipv6-address-list object that needs to be updated.
30792 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30796 summary: delete an existing l3-interface-ipv6-address-list
30797 description: delete an existing l3-interface-ipv6-address-list
30798 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30807 description: Response codes found in [response codes](https://wiki.onap.org/).
30811 description: Unique id of VNF. This is unique across the graph.
30814 example: __VNF-ID__
30815 - name: interface-name
30817 description: Name given to the interface
30820 example: __INTERFACE-NAME__
30821 - name: vlan-interface
30823 description: String that identifies the interface
30826 example: __VLAN-INTERFACE__
30827 - name: l3-interface-ipv6-address
30829 description: IP address
30832 example: __L3-INTERFACE-IPV6-ADDRESS__
30833 - name: resource-version
30835 description: resource-version for concurrency
30838 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
30842 summary: returns vlan
30843 description: returns vlan
30844 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
30850 description: successful operation
30852 $ref: "#/getDefinitions/vlan"
30854 description: Response codes found in [response codes](https://wiki.onap.org/).
30858 description: Unique id of VNF. This is unique across the graph.
30861 example: __VNF-ID__
30862 - name: interface-name
30864 description: Name given to the interface
30867 example: __INTERFACE-NAME__
30868 - name: vlan-interface
30870 description: String that identifies the interface
30873 example: __VLAN-INTERFACE__
30877 summary: create or update an existing vlan
30879 Create or update an existing vlan.
30881 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30882 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
30891 description: Response codes found in [response codes](https://wiki.onap.org/).
30895 description: Unique id of VNF. This is unique across the graph.
30898 example: __VNF-ID__
30899 - name: interface-name
30901 description: Name given to the interface
30904 example: __INTERFACE-NAME__
30905 - name: vlan-interface
30907 description: String that identifies the interface
30910 example: __VLAN-INTERFACE__
30913 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
30916 $ref: "#/definitions/vlan"
30920 summary: update an existing vlan
30922 Update an existing vlan
30924 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30925 The PUT operation will entirely replace an existing object.
30926 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30928 Other differences between PUT and PATCH are:
30930 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30931 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30932 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30933 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
30942 description: Response codes found in [response codes](https://wiki.onap.org/).
30946 description: Unique id of VNF. This is unique across the graph.
30949 example: __VNF-ID__
30950 - name: interface-name
30952 description: Name given to the interface
30955 example: __INTERFACE-NAME__
30956 - name: vlan-interface
30958 description: String that identifies the interface
30961 example: __VLAN-INTERFACE__
30964 description: vlan object that needs to be updated.
30967 $ref: "#/patchDefinitions/vlan"
30971 summary: delete an existing vlan
30972 description: delete an existing vlan
30973 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
30982 description: Response codes found in [response codes](https://wiki.onap.org/).
30986 description: Unique id of VNF. This is unique across the graph.
30989 example: __VNF-ID__
30990 - name: interface-name
30992 description: Name given to the interface
30995 example: __INTERFACE-NAME__
30996 - name: vlan-interface
30998 description: String that identifies the interface
31001 example: __VLAN-INTERFACE__
31002 - name: resource-version
31004 description: resource-version for concurrency
31007 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
31011 summary: returns vlans
31012 description: returns vlans
31013 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
31019 description: successful operation
31021 $ref: "#/getDefinitions/vlans"
31023 description: Response codes found in [response codes](https://wiki.onap.org/).
31027 description: Unique id of VNF. This is unique across the graph.
31030 example: __VNF-ID__
31031 - name: interface-name
31033 description: Name given to the interface
31036 example: __INTERFACE-NAME__
31037 - name: vlan-interface
31042 - name: vlan-id-inner
31053 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
31057 summary: see node definition for valid relationships
31058 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31067 description: Response codes found in [response codes](https://wiki.onap.org/).
31071 description: Unique id of VNF. This is unique across the graph.
31074 example: __VNF-ID__
31075 - name: interface-name
31077 description: Name given to the interface
31080 example: __INTERFACE-NAME__
31083 description: PCI ID used to identify the sriov-vf
31086 example: __PCI-ID__
31089 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
31092 $ref: "#/definitions/relationship"
31096 summary: delete an existing relationship
31097 description: delete an existing relationship
31098 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31107 description: Response codes found in [response codes](https://wiki.onap.org/).
31111 description: Unique id of VNF. This is unique across the graph.
31114 example: __VNF-ID__
31115 - name: interface-name
31117 description: Name given to the interface
31120 example: __INTERFACE-NAME__
31123 description: PCI ID used to identify the sriov-vf
31126 example: __PCI-ID__
31127 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
31131 summary: returns sriov-vf
31132 description: returns sriov-vf
31133 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31139 description: successful operation
31141 $ref: "#/getDefinitions/sriov-vf"
31143 description: Response codes found in [response codes](https://wiki.onap.org/).
31147 description: Unique id of VNF. This is unique across the graph.
31150 example: __VNF-ID__
31151 - name: interface-name
31153 description: Name given to the interface
31156 example: __INTERFACE-NAME__
31159 description: PCI ID used to identify the sriov-vf
31162 example: __PCI-ID__
31166 summary: create or update an existing sriov-vf
31168 Create or update an existing sriov-vf.
31170 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31171 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31180 description: Response codes found in [response codes](https://wiki.onap.org/).
31184 description: Unique id of VNF. This is unique across the graph.
31187 example: __VNF-ID__
31188 - name: interface-name
31190 description: Name given to the interface
31193 example: __INTERFACE-NAME__
31196 description: PCI ID used to identify the sriov-vf
31199 example: __PCI-ID__
31202 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
31205 $ref: "#/definitions/sriov-vf"
31209 summary: update an existing sriov-vf
31211 Update an existing sriov-vf
31213 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31214 The PUT operation will entirely replace an existing object.
31215 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31217 Other differences between PUT and PATCH are:
31219 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31220 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31221 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31222 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31231 description: Response codes found in [response codes](https://wiki.onap.org/).
31235 description: Unique id of VNF. This is unique across the graph.
31238 example: __VNF-ID__
31239 - name: interface-name
31241 description: Name given to the interface
31244 example: __INTERFACE-NAME__
31247 description: PCI ID used to identify the sriov-vf
31250 example: __PCI-ID__
31253 description: sriov-vf object that needs to be updated.
31256 $ref: "#/patchDefinitions/sriov-vf"
31260 summary: delete an existing sriov-vf
31261 description: delete an existing sriov-vf
31262 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31271 description: Response codes found in [response codes](https://wiki.onap.org/).
31275 description: Unique id of VNF. This is unique across the graph.
31278 example: __VNF-ID__
31279 - name: interface-name
31281 description: Name given to the interface
31284 example: __INTERFACE-NAME__
31287 description: PCI ID used to identify the sriov-vf
31290 example: __PCI-ID__
31291 - name: resource-version
31293 description: resource-version for concurrency
31296 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
31300 summary: returns sriov-vfs
31301 description: returns sriov-vfs
31302 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
31308 description: successful operation
31310 $ref: "#/getDefinitions/sriov-vfs"
31312 description: Response codes found in [response codes](https://wiki.onap.org/).
31316 description: Unique id of VNF. This is unique across the graph.
31319 example: __VNF-ID__
31320 - name: interface-name
31322 description: Name given to the interface
31325 example: __INTERFACE-NAME__
31331 - name: vf-vlan-filter
31336 - name: vf-mac-filter
31341 - name: vf-vlan-strip
31346 - name: neutron-network-id
31351 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
31355 summary: see node definition for valid relationships
31356 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
31365 description: Response codes found in [response codes](https://wiki.onap.org/).
31369 description: Unique id of VNF. This is unique across the graph.
31372 example: __VNF-ID__
31373 - name: interface-name
31375 description: Name given to the interface
31378 example: __INTERFACE-NAME__
31381 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
31384 $ref: "#/definitions/relationship"
31388 summary: delete an existing relationship
31389 description: delete an existing relationship
31390 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
31399 description: Response codes found in [response codes](https://wiki.onap.org/).
31403 description: Unique id of VNF. This is unique across the graph.
31406 example: __VNF-ID__
31407 - name: interface-name
31409 description: Name given to the interface
31412 example: __INTERFACE-NAME__
31413 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
31417 summary: see node definition for valid relationships
31418 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
31427 description: Response codes found in [response codes](https://wiki.onap.org/).
31431 description: Unique id of VNF. This is unique across the graph.
31434 example: __VNF-ID__
31435 - name: interface-name
31437 description: Name given to the interface
31440 example: __INTERFACE-NAME__
31441 - name: l3-interface-ipv4-address
31443 description: IP address
31446 example: __L3-INTERFACE-IPV4-ADDRESS__
31449 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
31452 $ref: "#/definitions/relationship"
31456 summary: delete an existing relationship
31457 description: delete an existing relationship
31458 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
31467 description: Response codes found in [response codes](https://wiki.onap.org/).
31471 description: Unique id of VNF. This is unique across the graph.
31474 example: __VNF-ID__
31475 - name: interface-name
31477 description: Name given to the interface
31480 example: __INTERFACE-NAME__
31481 - name: l3-interface-ipv4-address
31483 description: IP address
31486 example: __L3-INTERFACE-IPV4-ADDRESS__
31487 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31491 summary: returns l3-interface-ipv4-address-list
31492 description: returns l3-interface-ipv4-address-list
31493 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
31499 description: successful operation
31501 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31503 description: Response codes found in [response codes](https://wiki.onap.org/).
31507 description: Unique id of VNF. This is unique across the graph.
31510 example: __VNF-ID__
31511 - name: interface-name
31513 description: Name given to the interface
31516 example: __INTERFACE-NAME__
31517 - name: l3-interface-ipv4-address
31519 description: IP address
31522 example: __L3-INTERFACE-IPV4-ADDRESS__
31526 summary: create or update an existing l3-interface-ipv4-address-list
31528 Create or update an existing l3-interface-ipv4-address-list.
31530 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31531 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
31540 description: Response codes found in [response codes](https://wiki.onap.org/).
31544 description: Unique id of VNF. This is unique across the graph.
31547 example: __VNF-ID__
31548 - name: interface-name
31550 description: Name given to the interface
31553 example: __INTERFACE-NAME__
31554 - name: l3-interface-ipv4-address
31556 description: IP address
31559 example: __L3-INTERFACE-IPV4-ADDRESS__
31562 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
31565 $ref: "#/definitions/l3-interface-ipv4-address-list"
31569 summary: update an existing l3-interface-ipv4-address-list
31571 Update an existing l3-interface-ipv4-address-list
31573 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31574 The PUT operation will entirely replace an existing object.
31575 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31577 Other differences between PUT and PATCH are:
31579 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31580 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31581 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31582 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
31591 description: Response codes found in [response codes](https://wiki.onap.org/).
31595 description: Unique id of VNF. This is unique across the graph.
31598 example: __VNF-ID__
31599 - name: interface-name
31601 description: Name given to the interface
31604 example: __INTERFACE-NAME__
31605 - name: l3-interface-ipv4-address
31607 description: IP address
31610 example: __L3-INTERFACE-IPV4-ADDRESS__
31613 description: l3-interface-ipv4-address-list object that needs to be updated.
31616 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31620 summary: delete an existing l3-interface-ipv4-address-list
31621 description: delete an existing l3-interface-ipv4-address-list
31622 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
31631 description: Response codes found in [response codes](https://wiki.onap.org/).
31635 description: Unique id of VNF. This is unique across the graph.
31638 example: __VNF-ID__
31639 - name: interface-name
31641 description: Name given to the interface
31644 example: __INTERFACE-NAME__
31645 - name: l3-interface-ipv4-address
31647 description: IP address
31650 example: __L3-INTERFACE-IPV4-ADDRESS__
31651 - name: resource-version
31653 description: resource-version for concurrency
31656 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
31660 summary: see node definition for valid relationships
31661 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31670 description: Response codes found in [response codes](https://wiki.onap.org/).
31674 description: Unique id of VNF. This is unique across the graph.
31677 example: __VNF-ID__
31678 - name: interface-name
31680 description: Name given to the interface
31683 example: __INTERFACE-NAME__
31684 - name: l3-interface-ipv6-address
31686 description: IP address
31689 example: __L3-INTERFACE-IPV6-ADDRESS__
31692 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31695 $ref: "#/definitions/relationship"
31699 summary: delete an existing relationship
31700 description: delete an existing relationship
31701 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31710 description: Response codes found in [response codes](https://wiki.onap.org/).
31714 description: Unique id of VNF. This is unique across the graph.
31717 example: __VNF-ID__
31718 - name: interface-name
31720 description: Name given to the interface
31723 example: __INTERFACE-NAME__
31724 - name: l3-interface-ipv6-address
31726 description: IP address
31729 example: __L3-INTERFACE-IPV6-ADDRESS__
31730 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31734 summary: returns l3-interface-ipv6-address-list
31735 description: returns l3-interface-ipv6-address-list
31736 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
31742 description: successful operation
31744 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31746 description: Response codes found in [response codes](https://wiki.onap.org/).
31750 description: Unique id of VNF. This is unique across the graph.
31753 example: __VNF-ID__
31754 - name: interface-name
31756 description: Name given to the interface
31759 example: __INTERFACE-NAME__
31760 - name: l3-interface-ipv6-address
31762 description: IP address
31765 example: __L3-INTERFACE-IPV6-ADDRESS__
31769 summary: create or update an existing l3-interface-ipv6-address-list
31771 Create or update an existing l3-interface-ipv6-address-list.
31773 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31774 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
31783 description: Response codes found in [response codes](https://wiki.onap.org/).
31787 description: Unique id of VNF. This is unique across the graph.
31790 example: __VNF-ID__
31791 - name: interface-name
31793 description: Name given to the interface
31796 example: __INTERFACE-NAME__
31797 - name: l3-interface-ipv6-address
31799 description: IP address
31802 example: __L3-INTERFACE-IPV6-ADDRESS__
31805 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31808 $ref: "#/definitions/l3-interface-ipv6-address-list"
31812 summary: update an existing l3-interface-ipv6-address-list
31814 Update an existing l3-interface-ipv6-address-list
31816 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31817 The PUT operation will entirely replace an existing object.
31818 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31820 Other differences between PUT and PATCH are:
31822 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31823 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31824 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31825 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
31834 description: Response codes found in [response codes](https://wiki.onap.org/).
31838 description: Unique id of VNF. This is unique across the graph.
31841 example: __VNF-ID__
31842 - name: interface-name
31844 description: Name given to the interface
31847 example: __INTERFACE-NAME__
31848 - name: l3-interface-ipv6-address
31850 description: IP address
31853 example: __L3-INTERFACE-IPV6-ADDRESS__
31856 description: l3-interface-ipv6-address-list object that needs to be updated.
31859 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31863 summary: delete an existing l3-interface-ipv6-address-list
31864 description: delete an existing l3-interface-ipv6-address-list
31865 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
31874 description: Response codes found in [response codes](https://wiki.onap.org/).
31878 description: Unique id of VNF. This is unique across the graph.
31881 example: __VNF-ID__
31882 - name: interface-name
31884 description: Name given to the interface
31887 example: __INTERFACE-NAME__
31888 - name: l3-interface-ipv6-address
31890 description: IP address
31893 example: __L3-INTERFACE-IPV6-ADDRESS__
31894 - name: resource-version
31896 description: resource-version for concurrency
31899 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
31903 summary: returns l-interface
31904 description: returns l-interface
31905 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
31911 description: successful operation
31913 $ref: "#/getDefinitions/l-interface"
31915 description: Response codes found in [response codes](https://wiki.onap.org/).
31919 description: Unique id of VNF. This is unique across the graph.
31922 example: __VNF-ID__
31923 - name: interface-name
31925 description: Name given to the interface
31928 example: __INTERFACE-NAME__
31932 summary: create or update an existing l-interface
31934 Create or update an existing l-interface.
31936 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31937 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
31946 description: Response codes found in [response codes](https://wiki.onap.org/).
31950 description: Unique id of VNF. This is unique across the graph.
31953 example: __VNF-ID__
31954 - name: interface-name
31956 description: Name given to the interface
31959 example: __INTERFACE-NAME__
31962 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
31965 $ref: "#/definitions/l-interface"
31969 summary: update an existing l-interface
31971 Update an existing l-interface
31973 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31974 The PUT operation will entirely replace an existing object.
31975 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31977 Other differences between PUT and PATCH are:
31979 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31980 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31981 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31982 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
31991 description: Response codes found in [response codes](https://wiki.onap.org/).
31995 description: Unique id of VNF. This is unique across the graph.
31998 example: __VNF-ID__
31999 - name: interface-name
32001 description: Name given to the interface
32004 example: __INTERFACE-NAME__
32007 description: l-interface object that needs to be updated.
32010 $ref: "#/patchDefinitions/l-interface"
32014 summary: delete an existing l-interface
32015 description: delete an existing l-interface
32016 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
32025 description: Response codes found in [response codes](https://wiki.onap.org/).
32029 description: Unique id of VNF. This is unique across the graph.
32032 example: __VNF-ID__
32033 - name: interface-name
32035 description: Name given to the interface
32038 example: __INTERFACE-NAME__
32039 - name: resource-version
32041 description: resource-version for concurrency
32044 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
32048 summary: returns l-interfaces
32049 description: returns l-interfaces
32050 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
32056 description: successful operation
32058 $ref: "#/getDefinitions/l-interfaces"
32060 description: Response codes found in [response codes](https://wiki.onap.org/).
32064 description: Unique id of VNF. This is unique across the graph.
32067 example: __VNF-ID__
32068 - name: interface-name
32073 - name: interface-id
32083 - name: network-name
32088 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
32092 summary: see node definition for valid relationships
32093 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
32102 description: Response codes found in [response codes](https://wiki.onap.org/).
32106 description: Unique id of VNF. This is unique across the graph.
32109 example: __VNF-ID__
32110 - name: interface-name
32112 description: Name that identifies the link aggregate interface
32115 example: __INTERFACE-NAME__
32118 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
32121 $ref: "#/definitions/relationship"
32125 summary: delete an existing relationship
32126 description: delete an existing relationship
32127 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
32136 description: Response codes found in [response codes](https://wiki.onap.org/).
32140 description: Unique id of VNF. This is unique across the graph.
32143 example: __VNF-ID__
32144 - name: interface-name
32146 description: Name that identifies the link aggregate interface
32149 example: __INTERFACE-NAME__
32150 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
32154 summary: see node definition for valid relationships
32155 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32164 description: Response codes found in [response codes](https://wiki.onap.org/).
32168 description: Unique id of VNF. This is unique across the graph.
32171 example: __VNF-ID__
32172 - name: interface-name
32174 description: Name that identifies the link aggregate interface
32177 example: __INTERFACE-NAME__
32178 - name: interface-name
32180 description: Name given to the interface
32183 example: __INTERFACE-NAME__
32184 - name: vlan-interface
32186 description: String that identifies the interface
32189 example: __VLAN-INTERFACE__
32192 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
32195 $ref: "#/definitions/relationship"
32199 summary: delete an existing relationship
32200 description: delete an existing relationship
32201 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32210 description: Response codes found in [response codes](https://wiki.onap.org/).
32214 description: Unique id of VNF. This is unique across the graph.
32217 example: __VNF-ID__
32218 - name: interface-name
32220 description: Name that identifies the link aggregate interface
32223 example: __INTERFACE-NAME__
32224 - name: interface-name
32226 description: Name given to the interface
32229 example: __INTERFACE-NAME__
32230 - name: vlan-interface
32232 description: String that identifies the interface
32235 example: __VLAN-INTERFACE__
32236 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
32240 summary: see node definition for valid relationships
32241 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32250 description: Response codes found in [response codes](https://wiki.onap.org/).
32254 description: Unique id of VNF. This is unique across the graph.
32257 example: __VNF-ID__
32258 - name: interface-name
32260 description: Name that identifies the link aggregate interface
32263 example: __INTERFACE-NAME__
32264 - name: interface-name
32266 description: Name given to the interface
32269 example: __INTERFACE-NAME__
32270 - name: vlan-interface
32272 description: String that identifies the interface
32275 example: __VLAN-INTERFACE__
32276 - name: l3-interface-ipv4-address
32278 description: IP address
32281 example: __L3-INTERFACE-IPV4-ADDRESS__
32284 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32287 $ref: "#/definitions/relationship"
32291 summary: delete an existing relationship
32292 description: delete an existing relationship
32293 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32302 description: Response codes found in [response codes](https://wiki.onap.org/).
32306 description: Unique id of VNF. This is unique across the graph.
32309 example: __VNF-ID__
32310 - name: interface-name
32312 description: Name that identifies the link aggregate interface
32315 example: __INTERFACE-NAME__
32316 - name: interface-name
32318 description: Name given to the interface
32321 example: __INTERFACE-NAME__
32322 - name: vlan-interface
32324 description: String that identifies the interface
32327 example: __VLAN-INTERFACE__
32328 - name: l3-interface-ipv4-address
32330 description: IP address
32333 example: __L3-INTERFACE-IPV4-ADDRESS__
32334 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32338 summary: returns l3-interface-ipv4-address-list
32339 description: returns l3-interface-ipv4-address-list
32340 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32346 description: successful operation
32348 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32350 description: Response codes found in [response codes](https://wiki.onap.org/).
32354 description: Unique id of VNF. This is unique across the graph.
32357 example: __VNF-ID__
32358 - name: interface-name
32360 description: Name that identifies the link aggregate interface
32363 example: __INTERFACE-NAME__
32364 - name: interface-name
32366 description: Name given to the interface
32369 example: __INTERFACE-NAME__
32370 - name: vlan-interface
32372 description: String that identifies the interface
32375 example: __VLAN-INTERFACE__
32376 - name: l3-interface-ipv4-address
32378 description: IP address
32381 example: __L3-INTERFACE-IPV4-ADDRESS__
32385 summary: create or update an existing l3-interface-ipv4-address-list
32387 Create or update an existing l3-interface-ipv4-address-list.
32389 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32390 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32399 description: Response codes found in [response codes](https://wiki.onap.org/).
32403 description: Unique id of VNF. This is unique across the graph.
32406 example: __VNF-ID__
32407 - name: interface-name
32409 description: Name that identifies the link aggregate interface
32412 example: __INTERFACE-NAME__
32413 - name: interface-name
32415 description: Name given to the interface
32418 example: __INTERFACE-NAME__
32419 - name: vlan-interface
32421 description: String that identifies the interface
32424 example: __VLAN-INTERFACE__
32425 - name: l3-interface-ipv4-address
32427 description: IP address
32430 example: __L3-INTERFACE-IPV4-ADDRESS__
32433 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32436 $ref: "#/definitions/l3-interface-ipv4-address-list"
32440 summary: update an existing l3-interface-ipv4-address-list
32442 Update an existing l3-interface-ipv4-address-list
32444 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32445 The PUT operation will entirely replace an existing object.
32446 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32448 Other differences between PUT and PATCH are:
32450 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32451 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32452 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32453 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32462 description: Response codes found in [response codes](https://wiki.onap.org/).
32466 description: Unique id of VNF. This is unique across the graph.
32469 example: __VNF-ID__
32470 - name: interface-name
32472 description: Name that identifies the link aggregate interface
32475 example: __INTERFACE-NAME__
32476 - name: interface-name
32478 description: Name given to the interface
32481 example: __INTERFACE-NAME__
32482 - name: vlan-interface
32484 description: String that identifies the interface
32487 example: __VLAN-INTERFACE__
32488 - name: l3-interface-ipv4-address
32490 description: IP address
32493 example: __L3-INTERFACE-IPV4-ADDRESS__
32496 description: l3-interface-ipv4-address-list object that needs to be updated.
32499 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32503 summary: delete an existing l3-interface-ipv4-address-list
32504 description: delete an existing l3-interface-ipv4-address-list
32505 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32514 description: Response codes found in [response codes](https://wiki.onap.org/).
32518 description: Unique id of VNF. This is unique across the graph.
32521 example: __VNF-ID__
32522 - name: interface-name
32524 description: Name that identifies the link aggregate interface
32527 example: __INTERFACE-NAME__
32528 - name: interface-name
32530 description: Name given to the interface
32533 example: __INTERFACE-NAME__
32534 - name: vlan-interface
32536 description: String that identifies the interface
32539 example: __VLAN-INTERFACE__
32540 - name: l3-interface-ipv4-address
32542 description: IP address
32545 example: __L3-INTERFACE-IPV4-ADDRESS__
32546 - name: resource-version
32548 description: resource-version for concurrency
32551 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
32555 summary: see node definition for valid relationships
32556 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
32565 description: Response codes found in [response codes](https://wiki.onap.org/).
32569 description: Unique id of VNF. This is unique across the graph.
32572 example: __VNF-ID__
32573 - name: interface-name
32575 description: Name that identifies the link aggregate interface
32578 example: __INTERFACE-NAME__
32579 - name: interface-name
32581 description: Name given to the interface
32584 example: __INTERFACE-NAME__
32585 - name: vlan-interface
32587 description: String that identifies the interface
32590 example: __VLAN-INTERFACE__
32591 - name: l3-interface-ipv6-address
32593 description: IP address
32596 example: __L3-INTERFACE-IPV6-ADDRESS__
32599 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32602 $ref: "#/definitions/relationship"
32606 summary: delete an existing relationship
32607 description: delete an existing relationship
32608 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
32617 description: Response codes found in [response codes](https://wiki.onap.org/).
32621 description: Unique id of VNF. This is unique across the graph.
32624 example: __VNF-ID__
32625 - name: interface-name
32627 description: Name that identifies the link aggregate interface
32630 example: __INTERFACE-NAME__
32631 - name: interface-name
32633 description: Name given to the interface
32636 example: __INTERFACE-NAME__
32637 - name: vlan-interface
32639 description: String that identifies the interface
32642 example: __VLAN-INTERFACE__
32643 - name: l3-interface-ipv6-address
32645 description: IP address
32648 example: __L3-INTERFACE-IPV6-ADDRESS__
32649 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
32653 summary: returns l3-interface-ipv6-address-list
32654 description: returns l3-interface-ipv6-address-list
32655 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32661 description: successful operation
32663 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32665 description: Response codes found in [response codes](https://wiki.onap.org/).
32669 description: Unique id of VNF. This is unique across the graph.
32672 example: __VNF-ID__
32673 - name: interface-name
32675 description: Name that identifies the link aggregate interface
32678 example: __INTERFACE-NAME__
32679 - name: interface-name
32681 description: Name given to the interface
32684 example: __INTERFACE-NAME__
32685 - name: vlan-interface
32687 description: String that identifies the interface
32690 example: __VLAN-INTERFACE__
32691 - name: l3-interface-ipv6-address
32693 description: IP address
32696 example: __L3-INTERFACE-IPV6-ADDRESS__
32700 summary: create or update an existing l3-interface-ipv6-address-list
32702 Create or update an existing l3-interface-ipv6-address-list.
32704 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32705 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32714 description: Response codes found in [response codes](https://wiki.onap.org/).
32718 description: Unique id of VNF. This is unique across the graph.
32721 example: __VNF-ID__
32722 - name: interface-name
32724 description: Name that identifies the link aggregate interface
32727 example: __INTERFACE-NAME__
32728 - name: interface-name
32730 description: Name given to the interface
32733 example: __INTERFACE-NAME__
32734 - name: vlan-interface
32736 description: String that identifies the interface
32739 example: __VLAN-INTERFACE__
32740 - name: l3-interface-ipv6-address
32742 description: IP address
32745 example: __L3-INTERFACE-IPV6-ADDRESS__
32748 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32751 $ref: "#/definitions/l3-interface-ipv6-address-list"
32755 summary: update an existing l3-interface-ipv6-address-list
32757 Update an existing l3-interface-ipv6-address-list
32759 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32760 The PUT operation will entirely replace an existing object.
32761 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32763 Other differences between PUT and PATCH are:
32765 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32766 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32767 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32768 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32777 description: Response codes found in [response codes](https://wiki.onap.org/).
32781 description: Unique id of VNF. This is unique across the graph.
32784 example: __VNF-ID__
32785 - name: interface-name
32787 description: Name that identifies the link aggregate interface
32790 example: __INTERFACE-NAME__
32791 - name: interface-name
32793 description: Name given to the interface
32796 example: __INTERFACE-NAME__
32797 - name: vlan-interface
32799 description: String that identifies the interface
32802 example: __VLAN-INTERFACE__
32803 - name: l3-interface-ipv6-address
32805 description: IP address
32808 example: __L3-INTERFACE-IPV6-ADDRESS__
32811 description: l3-interface-ipv6-address-list object that needs to be updated.
32814 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32818 summary: delete an existing l3-interface-ipv6-address-list
32819 description: delete an existing l3-interface-ipv6-address-list
32820 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32829 description: Response codes found in [response codes](https://wiki.onap.org/).
32833 description: Unique id of VNF. This is unique across the graph.
32836 example: __VNF-ID__
32837 - name: interface-name
32839 description: Name that identifies the link aggregate interface
32842 example: __INTERFACE-NAME__
32843 - name: interface-name
32845 description: Name given to the interface
32848 example: __INTERFACE-NAME__
32849 - name: vlan-interface
32851 description: String that identifies the interface
32854 example: __VLAN-INTERFACE__
32855 - name: l3-interface-ipv6-address
32857 description: IP address
32860 example: __L3-INTERFACE-IPV6-ADDRESS__
32861 - name: resource-version
32863 description: resource-version for concurrency
32866 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
32870 summary: returns vlan
32871 description: returns vlan
32872 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
32878 description: successful operation
32880 $ref: "#/getDefinitions/vlan"
32882 description: Response codes found in [response codes](https://wiki.onap.org/).
32886 description: Unique id of VNF. This is unique across the graph.
32889 example: __VNF-ID__
32890 - name: interface-name
32892 description: Name that identifies the link aggregate interface
32895 example: __INTERFACE-NAME__
32896 - name: interface-name
32898 description: Name given to the interface
32901 example: __INTERFACE-NAME__
32902 - name: vlan-interface
32904 description: String that identifies the interface
32907 example: __VLAN-INTERFACE__
32911 summary: create or update an existing vlan
32913 Create or update an existing vlan.
32915 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32916 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
32925 description: Response codes found in [response codes](https://wiki.onap.org/).
32929 description: Unique id of VNF. This is unique across the graph.
32932 example: __VNF-ID__
32933 - name: interface-name
32935 description: Name that identifies the link aggregate interface
32938 example: __INTERFACE-NAME__
32939 - name: interface-name
32941 description: Name given to the interface
32944 example: __INTERFACE-NAME__
32945 - name: vlan-interface
32947 description: String that identifies the interface
32950 example: __VLAN-INTERFACE__
32953 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
32956 $ref: "#/definitions/vlan"
32960 summary: update an existing vlan
32962 Update an existing vlan
32964 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32965 The PUT operation will entirely replace an existing object.
32966 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32968 Other differences between PUT and PATCH are:
32970 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32971 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32972 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32973 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
32982 description: Response codes found in [response codes](https://wiki.onap.org/).
32986 description: Unique id of VNF. This is unique across the graph.
32989 example: __VNF-ID__
32990 - name: interface-name
32992 description: Name that identifies the link aggregate interface
32995 example: __INTERFACE-NAME__
32996 - name: interface-name
32998 description: Name given to the interface
33001 example: __INTERFACE-NAME__
33002 - name: vlan-interface
33004 description: String that identifies the interface
33007 example: __VLAN-INTERFACE__
33010 description: vlan object that needs to be updated.
33013 $ref: "#/patchDefinitions/vlan"
33017 summary: delete an existing vlan
33018 description: delete an existing vlan
33019 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
33028 description: Response codes found in [response codes](https://wiki.onap.org/).
33032 description: Unique id of VNF. This is unique across the graph.
33035 example: __VNF-ID__
33036 - name: interface-name
33038 description: Name that identifies the link aggregate interface
33041 example: __INTERFACE-NAME__
33042 - name: interface-name
33044 description: Name given to the interface
33047 example: __INTERFACE-NAME__
33048 - name: vlan-interface
33050 description: String that identifies the interface
33053 example: __VLAN-INTERFACE__
33054 - name: resource-version
33056 description: resource-version for concurrency
33059 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
33063 summary: returns vlans
33064 description: returns vlans
33065 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
33071 description: successful operation
33073 $ref: "#/getDefinitions/vlans"
33075 description: Response codes found in [response codes](https://wiki.onap.org/).
33079 description: Unique id of VNF. This is unique across the graph.
33082 example: __VNF-ID__
33083 - name: interface-name
33085 description: Name that identifies the link aggregate interface
33088 example: __INTERFACE-NAME__
33089 - name: interface-name
33091 description: Name given to the interface
33094 example: __INTERFACE-NAME__
33095 - name: vlan-interface
33100 - name: vlan-id-inner
33111 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
33115 summary: see node definition for valid relationships
33116 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33125 description: Response codes found in [response codes](https://wiki.onap.org/).
33129 description: Unique id of VNF. This is unique across the graph.
33132 example: __VNF-ID__
33133 - name: interface-name
33135 description: Name that identifies the link aggregate interface
33138 example: __INTERFACE-NAME__
33139 - name: interface-name
33141 description: Name given to the interface
33144 example: __INTERFACE-NAME__
33147 description: PCI ID used to identify the sriov-vf
33150 example: __PCI-ID__
33153 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
33156 $ref: "#/definitions/relationship"
33160 summary: delete an existing relationship
33161 description: delete an existing relationship
33162 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33171 description: Response codes found in [response codes](https://wiki.onap.org/).
33175 description: Unique id of VNF. This is unique across the graph.
33178 example: __VNF-ID__
33179 - name: interface-name
33181 description: Name that identifies the link aggregate interface
33184 example: __INTERFACE-NAME__
33185 - name: interface-name
33187 description: Name given to the interface
33190 example: __INTERFACE-NAME__
33193 description: PCI ID used to identify the sriov-vf
33196 example: __PCI-ID__
33197 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
33201 summary: returns sriov-vf
33202 description: returns sriov-vf
33203 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33209 description: successful operation
33211 $ref: "#/getDefinitions/sriov-vf"
33213 description: Response codes found in [response codes](https://wiki.onap.org/).
33217 description: Unique id of VNF. This is unique across the graph.
33220 example: __VNF-ID__
33221 - name: interface-name
33223 description: Name that identifies the link aggregate interface
33226 example: __INTERFACE-NAME__
33227 - name: interface-name
33229 description: Name given to the interface
33232 example: __INTERFACE-NAME__
33235 description: PCI ID used to identify the sriov-vf
33238 example: __PCI-ID__
33242 summary: create or update an existing sriov-vf
33244 Create or update an existing sriov-vf.
33246 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33247 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33256 description: Response codes found in [response codes](https://wiki.onap.org/).
33260 description: Unique id of VNF. This is unique across the graph.
33263 example: __VNF-ID__
33264 - name: interface-name
33266 description: Name that identifies the link aggregate interface
33269 example: __INTERFACE-NAME__
33270 - name: interface-name
33272 description: Name given to the interface
33275 example: __INTERFACE-NAME__
33278 description: PCI ID used to identify the sriov-vf
33281 example: __PCI-ID__
33284 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
33287 $ref: "#/definitions/sriov-vf"
33291 summary: update an existing sriov-vf
33293 Update an existing sriov-vf
33295 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33296 The PUT operation will entirely replace an existing object.
33297 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33299 Other differences between PUT and PATCH are:
33301 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33302 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33303 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33304 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33313 description: Response codes found in [response codes](https://wiki.onap.org/).
33317 description: Unique id of VNF. This is unique across the graph.
33320 example: __VNF-ID__
33321 - name: interface-name
33323 description: Name that identifies the link aggregate interface
33326 example: __INTERFACE-NAME__
33327 - name: interface-name
33329 description: Name given to the interface
33332 example: __INTERFACE-NAME__
33335 description: PCI ID used to identify the sriov-vf
33338 example: __PCI-ID__
33341 description: sriov-vf object that needs to be updated.
33344 $ref: "#/patchDefinitions/sriov-vf"
33348 summary: delete an existing sriov-vf
33349 description: delete an existing sriov-vf
33350 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
33359 description: Response codes found in [response codes](https://wiki.onap.org/).
33363 description: Unique id of VNF. This is unique across the graph.
33366 example: __VNF-ID__
33367 - name: interface-name
33369 description: Name that identifies the link aggregate interface
33372 example: __INTERFACE-NAME__
33373 - name: interface-name
33375 description: Name given to the interface
33378 example: __INTERFACE-NAME__
33381 description: PCI ID used to identify the sriov-vf
33384 example: __PCI-ID__
33385 - name: resource-version
33387 description: resource-version for concurrency
33390 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
33394 summary: returns sriov-vfs
33395 description: returns sriov-vfs
33396 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
33402 description: successful operation
33404 $ref: "#/getDefinitions/sriov-vfs"
33406 description: Response codes found in [response codes](https://wiki.onap.org/).
33410 description: Unique id of VNF. This is unique across the graph.
33413 example: __VNF-ID__
33414 - name: interface-name
33416 description: Name that identifies the link aggregate interface
33419 example: __INTERFACE-NAME__
33420 - name: interface-name
33422 description: Name given to the interface
33425 example: __INTERFACE-NAME__
33431 - name: vf-vlan-filter
33436 - name: vf-mac-filter
33441 - name: vf-vlan-strip
33446 - name: neutron-network-id
33451 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
33455 summary: see node definition for valid relationships
33456 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
33465 description: Response codes found in [response codes](https://wiki.onap.org/).
33469 description: Unique id of VNF. This is unique across the graph.
33472 example: __VNF-ID__
33473 - name: interface-name
33475 description: Name that identifies the link aggregate interface
33478 example: __INTERFACE-NAME__
33479 - name: interface-name
33481 description: Name given to the interface
33484 example: __INTERFACE-NAME__
33487 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
33490 $ref: "#/definitions/relationship"
33494 summary: delete an existing relationship
33495 description: delete an existing relationship
33496 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
33505 description: Response codes found in [response codes](https://wiki.onap.org/).
33509 description: Unique id of VNF. This is unique across the graph.
33512 example: __VNF-ID__
33513 - name: interface-name
33515 description: Name that identifies the link aggregate interface
33518 example: __INTERFACE-NAME__
33519 - name: interface-name
33521 description: Name given to the interface
33524 example: __INTERFACE-NAME__
33525 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
33529 summary: see node definition for valid relationships
33530 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33539 description: Response codes found in [response codes](https://wiki.onap.org/).
33543 description: Unique id of VNF. This is unique across the graph.
33546 example: __VNF-ID__
33547 - name: interface-name
33549 description: Name that identifies the link aggregate interface
33552 example: __INTERFACE-NAME__
33553 - name: interface-name
33555 description: Name given to the interface
33558 example: __INTERFACE-NAME__
33559 - name: l3-interface-ipv4-address
33561 description: IP address
33564 example: __L3-INTERFACE-IPV4-ADDRESS__
33567 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
33570 $ref: "#/definitions/relationship"
33574 summary: delete an existing relationship
33575 description: delete an existing relationship
33576 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33585 description: Response codes found in [response codes](https://wiki.onap.org/).
33589 description: Unique id of VNF. This is unique across the graph.
33592 example: __VNF-ID__
33593 - name: interface-name
33595 description: Name that identifies the link aggregate interface
33598 example: __INTERFACE-NAME__
33599 - name: interface-name
33601 description: Name given to the interface
33604 example: __INTERFACE-NAME__
33605 - name: l3-interface-ipv4-address
33607 description: IP address
33610 example: __L3-INTERFACE-IPV4-ADDRESS__
33611 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
33615 summary: returns l3-interface-ipv4-address-list
33616 description: returns l3-interface-ipv4-address-list
33617 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33623 description: successful operation
33625 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33627 description: Response codes found in [response codes](https://wiki.onap.org/).
33631 description: Unique id of VNF. This is unique across the graph.
33634 example: __VNF-ID__
33635 - name: interface-name
33637 description: Name that identifies the link aggregate interface
33640 example: __INTERFACE-NAME__
33641 - name: interface-name
33643 description: Name given to the interface
33646 example: __INTERFACE-NAME__
33647 - name: l3-interface-ipv4-address
33649 description: IP address
33652 example: __L3-INTERFACE-IPV4-ADDRESS__
33656 summary: create or update an existing l3-interface-ipv4-address-list
33658 Create or update an existing l3-interface-ipv4-address-list.
33660 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33661 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33670 description: Response codes found in [response codes](https://wiki.onap.org/).
33674 description: Unique id of VNF. This is unique across the graph.
33677 example: __VNF-ID__
33678 - name: interface-name
33680 description: Name that identifies the link aggregate interface
33683 example: __INTERFACE-NAME__
33684 - name: interface-name
33686 description: Name given to the interface
33689 example: __INTERFACE-NAME__
33690 - name: l3-interface-ipv4-address
33692 description: IP address
33695 example: __L3-INTERFACE-IPV4-ADDRESS__
33698 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
33701 $ref: "#/definitions/l3-interface-ipv4-address-list"
33705 summary: update an existing l3-interface-ipv4-address-list
33707 Update an existing l3-interface-ipv4-address-list
33709 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33710 The PUT operation will entirely replace an existing object.
33711 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33713 Other differences between PUT and PATCH are:
33715 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33716 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33717 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33718 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33727 description: Response codes found in [response codes](https://wiki.onap.org/).
33731 description: Unique id of VNF. This is unique across the graph.
33734 example: __VNF-ID__
33735 - name: interface-name
33737 description: Name that identifies the link aggregate interface
33740 example: __INTERFACE-NAME__
33741 - name: interface-name
33743 description: Name given to the interface
33746 example: __INTERFACE-NAME__
33747 - name: l3-interface-ipv4-address
33749 description: IP address
33752 example: __L3-INTERFACE-IPV4-ADDRESS__
33755 description: l3-interface-ipv4-address-list object that needs to be updated.
33758 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33762 summary: delete an existing l3-interface-ipv4-address-list
33763 description: delete an existing l3-interface-ipv4-address-list
33764 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33773 description: Response codes found in [response codes](https://wiki.onap.org/).
33777 description: Unique id of VNF. This is unique across the graph.
33780 example: __VNF-ID__
33781 - name: interface-name
33783 description: Name that identifies the link aggregate interface
33786 example: __INTERFACE-NAME__
33787 - name: interface-name
33789 description: Name given to the interface
33792 example: __INTERFACE-NAME__
33793 - name: l3-interface-ipv4-address
33795 description: IP address
33798 example: __L3-INTERFACE-IPV4-ADDRESS__
33799 - name: resource-version
33801 description: resource-version for concurrency
33804 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
33808 summary: see node definition for valid relationships
33809 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33818 description: Response codes found in [response codes](https://wiki.onap.org/).
33822 description: Unique id of VNF. This is unique across the graph.
33825 example: __VNF-ID__
33826 - name: interface-name
33828 description: Name that identifies the link aggregate interface
33831 example: __INTERFACE-NAME__
33832 - name: interface-name
33834 description: Name given to the interface
33837 example: __INTERFACE-NAME__
33838 - name: l3-interface-ipv6-address
33840 description: IP address
33843 example: __L3-INTERFACE-IPV6-ADDRESS__
33846 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33849 $ref: "#/definitions/relationship"
33853 summary: delete an existing relationship
33854 description: delete an existing relationship
33855 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33864 description: Response codes found in [response codes](https://wiki.onap.org/).
33868 description: Unique id of VNF. This is unique across the graph.
33871 example: __VNF-ID__
33872 - name: interface-name
33874 description: Name that identifies the link aggregate interface
33877 example: __INTERFACE-NAME__
33878 - name: interface-name
33880 description: Name given to the interface
33883 example: __INTERFACE-NAME__
33884 - name: l3-interface-ipv6-address
33886 description: IP address
33889 example: __L3-INTERFACE-IPV6-ADDRESS__
33890 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33894 summary: returns l3-interface-ipv6-address-list
33895 description: returns l3-interface-ipv6-address-list
33896 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33902 description: successful operation
33904 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33906 description: Response codes found in [response codes](https://wiki.onap.org/).
33910 description: Unique id of VNF. This is unique across the graph.
33913 example: __VNF-ID__
33914 - name: interface-name
33916 description: Name that identifies the link aggregate interface
33919 example: __INTERFACE-NAME__
33920 - name: interface-name
33922 description: Name given to the interface
33925 example: __INTERFACE-NAME__
33926 - name: l3-interface-ipv6-address
33928 description: IP address
33931 example: __L3-INTERFACE-IPV6-ADDRESS__
33935 summary: create or update an existing l3-interface-ipv6-address-list
33937 Create or update an existing l3-interface-ipv6-address-list.
33939 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33940 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33949 description: Response codes found in [response codes](https://wiki.onap.org/).
33953 description: Unique id of VNF. This is unique across the graph.
33956 example: __VNF-ID__
33957 - name: interface-name
33959 description: Name that identifies the link aggregate interface
33962 example: __INTERFACE-NAME__
33963 - name: interface-name
33965 description: Name given to the interface
33968 example: __INTERFACE-NAME__
33969 - name: l3-interface-ipv6-address
33971 description: IP address
33974 example: __L3-INTERFACE-IPV6-ADDRESS__
33977 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33980 $ref: "#/definitions/l3-interface-ipv6-address-list"
33984 summary: update an existing l3-interface-ipv6-address-list
33986 Update an existing l3-interface-ipv6-address-list
33988 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33989 The PUT operation will entirely replace an existing object.
33990 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33992 Other differences between PUT and PATCH are:
33994 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33995 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33996 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33997 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34006 description: Response codes found in [response codes](https://wiki.onap.org/).
34010 description: Unique id of VNF. This is unique across the graph.
34013 example: __VNF-ID__
34014 - name: interface-name
34016 description: Name that identifies the link aggregate interface
34019 example: __INTERFACE-NAME__
34020 - name: interface-name
34022 description: Name given to the interface
34025 example: __INTERFACE-NAME__
34026 - name: l3-interface-ipv6-address
34028 description: IP address
34031 example: __L3-INTERFACE-IPV6-ADDRESS__
34034 description: l3-interface-ipv6-address-list object that needs to be updated.
34037 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34041 summary: delete an existing l3-interface-ipv6-address-list
34042 description: delete an existing l3-interface-ipv6-address-list
34043 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34052 description: Response codes found in [response codes](https://wiki.onap.org/).
34056 description: Unique id of VNF. This is unique across the graph.
34059 example: __VNF-ID__
34060 - name: interface-name
34062 description: Name that identifies the link aggregate interface
34065 example: __INTERFACE-NAME__
34066 - name: interface-name
34068 description: Name given to the interface
34071 example: __INTERFACE-NAME__
34072 - name: l3-interface-ipv6-address
34074 description: IP address
34077 example: __L3-INTERFACE-IPV6-ADDRESS__
34078 - name: resource-version
34080 description: resource-version for concurrency
34083 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
34087 summary: returns l-interface
34088 description: returns l-interface
34089 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
34095 description: successful operation
34097 $ref: "#/getDefinitions/l-interface"
34099 description: Response codes found in [response codes](https://wiki.onap.org/).
34103 description: Unique id of VNF. This is unique across the graph.
34106 example: __VNF-ID__
34107 - name: interface-name
34109 description: Name that identifies the link aggregate interface
34112 example: __INTERFACE-NAME__
34113 - name: interface-name
34115 description: Name given to the interface
34118 example: __INTERFACE-NAME__
34122 summary: create or update an existing l-interface
34124 Create or update an existing l-interface.
34126 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34127 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
34136 description: Response codes found in [response codes](https://wiki.onap.org/).
34140 description: Unique id of VNF. This is unique across the graph.
34143 example: __VNF-ID__
34144 - name: interface-name
34146 description: Name that identifies the link aggregate interface
34149 example: __INTERFACE-NAME__
34150 - name: interface-name
34152 description: Name given to the interface
34155 example: __INTERFACE-NAME__
34158 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
34161 $ref: "#/definitions/l-interface"
34165 summary: update an existing l-interface
34167 Update an existing l-interface
34169 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34170 The PUT operation will entirely replace an existing object.
34171 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34173 Other differences between PUT and PATCH are:
34175 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34176 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34177 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34178 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
34187 description: Response codes found in [response codes](https://wiki.onap.org/).
34191 description: Unique id of VNF. This is unique across the graph.
34194 example: __VNF-ID__
34195 - name: interface-name
34197 description: Name that identifies the link aggregate interface
34200 example: __INTERFACE-NAME__
34201 - name: interface-name
34203 description: Name given to the interface
34206 example: __INTERFACE-NAME__
34209 description: l-interface object that needs to be updated.
34212 $ref: "#/patchDefinitions/l-interface"
34216 summary: delete an existing l-interface
34217 description: delete an existing l-interface
34218 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
34227 description: Response codes found in [response codes](https://wiki.onap.org/).
34231 description: Unique id of VNF. This is unique across the graph.
34234 example: __VNF-ID__
34235 - name: interface-name
34237 description: Name that identifies the link aggregate interface
34240 example: __INTERFACE-NAME__
34241 - name: interface-name
34243 description: Name given to the interface
34246 example: __INTERFACE-NAME__
34247 - name: resource-version
34249 description: resource-version for concurrency
34252 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
34256 summary: returns l-interfaces
34257 description: returns l-interfaces
34258 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
34264 description: successful operation
34266 $ref: "#/getDefinitions/l-interfaces"
34268 description: Response codes found in [response codes](https://wiki.onap.org/).
34272 description: Unique id of VNF. This is unique across the graph.
34275 example: __VNF-ID__
34276 - name: interface-name
34278 description: Name that identifies the link aggregate interface
34281 example: __INTERFACE-NAME__
34282 - name: interface-name
34287 - name: interface-id
34297 - name: network-name
34302 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
34306 summary: returns lag-interface
34307 description: returns lag-interface
34308 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
34314 description: successful operation
34316 $ref: "#/getDefinitions/lag-interface"
34318 description: Response codes found in [response codes](https://wiki.onap.org/).
34322 description: Unique id of VNF. This is unique across the graph.
34325 example: __VNF-ID__
34326 - name: interface-name
34328 description: Name that identifies the link aggregate interface
34331 example: __INTERFACE-NAME__
34335 summary: create or update an existing lag-interface
34337 Create or update an existing lag-interface.
34339 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34340 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
34349 description: Response codes found in [response codes](https://wiki.onap.org/).
34353 description: Unique id of VNF. This is unique across the graph.
34356 example: __VNF-ID__
34357 - name: interface-name
34359 description: Name that identifies the link aggregate interface
34362 example: __INTERFACE-NAME__
34365 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
34368 $ref: "#/definitions/lag-interface"
34372 summary: update an existing lag-interface
34374 Update an existing lag-interface
34376 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34377 The PUT operation will entirely replace an existing object.
34378 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34380 Other differences between PUT and PATCH are:
34382 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34383 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34384 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34385 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
34394 description: Response codes found in [response codes](https://wiki.onap.org/).
34398 description: Unique id of VNF. This is unique across the graph.
34401 example: __VNF-ID__
34402 - name: interface-name
34404 description: Name that identifies the link aggregate interface
34407 example: __INTERFACE-NAME__
34410 description: lag-interface object that needs to be updated.
34413 $ref: "#/patchDefinitions/lag-interface"
34417 summary: delete an existing lag-interface
34418 description: delete an existing lag-interface
34419 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
34428 description: Response codes found in [response codes](https://wiki.onap.org/).
34432 description: Unique id of VNF. This is unique across the graph.
34435 example: __VNF-ID__
34436 - name: interface-name
34438 description: Name that identifies the link aggregate interface
34441 example: __INTERFACE-NAME__
34442 - name: resource-version
34444 description: resource-version for concurrency
34447 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
34451 summary: returns lag-interfaces
34452 description: returns lag-interfaces
34453 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
34459 description: successful operation
34461 $ref: "#/getDefinitions/lag-interfaces"
34463 description: Response codes found in [response codes](https://wiki.onap.org/).
34467 description: Unique id of VNF. This is unique across the graph.
34470 example: __VNF-ID__
34471 - name: interface-name
34476 - name: interface-id
34481 - name: interface-role
34486 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
34490 summary: see node definition for valid relationships
34491 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
34500 description: Response codes found in [response codes](https://wiki.onap.org/).
34504 description: Unique id of VNF. This is unique across the graph.
34507 example: __VNF-ID__
34508 - name: vf-module-id
34510 description: Unique ID of vf-module.
34513 example: __VF-MODULE-ID__
34516 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
34519 $ref: "#/definitions/relationship"
34523 summary: delete an existing relationship
34524 description: delete an existing relationship
34525 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
34534 description: Response codes found in [response codes](https://wiki.onap.org/).
34538 description: Unique id of VNF. This is unique across the graph.
34541 example: __VNF-ID__
34542 - name: vf-module-id
34544 description: Unique ID of vf-module.
34547 example: __VF-MODULE-ID__
34548 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
34552 summary: returns vf-module
34553 description: returns vf-module
34554 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
34560 description: successful operation
34562 $ref: "#/getDefinitions/vf-module"
34564 description: Response codes found in [response codes](https://wiki.onap.org/).
34568 description: Unique id of VNF. This is unique across the graph.
34571 example: __VNF-ID__
34572 - name: vf-module-id
34574 description: Unique ID of vf-module.
34577 example: __VF-MODULE-ID__
34581 summary: create or update an existing vf-module
34583 Create or update an existing vf-module.
34585 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34586 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
34595 description: Response codes found in [response codes](https://wiki.onap.org/).
34599 description: Unique id of VNF. This is unique across the graph.
34602 example: __VNF-ID__
34603 - name: vf-module-id
34605 description: Unique ID of vf-module.
34608 example: __VF-MODULE-ID__
34611 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
34614 $ref: "#/definitions/vf-module"
34618 summary: update an existing vf-module
34620 Update an existing vf-module
34622 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34623 The PUT operation will entirely replace an existing object.
34624 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34626 Other differences between PUT and PATCH are:
34628 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34629 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34630 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34631 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
34640 description: Response codes found in [response codes](https://wiki.onap.org/).
34644 description: Unique id of VNF. This is unique across the graph.
34647 example: __VNF-ID__
34648 - name: vf-module-id
34650 description: Unique ID of vf-module.
34653 example: __VF-MODULE-ID__
34656 description: vf-module object that needs to be updated.
34659 $ref: "#/patchDefinitions/vf-module"
34663 summary: delete an existing vf-module
34664 description: delete an existing vf-module
34665 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
34674 description: Response codes found in [response codes](https://wiki.onap.org/).
34678 description: Unique id of VNF. This is unique across the graph.
34681 example: __VNF-ID__
34682 - name: vf-module-id
34684 description: Unique ID of vf-module.
34687 example: __VF-MODULE-ID__
34688 - name: resource-version
34690 description: resource-version for concurrency
34693 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
34697 summary: returns vf-modules
34698 description: returns vf-modules
34699 operationId: getNetworkGenericVnfsGenericVnfVfModules
34705 description: successful operation
34707 $ref: "#/getDefinitions/vf-modules"
34709 description: Response codes found in [response codes](https://wiki.onap.org/).
34713 description: Unique id of VNF. This is unique across the graph.
34716 example: __VNF-ID__
34717 - name: vf-module-id
34722 - name: vf-module-name
34727 - name: heat-stack-id
34732 - name: model-invariant-id
34737 - name: model-version-id
34742 - name: widget-model-id
34747 - name: widget-model-version
34752 - name: contrail-service-instance-fqdn
34757 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
34761 summary: see node definition for valid relationships
34762 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
34771 description: Response codes found in [response codes](https://wiki.onap.org/).
34775 description: Unique id of VNF. This is unique across the graph.
34778 example: __VNF-ID__
34781 description: Unique ID for the license group the resource belongs to, should be uuid.
34784 example: __GROUP-UUID__
34785 - name: resource-uuid
34787 description: Unique ID of a license resource.
34790 example: __RESOURCE-UUID__
34793 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
34796 $ref: "#/definitions/relationship"
34800 summary: delete an existing relationship
34801 description: delete an existing relationship
34802 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
34811 description: Response codes found in [response codes](https://wiki.onap.org/).
34815 description: Unique id of VNF. This is unique across the graph.
34818 example: __VNF-ID__
34821 description: Unique ID for the license group the resource belongs to, should be uuid.
34824 example: __GROUP-UUID__
34825 - name: resource-uuid
34827 description: Unique ID of a license resource.
34830 example: __RESOURCE-UUID__
34831 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
34835 summary: returns license
34836 description: returns license
34837 operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
34843 description: successful operation
34845 $ref: "#/getDefinitions/license"
34847 description: Response codes found in [response codes](https://wiki.onap.org/).
34851 description: Unique id of VNF. This is unique across the graph.
34854 example: __VNF-ID__
34857 description: Unique ID for the license group the resource belongs to, should be uuid.
34860 example: __GROUP-UUID__
34861 - name: resource-uuid
34863 description: Unique ID of a license resource.
34866 example: __RESOURCE-UUID__
34870 summary: create or update an existing license
34872 Create or update an existing license.
34874 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34875 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
34884 description: Response codes found in [response codes](https://wiki.onap.org/).
34888 description: Unique id of VNF. This is unique across the graph.
34891 example: __VNF-ID__
34894 description: Unique ID for the license group the resource belongs to, should be uuid.
34897 example: __GROUP-UUID__
34898 - name: resource-uuid
34900 description: Unique ID of a license resource.
34903 example: __RESOURCE-UUID__
34906 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
34909 $ref: "#/definitions/license"
34913 summary: update an existing license
34915 Update an existing license
34917 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34918 The PUT operation will entirely replace an existing object.
34919 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34921 Other differences between PUT and PATCH are:
34923 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34924 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34925 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34926 operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
34935 description: Response codes found in [response codes](https://wiki.onap.org/).
34939 description: Unique id of VNF. This is unique across the graph.
34942 example: __VNF-ID__
34945 description: Unique ID for the license group the resource belongs to, should be uuid.
34948 example: __GROUP-UUID__
34949 - name: resource-uuid
34951 description: Unique ID of a license resource.
34954 example: __RESOURCE-UUID__
34957 description: license object that needs to be updated.
34960 $ref: "#/patchDefinitions/license"
34964 summary: delete an existing license
34965 description: delete an existing license
34966 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
34975 description: Response codes found in [response codes](https://wiki.onap.org/).
34979 description: Unique id of VNF. This is unique across the graph.
34982 example: __VNF-ID__
34985 description: Unique ID for the license group the resource belongs to, should be uuid.
34988 example: __GROUP-UUID__
34989 - name: resource-uuid
34991 description: Unique ID of a license resource.
34994 example: __RESOURCE-UUID__
34995 - name: resource-version
34997 description: resource-version for concurrency
35000 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
35004 summary: returns licenses
35005 description: returns licenses
35006 operationId: getNetworkGenericVnfsGenericVnfLicenses
35012 description: successful operation
35014 $ref: "#/getDefinitions/licenses"
35016 description: Response codes found in [response codes](https://wiki.onap.org/).
35020 description: Unique id of VNF. This is unique across the graph.
35023 example: __VNF-ID__
35029 - name: resource-uuid
35034 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
35038 summary: see node definition for valid relationships
35039 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
35048 description: Response codes found in [response codes](https://wiki.onap.org/).
35052 description: Unique id of VNF. This is unique across the graph.
35055 example: __VNF-ID__
35058 description: Unique ID for the entitlement group the resource comes from, should be uuid.
35061 example: __GROUP-UUID__
35062 - name: resource-uuid
35064 description: Unique ID of an entitlement resource.
35067 example: __RESOURCE-UUID__
35070 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
35073 $ref: "#/definitions/relationship"
35077 summary: delete an existing relationship
35078 description: delete an existing relationship
35079 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
35088 description: Response codes found in [response codes](https://wiki.onap.org/).
35092 description: Unique id of VNF. This is unique across the graph.
35095 example: __VNF-ID__
35098 description: Unique ID for the entitlement group the resource comes from, should be uuid.
35101 example: __GROUP-UUID__
35102 - name: resource-uuid
35104 description: Unique ID of an entitlement resource.
35107 example: __RESOURCE-UUID__
35108 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
35112 summary: returns entitlement
35113 description: returns entitlement
35114 operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
35120 description: successful operation
35122 $ref: "#/getDefinitions/entitlement"
35124 description: Response codes found in [response codes](https://wiki.onap.org/).
35128 description: Unique id of VNF. This is unique across the graph.
35131 example: __VNF-ID__
35134 description: Unique ID for the entitlement group the resource comes from, should be uuid.
35137 example: __GROUP-UUID__
35138 - name: resource-uuid
35140 description: Unique ID of an entitlement resource.
35143 example: __RESOURCE-UUID__
35147 summary: create or update an existing entitlement
35149 Create or update an existing entitlement.
35151 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35152 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
35161 description: Response codes found in [response codes](https://wiki.onap.org/).
35165 description: Unique id of VNF. This is unique across the graph.
35168 example: __VNF-ID__
35171 description: Unique ID for the entitlement group the resource comes from, should be uuid.
35174 example: __GROUP-UUID__
35175 - name: resource-uuid
35177 description: Unique ID of an entitlement resource.
35180 example: __RESOURCE-UUID__
35183 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
35186 $ref: "#/definitions/entitlement"
35190 summary: update an existing entitlement
35192 Update an existing entitlement
35194 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35195 The PUT operation will entirely replace an existing object.
35196 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35198 Other differences between PUT and PATCH are:
35200 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35201 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35202 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35203 operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
35212 description: Response codes found in [response codes](https://wiki.onap.org/).
35216 description: Unique id of VNF. This is unique across the graph.
35219 example: __VNF-ID__
35222 description: Unique ID for the entitlement group the resource comes from, should be uuid.
35225 example: __GROUP-UUID__
35226 - name: resource-uuid
35228 description: Unique ID of an entitlement resource.
35231 example: __RESOURCE-UUID__
35234 description: entitlement object that needs to be updated.
35237 $ref: "#/patchDefinitions/entitlement"
35241 summary: delete an existing entitlement
35242 description: delete an existing entitlement
35243 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
35252 description: Response codes found in [response codes](https://wiki.onap.org/).
35256 description: Unique id of VNF. This is unique across the graph.
35259 example: __VNF-ID__
35262 description: Unique ID for the entitlement group the resource comes from, should be uuid.
35265 example: __GROUP-UUID__
35266 - name: resource-uuid
35268 description: Unique ID of an entitlement resource.
35271 example: __RESOURCE-UUID__
35272 - name: resource-version
35274 description: resource-version for concurrency
35277 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
35281 summary: returns entitlements
35282 description: returns entitlements
35283 operationId: getNetworkGenericVnfsGenericVnfEntitlements
35289 description: successful operation
35291 $ref: "#/getDefinitions/entitlements"
35293 description: Response codes found in [response codes](https://wiki.onap.org/).
35297 description: Unique id of VNF. This is unique across the graph.
35300 example: __VNF-ID__
35306 - name: resource-uuid
35311 /network/generic-vnfs/generic-vnf/{vnf-id}:
35315 summary: returns generic-vnf
35316 description: returns generic-vnf
35317 operationId: getNetworkGenericVnfsGenericVnf
35323 description: successful operation
35325 $ref: "#/getDefinitions/generic-vnf"
35327 description: Response codes found in [response codes](https://wiki.onap.org/).
35331 description: Unique id of VNF. This is unique across the graph.
35334 example: __VNF-ID__
35338 summary: create or update an existing generic-vnf
35340 Create or update an existing generic-vnf.
35342 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35343 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
35352 description: Response codes found in [response codes](https://wiki.onap.org/).
35356 description: Unique id of VNF. This is unique across the graph.
35359 example: __VNF-ID__
35362 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)
35365 $ref: "#/definitions/generic-vnf"
35369 summary: update an existing generic-vnf
35371 Update an existing generic-vnf
35373 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35374 The PUT operation will entirely replace an existing object.
35375 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35377 Other differences between PUT and PATCH are:
35379 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35380 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35381 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35382 operationId: UpdateNetworkGenericVnfsGenericVnf
35391 description: Response codes found in [response codes](https://wiki.onap.org/).
35395 description: Unique id of VNF. This is unique across the graph.
35398 example: __VNF-ID__
35401 description: generic-vnf object that needs to be updated.
35404 $ref: "#/patchDefinitions/generic-vnf"
35408 summary: delete an existing generic-vnf
35409 description: delete an existing generic-vnf
35410 operationId: deleteNetworkGenericVnfsGenericVnf
35419 description: Response codes found in [response codes](https://wiki.onap.org/).
35423 description: Unique id of VNF. This is unique across the graph.
35426 example: __VNF-ID__
35427 - name: resource-version
35429 description: resource-version for concurrency
35432 /network/generic-vnfs:
35436 summary: returns generic-vnfs
35437 description: returns generic-vnfs
35438 operationId: getNetworkGenericVnfs
35444 description: successful operation
35446 $ref: "#/getDefinitions/generic-vnfs"
35448 description: Response codes found in [response codes](https://wiki.onap.org/).
35475 - name: regional-resource-zone
35480 - name: prov-status
35485 - name: heat-stack-id
35495 - name: is-closed-loop-disabled
35500 - name: model-invariant-id
35505 - name: model-version-id
35510 - name: widget-model-id
35515 - name: widget-model-version
35525 - name: nf-function
35535 - name: nf-naming-code
35540 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
35544 summary: see node definition for valid relationships
35545 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
35554 description: Response codes found in [response codes](https://wiki.onap.org/).
35558 description: Alphabetical concatenation of lag-interface names
35561 example: __LINK-NAME__
35564 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
35567 $ref: "#/definitions/relationship"
35571 summary: delete an existing relationship
35572 description: delete an existing relationship
35573 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
35582 description: Response codes found in [response codes](https://wiki.onap.org/).
35586 description: Alphabetical concatenation of lag-interface names
35589 example: __LINK-NAME__
35590 /network/lag-links/lag-link/{link-name}:
35594 summary: returns lag-link
35595 description: returns lag-link
35596 operationId: getNetworkLagLinksLagLink
35602 description: successful operation
35604 $ref: "#/getDefinitions/lag-link"
35606 description: Response codes found in [response codes](https://wiki.onap.org/).
35610 description: Alphabetical concatenation of lag-interface names
35613 example: __LINK-NAME__
35617 summary: create or update an existing lag-link
35619 Create or update an existing lag-link.
35621 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35622 operationId: createOrUpdateNetworkLagLinksLagLink
35631 description: Response codes found in [response codes](https://wiki.onap.org/).
35635 description: Alphabetical concatenation of lag-interface names
35638 example: __LINK-NAME__
35641 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
35644 $ref: "#/definitions/lag-link"
35648 summary: update an existing lag-link
35650 Update an existing lag-link
35652 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35653 The PUT operation will entirely replace an existing object.
35654 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35656 Other differences between PUT and PATCH are:
35658 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35659 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35660 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35661 operationId: UpdateNetworkLagLinksLagLink
35670 description: Response codes found in [response codes](https://wiki.onap.org/).
35674 description: Alphabetical concatenation of lag-interface names
35677 example: __LINK-NAME__
35680 description: lag-link object that needs to be updated.
35683 $ref: "#/patchDefinitions/lag-link"
35687 summary: delete an existing lag-link
35688 description: delete an existing lag-link
35689 operationId: deleteNetworkLagLinksLagLink
35698 description: Response codes found in [response codes](https://wiki.onap.org/).
35702 description: Alphabetical concatenation of lag-interface names
35705 example: __LINK-NAME__
35706 - name: resource-version
35708 description: resource-version for concurrency
35711 /network/lag-links:
35715 summary: returns lag-links
35716 description: returns lag-links
35717 operationId: getNetworkLagLinks
35723 description: successful operation
35725 $ref: "#/getDefinitions/lag-links"
35727 description: Response codes found in [response codes](https://wiki.onap.org/).
35734 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
35738 summary: see node definition for valid relationships
35739 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
35748 description: Response codes found in [response codes](https://wiki.onap.org/).
35752 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35755 example: __VNF-ID2__
35758 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)
35761 $ref: "#/definitions/relationship"
35765 summary: delete an existing relationship
35766 description: delete an existing relationship
35767 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
35776 description: Response codes found in [response codes](https://wiki.onap.org/).
35780 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35783 example: __VNF-ID2__
35784 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
35788 summary: see node definition for valid relationships
35789 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35798 description: Response codes found in [response codes](https://wiki.onap.org/).
35802 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35805 example: __VNF-ID2__
35806 - name: interface-name
35808 description: Name given to the interface
35811 example: __INTERFACE-NAME__
35812 - name: vlan-interface
35814 description: String that identifies the interface
35817 example: __VLAN-INTERFACE__
35820 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
35823 $ref: "#/definitions/relationship"
35827 summary: delete an existing relationship
35828 description: delete an existing relationship
35829 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35838 description: Response codes found in [response codes](https://wiki.onap.org/).
35842 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35845 example: __VNF-ID2__
35846 - name: interface-name
35848 description: Name given to the interface
35851 example: __INTERFACE-NAME__
35852 - name: vlan-interface
35854 description: String that identifies the interface
35857 example: __VLAN-INTERFACE__
35858 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
35862 summary: see node definition for valid relationships
35863 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35872 description: Response codes found in [response codes](https://wiki.onap.org/).
35876 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35879 example: __VNF-ID2__
35880 - name: interface-name
35882 description: Name given to the interface
35885 example: __INTERFACE-NAME__
35886 - name: vlan-interface
35888 description: String that identifies the interface
35891 example: __VLAN-INTERFACE__
35892 - name: l3-interface-ipv4-address
35894 description: IP address
35897 example: __L3-INTERFACE-IPV4-ADDRESS__
35900 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35903 $ref: "#/definitions/relationship"
35907 summary: delete an existing relationship
35908 description: delete an existing relationship
35909 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35918 description: Response codes found in [response codes](https://wiki.onap.org/).
35922 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35925 example: __VNF-ID2__
35926 - name: interface-name
35928 description: Name given to the interface
35931 example: __INTERFACE-NAME__
35932 - name: vlan-interface
35934 description: String that identifies the interface
35937 example: __VLAN-INTERFACE__
35938 - name: l3-interface-ipv4-address
35940 description: IP address
35943 example: __L3-INTERFACE-IPV4-ADDRESS__
35944 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
35948 summary: returns l3-interface-ipv4-address-list
35949 description: returns l3-interface-ipv4-address-list
35950 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35956 description: successful operation
35958 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35960 description: Response codes found in [response codes](https://wiki.onap.org/).
35964 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35967 example: __VNF-ID2__
35968 - name: interface-name
35970 description: Name given to the interface
35973 example: __INTERFACE-NAME__
35974 - name: vlan-interface
35976 description: String that identifies the interface
35979 example: __VLAN-INTERFACE__
35980 - name: l3-interface-ipv4-address
35982 description: IP address
35985 example: __L3-INTERFACE-IPV4-ADDRESS__
35989 summary: create or update an existing l3-interface-ipv4-address-list
35991 Create or update an existing l3-interface-ipv4-address-list.
35993 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35994 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
36003 description: Response codes found in [response codes](https://wiki.onap.org/).
36007 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36010 example: __VNF-ID2__
36011 - name: interface-name
36013 description: Name given to the interface
36016 example: __INTERFACE-NAME__
36017 - name: vlan-interface
36019 description: String that identifies the interface
36022 example: __VLAN-INTERFACE__
36023 - name: l3-interface-ipv4-address
36025 description: IP address
36028 example: __L3-INTERFACE-IPV4-ADDRESS__
36031 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
36034 $ref: "#/definitions/l3-interface-ipv4-address-list"
36038 summary: update an existing l3-interface-ipv4-address-list
36040 Update an existing l3-interface-ipv4-address-list
36042 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36043 The PUT operation will entirely replace an existing object.
36044 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36046 Other differences between PUT and PATCH are:
36048 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36049 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36050 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36051 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
36060 description: Response codes found in [response codes](https://wiki.onap.org/).
36064 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36067 example: __VNF-ID2__
36068 - name: interface-name
36070 description: Name given to the interface
36073 example: __INTERFACE-NAME__
36074 - name: vlan-interface
36076 description: String that identifies the interface
36079 example: __VLAN-INTERFACE__
36080 - name: l3-interface-ipv4-address
36082 description: IP address
36085 example: __L3-INTERFACE-IPV4-ADDRESS__
36088 description: l3-interface-ipv4-address-list object that needs to be updated.
36091 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36095 summary: delete an existing l3-interface-ipv4-address-list
36096 description: delete an existing l3-interface-ipv4-address-list
36097 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
36106 description: Response codes found in [response codes](https://wiki.onap.org/).
36110 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36113 example: __VNF-ID2__
36114 - name: interface-name
36116 description: Name given to the interface
36119 example: __INTERFACE-NAME__
36120 - name: vlan-interface
36122 description: String that identifies the interface
36125 example: __VLAN-INTERFACE__
36126 - name: l3-interface-ipv4-address
36128 description: IP address
36131 example: __L3-INTERFACE-IPV4-ADDRESS__
36132 - name: resource-version
36134 description: resource-version for concurrency
36137 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
36141 summary: see node definition for valid relationships
36142 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
36151 description: Response codes found in [response codes](https://wiki.onap.org/).
36155 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36158 example: __VNF-ID2__
36159 - name: interface-name
36161 description: Name given to the interface
36164 example: __INTERFACE-NAME__
36165 - name: vlan-interface
36167 description: String that identifies the interface
36170 example: __VLAN-INTERFACE__
36171 - name: l3-interface-ipv6-address
36173 description: IP address
36176 example: __L3-INTERFACE-IPV6-ADDRESS__
36179 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
36182 $ref: "#/definitions/relationship"
36186 summary: delete an existing relationship
36187 description: delete an existing relationship
36188 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
36197 description: Response codes found in [response codes](https://wiki.onap.org/).
36201 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36204 example: __VNF-ID2__
36205 - name: interface-name
36207 description: Name given to the interface
36210 example: __INTERFACE-NAME__
36211 - name: vlan-interface
36213 description: String that identifies the interface
36216 example: __VLAN-INTERFACE__
36217 - name: l3-interface-ipv6-address
36219 description: IP address
36222 example: __L3-INTERFACE-IPV6-ADDRESS__
36223 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
36227 summary: returns l3-interface-ipv6-address-list
36228 description: returns l3-interface-ipv6-address-list
36229 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36235 description: successful operation
36237 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36239 description: Response codes found in [response codes](https://wiki.onap.org/).
36243 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36246 example: __VNF-ID2__
36247 - name: interface-name
36249 description: Name given to the interface
36252 example: __INTERFACE-NAME__
36253 - name: vlan-interface
36255 description: String that identifies the interface
36258 example: __VLAN-INTERFACE__
36259 - name: l3-interface-ipv6-address
36261 description: IP address
36264 example: __L3-INTERFACE-IPV6-ADDRESS__
36268 summary: create or update an existing l3-interface-ipv6-address-list
36270 Create or update an existing l3-interface-ipv6-address-list.
36272 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36273 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36282 description: Response codes found in [response codes](https://wiki.onap.org/).
36286 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36289 example: __VNF-ID2__
36290 - name: interface-name
36292 description: Name given to the interface
36295 example: __INTERFACE-NAME__
36296 - name: vlan-interface
36298 description: String that identifies the interface
36301 example: __VLAN-INTERFACE__
36302 - name: l3-interface-ipv6-address
36304 description: IP address
36307 example: __L3-INTERFACE-IPV6-ADDRESS__
36310 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
36313 $ref: "#/definitions/l3-interface-ipv6-address-list"
36317 summary: update an existing l3-interface-ipv6-address-list
36319 Update an existing l3-interface-ipv6-address-list
36321 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36322 The PUT operation will entirely replace an existing object.
36323 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36325 Other differences between PUT and PATCH are:
36327 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36328 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36329 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36330 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36339 description: Response codes found in [response codes](https://wiki.onap.org/).
36343 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36346 example: __VNF-ID2__
36347 - name: interface-name
36349 description: Name given to the interface
36352 example: __INTERFACE-NAME__
36353 - name: vlan-interface
36355 description: String that identifies the interface
36358 example: __VLAN-INTERFACE__
36359 - name: l3-interface-ipv6-address
36361 description: IP address
36364 example: __L3-INTERFACE-IPV6-ADDRESS__
36367 description: l3-interface-ipv6-address-list object that needs to be updated.
36370 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36374 summary: delete an existing l3-interface-ipv6-address-list
36375 description: delete an existing l3-interface-ipv6-address-list
36376 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
36385 description: Response codes found in [response codes](https://wiki.onap.org/).
36389 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36392 example: __VNF-ID2__
36393 - name: interface-name
36395 description: Name given to the interface
36398 example: __INTERFACE-NAME__
36399 - name: vlan-interface
36401 description: String that identifies the interface
36404 example: __VLAN-INTERFACE__
36405 - name: l3-interface-ipv6-address
36407 description: IP address
36410 example: __L3-INTERFACE-IPV6-ADDRESS__
36411 - name: resource-version
36413 description: resource-version for concurrency
36416 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
36420 summary: returns vlan
36421 description: returns vlan
36422 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
36428 description: successful operation
36430 $ref: "#/getDefinitions/vlan"
36432 description: Response codes found in [response codes](https://wiki.onap.org/).
36436 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36439 example: __VNF-ID2__
36440 - name: interface-name
36442 description: Name given to the interface
36445 example: __INTERFACE-NAME__
36446 - name: vlan-interface
36448 description: String that identifies the interface
36451 example: __VLAN-INTERFACE__
36455 summary: create or update an existing vlan
36457 Create or update an existing vlan.
36459 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36460 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
36469 description: Response codes found in [response codes](https://wiki.onap.org/).
36473 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36476 example: __VNF-ID2__
36477 - name: interface-name
36479 description: Name given to the interface
36482 example: __INTERFACE-NAME__
36483 - name: vlan-interface
36485 description: String that identifies the interface
36488 example: __VLAN-INTERFACE__
36491 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
36494 $ref: "#/definitions/vlan"
36498 summary: update an existing vlan
36500 Update an existing vlan
36502 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36503 The PUT operation will entirely replace an existing object.
36504 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36506 Other differences between PUT and PATCH are:
36508 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36509 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36510 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36511 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
36520 description: Response codes found in [response codes](https://wiki.onap.org/).
36524 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36527 example: __VNF-ID2__
36528 - name: interface-name
36530 description: Name given to the interface
36533 example: __INTERFACE-NAME__
36534 - name: vlan-interface
36536 description: String that identifies the interface
36539 example: __VLAN-INTERFACE__
36542 description: vlan object that needs to be updated.
36545 $ref: "#/patchDefinitions/vlan"
36549 summary: delete an existing vlan
36550 description: delete an existing vlan
36551 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
36560 description: Response codes found in [response codes](https://wiki.onap.org/).
36564 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36567 example: __VNF-ID2__
36568 - name: interface-name
36570 description: Name given to the interface
36573 example: __INTERFACE-NAME__
36574 - name: vlan-interface
36576 description: String that identifies the interface
36579 example: __VLAN-INTERFACE__
36580 - name: resource-version
36582 description: resource-version for concurrency
36585 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
36589 summary: returns vlans
36590 description: returns vlans
36591 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
36597 description: successful operation
36599 $ref: "#/getDefinitions/vlans"
36601 description: Response codes found in [response codes](https://wiki.onap.org/).
36605 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36608 example: __VNF-ID2__
36609 - name: interface-name
36611 description: Name given to the interface
36614 example: __INTERFACE-NAME__
36615 - name: vlan-interface
36620 - name: vlan-id-inner
36631 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
36635 summary: see node definition for valid relationships
36636 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36645 description: Response codes found in [response codes](https://wiki.onap.org/).
36649 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36652 example: __VNF-ID2__
36653 - name: interface-name
36655 description: Name given to the interface
36658 example: __INTERFACE-NAME__
36661 description: PCI ID used to identify the sriov-vf
36664 example: __PCI-ID__
36667 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
36670 $ref: "#/definitions/relationship"
36674 summary: delete an existing relationship
36675 description: delete an existing relationship
36676 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36685 description: Response codes found in [response codes](https://wiki.onap.org/).
36689 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36692 example: __VNF-ID2__
36693 - name: interface-name
36695 description: Name given to the interface
36698 example: __INTERFACE-NAME__
36701 description: PCI ID used to identify the sriov-vf
36704 example: __PCI-ID__
36705 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
36709 summary: returns sriov-vf
36710 description: returns sriov-vf
36711 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36717 description: successful operation
36719 $ref: "#/getDefinitions/sriov-vf"
36721 description: Response codes found in [response codes](https://wiki.onap.org/).
36725 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36728 example: __VNF-ID2__
36729 - name: interface-name
36731 description: Name given to the interface
36734 example: __INTERFACE-NAME__
36737 description: PCI ID used to identify the sriov-vf
36740 example: __PCI-ID__
36744 summary: create or update an existing sriov-vf
36746 Create or update an existing sriov-vf.
36748 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36749 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36758 description: Response codes found in [response codes](https://wiki.onap.org/).
36762 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36765 example: __VNF-ID2__
36766 - name: interface-name
36768 description: Name given to the interface
36771 example: __INTERFACE-NAME__
36774 description: PCI ID used to identify the sriov-vf
36777 example: __PCI-ID__
36780 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
36783 $ref: "#/definitions/sriov-vf"
36787 summary: update an existing sriov-vf
36789 Update an existing sriov-vf
36791 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36792 The PUT operation will entirely replace an existing object.
36793 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36795 Other differences between PUT and PATCH are:
36797 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36798 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36799 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36800 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36809 description: Response codes found in [response codes](https://wiki.onap.org/).
36813 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36816 example: __VNF-ID2__
36817 - name: interface-name
36819 description: Name given to the interface
36822 example: __INTERFACE-NAME__
36825 description: PCI ID used to identify the sriov-vf
36828 example: __PCI-ID__
36831 description: sriov-vf object that needs to be updated.
36834 $ref: "#/patchDefinitions/sriov-vf"
36838 summary: delete an existing sriov-vf
36839 description: delete an existing sriov-vf
36840 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36849 description: Response codes found in [response codes](https://wiki.onap.org/).
36853 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36856 example: __VNF-ID2__
36857 - name: interface-name
36859 description: Name given to the interface
36862 example: __INTERFACE-NAME__
36865 description: PCI ID used to identify the sriov-vf
36868 example: __PCI-ID__
36869 - name: resource-version
36871 description: resource-version for concurrency
36874 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36878 summary: returns sriov-vfs
36879 description: returns sriov-vfs
36880 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
36886 description: successful operation
36888 $ref: "#/getDefinitions/sriov-vfs"
36890 description: Response codes found in [response codes](https://wiki.onap.org/).
36894 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36897 example: __VNF-ID2__
36898 - name: interface-name
36900 description: Name given to the interface
36903 example: __INTERFACE-NAME__
36909 - name: vf-vlan-filter
36914 - name: vf-mac-filter
36919 - name: vf-vlan-strip
36924 - name: neutron-network-id
36929 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36933 summary: see node definition for valid relationships
36934 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
36943 description: Response codes found in [response codes](https://wiki.onap.org/).
36947 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36950 example: __VNF-ID2__
36951 - name: interface-name
36953 description: Name given to the interface
36956 example: __INTERFACE-NAME__
36959 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)
36962 $ref: "#/definitions/relationship"
36966 summary: delete an existing relationship
36967 description: delete an existing relationship
36968 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
36977 description: Response codes found in [response codes](https://wiki.onap.org/).
36981 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36984 example: __VNF-ID2__
36985 - name: interface-name
36987 description: Name given to the interface
36990 example: __INTERFACE-NAME__
36991 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
36995 summary: see node definition for valid relationships
36996 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
37005 description: Response codes found in [response codes](https://wiki.onap.org/).
37009 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37012 example: __VNF-ID2__
37013 - name: interface-name
37015 description: Name given to the interface
37018 example: __INTERFACE-NAME__
37019 - name: l3-interface-ipv4-address
37021 description: IP address
37024 example: __L3-INTERFACE-IPV4-ADDRESS__
37027 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
37030 $ref: "#/definitions/relationship"
37034 summary: delete an existing relationship
37035 description: delete an existing relationship
37036 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
37045 description: Response codes found in [response codes](https://wiki.onap.org/).
37049 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37052 example: __VNF-ID2__
37053 - name: interface-name
37055 description: Name given to the interface
37058 example: __INTERFACE-NAME__
37059 - name: l3-interface-ipv4-address
37061 description: IP address
37064 example: __L3-INTERFACE-IPV4-ADDRESS__
37065 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
37069 summary: returns l3-interface-ipv4-address-list
37070 description: returns l3-interface-ipv4-address-list
37071 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
37077 description: successful operation
37079 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37081 description: Response codes found in [response codes](https://wiki.onap.org/).
37085 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37088 example: __VNF-ID2__
37089 - name: interface-name
37091 description: Name given to the interface
37094 example: __INTERFACE-NAME__
37095 - name: l3-interface-ipv4-address
37097 description: IP address
37100 example: __L3-INTERFACE-IPV4-ADDRESS__
37104 summary: create or update an existing l3-interface-ipv4-address-list
37106 Create or update an existing l3-interface-ipv4-address-list.
37108 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37109 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
37118 description: Response codes found in [response codes](https://wiki.onap.org/).
37122 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37125 example: __VNF-ID2__
37126 - name: interface-name
37128 description: Name given to the interface
37131 example: __INTERFACE-NAME__
37132 - name: l3-interface-ipv4-address
37134 description: IP address
37137 example: __L3-INTERFACE-IPV4-ADDRESS__
37140 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
37143 $ref: "#/definitions/l3-interface-ipv4-address-list"
37147 summary: update an existing l3-interface-ipv4-address-list
37149 Update an existing l3-interface-ipv4-address-list
37151 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37152 The PUT operation will entirely replace an existing object.
37153 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37155 Other differences between PUT and PATCH are:
37157 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37158 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37159 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37160 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
37169 description: Response codes found in [response codes](https://wiki.onap.org/).
37173 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37176 example: __VNF-ID2__
37177 - name: interface-name
37179 description: Name given to the interface
37182 example: __INTERFACE-NAME__
37183 - name: l3-interface-ipv4-address
37185 description: IP address
37188 example: __L3-INTERFACE-IPV4-ADDRESS__
37191 description: l3-interface-ipv4-address-list object that needs to be updated.
37194 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37198 summary: delete an existing l3-interface-ipv4-address-list
37199 description: delete an existing l3-interface-ipv4-address-list
37200 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
37209 description: Response codes found in [response codes](https://wiki.onap.org/).
37213 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37216 example: __VNF-ID2__
37217 - name: interface-name
37219 description: Name given to the interface
37222 example: __INTERFACE-NAME__
37223 - name: l3-interface-ipv4-address
37225 description: IP address
37228 example: __L3-INTERFACE-IPV4-ADDRESS__
37229 - name: resource-version
37231 description: resource-version for concurrency
37234 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
37238 summary: see node definition for valid relationships
37239 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
37248 description: Response codes found in [response codes](https://wiki.onap.org/).
37252 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37255 example: __VNF-ID2__
37256 - name: interface-name
37258 description: Name given to the interface
37261 example: __INTERFACE-NAME__
37262 - name: l3-interface-ipv6-address
37264 description: IP address
37267 example: __L3-INTERFACE-IPV6-ADDRESS__
37270 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
37273 $ref: "#/definitions/relationship"
37277 summary: delete an existing relationship
37278 description: delete an existing relationship
37279 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
37288 description: Response codes found in [response codes](https://wiki.onap.org/).
37292 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37295 example: __VNF-ID2__
37296 - name: interface-name
37298 description: Name given to the interface
37301 example: __INTERFACE-NAME__
37302 - name: l3-interface-ipv6-address
37304 description: IP address
37307 example: __L3-INTERFACE-IPV6-ADDRESS__
37308 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
37312 summary: returns l3-interface-ipv6-address-list
37313 description: returns l3-interface-ipv6-address-list
37314 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37320 description: successful operation
37322 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37324 description: Response codes found in [response codes](https://wiki.onap.org/).
37328 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37331 example: __VNF-ID2__
37332 - name: interface-name
37334 description: Name given to the interface
37337 example: __INTERFACE-NAME__
37338 - name: l3-interface-ipv6-address
37340 description: IP address
37343 example: __L3-INTERFACE-IPV6-ADDRESS__
37347 summary: create or update an existing l3-interface-ipv6-address-list
37349 Create or update an existing l3-interface-ipv6-address-list.
37351 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37352 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37361 description: Response codes found in [response codes](https://wiki.onap.org/).
37365 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37368 example: __VNF-ID2__
37369 - name: interface-name
37371 description: Name given to the interface
37374 example: __INTERFACE-NAME__
37375 - name: l3-interface-ipv6-address
37377 description: IP address
37380 example: __L3-INTERFACE-IPV6-ADDRESS__
37383 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
37386 $ref: "#/definitions/l3-interface-ipv6-address-list"
37390 summary: update an existing l3-interface-ipv6-address-list
37392 Update an existing l3-interface-ipv6-address-list
37394 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37395 The PUT operation will entirely replace an existing object.
37396 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37398 Other differences between PUT and PATCH are:
37400 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37401 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37402 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37403 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37412 description: Response codes found in [response codes](https://wiki.onap.org/).
37416 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37419 example: __VNF-ID2__
37420 - name: interface-name
37422 description: Name given to the interface
37425 example: __INTERFACE-NAME__
37426 - name: l3-interface-ipv6-address
37428 description: IP address
37431 example: __L3-INTERFACE-IPV6-ADDRESS__
37434 description: l3-interface-ipv6-address-list object that needs to be updated.
37437 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37441 summary: delete an existing l3-interface-ipv6-address-list
37442 description: delete an existing l3-interface-ipv6-address-list
37443 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37452 description: Response codes found in [response codes](https://wiki.onap.org/).
37456 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37459 example: __VNF-ID2__
37460 - name: interface-name
37462 description: Name given to the interface
37465 example: __INTERFACE-NAME__
37466 - name: l3-interface-ipv6-address
37468 description: IP address
37471 example: __L3-INTERFACE-IPV6-ADDRESS__
37472 - name: resource-version
37474 description: resource-version for concurrency
37477 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
37481 summary: returns l-interface
37482 description: returns l-interface
37483 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
37489 description: successful operation
37491 $ref: "#/getDefinitions/l-interface"
37493 description: Response codes found in [response codes](https://wiki.onap.org/).
37497 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37500 example: __VNF-ID2__
37501 - name: interface-name
37503 description: Name given to the interface
37506 example: __INTERFACE-NAME__
37510 summary: create or update an existing l-interface
37512 Create or update an existing l-interface.
37514 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37515 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
37524 description: Response codes found in [response codes](https://wiki.onap.org/).
37528 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37531 example: __VNF-ID2__
37532 - name: interface-name
37534 description: Name given to the interface
37537 example: __INTERFACE-NAME__
37540 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)
37543 $ref: "#/definitions/l-interface"
37547 summary: update an existing l-interface
37549 Update an existing l-interface
37551 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37552 The PUT operation will entirely replace an existing object.
37553 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37555 Other differences between PUT and PATCH are:
37557 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37558 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37559 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37560 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
37569 description: Response codes found in [response codes](https://wiki.onap.org/).
37573 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37576 example: __VNF-ID2__
37577 - name: interface-name
37579 description: Name given to the interface
37582 example: __INTERFACE-NAME__
37585 description: l-interface object that needs to be updated.
37588 $ref: "#/patchDefinitions/l-interface"
37592 summary: delete an existing l-interface
37593 description: delete an existing l-interface
37594 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
37603 description: Response codes found in [response codes](https://wiki.onap.org/).
37607 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37610 example: __VNF-ID2__
37611 - name: interface-name
37613 description: Name given to the interface
37616 example: __INTERFACE-NAME__
37617 - name: resource-version
37619 description: resource-version for concurrency
37622 /network/newvces/newvce/{vnf-id2}/l-interfaces:
37626 summary: returns l-interfaces
37627 description: returns l-interfaces
37628 operationId: getNetworkNewvcesNewvceLInterfaces
37634 description: successful operation
37636 $ref: "#/getDefinitions/l-interfaces"
37638 description: Response codes found in [response codes](https://wiki.onap.org/).
37642 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37645 example: __VNF-ID2__
37646 - name: interface-name
37651 - name: interface-id
37661 - name: network-name
37666 /network/newvces/newvce/{vnf-id2}:
37670 summary: returns newvce
37671 description: returns newvce
37672 operationId: getNetworkNewvcesNewvce
37678 description: successful operation
37680 $ref: "#/getDefinitions/newvce"
37682 description: Response codes found in [response codes](https://wiki.onap.org/).
37686 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37689 example: __VNF-ID2__
37693 summary: create or update an existing newvce
37695 Create or update an existing newvce.
37697 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37698 operationId: createOrUpdateNetworkNewvcesNewvce
37707 description: Response codes found in [response codes](https://wiki.onap.org/).
37711 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37714 example: __VNF-ID2__
37717 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)
37720 $ref: "#/definitions/newvce"
37724 summary: update an existing newvce
37726 Update an existing newvce
37728 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37729 The PUT operation will entirely replace an existing object.
37730 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37732 Other differences between PUT and PATCH are:
37734 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37735 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37736 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37737 operationId: UpdateNetworkNewvcesNewvce
37746 description: Response codes found in [response codes](https://wiki.onap.org/).
37750 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37753 example: __VNF-ID2__
37756 description: newvce object that needs to be updated.
37759 $ref: "#/patchDefinitions/newvce"
37763 summary: delete an existing newvce
37764 description: delete an existing newvce
37765 operationId: deleteNetworkNewvcesNewvce
37774 description: Response codes found in [response codes](https://wiki.onap.org/).
37778 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37781 example: __VNF-ID2__
37782 - name: resource-version
37784 description: resource-version for concurrency
37791 summary: returns newvces
37792 description: returns newvces
37793 operationId: getNetworkNewvces
37799 description: successful operation
37801 $ref: "#/getDefinitions/newvces"
37803 description: Response codes found in [response codes](https://wiki.onap.org/).
37825 - name: prov-status
37830 - name: heat-stack-id
37835 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
37839 summary: see node definition for valid relationships
37840 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
37849 description: Response codes found in [response codes](https://wiki.onap.org/).
37853 description: unique name of Physical Network Function.
37856 example: __PNF-NAME__
37859 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)
37862 $ref: "#/definitions/relationship"
37866 summary: delete an existing relationship
37867 description: delete an existing relationship
37868 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
37877 description: Response codes found in [response codes](https://wiki.onap.org/).
37881 description: unique name of Physical Network Function.
37884 example: __PNF-NAME__
37885 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
37889 summary: see node definition for valid relationships
37890 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
37899 description: Response codes found in [response codes](https://wiki.onap.org/).
37903 description: unique name of Physical Network Function.
37906 example: __PNF-NAME__
37907 - name: interface-name
37909 description: Name that identifies the physical interface
37912 example: __INTERFACE-NAME__
37915 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)
37918 $ref: "#/definitions/relationship"
37922 summary: delete an existing relationship
37923 description: delete an existing relationship
37924 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
37933 description: Response codes found in [response codes](https://wiki.onap.org/).
37937 description: unique name of Physical Network Function.
37940 example: __PNF-NAME__
37941 - name: interface-name
37943 description: Name that identifies the physical interface
37946 example: __INTERFACE-NAME__
37947 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
37951 summary: see node definition for valid relationships
37952 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
37961 description: Response codes found in [response codes](https://wiki.onap.org/).
37965 description: unique name of Physical Network Function.
37968 example: __PNF-NAME__
37969 - name: interface-name
37971 description: Name that identifies the physical interface
37974 example: __INTERFACE-NAME__
37977 description: Identifier for the sriov-pf
37980 example: __PF-PCI-ID__
37983 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
37986 $ref: "#/definitions/relationship"
37990 summary: delete an existing relationship
37991 description: delete an existing relationship
37992 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
38001 description: Response codes found in [response codes](https://wiki.onap.org/).
38005 description: unique name of Physical Network Function.
38008 example: __PNF-NAME__
38009 - name: interface-name
38011 description: Name that identifies the physical interface
38014 example: __INTERFACE-NAME__
38017 description: Identifier for the sriov-pf
38020 example: __PF-PCI-ID__
38021 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
38025 summary: returns sriov-pf
38026 description: returns sriov-pf
38027 operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
38033 description: successful operation
38035 $ref: "#/getDefinitions/sriov-pf"
38037 description: Response codes found in [response codes](https://wiki.onap.org/).
38041 description: unique name of Physical Network Function.
38044 example: __PNF-NAME__
38045 - name: interface-name
38047 description: Name that identifies the physical interface
38050 example: __INTERFACE-NAME__
38053 description: Identifier for the sriov-pf
38056 example: __PF-PCI-ID__
38060 summary: create or update an existing sriov-pf
38062 Create or update an existing sriov-pf.
38064 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38065 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
38074 description: Response codes found in [response codes](https://wiki.onap.org/).
38078 description: unique name of Physical Network Function.
38081 example: __PNF-NAME__
38082 - name: interface-name
38084 description: Name that identifies the physical interface
38087 example: __INTERFACE-NAME__
38090 description: Identifier for the sriov-pf
38093 example: __PF-PCI-ID__
38096 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
38099 $ref: "#/definitions/sriov-pf"
38103 summary: update an existing sriov-pf
38105 Update an existing sriov-pf
38107 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38108 The PUT operation will entirely replace an existing object.
38109 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38111 Other differences between PUT and PATCH are:
38113 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38114 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38115 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38116 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
38125 description: Response codes found in [response codes](https://wiki.onap.org/).
38129 description: unique name of Physical Network Function.
38132 example: __PNF-NAME__
38133 - name: interface-name
38135 description: Name that identifies the physical interface
38138 example: __INTERFACE-NAME__
38141 description: Identifier for the sriov-pf
38144 example: __PF-PCI-ID__
38147 description: sriov-pf object that needs to be updated.
38150 $ref: "#/patchDefinitions/sriov-pf"
38154 summary: delete an existing sriov-pf
38155 description: delete an existing sriov-pf
38156 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
38165 description: Response codes found in [response codes](https://wiki.onap.org/).
38169 description: unique name of Physical Network Function.
38172 example: __PNF-NAME__
38173 - name: interface-name
38175 description: Name that identifies the physical interface
38178 example: __INTERFACE-NAME__
38181 description: Identifier for the sriov-pf
38184 example: __PF-PCI-ID__
38185 - name: resource-version
38187 description: resource-version for concurrency
38190 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
38194 summary: returns sriov-pfs
38195 description: returns sriov-pfs
38196 operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
38202 description: successful operation
38204 $ref: "#/getDefinitions/sriov-pfs"
38206 description: Response codes found in [response codes](https://wiki.onap.org/).
38210 description: unique name of Physical Network Function.
38213 example: __PNF-NAME__
38214 - name: interface-name
38216 description: Name that identifies the physical interface
38219 example: __INTERFACE-NAME__
38225 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
38229 summary: see node definition for valid relationships
38230 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38239 description: Response codes found in [response codes](https://wiki.onap.org/).
38243 description: unique name of Physical Network Function.
38246 example: __PNF-NAME__
38247 - name: interface-name
38249 description: Name that identifies the physical interface
38252 example: __INTERFACE-NAME__
38253 - name: interface-name
38255 description: Name given to the interface
38258 example: __INTERFACE-NAME__
38259 - name: vlan-interface
38261 description: String that identifies the interface
38264 example: __VLAN-INTERFACE__
38267 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
38270 $ref: "#/definitions/relationship"
38274 summary: delete an existing relationship
38275 description: delete an existing relationship
38276 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38285 description: Response codes found in [response codes](https://wiki.onap.org/).
38289 description: unique name of Physical Network Function.
38292 example: __PNF-NAME__
38293 - name: interface-name
38295 description: Name that identifies the physical interface
38298 example: __INTERFACE-NAME__
38299 - name: interface-name
38301 description: Name given to the interface
38304 example: __INTERFACE-NAME__
38305 - name: vlan-interface
38307 description: String that identifies the interface
38310 example: __VLAN-INTERFACE__
38311 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
38315 summary: see node definition for valid relationships
38316 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38325 description: Response codes found in [response codes](https://wiki.onap.org/).
38329 description: unique name of Physical Network Function.
38332 example: __PNF-NAME__
38333 - name: interface-name
38335 description: Name that identifies the physical interface
38338 example: __INTERFACE-NAME__
38339 - name: interface-name
38341 description: Name given to the interface
38344 example: __INTERFACE-NAME__
38345 - name: vlan-interface
38347 description: String that identifies the interface
38350 example: __VLAN-INTERFACE__
38351 - name: l3-interface-ipv4-address
38353 description: IP address
38356 example: __L3-INTERFACE-IPV4-ADDRESS__
38359 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38362 $ref: "#/definitions/relationship"
38366 summary: delete an existing relationship
38367 description: delete an existing relationship
38368 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38377 description: Response codes found in [response codes](https://wiki.onap.org/).
38381 description: unique name of Physical Network Function.
38384 example: __PNF-NAME__
38385 - name: interface-name
38387 description: Name that identifies the physical interface
38390 example: __INTERFACE-NAME__
38391 - name: interface-name
38393 description: Name given to the interface
38396 example: __INTERFACE-NAME__
38397 - name: vlan-interface
38399 description: String that identifies the interface
38402 example: __VLAN-INTERFACE__
38403 - name: l3-interface-ipv4-address
38405 description: IP address
38408 example: __L3-INTERFACE-IPV4-ADDRESS__
38409 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
38413 summary: returns l3-interface-ipv4-address-list
38414 description: returns l3-interface-ipv4-address-list
38415 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38421 description: successful operation
38423 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38425 description: Response codes found in [response codes](https://wiki.onap.org/).
38429 description: unique name of Physical Network Function.
38432 example: __PNF-NAME__
38433 - name: interface-name
38435 description: Name that identifies the physical interface
38438 example: __INTERFACE-NAME__
38439 - name: interface-name
38441 description: Name given to the interface
38444 example: __INTERFACE-NAME__
38445 - name: vlan-interface
38447 description: String that identifies the interface
38450 example: __VLAN-INTERFACE__
38451 - name: l3-interface-ipv4-address
38453 description: IP address
38456 example: __L3-INTERFACE-IPV4-ADDRESS__
38460 summary: create or update an existing l3-interface-ipv4-address-list
38462 Create or update an existing l3-interface-ipv4-address-list.
38464 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38465 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38474 description: Response codes found in [response codes](https://wiki.onap.org/).
38478 description: unique name of Physical Network Function.
38481 example: __PNF-NAME__
38482 - name: interface-name
38484 description: Name that identifies the physical interface
38487 example: __INTERFACE-NAME__
38488 - name: interface-name
38490 description: Name given to the interface
38493 example: __INTERFACE-NAME__
38494 - name: vlan-interface
38496 description: String that identifies the interface
38499 example: __VLAN-INTERFACE__
38500 - name: l3-interface-ipv4-address
38502 description: IP address
38505 example: __L3-INTERFACE-IPV4-ADDRESS__
38508 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38511 $ref: "#/definitions/l3-interface-ipv4-address-list"
38515 summary: update an existing l3-interface-ipv4-address-list
38517 Update an existing l3-interface-ipv4-address-list
38519 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38520 The PUT operation will entirely replace an existing object.
38521 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38523 Other differences between PUT and PATCH are:
38525 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38526 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38527 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38528 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38537 description: Response codes found in [response codes](https://wiki.onap.org/).
38541 description: unique name of Physical Network Function.
38544 example: __PNF-NAME__
38545 - name: interface-name
38547 description: Name that identifies the physical interface
38550 example: __INTERFACE-NAME__
38551 - name: interface-name
38553 description: Name given to the interface
38556 example: __INTERFACE-NAME__
38557 - name: vlan-interface
38559 description: String that identifies the interface
38562 example: __VLAN-INTERFACE__
38563 - name: l3-interface-ipv4-address
38565 description: IP address
38568 example: __L3-INTERFACE-IPV4-ADDRESS__
38571 description: l3-interface-ipv4-address-list object that needs to be updated.
38574 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38578 summary: delete an existing l3-interface-ipv4-address-list
38579 description: delete an existing l3-interface-ipv4-address-list
38580 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38589 description: Response codes found in [response codes](https://wiki.onap.org/).
38593 description: unique name of Physical Network Function.
38596 example: __PNF-NAME__
38597 - name: interface-name
38599 description: Name that identifies the physical interface
38602 example: __INTERFACE-NAME__
38603 - name: interface-name
38605 description: Name given to the interface
38608 example: __INTERFACE-NAME__
38609 - name: vlan-interface
38611 description: String that identifies the interface
38614 example: __VLAN-INTERFACE__
38615 - name: l3-interface-ipv4-address
38617 description: IP address
38620 example: __L3-INTERFACE-IPV4-ADDRESS__
38621 - name: resource-version
38623 description: resource-version for concurrency
38626 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
38630 summary: see node definition for valid relationships
38631 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38640 description: Response codes found in [response codes](https://wiki.onap.org/).
38644 description: unique name of Physical Network Function.
38647 example: __PNF-NAME__
38648 - name: interface-name
38650 description: Name that identifies the physical interface
38653 example: __INTERFACE-NAME__
38654 - name: interface-name
38656 description: Name given to the interface
38659 example: __INTERFACE-NAME__
38660 - name: vlan-interface
38662 description: String that identifies the interface
38665 example: __VLAN-INTERFACE__
38666 - name: l3-interface-ipv6-address
38668 description: IP address
38671 example: __L3-INTERFACE-IPV6-ADDRESS__
38674 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38677 $ref: "#/definitions/relationship"
38681 summary: delete an existing relationship
38682 description: delete an existing relationship
38683 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38692 description: Response codes found in [response codes](https://wiki.onap.org/).
38696 description: unique name of Physical Network Function.
38699 example: __PNF-NAME__
38700 - name: interface-name
38702 description: Name that identifies the physical interface
38705 example: __INTERFACE-NAME__
38706 - name: interface-name
38708 description: Name given to the interface
38711 example: __INTERFACE-NAME__
38712 - name: vlan-interface
38714 description: String that identifies the interface
38717 example: __VLAN-INTERFACE__
38718 - name: l3-interface-ipv6-address
38720 description: IP address
38723 example: __L3-INTERFACE-IPV6-ADDRESS__
38724 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
38728 summary: returns l3-interface-ipv6-address-list
38729 description: returns l3-interface-ipv6-address-list
38730 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38736 description: successful operation
38738 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38740 description: Response codes found in [response codes](https://wiki.onap.org/).
38744 description: unique name of Physical Network Function.
38747 example: __PNF-NAME__
38748 - name: interface-name
38750 description: Name that identifies the physical interface
38753 example: __INTERFACE-NAME__
38754 - name: interface-name
38756 description: Name given to the interface
38759 example: __INTERFACE-NAME__
38760 - name: vlan-interface
38762 description: String that identifies the interface
38765 example: __VLAN-INTERFACE__
38766 - name: l3-interface-ipv6-address
38768 description: IP address
38771 example: __L3-INTERFACE-IPV6-ADDRESS__
38775 summary: create or update an existing l3-interface-ipv6-address-list
38777 Create or update an existing l3-interface-ipv6-address-list.
38779 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38780 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38789 description: Response codes found in [response codes](https://wiki.onap.org/).
38793 description: unique name of Physical Network Function.
38796 example: __PNF-NAME__
38797 - name: interface-name
38799 description: Name that identifies the physical interface
38802 example: __INTERFACE-NAME__
38803 - name: interface-name
38805 description: Name given to the interface
38808 example: __INTERFACE-NAME__
38809 - name: vlan-interface
38811 description: String that identifies the interface
38814 example: __VLAN-INTERFACE__
38815 - name: l3-interface-ipv6-address
38817 description: IP address
38820 example: __L3-INTERFACE-IPV6-ADDRESS__
38823 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38826 $ref: "#/definitions/l3-interface-ipv6-address-list"
38830 summary: update an existing l3-interface-ipv6-address-list
38832 Update an existing l3-interface-ipv6-address-list
38834 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38835 The PUT operation will entirely replace an existing object.
38836 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38838 Other differences between PUT and PATCH are:
38840 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38841 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38842 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38843 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38852 description: Response codes found in [response codes](https://wiki.onap.org/).
38856 description: unique name of Physical Network Function.
38859 example: __PNF-NAME__
38860 - name: interface-name
38862 description: Name that identifies the physical interface
38865 example: __INTERFACE-NAME__
38866 - name: interface-name
38868 description: Name given to the interface
38871 example: __INTERFACE-NAME__
38872 - name: vlan-interface
38874 description: String that identifies the interface
38877 example: __VLAN-INTERFACE__
38878 - name: l3-interface-ipv6-address
38880 description: IP address
38883 example: __L3-INTERFACE-IPV6-ADDRESS__
38886 description: l3-interface-ipv6-address-list object that needs to be updated.
38889 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38893 summary: delete an existing l3-interface-ipv6-address-list
38894 description: delete an existing l3-interface-ipv6-address-list
38895 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38904 description: Response codes found in [response codes](https://wiki.onap.org/).
38908 description: unique name of Physical Network Function.
38911 example: __PNF-NAME__
38912 - name: interface-name
38914 description: Name that identifies the physical interface
38917 example: __INTERFACE-NAME__
38918 - name: interface-name
38920 description: Name given to the interface
38923 example: __INTERFACE-NAME__
38924 - name: vlan-interface
38926 description: String that identifies the interface
38929 example: __VLAN-INTERFACE__
38930 - name: l3-interface-ipv6-address
38932 description: IP address
38935 example: __L3-INTERFACE-IPV6-ADDRESS__
38936 - name: resource-version
38938 description: resource-version for concurrency
38941 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38945 summary: returns vlan
38946 description: returns vlan
38947 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38953 description: successful operation
38955 $ref: "#/getDefinitions/vlan"
38957 description: Response codes found in [response codes](https://wiki.onap.org/).
38961 description: unique name of Physical Network Function.
38964 example: __PNF-NAME__
38965 - name: interface-name
38967 description: Name that identifies the physical interface
38970 example: __INTERFACE-NAME__
38971 - name: interface-name
38973 description: Name given to the interface
38976 example: __INTERFACE-NAME__
38977 - name: vlan-interface
38979 description: String that identifies the interface
38982 example: __VLAN-INTERFACE__
38986 summary: create or update an existing vlan
38988 Create or update an existing vlan.
38990 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38991 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
39000 description: Response codes found in [response codes](https://wiki.onap.org/).
39004 description: unique name of Physical Network Function.
39007 example: __PNF-NAME__
39008 - name: interface-name
39010 description: Name that identifies the physical interface
39013 example: __INTERFACE-NAME__
39014 - name: interface-name
39016 description: Name given to the interface
39019 example: __INTERFACE-NAME__
39020 - name: vlan-interface
39022 description: String that identifies the interface
39025 example: __VLAN-INTERFACE__
39028 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
39031 $ref: "#/definitions/vlan"
39035 summary: update an existing vlan
39037 Update an existing vlan
39039 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39040 The PUT operation will entirely replace an existing object.
39041 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39043 Other differences between PUT and PATCH are:
39045 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39046 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39047 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39048 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
39057 description: Response codes found in [response codes](https://wiki.onap.org/).
39061 description: unique name of Physical Network Function.
39064 example: __PNF-NAME__
39065 - name: interface-name
39067 description: Name that identifies the physical interface
39070 example: __INTERFACE-NAME__
39071 - name: interface-name
39073 description: Name given to the interface
39076 example: __INTERFACE-NAME__
39077 - name: vlan-interface
39079 description: String that identifies the interface
39082 example: __VLAN-INTERFACE__
39085 description: vlan object that needs to be updated.
39088 $ref: "#/patchDefinitions/vlan"
39092 summary: delete an existing vlan
39093 description: delete an existing vlan
39094 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
39103 description: Response codes found in [response codes](https://wiki.onap.org/).
39107 description: unique name of Physical Network Function.
39110 example: __PNF-NAME__
39111 - name: interface-name
39113 description: Name that identifies the physical interface
39116 example: __INTERFACE-NAME__
39117 - name: interface-name
39119 description: Name given to the interface
39122 example: __INTERFACE-NAME__
39123 - name: vlan-interface
39125 description: String that identifies the interface
39128 example: __VLAN-INTERFACE__
39129 - name: resource-version
39131 description: resource-version for concurrency
39134 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
39138 summary: returns vlans
39139 description: returns vlans
39140 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
39146 description: successful operation
39148 $ref: "#/getDefinitions/vlans"
39150 description: Response codes found in [response codes](https://wiki.onap.org/).
39154 description: unique name of Physical Network Function.
39157 example: __PNF-NAME__
39158 - name: interface-name
39160 description: Name that identifies the physical interface
39163 example: __INTERFACE-NAME__
39164 - name: interface-name
39166 description: Name given to the interface
39169 example: __INTERFACE-NAME__
39170 - name: vlan-interface
39175 - name: vlan-id-inner
39186 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
39190 summary: see node definition for valid relationships
39191 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39200 description: Response codes found in [response codes](https://wiki.onap.org/).
39204 description: unique name of Physical Network Function.
39207 example: __PNF-NAME__
39208 - name: interface-name
39210 description: Name that identifies the physical interface
39213 example: __INTERFACE-NAME__
39214 - name: interface-name
39216 description: Name given to the interface
39219 example: __INTERFACE-NAME__
39222 description: PCI ID used to identify the sriov-vf
39225 example: __PCI-ID__
39228 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
39231 $ref: "#/definitions/relationship"
39235 summary: delete an existing relationship
39236 description: delete an existing relationship
39237 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39246 description: Response codes found in [response codes](https://wiki.onap.org/).
39250 description: unique name of Physical Network Function.
39253 example: __PNF-NAME__
39254 - name: interface-name
39256 description: Name that identifies the physical interface
39259 example: __INTERFACE-NAME__
39260 - name: interface-name
39262 description: Name given to the interface
39265 example: __INTERFACE-NAME__
39268 description: PCI ID used to identify the sriov-vf
39271 example: __PCI-ID__
39272 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
39276 summary: returns sriov-vf
39277 description: returns sriov-vf
39278 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39284 description: successful operation
39286 $ref: "#/getDefinitions/sriov-vf"
39288 description: Response codes found in [response codes](https://wiki.onap.org/).
39292 description: unique name of Physical Network Function.
39295 example: __PNF-NAME__
39296 - name: interface-name
39298 description: Name that identifies the physical interface
39301 example: __INTERFACE-NAME__
39302 - name: interface-name
39304 description: Name given to the interface
39307 example: __INTERFACE-NAME__
39310 description: PCI ID used to identify the sriov-vf
39313 example: __PCI-ID__
39317 summary: create or update an existing sriov-vf
39319 Create or update an existing sriov-vf.
39321 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39322 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39331 description: Response codes found in [response codes](https://wiki.onap.org/).
39335 description: unique name of Physical Network Function.
39338 example: __PNF-NAME__
39339 - name: interface-name
39341 description: Name that identifies the physical interface
39344 example: __INTERFACE-NAME__
39345 - name: interface-name
39347 description: Name given to the interface
39350 example: __INTERFACE-NAME__
39353 description: PCI ID used to identify the sriov-vf
39356 example: __PCI-ID__
39359 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
39362 $ref: "#/definitions/sriov-vf"
39366 summary: update an existing sriov-vf
39368 Update an existing sriov-vf
39370 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39371 The PUT operation will entirely replace an existing object.
39372 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39374 Other differences between PUT and PATCH are:
39376 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39377 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39378 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39379 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39388 description: Response codes found in [response codes](https://wiki.onap.org/).
39392 description: unique name of Physical Network Function.
39395 example: __PNF-NAME__
39396 - name: interface-name
39398 description: Name that identifies the physical interface
39401 example: __INTERFACE-NAME__
39402 - name: interface-name
39404 description: Name given to the interface
39407 example: __INTERFACE-NAME__
39410 description: PCI ID used to identify the sriov-vf
39413 example: __PCI-ID__
39416 description: sriov-vf object that needs to be updated.
39419 $ref: "#/patchDefinitions/sriov-vf"
39423 summary: delete an existing sriov-vf
39424 description: delete an existing sriov-vf
39425 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39434 description: Response codes found in [response codes](https://wiki.onap.org/).
39438 description: unique name of Physical Network Function.
39441 example: __PNF-NAME__
39442 - name: interface-name
39444 description: Name that identifies the physical interface
39447 example: __INTERFACE-NAME__
39448 - name: interface-name
39450 description: Name given to the interface
39453 example: __INTERFACE-NAME__
39456 description: PCI ID used to identify the sriov-vf
39459 example: __PCI-ID__
39460 - name: resource-version
39462 description: resource-version for concurrency
39465 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
39469 summary: returns sriov-vfs
39470 description: returns sriov-vfs
39471 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
39477 description: successful operation
39479 $ref: "#/getDefinitions/sriov-vfs"
39481 description: Response codes found in [response codes](https://wiki.onap.org/).
39485 description: unique name of Physical Network Function.
39488 example: __PNF-NAME__
39489 - name: interface-name
39491 description: Name that identifies the physical interface
39494 example: __INTERFACE-NAME__
39495 - name: interface-name
39497 description: Name given to the interface
39500 example: __INTERFACE-NAME__
39506 - name: vf-vlan-filter
39511 - name: vf-mac-filter
39516 - name: vf-vlan-strip
39521 - name: neutron-network-id
39526 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
39530 summary: see node definition for valid relationships
39531 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
39540 description: Response codes found in [response codes](https://wiki.onap.org/).
39544 description: unique name of Physical Network Function.
39547 example: __PNF-NAME__
39548 - name: interface-name
39550 description: Name that identifies the physical interface
39553 example: __INTERFACE-NAME__
39554 - name: interface-name
39556 description: Name given to the interface
39559 example: __INTERFACE-NAME__
39562 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
39565 $ref: "#/definitions/relationship"
39569 summary: delete an existing relationship
39570 description: delete an existing relationship
39571 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
39580 description: Response codes found in [response codes](https://wiki.onap.org/).
39584 description: unique name of Physical Network Function.
39587 example: __PNF-NAME__
39588 - name: interface-name
39590 description: Name that identifies the physical interface
39593 example: __INTERFACE-NAME__
39594 - name: interface-name
39596 description: Name given to the interface
39599 example: __INTERFACE-NAME__
39600 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
39604 summary: see node definition for valid relationships
39605 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39614 description: Response codes found in [response codes](https://wiki.onap.org/).
39618 description: unique name of Physical Network Function.
39621 example: __PNF-NAME__
39622 - name: interface-name
39624 description: Name that identifies the physical interface
39627 example: __INTERFACE-NAME__
39628 - name: interface-name
39630 description: Name given to the interface
39633 example: __INTERFACE-NAME__
39634 - name: l3-interface-ipv4-address
39636 description: IP address
39639 example: __L3-INTERFACE-IPV4-ADDRESS__
39642 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39645 $ref: "#/definitions/relationship"
39649 summary: delete an existing relationship
39650 description: delete an existing relationship
39651 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39660 description: Response codes found in [response codes](https://wiki.onap.org/).
39664 description: unique name of Physical Network Function.
39667 example: __PNF-NAME__
39668 - name: interface-name
39670 description: Name that identifies the physical interface
39673 example: __INTERFACE-NAME__
39674 - name: interface-name
39676 description: Name given to the interface
39679 example: __INTERFACE-NAME__
39680 - name: l3-interface-ipv4-address
39682 description: IP address
39685 example: __L3-INTERFACE-IPV4-ADDRESS__
39686 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
39690 summary: returns l3-interface-ipv4-address-list
39691 description: returns l3-interface-ipv4-address-list
39692 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39698 description: successful operation
39700 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39702 description: Response codes found in [response codes](https://wiki.onap.org/).
39706 description: unique name of Physical Network Function.
39709 example: __PNF-NAME__
39710 - name: interface-name
39712 description: Name that identifies the physical interface
39715 example: __INTERFACE-NAME__
39716 - name: interface-name
39718 description: Name given to the interface
39721 example: __INTERFACE-NAME__
39722 - name: l3-interface-ipv4-address
39724 description: IP address
39727 example: __L3-INTERFACE-IPV4-ADDRESS__
39731 summary: create or update an existing l3-interface-ipv4-address-list
39733 Create or update an existing l3-interface-ipv4-address-list.
39735 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39736 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39745 description: Response codes found in [response codes](https://wiki.onap.org/).
39749 description: unique name of Physical Network Function.
39752 example: __PNF-NAME__
39753 - name: interface-name
39755 description: Name that identifies the physical interface
39758 example: __INTERFACE-NAME__
39759 - name: interface-name
39761 description: Name given to the interface
39764 example: __INTERFACE-NAME__
39765 - name: l3-interface-ipv4-address
39767 description: IP address
39770 example: __L3-INTERFACE-IPV4-ADDRESS__
39773 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39776 $ref: "#/definitions/l3-interface-ipv4-address-list"
39780 summary: update an existing l3-interface-ipv4-address-list
39782 Update an existing l3-interface-ipv4-address-list
39784 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39785 The PUT operation will entirely replace an existing object.
39786 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39788 Other differences between PUT and PATCH are:
39790 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39791 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39792 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39793 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39802 description: Response codes found in [response codes](https://wiki.onap.org/).
39806 description: unique name of Physical Network Function.
39809 example: __PNF-NAME__
39810 - name: interface-name
39812 description: Name that identifies the physical interface
39815 example: __INTERFACE-NAME__
39816 - name: interface-name
39818 description: Name given to the interface
39821 example: __INTERFACE-NAME__
39822 - name: l3-interface-ipv4-address
39824 description: IP address
39827 example: __L3-INTERFACE-IPV4-ADDRESS__
39830 description: l3-interface-ipv4-address-list object that needs to be updated.
39833 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39837 summary: delete an existing l3-interface-ipv4-address-list
39838 description: delete an existing l3-interface-ipv4-address-list
39839 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39848 description: Response codes found in [response codes](https://wiki.onap.org/).
39852 description: unique name of Physical Network Function.
39855 example: __PNF-NAME__
39856 - name: interface-name
39858 description: Name that identifies the physical interface
39861 example: __INTERFACE-NAME__
39862 - name: interface-name
39864 description: Name given to the interface
39867 example: __INTERFACE-NAME__
39868 - name: l3-interface-ipv4-address
39870 description: IP address
39873 example: __L3-INTERFACE-IPV4-ADDRESS__
39874 - name: resource-version
39876 description: resource-version for concurrency
39879 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
39883 summary: see node definition for valid relationships
39884 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39893 description: Response codes found in [response codes](https://wiki.onap.org/).
39897 description: unique name of Physical Network Function.
39900 example: __PNF-NAME__
39901 - name: interface-name
39903 description: Name that identifies the physical interface
39906 example: __INTERFACE-NAME__
39907 - name: interface-name
39909 description: Name given to the interface
39912 example: __INTERFACE-NAME__
39913 - name: l3-interface-ipv6-address
39915 description: IP address
39918 example: __L3-INTERFACE-IPV6-ADDRESS__
39921 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39924 $ref: "#/definitions/relationship"
39928 summary: delete an existing relationship
39929 description: delete an existing relationship
39930 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39939 description: Response codes found in [response codes](https://wiki.onap.org/).
39943 description: unique name of Physical Network Function.
39946 example: __PNF-NAME__
39947 - name: interface-name
39949 description: Name that identifies the physical interface
39952 example: __INTERFACE-NAME__
39953 - name: interface-name
39955 description: Name given to the interface
39958 example: __INTERFACE-NAME__
39959 - name: l3-interface-ipv6-address
39961 description: IP address
39964 example: __L3-INTERFACE-IPV6-ADDRESS__
39965 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
39969 summary: returns l3-interface-ipv6-address-list
39970 description: returns l3-interface-ipv6-address-list
39971 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39977 description: successful operation
39979 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39981 description: Response codes found in [response codes](https://wiki.onap.org/).
39985 description: unique name of Physical Network Function.
39988 example: __PNF-NAME__
39989 - name: interface-name
39991 description: Name that identifies the physical interface
39994 example: __INTERFACE-NAME__
39995 - name: interface-name
39997 description: Name given to the interface
40000 example: __INTERFACE-NAME__
40001 - name: l3-interface-ipv6-address
40003 description: IP address
40006 example: __L3-INTERFACE-IPV6-ADDRESS__
40010 summary: create or update an existing l3-interface-ipv6-address-list
40012 Create or update an existing l3-interface-ipv6-address-list.
40014 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40015 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40024 description: Response codes found in [response codes](https://wiki.onap.org/).
40028 description: unique name of Physical Network Function.
40031 example: __PNF-NAME__
40032 - name: interface-name
40034 description: Name that identifies the physical interface
40037 example: __INTERFACE-NAME__
40038 - name: interface-name
40040 description: Name given to the interface
40043 example: __INTERFACE-NAME__
40044 - name: l3-interface-ipv6-address
40046 description: IP address
40049 example: __L3-INTERFACE-IPV6-ADDRESS__
40052 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40055 $ref: "#/definitions/l3-interface-ipv6-address-list"
40059 summary: update an existing l3-interface-ipv6-address-list
40061 Update an existing l3-interface-ipv6-address-list
40063 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40064 The PUT operation will entirely replace an existing object.
40065 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40067 Other differences between PUT and PATCH are:
40069 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40070 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40071 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40072 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40081 description: Response codes found in [response codes](https://wiki.onap.org/).
40085 description: unique name of Physical Network Function.
40088 example: __PNF-NAME__
40089 - name: interface-name
40091 description: Name that identifies the physical interface
40094 example: __INTERFACE-NAME__
40095 - name: interface-name
40097 description: Name given to the interface
40100 example: __INTERFACE-NAME__
40101 - name: l3-interface-ipv6-address
40103 description: IP address
40106 example: __L3-INTERFACE-IPV6-ADDRESS__
40109 description: l3-interface-ipv6-address-list object that needs to be updated.
40112 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40116 summary: delete an existing l3-interface-ipv6-address-list
40117 description: delete an existing l3-interface-ipv6-address-list
40118 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40127 description: Response codes found in [response codes](https://wiki.onap.org/).
40131 description: unique name of Physical Network Function.
40134 example: __PNF-NAME__
40135 - name: interface-name
40137 description: Name that identifies the physical interface
40140 example: __INTERFACE-NAME__
40141 - name: interface-name
40143 description: Name given to the interface
40146 example: __INTERFACE-NAME__
40147 - name: l3-interface-ipv6-address
40149 description: IP address
40152 example: __L3-INTERFACE-IPV6-ADDRESS__
40153 - name: resource-version
40155 description: resource-version for concurrency
40158 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
40162 summary: returns l-interface
40163 description: returns l-interface
40164 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
40170 description: successful operation
40172 $ref: "#/getDefinitions/l-interface"
40174 description: Response codes found in [response codes](https://wiki.onap.org/).
40178 description: unique name of Physical Network Function.
40181 example: __PNF-NAME__
40182 - name: interface-name
40184 description: Name that identifies the physical interface
40187 example: __INTERFACE-NAME__
40188 - name: interface-name
40190 description: Name given to the interface
40193 example: __INTERFACE-NAME__
40197 summary: create or update an existing l-interface
40199 Create or update an existing l-interface.
40201 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40202 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
40211 description: Response codes found in [response codes](https://wiki.onap.org/).
40215 description: unique name of Physical Network Function.
40218 example: __PNF-NAME__
40219 - name: interface-name
40221 description: Name that identifies the physical interface
40224 example: __INTERFACE-NAME__
40225 - name: interface-name
40227 description: Name given to the interface
40230 example: __INTERFACE-NAME__
40233 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
40236 $ref: "#/definitions/l-interface"
40240 summary: update an existing l-interface
40242 Update an existing l-interface
40244 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40245 The PUT operation will entirely replace an existing object.
40246 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40248 Other differences between PUT and PATCH are:
40250 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40251 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40252 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40253 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
40262 description: Response codes found in [response codes](https://wiki.onap.org/).
40266 description: unique name of Physical Network Function.
40269 example: __PNF-NAME__
40270 - name: interface-name
40272 description: Name that identifies the physical interface
40275 example: __INTERFACE-NAME__
40276 - name: interface-name
40278 description: Name given to the interface
40281 example: __INTERFACE-NAME__
40284 description: l-interface object that needs to be updated.
40287 $ref: "#/patchDefinitions/l-interface"
40291 summary: delete an existing l-interface
40292 description: delete an existing l-interface
40293 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
40302 description: Response codes found in [response codes](https://wiki.onap.org/).
40306 description: unique name of Physical Network Function.
40309 example: __PNF-NAME__
40310 - name: interface-name
40312 description: Name that identifies the physical interface
40315 example: __INTERFACE-NAME__
40316 - name: interface-name
40318 description: Name given to the interface
40321 example: __INTERFACE-NAME__
40322 - name: resource-version
40324 description: resource-version for concurrency
40327 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
40331 summary: returns l-interfaces
40332 description: returns l-interfaces
40333 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
40339 description: successful operation
40341 $ref: "#/getDefinitions/l-interfaces"
40343 description: Response codes found in [response codes](https://wiki.onap.org/).
40347 description: unique name of Physical Network Function.
40350 example: __PNF-NAME__
40351 - name: interface-name
40353 description: Name that identifies the physical interface
40356 example: __INTERFACE-NAME__
40357 - name: interface-name
40362 - name: interface-id
40372 - name: network-name
40377 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
40381 summary: returns p-interface
40382 description: returns p-interface
40383 operationId: getNetworkPnfsPnfPInterfacesPInterface
40389 description: successful operation
40391 $ref: "#/getDefinitions/p-interface"
40393 description: Response codes found in [response codes](https://wiki.onap.org/).
40397 description: unique name of Physical Network Function.
40400 example: __PNF-NAME__
40401 - name: interface-name
40403 description: Name that identifies the physical interface
40406 example: __INTERFACE-NAME__
40410 summary: create or update an existing p-interface
40412 Create or update an existing p-interface.
40414 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40415 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
40424 description: Response codes found in [response codes](https://wiki.onap.org/).
40428 description: unique name of Physical Network Function.
40431 example: __PNF-NAME__
40432 - name: interface-name
40434 description: Name that identifies the physical interface
40437 example: __INTERFACE-NAME__
40440 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)
40443 $ref: "#/definitions/p-interface"
40447 summary: update an existing p-interface
40449 Update an existing p-interface
40451 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40452 The PUT operation will entirely replace an existing object.
40453 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40455 Other differences between PUT and PATCH are:
40457 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40458 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40459 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40460 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
40469 description: Response codes found in [response codes](https://wiki.onap.org/).
40473 description: unique name of Physical Network Function.
40476 example: __PNF-NAME__
40477 - name: interface-name
40479 description: Name that identifies the physical interface
40482 example: __INTERFACE-NAME__
40485 description: p-interface object that needs to be updated.
40488 $ref: "#/patchDefinitions/p-interface"
40492 summary: delete an existing p-interface
40493 description: delete an existing p-interface
40494 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
40503 description: Response codes found in [response codes](https://wiki.onap.org/).
40507 description: unique name of Physical Network Function.
40510 example: __PNF-NAME__
40511 - name: interface-name
40513 description: Name that identifies the physical interface
40516 example: __INTERFACE-NAME__
40517 - name: resource-version
40519 description: resource-version for concurrency
40522 /network/pnfs/pnf/{pnf-name}/p-interfaces:
40526 summary: returns p-interfaces
40527 description: returns p-interfaces
40528 operationId: getNetworkPnfsPnfPInterfaces
40534 description: successful operation
40536 $ref: "#/getDefinitions/p-interfaces"
40538 description: Response codes found in [response codes](https://wiki.onap.org/).
40542 description: unique name of Physical Network Function.
40545 example: __PNF-NAME__
40546 - name: interface-name
40551 - name: prov-status
40556 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
40560 summary: see node definition for valid relationships
40561 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
40570 description: Response codes found in [response codes](https://wiki.onap.org/).
40574 description: unique name of Physical Network Function.
40577 example: __PNF-NAME__
40578 - name: interface-name
40580 description: Name that identifies the link aggregate interface
40583 example: __INTERFACE-NAME__
40586 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)
40589 $ref: "#/definitions/relationship"
40593 summary: delete an existing relationship
40594 description: delete an existing relationship
40595 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
40604 description: Response codes found in [response codes](https://wiki.onap.org/).
40608 description: unique name of Physical Network Function.
40611 example: __PNF-NAME__
40612 - name: interface-name
40614 description: Name that identifies the link aggregate interface
40617 example: __INTERFACE-NAME__
40618 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
40622 summary: see node definition for valid relationships
40623 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40632 description: Response codes found in [response codes](https://wiki.onap.org/).
40636 description: unique name of Physical Network Function.
40639 example: __PNF-NAME__
40640 - name: interface-name
40642 description: Name that identifies the link aggregate interface
40645 example: __INTERFACE-NAME__
40646 - name: interface-name
40648 description: Name given to the interface
40651 example: __INTERFACE-NAME__
40652 - name: vlan-interface
40654 description: String that identifies the interface
40657 example: __VLAN-INTERFACE__
40660 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
40663 $ref: "#/definitions/relationship"
40667 summary: delete an existing relationship
40668 description: delete an existing relationship
40669 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40678 description: Response codes found in [response codes](https://wiki.onap.org/).
40682 description: unique name of Physical Network Function.
40685 example: __PNF-NAME__
40686 - name: interface-name
40688 description: Name that identifies the link aggregate interface
40691 example: __INTERFACE-NAME__
40692 - name: interface-name
40694 description: Name given to the interface
40697 example: __INTERFACE-NAME__
40698 - name: vlan-interface
40700 description: String that identifies the interface
40703 example: __VLAN-INTERFACE__
40704 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
40708 summary: see node definition for valid relationships
40709 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40718 description: Response codes found in [response codes](https://wiki.onap.org/).
40722 description: unique name of Physical Network Function.
40725 example: __PNF-NAME__
40726 - name: interface-name
40728 description: Name that identifies the link aggregate interface
40731 example: __INTERFACE-NAME__
40732 - name: interface-name
40734 description: Name given to the interface
40737 example: __INTERFACE-NAME__
40738 - name: vlan-interface
40740 description: String that identifies the interface
40743 example: __VLAN-INTERFACE__
40744 - name: l3-interface-ipv4-address
40746 description: IP address
40749 example: __L3-INTERFACE-IPV4-ADDRESS__
40752 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
40755 $ref: "#/definitions/relationship"
40759 summary: delete an existing relationship
40760 description: delete an existing relationship
40761 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40770 description: Response codes found in [response codes](https://wiki.onap.org/).
40774 description: unique name of Physical Network Function.
40777 example: __PNF-NAME__
40778 - name: interface-name
40780 description: Name that identifies the link aggregate interface
40783 example: __INTERFACE-NAME__
40784 - name: interface-name
40786 description: Name given to the interface
40789 example: __INTERFACE-NAME__
40790 - name: vlan-interface
40792 description: String that identifies the interface
40795 example: __VLAN-INTERFACE__
40796 - name: l3-interface-ipv4-address
40798 description: IP address
40801 example: __L3-INTERFACE-IPV4-ADDRESS__
40802 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
40806 summary: returns l3-interface-ipv4-address-list
40807 description: returns l3-interface-ipv4-address-list
40808 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40814 description: successful operation
40816 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40818 description: Response codes found in [response codes](https://wiki.onap.org/).
40822 description: unique name of Physical Network Function.
40825 example: __PNF-NAME__
40826 - name: interface-name
40828 description: Name that identifies the link aggregate interface
40831 example: __INTERFACE-NAME__
40832 - name: interface-name
40834 description: Name given to the interface
40837 example: __INTERFACE-NAME__
40838 - name: vlan-interface
40840 description: String that identifies the interface
40843 example: __VLAN-INTERFACE__
40844 - name: l3-interface-ipv4-address
40846 description: IP address
40849 example: __L3-INTERFACE-IPV4-ADDRESS__
40853 summary: create or update an existing l3-interface-ipv4-address-list
40855 Create or update an existing l3-interface-ipv4-address-list.
40857 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40858 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40867 description: Response codes found in [response codes](https://wiki.onap.org/).
40871 description: unique name of Physical Network Function.
40874 example: __PNF-NAME__
40875 - name: interface-name
40877 description: Name that identifies the link aggregate interface
40880 example: __INTERFACE-NAME__
40881 - name: interface-name
40883 description: Name given to the interface
40886 example: __INTERFACE-NAME__
40887 - name: vlan-interface
40889 description: String that identifies the interface
40892 example: __VLAN-INTERFACE__
40893 - name: l3-interface-ipv4-address
40895 description: IP address
40898 example: __L3-INTERFACE-IPV4-ADDRESS__
40901 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
40904 $ref: "#/definitions/l3-interface-ipv4-address-list"
40908 summary: update an existing l3-interface-ipv4-address-list
40910 Update an existing l3-interface-ipv4-address-list
40912 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40913 The PUT operation will entirely replace an existing object.
40914 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40916 Other differences between PUT and PATCH are:
40918 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40919 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40920 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40921 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40930 description: Response codes found in [response codes](https://wiki.onap.org/).
40934 description: unique name of Physical Network Function.
40937 example: __PNF-NAME__
40938 - name: interface-name
40940 description: Name that identifies the link aggregate interface
40943 example: __INTERFACE-NAME__
40944 - name: interface-name
40946 description: Name given to the interface
40949 example: __INTERFACE-NAME__
40950 - name: vlan-interface
40952 description: String that identifies the interface
40955 example: __VLAN-INTERFACE__
40956 - name: l3-interface-ipv4-address
40958 description: IP address
40961 example: __L3-INTERFACE-IPV4-ADDRESS__
40964 description: l3-interface-ipv4-address-list object that needs to be updated.
40967 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40971 summary: delete an existing l3-interface-ipv4-address-list
40972 description: delete an existing l3-interface-ipv4-address-list
40973 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40982 description: Response codes found in [response codes](https://wiki.onap.org/).
40986 description: unique name of Physical Network Function.
40989 example: __PNF-NAME__
40990 - name: interface-name
40992 description: Name that identifies the link aggregate interface
40995 example: __INTERFACE-NAME__
40996 - name: interface-name
40998 description: Name given to the interface
41001 example: __INTERFACE-NAME__
41002 - name: vlan-interface
41004 description: String that identifies the interface
41007 example: __VLAN-INTERFACE__
41008 - name: l3-interface-ipv4-address
41010 description: IP address
41013 example: __L3-INTERFACE-IPV4-ADDRESS__
41014 - name: resource-version
41016 description: resource-version for concurrency
41019 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
41023 summary: see node definition for valid relationships
41024 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
41033 description: Response codes found in [response codes](https://wiki.onap.org/).
41037 description: unique name of Physical Network Function.
41040 example: __PNF-NAME__
41041 - name: interface-name
41043 description: Name that identifies the link aggregate interface
41046 example: __INTERFACE-NAME__
41047 - name: interface-name
41049 description: Name given to the interface
41052 example: __INTERFACE-NAME__
41053 - name: vlan-interface
41055 description: String that identifies the interface
41058 example: __VLAN-INTERFACE__
41059 - name: l3-interface-ipv6-address
41061 description: IP address
41064 example: __L3-INTERFACE-IPV6-ADDRESS__
41067 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
41070 $ref: "#/definitions/relationship"
41074 summary: delete an existing relationship
41075 description: delete an existing relationship
41076 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
41085 description: Response codes found in [response codes](https://wiki.onap.org/).
41089 description: unique name of Physical Network Function.
41092 example: __PNF-NAME__
41093 - name: interface-name
41095 description: Name that identifies the link aggregate interface
41098 example: __INTERFACE-NAME__
41099 - name: interface-name
41101 description: Name given to the interface
41104 example: __INTERFACE-NAME__
41105 - name: vlan-interface
41107 description: String that identifies the interface
41110 example: __VLAN-INTERFACE__
41111 - name: l3-interface-ipv6-address
41113 description: IP address
41116 example: __L3-INTERFACE-IPV6-ADDRESS__
41117 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
41121 summary: returns l3-interface-ipv6-address-list
41122 description: returns l3-interface-ipv6-address-list
41123 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41129 description: successful operation
41131 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41133 description: Response codes found in [response codes](https://wiki.onap.org/).
41137 description: unique name of Physical Network Function.
41140 example: __PNF-NAME__
41141 - name: interface-name
41143 description: Name that identifies the link aggregate interface
41146 example: __INTERFACE-NAME__
41147 - name: interface-name
41149 description: Name given to the interface
41152 example: __INTERFACE-NAME__
41153 - name: vlan-interface
41155 description: String that identifies the interface
41158 example: __VLAN-INTERFACE__
41159 - name: l3-interface-ipv6-address
41161 description: IP address
41164 example: __L3-INTERFACE-IPV6-ADDRESS__
41168 summary: create or update an existing l3-interface-ipv6-address-list
41170 Create or update an existing l3-interface-ipv6-address-list.
41172 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41173 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41182 description: Response codes found in [response codes](https://wiki.onap.org/).
41186 description: unique name of Physical Network Function.
41189 example: __PNF-NAME__
41190 - name: interface-name
41192 description: Name that identifies the link aggregate interface
41195 example: __INTERFACE-NAME__
41196 - name: interface-name
41198 description: Name given to the interface
41201 example: __INTERFACE-NAME__
41202 - name: vlan-interface
41204 description: String that identifies the interface
41207 example: __VLAN-INTERFACE__
41208 - name: l3-interface-ipv6-address
41210 description: IP address
41213 example: __L3-INTERFACE-IPV6-ADDRESS__
41216 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
41219 $ref: "#/definitions/l3-interface-ipv6-address-list"
41223 summary: update an existing l3-interface-ipv6-address-list
41225 Update an existing l3-interface-ipv6-address-list
41227 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41228 The PUT operation will entirely replace an existing object.
41229 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41231 Other differences between PUT and PATCH are:
41233 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41234 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41235 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41236 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41245 description: Response codes found in [response codes](https://wiki.onap.org/).
41249 description: unique name of Physical Network Function.
41252 example: __PNF-NAME__
41253 - name: interface-name
41255 description: Name that identifies the link aggregate interface
41258 example: __INTERFACE-NAME__
41259 - name: interface-name
41261 description: Name given to the interface
41264 example: __INTERFACE-NAME__
41265 - name: vlan-interface
41267 description: String that identifies the interface
41270 example: __VLAN-INTERFACE__
41271 - name: l3-interface-ipv6-address
41273 description: IP address
41276 example: __L3-INTERFACE-IPV6-ADDRESS__
41279 description: l3-interface-ipv6-address-list object that needs to be updated.
41282 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41286 summary: delete an existing l3-interface-ipv6-address-list
41287 description: delete an existing l3-interface-ipv6-address-list
41288 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41297 description: Response codes found in [response codes](https://wiki.onap.org/).
41301 description: unique name of Physical Network Function.
41304 example: __PNF-NAME__
41305 - name: interface-name
41307 description: Name that identifies the link aggregate interface
41310 example: __INTERFACE-NAME__
41311 - name: interface-name
41313 description: Name given to the interface
41316 example: __INTERFACE-NAME__
41317 - name: vlan-interface
41319 description: String that identifies the interface
41322 example: __VLAN-INTERFACE__
41323 - name: l3-interface-ipv6-address
41325 description: IP address
41328 example: __L3-INTERFACE-IPV6-ADDRESS__
41329 - name: resource-version
41331 description: resource-version for concurrency
41334 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
41338 summary: returns vlan
41339 description: returns vlan
41340 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41346 description: successful operation
41348 $ref: "#/getDefinitions/vlan"
41350 description: Response codes found in [response codes](https://wiki.onap.org/).
41354 description: unique name of Physical Network Function.
41357 example: __PNF-NAME__
41358 - name: interface-name
41360 description: Name that identifies the link aggregate interface
41363 example: __INTERFACE-NAME__
41364 - name: interface-name
41366 description: Name given to the interface
41369 example: __INTERFACE-NAME__
41370 - name: vlan-interface
41372 description: String that identifies the interface
41375 example: __VLAN-INTERFACE__
41379 summary: create or update an existing vlan
41381 Create or update an existing vlan.
41383 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41384 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41393 description: Response codes found in [response codes](https://wiki.onap.org/).
41397 description: unique name of Physical Network Function.
41400 example: __PNF-NAME__
41401 - name: interface-name
41403 description: Name that identifies the link aggregate interface
41406 example: __INTERFACE-NAME__
41407 - name: interface-name
41409 description: Name given to the interface
41412 example: __INTERFACE-NAME__
41413 - name: vlan-interface
41415 description: String that identifies the interface
41418 example: __VLAN-INTERFACE__
41421 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
41424 $ref: "#/definitions/vlan"
41428 summary: update an existing vlan
41430 Update an existing vlan
41432 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41433 The PUT operation will entirely replace an existing object.
41434 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41436 Other differences between PUT and PATCH are:
41438 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41439 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41440 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41441 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41450 description: Response codes found in [response codes](https://wiki.onap.org/).
41454 description: unique name of Physical Network Function.
41457 example: __PNF-NAME__
41458 - name: interface-name
41460 description: Name that identifies the link aggregate interface
41463 example: __INTERFACE-NAME__
41464 - name: interface-name
41466 description: Name given to the interface
41469 example: __INTERFACE-NAME__
41470 - name: vlan-interface
41472 description: String that identifies the interface
41475 example: __VLAN-INTERFACE__
41478 description: vlan object that needs to be updated.
41481 $ref: "#/patchDefinitions/vlan"
41485 summary: delete an existing vlan
41486 description: delete an existing vlan
41487 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41496 description: Response codes found in [response codes](https://wiki.onap.org/).
41500 description: unique name of Physical Network Function.
41503 example: __PNF-NAME__
41504 - name: interface-name
41506 description: Name that identifies the link aggregate interface
41509 example: __INTERFACE-NAME__
41510 - name: interface-name
41512 description: Name given to the interface
41515 example: __INTERFACE-NAME__
41516 - name: vlan-interface
41518 description: String that identifies the interface
41521 example: __VLAN-INTERFACE__
41522 - name: resource-version
41524 description: resource-version for concurrency
41527 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
41531 summary: returns vlans
41532 description: returns vlans
41533 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
41539 description: successful operation
41541 $ref: "#/getDefinitions/vlans"
41543 description: Response codes found in [response codes](https://wiki.onap.org/).
41547 description: unique name of Physical Network Function.
41550 example: __PNF-NAME__
41551 - name: interface-name
41553 description: Name that identifies the link aggregate interface
41556 example: __INTERFACE-NAME__
41557 - name: interface-name
41559 description: Name given to the interface
41562 example: __INTERFACE-NAME__
41563 - name: vlan-interface
41568 - name: vlan-id-inner
41579 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
41583 summary: see node definition for valid relationships
41584 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41593 description: Response codes found in [response codes](https://wiki.onap.org/).
41597 description: unique name of Physical Network Function.
41600 example: __PNF-NAME__
41601 - name: interface-name
41603 description: Name that identifies the link aggregate interface
41606 example: __INTERFACE-NAME__
41607 - name: interface-name
41609 description: Name given to the interface
41612 example: __INTERFACE-NAME__
41615 description: PCI ID used to identify the sriov-vf
41618 example: __PCI-ID__
41621 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
41624 $ref: "#/definitions/relationship"
41628 summary: delete an existing relationship
41629 description: delete an existing relationship
41630 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41639 description: Response codes found in [response codes](https://wiki.onap.org/).
41643 description: unique name of Physical Network Function.
41646 example: __PNF-NAME__
41647 - name: interface-name
41649 description: Name that identifies the link aggregate interface
41652 example: __INTERFACE-NAME__
41653 - name: interface-name
41655 description: Name given to the interface
41658 example: __INTERFACE-NAME__
41661 description: PCI ID used to identify the sriov-vf
41664 example: __PCI-ID__
41665 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
41669 summary: returns sriov-vf
41670 description: returns sriov-vf
41671 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41677 description: successful operation
41679 $ref: "#/getDefinitions/sriov-vf"
41681 description: Response codes found in [response codes](https://wiki.onap.org/).
41685 description: unique name of Physical Network Function.
41688 example: __PNF-NAME__
41689 - name: interface-name
41691 description: Name that identifies the link aggregate interface
41694 example: __INTERFACE-NAME__
41695 - name: interface-name
41697 description: Name given to the interface
41700 example: __INTERFACE-NAME__
41703 description: PCI ID used to identify the sriov-vf
41706 example: __PCI-ID__
41710 summary: create or update an existing sriov-vf
41712 Create or update an existing sriov-vf.
41714 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41715 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41724 description: Response codes found in [response codes](https://wiki.onap.org/).
41728 description: unique name of Physical Network Function.
41731 example: __PNF-NAME__
41732 - name: interface-name
41734 description: Name that identifies the link aggregate interface
41737 example: __INTERFACE-NAME__
41738 - name: interface-name
41740 description: Name given to the interface
41743 example: __INTERFACE-NAME__
41746 description: PCI ID used to identify the sriov-vf
41749 example: __PCI-ID__
41752 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
41755 $ref: "#/definitions/sriov-vf"
41759 summary: update an existing sriov-vf
41761 Update an existing sriov-vf
41763 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41764 The PUT operation will entirely replace an existing object.
41765 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41767 Other differences between PUT and PATCH are:
41769 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41770 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41771 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41772 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41781 description: Response codes found in [response codes](https://wiki.onap.org/).
41785 description: unique name of Physical Network Function.
41788 example: __PNF-NAME__
41789 - name: interface-name
41791 description: Name that identifies the link aggregate interface
41794 example: __INTERFACE-NAME__
41795 - name: interface-name
41797 description: Name given to the interface
41800 example: __INTERFACE-NAME__
41803 description: PCI ID used to identify the sriov-vf
41806 example: __PCI-ID__
41809 description: sriov-vf object that needs to be updated.
41812 $ref: "#/patchDefinitions/sriov-vf"
41816 summary: delete an existing sriov-vf
41817 description: delete an existing sriov-vf
41818 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41827 description: Response codes found in [response codes](https://wiki.onap.org/).
41831 description: unique name of Physical Network Function.
41834 example: __PNF-NAME__
41835 - name: interface-name
41837 description: Name that identifies the link aggregate interface
41840 example: __INTERFACE-NAME__
41841 - name: interface-name
41843 description: Name given to the interface
41846 example: __INTERFACE-NAME__
41849 description: PCI ID used to identify the sriov-vf
41852 example: __PCI-ID__
41853 - name: resource-version
41855 description: resource-version for concurrency
41858 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
41862 summary: returns sriov-vfs
41863 description: returns sriov-vfs
41864 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
41870 description: successful operation
41872 $ref: "#/getDefinitions/sriov-vfs"
41874 description: Response codes found in [response codes](https://wiki.onap.org/).
41878 description: unique name of Physical Network Function.
41881 example: __PNF-NAME__
41882 - name: interface-name
41884 description: Name that identifies the link aggregate interface
41887 example: __INTERFACE-NAME__
41888 - name: interface-name
41890 description: Name given to the interface
41893 example: __INTERFACE-NAME__
41899 - name: vf-vlan-filter
41904 - name: vf-mac-filter
41909 - name: vf-vlan-strip
41914 - name: neutron-network-id
41919 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
41923 summary: see node definition for valid relationships
41924 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
41933 description: Response codes found in [response codes](https://wiki.onap.org/).
41937 description: unique name of Physical Network Function.
41940 example: __PNF-NAME__
41941 - name: interface-name
41943 description: Name that identifies the link aggregate interface
41946 example: __INTERFACE-NAME__
41947 - name: interface-name
41949 description: Name given to the interface
41952 example: __INTERFACE-NAME__
41955 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
41958 $ref: "#/definitions/relationship"
41962 summary: delete an existing relationship
41963 description: delete an existing relationship
41964 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
41973 description: Response codes found in [response codes](https://wiki.onap.org/).
41977 description: unique name of Physical Network Function.
41980 example: __PNF-NAME__
41981 - name: interface-name
41983 description: Name that identifies the link aggregate interface
41986 example: __INTERFACE-NAME__
41987 - name: interface-name
41989 description: Name given to the interface
41992 example: __INTERFACE-NAME__
41993 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
41997 summary: see node definition for valid relationships
41998 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
42007 description: Response codes found in [response codes](https://wiki.onap.org/).
42011 description: unique name of Physical Network Function.
42014 example: __PNF-NAME__
42015 - name: interface-name
42017 description: Name that identifies the link aggregate interface
42020 example: __INTERFACE-NAME__
42021 - name: interface-name
42023 description: Name given to the interface
42026 example: __INTERFACE-NAME__
42027 - name: l3-interface-ipv4-address
42029 description: IP address
42032 example: __L3-INTERFACE-IPV4-ADDRESS__
42035 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
42038 $ref: "#/definitions/relationship"
42042 summary: delete an existing relationship
42043 description: delete an existing relationship
42044 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
42053 description: Response codes found in [response codes](https://wiki.onap.org/).
42057 description: unique name of Physical Network Function.
42060 example: __PNF-NAME__
42061 - name: interface-name
42063 description: Name that identifies the link aggregate interface
42066 example: __INTERFACE-NAME__
42067 - name: interface-name
42069 description: Name given to the interface
42072 example: __INTERFACE-NAME__
42073 - name: l3-interface-ipv4-address
42075 description: IP address
42078 example: __L3-INTERFACE-IPV4-ADDRESS__
42079 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
42083 summary: returns l3-interface-ipv4-address-list
42084 description: returns l3-interface-ipv4-address-list
42085 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42091 description: successful operation
42093 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42095 description: Response codes found in [response codes](https://wiki.onap.org/).
42099 description: unique name of Physical Network Function.
42102 example: __PNF-NAME__
42103 - name: interface-name
42105 description: Name that identifies the link aggregate interface
42108 example: __INTERFACE-NAME__
42109 - name: interface-name
42111 description: Name given to the interface
42114 example: __INTERFACE-NAME__
42115 - name: l3-interface-ipv4-address
42117 description: IP address
42120 example: __L3-INTERFACE-IPV4-ADDRESS__
42124 summary: create or update an existing l3-interface-ipv4-address-list
42126 Create or update an existing l3-interface-ipv4-address-list.
42128 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42129 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42138 description: Response codes found in [response codes](https://wiki.onap.org/).
42142 description: unique name of Physical Network Function.
42145 example: __PNF-NAME__
42146 - name: interface-name
42148 description: Name that identifies the link aggregate interface
42151 example: __INTERFACE-NAME__
42152 - name: interface-name
42154 description: Name given to the interface
42157 example: __INTERFACE-NAME__
42158 - name: l3-interface-ipv4-address
42160 description: IP address
42163 example: __L3-INTERFACE-IPV4-ADDRESS__
42166 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
42169 $ref: "#/definitions/l3-interface-ipv4-address-list"
42173 summary: update an existing l3-interface-ipv4-address-list
42175 Update an existing l3-interface-ipv4-address-list
42177 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42178 The PUT operation will entirely replace an existing object.
42179 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42181 Other differences between PUT and PATCH are:
42183 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42184 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42185 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42186 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42195 description: Response codes found in [response codes](https://wiki.onap.org/).
42199 description: unique name of Physical Network Function.
42202 example: __PNF-NAME__
42203 - name: interface-name
42205 description: Name that identifies the link aggregate interface
42208 example: __INTERFACE-NAME__
42209 - name: interface-name
42211 description: Name given to the interface
42214 example: __INTERFACE-NAME__
42215 - name: l3-interface-ipv4-address
42217 description: IP address
42220 example: __L3-INTERFACE-IPV4-ADDRESS__
42223 description: l3-interface-ipv4-address-list object that needs to be updated.
42226 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42230 summary: delete an existing l3-interface-ipv4-address-list
42231 description: delete an existing l3-interface-ipv4-address-list
42232 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42241 description: Response codes found in [response codes](https://wiki.onap.org/).
42245 description: unique name of Physical Network Function.
42248 example: __PNF-NAME__
42249 - name: interface-name
42251 description: Name that identifies the link aggregate interface
42254 example: __INTERFACE-NAME__
42255 - name: interface-name
42257 description: Name given to the interface
42260 example: __INTERFACE-NAME__
42261 - name: l3-interface-ipv4-address
42263 description: IP address
42266 example: __L3-INTERFACE-IPV4-ADDRESS__
42267 - name: resource-version
42269 description: resource-version for concurrency
42272 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
42276 summary: see node definition for valid relationships
42277 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42286 description: Response codes found in [response codes](https://wiki.onap.org/).
42290 description: unique name of Physical Network Function.
42293 example: __PNF-NAME__
42294 - name: interface-name
42296 description: Name that identifies the link aggregate interface
42299 example: __INTERFACE-NAME__
42300 - name: interface-name
42302 description: Name given to the interface
42305 example: __INTERFACE-NAME__
42306 - name: l3-interface-ipv6-address
42308 description: IP address
42311 example: __L3-INTERFACE-IPV6-ADDRESS__
42314 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42317 $ref: "#/definitions/relationship"
42321 summary: delete an existing relationship
42322 description: delete an existing relationship
42323 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42332 description: Response codes found in [response codes](https://wiki.onap.org/).
42336 description: unique name of Physical Network Function.
42339 example: __PNF-NAME__
42340 - name: interface-name
42342 description: Name that identifies the link aggregate interface
42345 example: __INTERFACE-NAME__
42346 - name: interface-name
42348 description: Name given to the interface
42351 example: __INTERFACE-NAME__
42352 - name: l3-interface-ipv6-address
42354 description: IP address
42357 example: __L3-INTERFACE-IPV6-ADDRESS__
42358 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
42362 summary: returns l3-interface-ipv6-address-list
42363 description: returns l3-interface-ipv6-address-list
42364 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42370 description: successful operation
42372 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42374 description: Response codes found in [response codes](https://wiki.onap.org/).
42378 description: unique name of Physical Network Function.
42381 example: __PNF-NAME__
42382 - name: interface-name
42384 description: Name that identifies the link aggregate interface
42387 example: __INTERFACE-NAME__
42388 - name: interface-name
42390 description: Name given to the interface
42393 example: __INTERFACE-NAME__
42394 - name: l3-interface-ipv6-address
42396 description: IP address
42399 example: __L3-INTERFACE-IPV6-ADDRESS__
42403 summary: create or update an existing l3-interface-ipv6-address-list
42405 Create or update an existing l3-interface-ipv6-address-list.
42407 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42408 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42417 description: Response codes found in [response codes](https://wiki.onap.org/).
42421 description: unique name of Physical Network Function.
42424 example: __PNF-NAME__
42425 - name: interface-name
42427 description: Name that identifies the link aggregate interface
42430 example: __INTERFACE-NAME__
42431 - name: interface-name
42433 description: Name given to the interface
42436 example: __INTERFACE-NAME__
42437 - name: l3-interface-ipv6-address
42439 description: IP address
42442 example: __L3-INTERFACE-IPV6-ADDRESS__
42445 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42448 $ref: "#/definitions/l3-interface-ipv6-address-list"
42452 summary: update an existing l3-interface-ipv6-address-list
42454 Update an existing l3-interface-ipv6-address-list
42456 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42457 The PUT operation will entirely replace an existing object.
42458 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42460 Other differences between PUT and PATCH are:
42462 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42463 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42464 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42465 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42474 description: Response codes found in [response codes](https://wiki.onap.org/).
42478 description: unique name of Physical Network Function.
42481 example: __PNF-NAME__
42482 - name: interface-name
42484 description: Name that identifies the link aggregate interface
42487 example: __INTERFACE-NAME__
42488 - name: interface-name
42490 description: Name given to the interface
42493 example: __INTERFACE-NAME__
42494 - name: l3-interface-ipv6-address
42496 description: IP address
42499 example: __L3-INTERFACE-IPV6-ADDRESS__
42502 description: l3-interface-ipv6-address-list object that needs to be updated.
42505 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42509 summary: delete an existing l3-interface-ipv6-address-list
42510 description: delete an existing l3-interface-ipv6-address-list
42511 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42520 description: Response codes found in [response codes](https://wiki.onap.org/).
42524 description: unique name of Physical Network Function.
42527 example: __PNF-NAME__
42528 - name: interface-name
42530 description: Name that identifies the link aggregate interface
42533 example: __INTERFACE-NAME__
42534 - name: interface-name
42536 description: Name given to the interface
42539 example: __INTERFACE-NAME__
42540 - name: l3-interface-ipv6-address
42542 description: IP address
42545 example: __L3-INTERFACE-IPV6-ADDRESS__
42546 - name: resource-version
42548 description: resource-version for concurrency
42551 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
42555 summary: returns l-interface
42556 description: returns l-interface
42557 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42563 description: successful operation
42565 $ref: "#/getDefinitions/l-interface"
42567 description: Response codes found in [response codes](https://wiki.onap.org/).
42571 description: unique name of Physical Network Function.
42574 example: __PNF-NAME__
42575 - name: interface-name
42577 description: Name that identifies the link aggregate interface
42580 example: __INTERFACE-NAME__
42581 - name: interface-name
42583 description: Name given to the interface
42586 example: __INTERFACE-NAME__
42590 summary: create or update an existing l-interface
42592 Create or update an existing l-interface.
42594 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42595 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42604 description: Response codes found in [response codes](https://wiki.onap.org/).
42608 description: unique name of Physical Network Function.
42611 example: __PNF-NAME__
42612 - name: interface-name
42614 description: Name that identifies the link aggregate interface
42617 example: __INTERFACE-NAME__
42618 - name: interface-name
42620 description: Name given to the interface
42623 example: __INTERFACE-NAME__
42626 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
42629 $ref: "#/definitions/l-interface"
42633 summary: update an existing l-interface
42635 Update an existing l-interface
42637 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42638 The PUT operation will entirely replace an existing object.
42639 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42641 Other differences between PUT and PATCH are:
42643 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42644 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42645 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42646 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42655 description: Response codes found in [response codes](https://wiki.onap.org/).
42659 description: unique name of Physical Network Function.
42662 example: __PNF-NAME__
42663 - name: interface-name
42665 description: Name that identifies the link aggregate interface
42668 example: __INTERFACE-NAME__
42669 - name: interface-name
42671 description: Name given to the interface
42674 example: __INTERFACE-NAME__
42677 description: l-interface object that needs to be updated.
42680 $ref: "#/patchDefinitions/l-interface"
42684 summary: delete an existing l-interface
42685 description: delete an existing l-interface
42686 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42695 description: Response codes found in [response codes](https://wiki.onap.org/).
42699 description: unique name of Physical Network Function.
42702 example: __PNF-NAME__
42703 - name: interface-name
42705 description: Name that identifies the link aggregate interface
42708 example: __INTERFACE-NAME__
42709 - name: interface-name
42711 description: Name given to the interface
42714 example: __INTERFACE-NAME__
42715 - name: resource-version
42717 description: resource-version for concurrency
42720 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
42724 summary: returns l-interfaces
42725 description: returns l-interfaces
42726 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
42732 description: successful operation
42734 $ref: "#/getDefinitions/l-interfaces"
42736 description: Response codes found in [response codes](https://wiki.onap.org/).
42740 description: unique name of Physical Network Function.
42743 example: __PNF-NAME__
42744 - name: interface-name
42746 description: Name that identifies the link aggregate interface
42749 example: __INTERFACE-NAME__
42750 - name: interface-name
42755 - name: interface-id
42765 - name: network-name
42770 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
42774 summary: returns lag-interface
42775 description: returns lag-interface
42776 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
42782 description: successful operation
42784 $ref: "#/getDefinitions/lag-interface"
42786 description: Response codes found in [response codes](https://wiki.onap.org/).
42790 description: unique name of Physical Network Function.
42793 example: __PNF-NAME__
42794 - name: interface-name
42796 description: Name that identifies the link aggregate interface
42799 example: __INTERFACE-NAME__
42803 summary: create or update an existing lag-interface
42805 Create or update an existing lag-interface.
42807 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42808 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
42817 description: Response codes found in [response codes](https://wiki.onap.org/).
42821 description: unique name of Physical Network Function.
42824 example: __PNF-NAME__
42825 - name: interface-name
42827 description: Name that identifies the link aggregate interface
42830 example: __INTERFACE-NAME__
42833 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)
42836 $ref: "#/definitions/lag-interface"
42840 summary: update an existing lag-interface
42842 Update an existing lag-interface
42844 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42845 The PUT operation will entirely replace an existing object.
42846 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42848 Other differences between PUT and PATCH are:
42850 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42851 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42852 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42853 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
42862 description: Response codes found in [response codes](https://wiki.onap.org/).
42866 description: unique name of Physical Network Function.
42869 example: __PNF-NAME__
42870 - name: interface-name
42872 description: Name that identifies the link aggregate interface
42875 example: __INTERFACE-NAME__
42878 description: lag-interface object that needs to be updated.
42881 $ref: "#/patchDefinitions/lag-interface"
42885 summary: delete an existing lag-interface
42886 description: delete an existing lag-interface
42887 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
42896 description: Response codes found in [response codes](https://wiki.onap.org/).
42900 description: unique name of Physical Network Function.
42903 example: __PNF-NAME__
42904 - name: interface-name
42906 description: Name that identifies the link aggregate interface
42909 example: __INTERFACE-NAME__
42910 - name: resource-version
42912 description: resource-version for concurrency
42915 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
42919 summary: returns lag-interfaces
42920 description: returns lag-interfaces
42921 operationId: getNetworkPnfsPnfLagInterfaces
42927 description: successful operation
42929 $ref: "#/getDefinitions/lag-interfaces"
42931 description: Response codes found in [response codes](https://wiki.onap.org/).
42935 description: unique name of Physical Network Function.
42938 example: __PNF-NAME__
42939 - name: interface-name
42944 - name: interface-id
42949 - name: interface-role
42954 /network/pnfs/pnf/{pnf-name}:
42958 summary: returns pnf
42959 description: returns pnf
42960 operationId: getNetworkPnfsPnf
42966 description: successful operation
42968 $ref: "#/getDefinitions/pnf"
42970 description: Response codes found in [response codes](https://wiki.onap.org/).
42974 description: unique name of Physical Network Function.
42977 example: __PNF-NAME__
42981 summary: create or update an existing pnf
42983 Create or update an existing pnf.
42985 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42986 operationId: createOrUpdateNetworkPnfsPnf
42995 description: Response codes found in [response codes](https://wiki.onap.org/).
42999 description: unique name of Physical Network Function.
43002 example: __PNF-NAME__
43005 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)
43008 $ref: "#/definitions/pnf"
43012 summary: update an existing pnf
43014 Update an existing pnf
43016 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43017 The PUT operation will entirely replace an existing object.
43018 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43020 Other differences between PUT and PATCH are:
43022 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43023 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43024 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43025 operationId: UpdateNetworkPnfsPnf
43034 description: Response codes found in [response codes](https://wiki.onap.org/).
43038 description: unique name of Physical Network Function.
43041 example: __PNF-NAME__
43044 description: pnf object that needs to be updated.
43047 $ref: "#/patchDefinitions/pnf"
43051 summary: delete an existing pnf
43052 description: delete an existing pnf
43053 operationId: deleteNetworkPnfsPnf
43062 description: Response codes found in [response codes](https://wiki.onap.org/).
43066 description: unique name of Physical Network Function.
43069 example: __PNF-NAME__
43070 - name: resource-version
43072 description: resource-version for concurrency
43079 summary: returns pnfs
43080 description: returns pnfs
43081 operationId: getNetworkPnfs
43087 description: successful operation
43089 $ref: "#/getDefinitions/pnfs"
43091 description: Response codes found in [response codes](https://wiki.onap.org/).
43103 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
43107 summary: see node definition for valid relationships
43108 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
43117 description: Response codes found in [response codes](https://wiki.onap.org/).
43121 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43124 example: __LINK-NAME__
43127 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)
43130 $ref: "#/definitions/relationship"
43134 summary: delete an existing relationship
43135 description: delete an existing relationship
43136 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
43145 description: Response codes found in [response codes](https://wiki.onap.org/).
43149 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43152 example: __LINK-NAME__
43153 /network/physical-links/physical-link/{link-name}:
43157 summary: returns physical-link
43158 description: returns physical-link
43159 operationId: getNetworkPhysicalLinksPhysicalLink
43165 description: successful operation
43167 $ref: "#/getDefinitions/physical-link"
43169 description: Response codes found in [response codes](https://wiki.onap.org/).
43173 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43176 example: __LINK-NAME__
43180 summary: create or update an existing physical-link
43182 Create or update an existing physical-link.
43184 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43185 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
43194 description: Response codes found in [response codes](https://wiki.onap.org/).
43198 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43201 example: __LINK-NAME__
43204 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)
43207 $ref: "#/definitions/physical-link"
43211 summary: update an existing physical-link
43213 Update an existing physical-link
43215 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43216 The PUT operation will entirely replace an existing object.
43217 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43219 Other differences between PUT and PATCH are:
43221 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43222 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43223 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43224 operationId: UpdateNetworkPhysicalLinksPhysicalLink
43233 description: Response codes found in [response codes](https://wiki.onap.org/).
43237 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43240 example: __LINK-NAME__
43243 description: physical-link object that needs to be updated.
43246 $ref: "#/patchDefinitions/physical-link"
43250 summary: delete an existing physical-link
43251 description: delete an existing physical-link
43252 operationId: deleteNetworkPhysicalLinksPhysicalLink
43261 description: Response codes found in [response codes](https://wiki.onap.org/).
43265 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43268 example: __LINK-NAME__
43269 - name: resource-version
43271 description: resource-version for concurrency
43274 /network/physical-links:
43278 summary: returns physical-links
43279 description: returns physical-links
43280 operationId: getNetworkPhysicalLinks
43286 description: successful operation
43288 $ref: "#/getDefinitions/physical-links"
43290 description: Response codes found in [response codes](https://wiki.onap.org/).
43302 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
43306 summary: see node definition for valid relationships
43307 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
43316 description: Response codes found in [response codes](https://wiki.onap.org/).
43318 - name: ipsec-configuration-id
43320 description: UUID of this configuration
43323 example: __IPSEC-CONFIGURATION-ID__
43326 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)
43329 $ref: "#/definitions/relationship"
43333 summary: delete an existing relationship
43334 description: delete an existing relationship
43335 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
43344 description: Response codes found in [response codes](https://wiki.onap.org/).
43346 - name: ipsec-configuration-id
43348 description: UUID of this configuration
43351 example: __IPSEC-CONFIGURATION-ID__
43352 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
43356 summary: see node definition for valid relationships
43357 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
43366 description: Response codes found in [response codes](https://wiki.onap.org/).
43368 - name: ipsec-configuration-id
43370 description: UUID of this configuration
43373 example: __IPSEC-CONFIGURATION-ID__
43374 - name: vig-address-type
43376 description: indicates whether the VIG is for AVPN or INTERNET
43379 example: __VIG-ADDRESS-TYPE__
43382 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
43385 $ref: "#/definitions/relationship"
43389 summary: delete an existing relationship
43390 description: delete an existing relationship
43391 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
43400 description: Response codes found in [response codes](https://wiki.onap.org/).
43402 - name: ipsec-configuration-id
43404 description: UUID of this configuration
43407 example: __IPSEC-CONFIGURATION-ID__
43408 - name: vig-address-type
43410 description: indicates whether the VIG is for AVPN or INTERNET
43413 example: __VIG-ADDRESS-TYPE__
43414 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
43418 summary: returns vig-server
43419 description: returns vig-server
43420 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43426 description: successful operation
43428 $ref: "#/getDefinitions/vig-server"
43430 description: Response codes found in [response codes](https://wiki.onap.org/).
43432 - name: ipsec-configuration-id
43434 description: UUID of this configuration
43437 example: __IPSEC-CONFIGURATION-ID__
43438 - name: vig-address-type
43440 description: indicates whether the VIG is for AVPN or INTERNET
43443 example: __VIG-ADDRESS-TYPE__
43447 summary: create or update an existing vig-server
43449 Create or update an existing vig-server.
43451 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43452 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43461 description: Response codes found in [response codes](https://wiki.onap.org/).
43463 - name: ipsec-configuration-id
43465 description: UUID of this configuration
43468 example: __IPSEC-CONFIGURATION-ID__
43469 - name: vig-address-type
43471 description: indicates whether the VIG is for AVPN or INTERNET
43474 example: __VIG-ADDRESS-TYPE__
43477 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
43480 $ref: "#/definitions/vig-server"
43484 summary: update an existing vig-server
43486 Update an existing vig-server
43488 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43489 The PUT operation will entirely replace an existing object.
43490 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43492 Other differences between PUT and PATCH are:
43494 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43495 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43496 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43497 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43506 description: Response codes found in [response codes](https://wiki.onap.org/).
43508 - name: ipsec-configuration-id
43510 description: UUID of this configuration
43513 example: __IPSEC-CONFIGURATION-ID__
43514 - name: vig-address-type
43516 description: indicates whether the VIG is for AVPN or INTERNET
43519 example: __VIG-ADDRESS-TYPE__
43522 description: vig-server object that needs to be updated.
43525 $ref: "#/patchDefinitions/vig-server"
43529 summary: delete an existing vig-server
43530 description: delete an existing vig-server
43531 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43540 description: Response codes found in [response codes](https://wiki.onap.org/).
43542 - name: ipsec-configuration-id
43544 description: UUID of this configuration
43547 example: __IPSEC-CONFIGURATION-ID__
43548 - name: vig-address-type
43550 description: indicates whether the VIG is for AVPN or INTERNET
43553 example: __VIG-ADDRESS-TYPE__
43554 - name: resource-version
43556 description: resource-version for concurrency
43559 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
43563 summary: returns vig-servers
43564 description: returns vig-servers
43565 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
43571 description: successful operation
43573 $ref: "#/getDefinitions/vig-servers"
43575 description: Response codes found in [response codes](https://wiki.onap.org/).
43577 - name: ipsec-configuration-id
43579 description: UUID of this configuration
43582 example: __IPSEC-CONFIGURATION-ID__
43583 - name: vig-address-type
43588 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
43592 summary: returns ipsec-configuration
43593 description: returns ipsec-configuration
43594 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
43600 description: successful operation
43602 $ref: "#/getDefinitions/ipsec-configuration"
43604 description: Response codes found in [response codes](https://wiki.onap.org/).
43606 - name: ipsec-configuration-id
43608 description: UUID of this configuration
43611 example: __IPSEC-CONFIGURATION-ID__
43615 summary: create or update an existing ipsec-configuration
43617 Create or update an existing ipsec-configuration.
43619 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43620 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
43629 description: Response codes found in [response codes](https://wiki.onap.org/).
43631 - name: ipsec-configuration-id
43633 description: UUID of this configuration
43636 example: __IPSEC-CONFIGURATION-ID__
43639 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)
43642 $ref: "#/definitions/ipsec-configuration"
43646 summary: update an existing ipsec-configuration
43648 Update an existing ipsec-configuration
43650 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43651 The PUT operation will entirely replace an existing object.
43652 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43654 Other differences between PUT and PATCH are:
43656 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43657 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43658 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43659 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
43668 description: Response codes found in [response codes](https://wiki.onap.org/).
43670 - name: ipsec-configuration-id
43672 description: UUID of this configuration
43675 example: __IPSEC-CONFIGURATION-ID__
43678 description: ipsec-configuration object that needs to be updated.
43681 $ref: "#/patchDefinitions/ipsec-configuration"
43685 summary: delete an existing ipsec-configuration
43686 description: delete an existing ipsec-configuration
43687 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
43696 description: Response codes found in [response codes](https://wiki.onap.org/).
43698 - name: ipsec-configuration-id
43700 description: UUID of this configuration
43703 example: __IPSEC-CONFIGURATION-ID__
43704 - name: resource-version
43706 description: resource-version for concurrency
43709 /network/ipsec-configurations:
43713 summary: returns ipsec-configurations
43714 description: returns ipsec-configurations
43715 operationId: getNetworkIpsecConfigurations
43721 description: successful operation
43723 $ref: "#/getDefinitions/ipsec-configurations"
43725 description: Response codes found in [response codes](https://wiki.onap.org/).
43727 - name: ipsec-configuration-id
43732 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
43736 summary: see node definition for valid relationships
43737 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
43746 description: Response codes found in [response codes](https://wiki.onap.org/).
43748 - name: route-table-reference-id
43750 description: Route Table Reference id, UUID assigned to this instance.
43753 example: __ROUTE-TABLE-REFERENCE-ID__
43756 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)
43759 $ref: "#/definitions/relationship"
43763 summary: delete an existing relationship
43764 description: delete an existing relationship
43765 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
43774 description: Response codes found in [response codes](https://wiki.onap.org/).
43776 - name: route-table-reference-id
43778 description: Route Table Reference id, UUID assigned to this instance.
43781 example: __ROUTE-TABLE-REFERENCE-ID__
43782 /network/route-table-references/route-table-reference/{route-table-reference-id}:
43786 summary: returns route-table-reference
43787 description: returns route-table-reference
43788 operationId: getNetworkRouteTableReferencesRouteTableReference
43794 description: successful operation
43796 $ref: "#/getDefinitions/route-table-reference"
43798 description: Response codes found in [response codes](https://wiki.onap.org/).
43800 - name: route-table-reference-id
43802 description: Route Table Reference id, UUID assigned to this instance.
43805 example: __ROUTE-TABLE-REFERENCE-ID__
43809 summary: create or update an existing route-table-reference
43811 Create or update an existing route-table-reference.
43813 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43814 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
43823 description: Response codes found in [response codes](https://wiki.onap.org/).
43825 - name: route-table-reference-id
43827 description: Route Table Reference id, UUID assigned to this instance.
43830 example: __ROUTE-TABLE-REFERENCE-ID__
43833 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)
43836 $ref: "#/definitions/route-table-reference"
43840 summary: update an existing route-table-reference
43842 Update an existing route-table-reference
43844 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43845 The PUT operation will entirely replace an existing object.
43846 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43848 Other differences between PUT and PATCH are:
43850 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43851 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43852 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43853 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
43862 description: Response codes found in [response codes](https://wiki.onap.org/).
43864 - name: route-table-reference-id
43866 description: Route Table Reference id, UUID assigned to this instance.
43869 example: __ROUTE-TABLE-REFERENCE-ID__
43872 description: route-table-reference object that needs to be updated.
43875 $ref: "#/patchDefinitions/route-table-reference"
43879 summary: delete an existing route-table-reference
43880 description: delete an existing route-table-reference
43881 operationId: deleteNetworkRouteTableReferencesRouteTableReference
43890 description: Response codes found in [response codes](https://wiki.onap.org/).
43892 - name: route-table-reference-id
43894 description: Route Table Reference id, UUID assigned to this instance.
43897 example: __ROUTE-TABLE-REFERENCE-ID__
43898 - name: resource-version
43900 description: resource-version for concurrency
43903 /network/route-table-references:
43907 summary: returns route-table-references
43908 description: returns route-table-references
43909 operationId: getNetworkRouteTableReferences
43915 description: successful operation
43917 $ref: "#/getDefinitions/route-table-references"
43919 description: Response codes found in [response codes](https://wiki.onap.org/).
43921 - name: route-table-reference-id
43926 - name: route-table-reference-fqdn
43931 /network/instance-groups/instance-group/{id}/relationship-list/relationship:
43935 summary: see node definition for valid relationships
43936 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
43945 description: Response codes found in [response codes](https://wiki.onap.org/).
43949 description: Instance Group ID, UUID assigned to this instance.
43955 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
43958 $ref: "#/definitions/relationship"
43962 summary: delete an existing relationship
43963 description: delete an existing relationship
43964 operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
43973 description: Response codes found in [response codes](https://wiki.onap.org/).
43977 description: Instance Group ID, UUID assigned to this instance.
43981 /network/instance-groups/instance-group/{id}:
43985 summary: returns instance-group
43986 description: returns instance-group
43987 operationId: getNetworkInstanceGroupsInstanceGroup
43993 description: successful operation
43995 $ref: "#/getDefinitions/instance-group"
43997 description: Response codes found in [response codes](https://wiki.onap.org/).
44001 description: Instance Group ID, UUID assigned to this instance.
44008 summary: create or update an existing instance-group
44010 Create or update an existing instance-group.
44012 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44013 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
44022 description: Response codes found in [response codes](https://wiki.onap.org/).
44026 description: Instance Group ID, UUID assigned to this instance.
44032 description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
44035 $ref: "#/definitions/instance-group"
44039 summary: update an existing instance-group
44041 Update an existing instance-group
44043 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44044 The PUT operation will entirely replace an existing object.
44045 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44047 Other differences between PUT and PATCH are:
44049 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44050 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44051 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44052 operationId: UpdateNetworkInstanceGroupsInstanceGroup
44061 description: Response codes found in [response codes](https://wiki.onap.org/).
44065 description: Instance Group ID, UUID assigned to this instance.
44071 description: instance-group object that needs to be updated.
44074 $ref: "#/patchDefinitions/instance-group"
44078 summary: delete an existing instance-group
44079 description: delete an existing instance-group
44080 operationId: deleteNetworkInstanceGroupsInstanceGroup
44089 description: Response codes found in [response codes](https://wiki.onap.org/).
44093 description: Instance Group ID, UUID assigned to this instance.
44097 - name: resource-version
44099 description: resource-version for concurrency
44102 /network/instance-groups:
44106 summary: returns instance-groups
44107 description: returns instance-groups
44108 operationId: getNetworkInstanceGroups
44114 description: successful operation
44116 $ref: "#/getDefinitions/instance-groups"
44118 description: Response codes found in [response codes](https://wiki.onap.org/).
44125 - name: description
44140 /network/zones/zone/{zone-id}/relationship-list/relationship:
44144 summary: see node definition for valid relationships
44145 operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
44154 description: Response codes found in [response codes](https://wiki.onap.org/).
44158 description: Code assigned by AIC to the zone
44161 example: __ZONE-ID__
44164 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
44167 $ref: "#/definitions/relationship"
44171 summary: delete an existing relationship
44172 description: delete an existing relationship
44173 operationId: deleteNetworkZonesZoneRelationshipListRelationship
44182 description: Response codes found in [response codes](https://wiki.onap.org/).
44186 description: Code assigned by AIC to the zone
44189 example: __ZONE-ID__
44190 /network/zones/zone/{zone-id}:
44194 summary: returns zone
44195 description: returns zone
44196 operationId: getNetworkZonesZone
44202 description: successful operation
44204 $ref: "#/getDefinitions/zone"
44206 description: Response codes found in [response codes](https://wiki.onap.org/).
44210 description: Code assigned by AIC to the zone
44213 example: __ZONE-ID__
44217 summary: create or update an existing zone
44219 Create or update an existing zone.
44221 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44222 operationId: createOrUpdateNetworkZonesZone
44231 description: Response codes found in [response codes](https://wiki.onap.org/).
44235 description: Code assigned by AIC to the zone
44238 example: __ZONE-ID__
44241 description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
44244 $ref: "#/definitions/zone"
44248 summary: update an existing zone
44250 Update an existing zone
44252 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44253 The PUT operation will entirely replace an existing object.
44254 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44256 Other differences between PUT and PATCH are:
44258 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44259 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44260 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44261 operationId: UpdateNetworkZonesZone
44270 description: Response codes found in [response codes](https://wiki.onap.org/).
44274 description: Code assigned by AIC to the zone
44277 example: __ZONE-ID__
44280 description: zone object that needs to be updated.
44283 $ref: "#/patchDefinitions/zone"
44287 summary: delete an existing zone
44288 description: delete an existing zone
44289 operationId: deleteNetworkZonesZone
44298 description: Response codes found in [response codes](https://wiki.onap.org/).
44302 description: Code assigned by AIC to the zone
44305 example: __ZONE-ID__
44306 - name: resource-version
44308 description: resource-version for concurrency
44315 summary: returns zones
44316 description: returns zones
44317 operationId: getNetworkZones
44323 description: successful operation
44325 $ref: "#/getDefinitions/zones"
44327 description: Response codes found in [response codes](https://wiki.onap.org/).
44334 - name: design-type
44339 - name: zone-context
44344 /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
44348 summary: see node definition for valid relationships
44349 operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
44358 description: Response codes found in [response codes](https://wiki.onap.org/).
44360 - name: configuration-id
44362 description: UUID assigned to configuration.
44365 example: __CONFIGURATION-ID__
44368 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
44371 $ref: "#/definitions/relationship"
44375 summary: delete an existing relationship
44376 description: delete an existing relationship
44377 operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
44386 description: Response codes found in [response codes](https://wiki.onap.org/).
44388 - name: configuration-id
44390 description: UUID assigned to configuration.
44393 example: __CONFIGURATION-ID__
44394 /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
44398 summary: returns metadatum
44399 description: returns metadatum
44400 operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
44406 description: successful operation
44408 $ref: "#/getDefinitions/metadatum"
44410 description: Response codes found in [response codes](https://wiki.onap.org/).
44412 - name: configuration-id
44414 description: UUID assigned to configuration.
44417 example: __CONFIGURATION-ID__
44422 example: __METANAME__
44426 summary: create or update an existing metadatum
44428 Create or update an existing metadatum.
44430 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44431 operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
44440 description: Response codes found in [response codes](https://wiki.onap.org/).
44442 - name: configuration-id
44444 description: UUID assigned to configuration.
44447 example: __CONFIGURATION-ID__
44452 example: __METANAME__
44455 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfigurationMetadataMetadatum.json)
44458 $ref: "#/definitions/metadatum"
44462 summary: update an existing metadatum
44464 Update an existing metadatum
44466 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44467 The PUT operation will entirely replace an existing object.
44468 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44470 Other differences between PUT and PATCH are:
44472 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44473 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44474 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44475 operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
44484 description: Response codes found in [response codes](https://wiki.onap.org/).
44486 - name: configuration-id
44488 description: UUID assigned to configuration.
44491 example: __CONFIGURATION-ID__
44496 example: __METANAME__
44499 description: metadatum object that needs to be updated.
44502 $ref: "#/patchDefinitions/metadatum"
44506 summary: delete an existing metadatum
44507 description: delete an existing metadatum
44508 operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
44517 description: Response codes found in [response codes](https://wiki.onap.org/).
44519 - name: configuration-id
44521 description: UUID assigned to configuration.
44524 example: __CONFIGURATION-ID__
44529 example: __METANAME__
44530 - name: resource-version
44532 description: resource-version for concurrency
44535 /network/configurations/configuration/{configuration-id}/metadata:
44539 summary: returns metadata
44540 description: returns metadata
44541 operationId: getNetworkConfigurationsConfigurationMetadata
44547 description: successful operation
44549 $ref: "#/getDefinitions/metadata"
44551 description: Response codes found in [response codes](https://wiki.onap.org/).
44553 - name: configuration-id
44555 description: UUID assigned to configuration.
44558 example: __CONFIGURATION-ID__
44564 /network/configurations/configuration/{configuration-id}:
44568 summary: returns configuration
44569 description: returns configuration
44570 operationId: getNetworkConfigurationsConfiguration
44576 description: successful operation
44578 $ref: "#/getDefinitions/configuration"
44580 description: Response codes found in [response codes](https://wiki.onap.org/).
44582 - name: configuration-id
44584 description: UUID assigned to configuration.
44587 example: __CONFIGURATION-ID__
44591 summary: create or update an existing configuration
44593 Create or update an existing configuration.
44595 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44596 operationId: createOrUpdateNetworkConfigurationsConfiguration
44605 description: Response codes found in [response codes](https://wiki.onap.org/).
44607 - name: configuration-id
44609 description: UUID assigned to configuration.
44612 example: __CONFIGURATION-ID__
44615 description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
44618 $ref: "#/definitions/configuration"
44622 summary: update an existing configuration
44624 Update an existing configuration
44626 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44627 The PUT operation will entirely replace an existing object.
44628 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44630 Other differences between PUT and PATCH are:
44632 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44633 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44634 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44635 operationId: UpdateNetworkConfigurationsConfiguration
44644 description: Response codes found in [response codes](https://wiki.onap.org/).
44646 - name: configuration-id
44648 description: UUID assigned to configuration.
44651 example: __CONFIGURATION-ID__
44654 description: configuration object that needs to be updated.
44657 $ref: "#/patchDefinitions/configuration"
44661 summary: delete an existing configuration
44662 description: delete an existing configuration
44663 operationId: deleteNetworkConfigurationsConfiguration
44672 description: Response codes found in [response codes](https://wiki.onap.org/).
44674 - name: configuration-id
44676 description: UUID assigned to configuration.
44679 example: __CONFIGURATION-ID__
44680 - name: resource-version
44682 description: resource-version for concurrency
44685 /network/configurations:
44689 summary: returns configurations
44690 description: returns configurations
44691 operationId: getNetworkConfigurations
44697 description: successful operation
44699 $ref: "#/getDefinitions/configurations"
44701 description: Response codes found in [response codes](https://wiki.onap.org/).
44703 - name: configuration-id
44708 - name: model-invariant-id
44713 - name: model-version-id
44726 $ref: "#/definitions/action-data"
44735 APIs that are more action related than REST (e.g., notify, update).
44739 $ref: "#/definitions/update"
44742 $ref: "#/definitions/notify"
44745 Represents a slice or partial piece of a resource that gets separately allotted
44746 ###### Related Nodes
44747 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
44748 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
44749 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
44750 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
44751 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
44752 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
44753 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
44754 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
44755 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
44756 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
44757 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
44758 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
44759 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
44761 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
44762 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
44763 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
44769 description: Allotted Resource id UUID assigned to this instance.
44772 description: The descriptive information assigned to this allotted resource instance
44775 description: Link back to more information in the controller
44776 model-invariant-id:
44778 description: the ASDC model id for this resource or service model.
44781 description: the ASDC model version for this resource or service model.
44782 persona-model-version:
44784 description: the ASDC model version for this resource or service model.
44787 description: Concurrency value
44788 orchestration-status:
44790 description: Orchestration status
44791 operational-status:
44793 description: Indicator for whether the resource is considered operational
44796 description: Generic description of the type of allotted resource.
44799 description: role in the network that this resource will be providing.
44803 $ref: "#/definitions/tunnel-xconnect"
44807 $ref: "#/definitions/relationship"
44808 allotted-resources:
44810 This object is used to store slices of services being offered
44815 $ref: "#/definitions/allotted-resource"
44818 Availability zone, a collection of compute hosts/pservers
44819 ###### Related Nodes
44820 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
44821 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
44822 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
44823 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
44824 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
44825 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
44826 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
44827 - FROM vce( vce Uses availability-zone, MANY2MANY)
44829 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
44830 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
44833 - availability-zone-name
44836 availability-zone-name:
44838 description: Name of the availability zone. Unique across a cloud region
44841 description: Type of hypervisor. Source of truth should define valid values.
44842 operational-status:
44844 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
44847 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44851 $ref: "#/definitions/relationship"
44852 availability-zones:
44854 Collection of availability zones
44859 $ref: "#/definitions/availability-zone"
44860 az-and-dvs-switches:
44864 $ref: "#/definitions/dvs-switches"
44867 $ref: "#/definitions/availability-zone"
44870 Namespace for business related constructs
44875 $ref: "#/definitions/connector"
44879 $ref: "#/definitions/customer"
44883 $ref: "#/definitions/line-of-business"
44887 $ref: "#/definitions/owning-entity"
44891 $ref: "#/definitions/platform"
44895 $ref: "#/definitions/project"
44898 ###### Related Nodes
44899 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
44901 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
44907 description: unique identifier of probe
44910 description: identifier of probe
44913 description: type of probe
44916 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44920 $ref: "#/definitions/relationship"
44921 classes-of-service:
44923 class-of-service of probe
44928 $ref: "#/definitions/class-of-service"
44929 cloud-infrastructure:
44931 Namespace for cloud infrastructure.
44936 $ref: "#/definitions/complex"
44940 $ref: "#/definitions/cloud-region"
44944 $ref: "#/definitions/network-profile"
44948 $ref: "#/definitions/pserver"
44949 virtual-data-centers:
44952 $ref: "#/definitions/virtual-data-center"
44955 cloud-region designates an installation of a cloud cluster or region or instantiation.
44956 ###### Related Nodes
44957 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
44958 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
44959 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
44960 - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
44961 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
44962 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
44963 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
44964 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
44965 - FROM image( image BelongsTo cloud-region, MANY2ONE)
44966 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
44967 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
44968 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
44969 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
44970 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
44971 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
44972 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
44973 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
44975 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
44976 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
44985 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
44988 description: Identifier used by the vendor for the region. Second part of composite key
44991 description: Type of the cloud (e.g., openstack)
44992 owner-defined-type:
44994 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
44995 cloud-region-version:
44997 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
45000 description: URL of the keystone identity service
45003 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
45006 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
45009 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
45012 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
45015 description: MultiVIM will discover and expose EPA capabilities.
45018 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45022 $ref: "#/definitions/volume-group"
45026 $ref: "#/definitions/tenant"
45030 $ref: "#/definitions/flavor"
45034 $ref: "#/definitions/group-assignment"
45038 $ref: "#/definitions/snapshot"
45042 $ref: "#/definitions/image"
45046 $ref: "#/definitions/dvs-switch"
45050 $ref: "#/definitions/oam-network"
45051 availability-zones:
45054 $ref: "#/definitions/availability-zone"
45058 $ref: "#/definitions/relationship"
45059 esr-system-info-list:
45062 $ref: "#/definitions/esr-system-info"
45063 vip-ipv4-address-list:
45066 $ref: "#/definitions/vip-ipv4-address-list"
45067 vip-ipv6-address-list:
45070 $ref: "#/definitions/vip-ipv6-address-list"
45076 $ref: "#/definitions/cloud-region"
45079 Collection of physical locations that can house cloud-regions.
45080 ###### Related Nodes
45081 - TO l3-network( complex Uses l3-network, MANY2MANY)
45082 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
45083 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
45084 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
45085 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
45086 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
45087 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
45088 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
45089 - FROM vce( vce LocatedIn complex, MANY2MANY)
45090 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
45091 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
45092 - FROM zone( zone LocatedIn complex, MANY2ONE)
45094 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
45095 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
45098 - physical-location-id
45099 - physical-location-type
45106 physical-location-id:
45108 description: Unique identifier for physical location, e.g., CLLI
45111 description: Data center code which can be an alternate way to identify a complex
45114 description: Gamma complex name for LCP instance.
45117 description: URL of the keystone identity service
45120 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45121 physical-location-type:
45123 description: Type, e.g., central office, data center.
45149 $ref: "#/definitions/ctag-pool"
45153 $ref: "#/definitions/relationship"
45156 Collection of physical locations that can house cloud-regions.
45161 $ref: "#/definitions/complex"
45164 Port Mirror Configuration.
45165 ###### Related Nodes
45166 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
45167 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
45168 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
45169 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
45170 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
45172 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
45173 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
45174 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
45177 - configuration-type
45178 - configuration-sub-type
45179 - orchestration-status
45180 - operational-status
45181 - configuration-selflink
45182 - model-customization-id
45186 description: UUID assigned to configuration.
45189 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
45190 configuration-name:
45192 description: Name of the configuration.
45193 configuration-type:
45195 description: port-mirroring-configuration.
45196 configuration-sub-type:
45198 description: vprobe, pprobe.
45199 model-invariant-id:
45201 description: the ASDC model id for this resource or service model.
45204 description: the ASDC model version for this resource or service model.
45205 orchestration-status:
45207 description: Orchestration status of the configuration.
45208 operational-status:
45210 description: Indicator for whether the resource is considered operational.
45211 configuration-selflink:
45213 description: URL to endpoint where AAI can get more details from SDN-GC.
45214 model-customization-id:
45216 description: id of the configuration used to customize the resource
45219 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45223 $ref: "#/definitions/relationship"
45227 $ref: "#/definitions/metadatum"
45230 Collection of configurations
45235 $ref: "#/definitions/configuration"
45238 Collection of resource instances used to connect a variety of disparate inventory widgets
45239 ###### Related Nodes
45240 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
45241 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
45242 - FROM service-instance( service-instance Uses connector, MANY2MANY)
45244 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
45246 - resource-instance-id
45248 resource-instance-id:
45250 description: Unique id of resource instance.
45253 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45254 model-invariant-id:
45256 description: the ASDC model id for this resource or service model.
45259 description: the ASDC model version for this resource or service model.
45260 persona-model-version:
45262 description: the ASDC model version for this resource or service model.
45265 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45266 widget-model-version:
45268 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45272 $ref: "#/definitions/relationship"
45276 $ref: "#/definitions/metadatum"
45279 Collection of resource instances used to connect a variety of disparate inventory widgets
45284 $ref: "#/definitions/connector"
45285 constrained-element-set:
45287 This is how we would capture constraints defining allowed sets of elements.
45288 ###### Related Nodes
45289 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
45290 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
45291 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
45293 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
45294 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
45296 - constrained-element-set-uuid
45300 constrained-element-set-uuid:
45308 element-choice-sets:
45311 $ref: "#/definitions/element-choice-set"
45315 $ref: "#/definitions/relationship"
45316 constrained-element-sets:
45318 constrained-element-set:
45321 $ref: "#/definitions/constrained-element-set"
45324 ###### Related Nodes
45325 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
45326 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
45328 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
45338 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45342 $ref: "#/definitions/relationship"
45348 $ref: "#/definitions/ctag-assignment"
45351 A collection of C tags (vlan tags) grouped for a specific purpose.
45352 ###### Related Nodes
45353 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
45354 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
45355 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
45356 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
45358 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
45361 - availability-zone-name
45362 - ctag-pool-purpose
45366 description: The Target provider edge router
45367 availability-zone-name:
45369 description: Name of the availability zone
45372 description: Describes what the intended purpose of this pool is.
45375 description: Comma separated list of ctags
45378 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45382 $ref: "#/definitions/relationship"
45388 $ref: "#/definitions/ctag-pool"
45391 customer identifiers to provide linkage back to BSS information.
45392 ###### Related Nodes
45393 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
45395 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
45397 - global-customer-id
45401 global-customer-id:
45403 description: Global customer id used across ECOMP to uniquely identify customer.
45406 description: Subscriber name, an alternate way to retrieve a customer.
45409 description: Subscriber type, a way to provide VID with only the INFRA customers.
45412 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45413 service-subscriptions:
45416 $ref: "#/definitions/service-subscription"
45420 $ref: "#/definitions/relationship"
45423 Collection of customer identifiers to provide linkage back to BSS information.
45428 $ref: "#/definitions/customer"
45436 description: See mis-na-virtualization-platform.yang
45439 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45443 $ref: "#/definitions/relationship"
45449 $ref: "#/definitions/cvlan-tag-entry"
45452 Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
45453 ###### Related Nodes
45454 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
45455 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
45463 description: DVS switch name
45466 description: URL used to reach the vcenter
45469 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45473 $ref: "#/definitions/relationship"
45476 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
45481 $ref: "#/definitions/dvs-switch"
45484 Internal map to define the properties of an edge and interpret the map EdgeRules
45500 edge-tag-query-request:
45511 $ref: "#/definitions/start-node-filter"
45512 include-node-filter:
45515 $ref: "#/definitions/include-node-filter"
45519 $ref: "#/definitions/secondary-filter"
45520 edge-tag-query-result:
45522 tagged-inventory-item-list:
45525 $ref: "#/definitions/tagged-inventory-item-list"
45526 element-choice-set:
45528 This is how we would capture constraints defining allowed sets of elements.
45529 ###### Related Nodes
45530 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
45531 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
45533 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
45534 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
45536 - element-choice-set-uuid
45537 - element-choice-set-name
45539 element-choice-set-uuid:
45541 element-choice-set-name:
45550 $ref: "#/definitions/model-element"
45554 $ref: "#/definitions/relationship"
45555 element-choice-sets:
45557 element-choice-set:
45560 $ref: "#/definitions/element-choice-set"
45563 Metadata for entitlement group.
45564 ###### Related Nodes
45565 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
45566 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
45568 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
45575 description: Unique ID for the entitlement group the resource comes from, should be uuid.
45578 description: Unique ID of an entitlement resource.
45581 description: Concurrency value
45585 $ref: "#/definitions/relationship"
45588 Entitlements, keyed by group-uuid and resource-uuid, related to license management
45593 $ref: "#/definitions/entitlement"
45596 Persist EMS address information used by EMS driver.
45597 ###### Related Nodes
45598 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
45600 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
45606 description: Unique ID of EMS.
45609 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45610 esr-system-info-list:
45612 $ref: "#/definitions/esr-system-info-list"
45615 $ref: "#/definitions/relationship-list"
45621 $ref: "#/definitions/esr-ems"
45624 Persist common address information of external systems.
45625 ###### Related Nodes
45626 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
45627 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
45628 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
45629 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
45631 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
45633 - esr-system-info-id
45638 esr-system-info-id:
45640 description: Unique ID of esr system info.
45643 description: name of external system.
45646 description: type of external systems.
45649 description: vendor of external systems.
45652 description: version of external systems.
45655 description: url used to access external systems.
45658 description: username used to access external systems.
45661 description: password used to access external systems.
45664 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
45667 description: protocol of third party SDNC, for example netconf/snmp.
45670 description: ca file content if enabled ssl on auth-url.
45673 description: Whether to verify VIM's certificate.
45676 description: service IP of ftp server.
45679 description: service port of ftp server.
45682 description: domain info for authentication.
45685 description: default tenant of VIM.
45688 description: ftp passive mode or not.
45691 description: resource or performance data file path.
45694 description: the status of external system.
45697 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45701 $ref: "#/definitions/relationship"
45702 esr-system-info-list:
45704 Collection of persistent block-level external system auth info.
45709 $ref: "#/definitions/esr-system-info"
45710 esr-thirdparty-sdnc:
45712 Persist SDNC address information used by ONAP SDNC.
45713 ###### Related Nodes
45714 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
45715 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
45717 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
45719 - thirdparty-sdnc-id
45721 thirdparty-sdnc-id:
45723 description: Unique ID of SDNC.
45726 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
45729 description: password used to access SDNC server.
45732 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45733 esr-system-info-list:
45735 $ref: "#/definitions/esr-system-info-list"
45738 $ref: "#/definitions/relationship-list"
45739 esr-thirdparty-sdnc-list:
45741 esr-thirdparty-sdnc:
45744 $ref: "#/definitions/esr-thirdparty-sdnc"
45747 Persist VNFM address information used by VF-C.
45748 ###### Related Nodes
45749 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
45751 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
45757 description: Unique ID of VNFM.
45760 description: indecate the VIM to deploy VNF.
45763 description: certificate url of VNFM.
45766 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45767 esr-system-info-list:
45769 $ref: "#/definitions/esr-system-info-list"
45772 $ref: "#/definitions/relationship-list"
45778 $ref: "#/definitions/esr-vnfm"
45781 evc object is an optional child object of the Configuration object.
45782 ###### Related Nodes
45783 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
45785 -(4) IF this TO node is deleted, this EVC is DELETED also
45791 description: Unique/key field for the evc object
45792 forwarding-path-topology:
45794 description: Point-to-Point, Multi-Point
45797 description: Commited Information Rate
45800 description: CIR units
45801 connection-diversity-group-id:
45803 description: Diversity Group ID
45806 description: formerly Performance Group
45807 esp-evc-circuit-id:
45809 description: EVC Circuit ID of ESP EVC
45812 description: Committed Information Rate (For ESP)
45815 description: CIR units (For ESP)
45818 description: Identifies ESP
45819 collector-pop-clli:
45821 description: Collector POP CLLI (from the hostname of the access pnf)
45822 inter-connect-type-ingress:
45824 description: Interconnect type on ingress side of EVC.
45825 tagmode-access-ingress:
45827 description: tagode for collector side of EVC
45828 tagmode-access-egress:
45830 description: tagMode for network side of EVC
45834 $ref: "#/definitions/relationship"
45837 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45843 $ref: "#/definitions/evc"
45846 Namespace for external system.
45850 $ref: "#/definitions/esr-ems-list"
45853 $ref: "#/definitions/esr-vnfm-list"
45854 esr-thirdparty-sdnc-list:
45856 $ref: "#/definitions/esr-thirdparty-sdnc-list"
45859 Extra properties for inventory item for response list
45864 $ref: "#/definitions/extra-property"
45874 ###### Related Nodes
45875 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
45876 - FROM vserver( vserver Uses flavor, MANY2ONE)
45878 -FLAVOR cannot be deleted if related to VSERVER
45887 description: Flavor id, expected to be unique across cloud-region.
45890 description: Flavor name
45894 description: Number of CPUs
45898 description: Amount of memory
45902 description: Disk space
45906 description: Amount of ephemeral disk space
45909 description: amount of swap space allocation
45912 description: whether flavor is available to all users or private to the tenant it was created in.
45915 description: URL to endpoint where AAI can get more details
45918 description: Boolean as to whether this flavor is no longer enabled
45921 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45925 $ref: "#/definitions/relationship"
45928 Collection of openstack flavors.
45933 $ref: "#/definitions/flavor"
45936 Entity describing a sequenced segment of forwarding path
45937 ###### Related Nodes
45938 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
45939 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
45940 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
45941 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
45942 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
45944 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
45945 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
45952 description: Unique ID of this segmentation
45955 description: ingress, intermediate, egress
45959 $ref: "#/definitions/relationship"
45962 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45965 forwarder object is an optional child object of the Configuration object.
45966 ###### Related Nodes
45967 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
45969 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
45975 description: Key for forwarder-evc object
45978 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
45981 description: Internal VLAN.
45984 description: SVLAN value for ingress of egress forwarder.
45987 description: CVLAN value for ingress of egress forwarder.
45991 $ref: "#/definitions/relationship"
45994 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46000 $ref: "#/definitions/forwarder-evc"
46006 $ref: "#/definitions/forwarder"
46009 Entity that describes the sequenced forwarding path between interfaces of services or resources
46010 ###### Related Nodes
46011 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
46012 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
46013 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
46015 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
46016 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
46017 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
46019 - forwarding-path-id
46020 - forwarding-path-name
46022 forwarding-path-id:
46024 description: Unique ID of this FP
46025 forwarding-path-name:
46027 description: Name of the FP
46031 $ref: "#/definitions/relationship"
46034 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46037 description: the self link for this FP
46041 $ref: "#/definitions/forwarder"
46047 $ref: "#/definitions/forwarding-path"
46050 General purpose VNF
46051 ###### Related Nodes
46052 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
46053 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
46054 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
46055 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
46056 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
46057 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
46058 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
46059 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
46060 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
46061 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
46062 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
46063 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
46064 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
46065 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
46066 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
46067 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
46068 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
46069 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
46070 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
46071 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
46072 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
46073 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
46074 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
46075 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
46076 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
46077 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
46078 - FROM platform( platform Uses generic-vnf, MANY2MANY)
46080 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
46081 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
46087 - is-closed-loop-disabled
46091 description: Unique id of VNF. This is unique across the graph.
46094 description: vnf instance id.
46097 description: Name of VNF.
46100 description: Alternate name of VNF.
46103 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
46106 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
46107 regional-resource-zone:
46109 description: Regional way of organizing pservers, source of truth should define values
46112 description: Trigger for operational monitoring of this resource by Service Assurance systems.
46113 operational-status:
46115 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
46118 description: OBSOLETE - do not use
46121 description: Client should send valid enumerated value
46122 orchestration-status:
46124 description: Orchestration status of this VNF, used by MSO.
46127 vnf-discriptor-name:
46129 description: vnf discriptor name
46132 description: job id corresponding to vnf
46135 description: Heat stack id corresponding to this instance, managed by MSO
46138 description: Corresponds to the SDN-C catalog id used to configure this VCE
46141 description: identifier of managed by ATT or customer
46144 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
46145 ipv4-loopback0-address:
46147 description: v4 Loopback0 address
46150 description: v6 Loopback address
46151 management-v6-address:
46153 description: v6 management address
46157 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
46160 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
46164 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
46167 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
46171 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
46174 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
46178 description: number of associated SHD in vnf.
46182 description: number of vms in vnf.
46186 description: number of network in vnf.
46189 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
46190 is-closed-loop-disabled:
46192 description: used to indicate whether closed loop function is enabled on this node
46195 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46198 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
46199 encrypted-access-flag:
46201 description: indicates whether generic-vnf access uses SSH
46202 entitlement-assignment-group-uuid:
46204 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
46205 entitlement-resource-uuid:
46207 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
46208 license-assignment-group-uuid:
46210 description: UUID of the license assignment group. OBSOLETE - See child relationships.
46213 description: UUID of the actual license resource. OBSOLETE - See child relationships.
46214 model-invariant-id:
46216 description: the ASDC model id for this resource or service model.
46219 description: the ASDC model version for this resource or service model.
46220 persona-model-version:
46222 description: the ASDC model version for this resource or service model.
46223 model-customization-id:
46225 description: captures the id of all the configuration used to customize the resource for the service.
46228 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
46229 widget-model-version:
46231 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
46234 description: as-number of the VNF
46235 regional-resource-subzone:
46237 description: represents sub zone of the rr plane
46240 description: Generic description of the type of NF
46243 description: English description of Network function that the specific VNF deployment is providing
46246 description: role in the network that this model will be providing
46249 description: string assigned to this model used for naming purposes
46252 description: Path to the controller object.
46253 ipv4-oam-gateway-address:
46255 description: Gateway address
46256 ipv4-oam-gateway-address-prefix-length:
46259 description: Prefix length for oam-address
46263 description: Temporary location for S-TAG to get to VCE
46266 description: Network Management profile of this VNF
46270 $ref: "#/definitions/relationship"
46274 $ref: "#/definitions/l-interface"
46278 $ref: "#/definitions/lag-interface"
46282 $ref: "#/definitions/vf-module"
46286 $ref: "#/definitions/license"
46290 $ref: "#/definitions/entitlement"
46298 $ref: "#/definitions/generic-vnf"
46301 Openstack group-assignment used to store exclusivity groups (EG).
46302 ###### Related Nodes
46303 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
46304 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
46305 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
46314 description: Group id, expected to be unique across cloud-region.
46317 description: Group type - the type of group this instance refers to
46320 description: Group name - name assigned to the group
46323 description: Group description - description of the group
46326 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46330 $ref: "#/definitions/relationship"
46333 Collection of openstack group assignments
46338 $ref: "#/definitions/group-assignment"
46341 ###### Related Nodes
46342 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
46344 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
46352 description: host-route id
46355 description: subnet prefix
46358 description: Could be ip-address, hostname, or service-instance
46361 description: Should be ip-address, hostname, or service-instance to match next-hop
46364 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46368 $ref: "#/definitions/relationship"
46374 $ref: "#/definitions/host-route"
46377 Collection of HPA Capabilities
46382 $ref: "#/definitions/hpa-capability"
46385 Represents a HPA capability
46386 ###### Related Nodes
46387 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
46388 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
46389 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
46391 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
46393 - hpa-capability-id
46398 description: UUID to uniquely identify a HPA capability
46401 description: Name of the HPACapability
46404 description: HPA schema version
46407 description: Hardware architecture
46410 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46414 $ref: "#/definitions/relationship"
46415 hpa-feature-attributes:
46418 $ref: "#/definitions/hpa-feature-attributes"
46419 hpa-feature-attributes:
46421 HPA Capability Feature attributes
46422 ###### Related Nodes
46423 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
46425 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
46427 - hpa-attribute-key
46431 description: name of the specific HPA attribute
46432 hpa-attribute-value:
46434 description: JSON string specifying the value, unit and type of the specific HPA attribute
46437 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46441 $ref: "#/definitions/relationship"
46445 ###### Related Nodes
46446 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
46447 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
46448 - FROM vserver( vserver Uses image, MANY2ONE)
46450 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
46451 -IMAGE cannot be deleted if related to VSERVER
46462 description: Image id, expected to be unique across cloud region
46465 description: Image name
46466 image-architecture:
46468 description: Operating system architecture.
46471 description: The common name of the operating system distribution in lowercase
46474 description: The operating system version as specified by the distributor.
46477 description: The application that the image instantiates.
46478 application-vendor:
46480 description: The vendor of the application.
46481 application-version:
46483 description: The version of the application.
46486 description: URL to endpoint where AAI can get more details
46489 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46493 $ref: "#/definitions/relationship"
46497 $ref: "#/definitions/metadatum"
46500 Collectio of Openstack images.
46505 $ref: "#/definitions/image"
46506 include-node-filter:
46512 InstanceFilter for performing a named-query or model query
46515 InstanceFilters for performing a named-query or model query
46520 $ref: "#/definitions/instance-filter"
46523 General mechanism for grouping instances
46524 ###### Related Nodes
46525 - TO model( instance-group Targets model, MANY2MANY)
46526 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
46527 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
46528 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
46529 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
46530 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
46531 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
46532 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
46533 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
46534 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
46535 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
46536 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
46543 instance-group-role:
46545 description: role of the instance group.
46546 model-invariant-id:
46548 description: ASDC model id for this resource or service model.
46551 description: ASDC model version uid for this resource model.
46554 description: Instance Group ID, UUID assigned to this instance.
46557 description: Descriptive text to help identify the usage of this instance-group
46560 description: Only valid value today is lower case ha for high availability
46563 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
46566 description: Concurrency value
46570 $ref: "#/definitions/relationship"
46573 Collection of openstack route table references
46578 $ref: "#/definitions/instance-group"
46583 $ref: "#/definitions/search"
46586 $ref: "#/definitions/actions"
46587 cloud-infrastructure:
46589 $ref: "#/definitions/cloud-infrastructure"
46592 $ref: "#/definitions/external-system"
46595 $ref: "#/definitions/business"
46596 service-design-and-creation:
46598 $ref: "#/definitions/service-design-and-creation"
46601 $ref: "#/definitions/network"
46604 $ref: "#/definitions/nodes"
46607 inventory-item-type:
46609 inventory-item-link:
46611 inventory-item-data:
46614 $ref: "#/definitions/inventory-item-data"
46615 tagged-inventory-item-list:
46618 $ref: "#/definitions/tagged-inventory-item-list"
46619 inventory-item-data:
46625 inventory-response-item:
46627 Inventory item for response list
46633 $ref: "#/definitions/extra-properties"
46634 inventory-response-items:
46636 $ref: "#/definitions/inventory-response-items"
46637 inventory-response-items:
46639 Container for inventory items in response list
46641 inventory-response-item:
46644 $ref: "#/definitions/inventory-response-item"
46645 ipsec-configuration:
46647 IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
46648 ###### Related Nodes
46649 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
46650 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
46652 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
46654 - ipsec-configuration-id
46656 ipsec-configuration-id:
46658 description: UUID of this configuration
46659 requested-vig-address-type:
46661 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
46662 requested-encryption-strength:
46664 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
46665 requested-dmz-type:
46667 description: ATT can offer a shared DMZ or a DMZ specific to a customer
46668 shared-dmz-network-address:
46670 description: Network address of shared DMZ
46671 requested-customer-name:
46673 description: If the DMZ is a custom DMZ, this field will indicate the customer information
46676 description: can be 1 or 2
46677 ikev1-authentication:
46679 description: Contains values like md5, sha1, sha256, sha384
46682 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
46685 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
46688 description: Group name defined in VIG for clients using aggressive mode
46691 description: pre-shared key for the above group name
46694 description: Lifetime for IKEv1 SA
46695 ipsec-authentication:
46697 description: md5, sha1, sha256, sha384
46700 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
46703 description: Life time for IPSec SA
46706 description: enable PFS or not
46709 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
46710 xauth-user-password:
46712 description: Encrypted using the Juniper $9$ algorithm
46715 description: The time between DPD probe
46718 description: Maximum number of DPD before claiming the tunnel is down
46721 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46725 $ref: "#/definitions/relationship"
46729 $ref: "#/definitions/vig-server"
46730 ipsec-configurations:
46732 ipsec-configuration:
46735 $ref: "#/definitions/ipsec-configuration"
46744 Logical interfaces, e.g., a vnic.
46745 ###### Related Nodes
46746 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
46747 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
46748 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
46749 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
46750 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
46751 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
46752 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
46753 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
46754 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
46755 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
46756 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
46757 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
46758 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
46759 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
46761 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
46762 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
46763 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
46772 description: Name given to the interface
46775 description: E.g., CUSTOMER, UPLINK, etc.
46778 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
46781 description: URL to endpoint where AAI can get more details
46784 description: ID of interface
46787 description: MAC address for the interface
46790 description: Name of the network
46793 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
46794 interface-description:
46796 description: Human friendly text regarding this interface.
46799 description: boolean indicatating whether or not port is a mirrored.
46802 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46805 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
46808 description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
46811 description: Flag indicating the interface uses the IP Unnumbered configuration.
46812 allowed-address-pairs:
46814 description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
46818 $ref: "#/definitions/vlan"
46822 $ref: "#/definitions/sriov-vf"
46826 $ref: "#/definitions/l-interface"
46830 $ref: "#/definitions/relationship"
46831 l3-interface-ipv4-address-list:
46834 $ref: "#/definitions/l3-interface-ipv4-address-list"
46835 l3-interface-ipv6-address-list:
46838 $ref: "#/definitions/l3-interface-ipv6-address-list"
46841 Collection of logical interfaces.
46846 $ref: "#/definitions/l-interface"
46847 l3-interface-ipv4-address-list:
46850 ###### Related Nodes
46851 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
46852 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
46853 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
46854 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
46855 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
46856 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
46858 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
46860 - l3-interface-ipv4-address
46862 l3-interface-ipv4-address:
46864 description: IP address
46865 l3-interface-ipv4-prefix-length:
46868 description: Prefix length, 32 for single address
46872 description: Inner VLAN tag
46876 description: Outer VLAN tag
46879 description: Indicator of fixed or floating address
46882 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46883 neutron-network-id:
46885 description: Neutron network id of the interface that address belongs to
46888 description: Neutron id of subnet that address belongs to
46892 $ref: "#/definitions/relationship"
46893 l3-interface-ipv6-address-list:
46896 ###### Related Nodes
46897 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
46898 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
46899 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
46900 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
46901 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
46902 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
46904 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
46906 - l3-interface-ipv6-address
46908 l3-interface-ipv6-address:
46910 description: IP address
46911 l3-interface-ipv6-prefix-length:
46914 description: Prefix length, 128 for single address
46918 description: Inner VLAN tag
46922 description: Outer VLAN tag
46925 description: Indicator of fixed or floating address
46928 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46929 neutron-network-id:
46931 description: Neutron network id of the interface that address belongs to
46934 description: Neutron id of subnet that address belongs to
46938 $ref: "#/definitions/relationship"
46941 Generic network definition
46942 ###### Related Nodes
46943 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
46944 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
46945 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
46946 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
46947 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
46948 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
46949 - FROM complex( complex Uses l3-network, MANY2MANY)
46950 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
46951 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
46952 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
46953 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
46954 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
46955 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
46956 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
46957 - FROM tenant( tenant Uses l3-network, MANY2MANY)
46958 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
46960 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
46965 - is-provider-network
46966 - is-shared-network
46967 - is-external-network
46971 description: Network ID, should be uuid. Unique across A&AI.
46974 description: Name of the network, governed by some naming convention..
46977 description: Type of the network - who defines these values?
46980 description: Role the network plans - who defines these values?
46981 network-technology:
46983 description: Network technology - who defines these values?
46984 neutron-network-id:
46986 description: Neutron network id of this Interface
46989 description: Set to true if bound to VPN
46992 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
46993 network-role-instance:
46996 description: network role instance
46999 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47000 orchestration-status:
47002 description: Orchestration status of this VNF, mastered by MSO
47005 description: Heat stack id corresponding to this instance, managed by MSO
47008 description: Corresponds to the SDN-C catalog id used to configure this VCE
47009 contrail-network-fqdn:
47011 description: Contrail FQDN for the network
47012 model-invariant-id:
47014 description: the ASDC model id for this resource or service model.
47017 description: the ASDC model version for this resource or service model.
47018 persona-model-version:
47020 description: the ASDC model version for this resource or service model.
47021 model-customization-id:
47023 description: captures the id of all the configuration used to customize the resource for the service.
47026 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47027 widget-model-version:
47029 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47030 physical-network-name:
47032 description: Name associated with the physical network.
47033 is-provider-network:
47035 description: boolean indicatating whether or not network is a provider network.
47038 description: boolean indicatating whether or not network is a shared network.
47039 is-external-network:
47041 description: boolean indicatating whether or not network is an external network.
47044 description: Path to the controller object.
47045 operational-status:
47047 description: Indicator for whether the resource is considered operational.
47051 $ref: "#/definitions/subnet"
47055 $ref: "#/definitions/ctag-assignment"
47056 segmentation-assignments:
47059 $ref: "#/definitions/segmentation-assignment"
47063 $ref: "#/definitions/relationship"
47064 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
47070 $ref: "#/definitions/l3-network"
47073 Link aggregate interface
47074 ###### Related Nodes
47075 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
47076 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
47077 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
47078 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
47079 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
47080 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
47081 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
47082 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
47084 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
47085 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
47086 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
47093 description: Name that identifies the link aggregate interface
47094 interface-description:
47096 description: Human friendly text regarding this interface.
47099 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47102 description: Captures the numeric part of the speed
47105 description: Captures the units corresponding to the speed
47108 description: ID of interface
47111 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
47114 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47117 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
47121 $ref: "#/definitions/relationship"
47125 $ref: "#/definitions/l-interface"
47128 Collection of link aggregate interfaces.
47133 $ref: "#/definitions/lag-interface"
47136 LAG links can connect lag-interfaces
47137 ###### Related Nodes
47138 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
47139 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
47141 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
47147 description: Alphabetical concatenation of lag-interface names
47150 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47154 $ref: "#/definitions/relationship"
47157 Collection of link aggregation connections
47162 $ref: "#/definitions/lag-link"
47165 Metadata for license group.
47166 ###### Related Nodes
47167 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
47168 - TO vce( license BelongsTo vce, MANY2ONE)(4)
47170 -(4) IF this TO node is deleted, this LICENSE is DELETED also
47177 description: Unique ID for the license group the resource belongs to, should be uuid.
47180 description: Unique ID of a license resource.
47183 description: Concurrency value
47187 $ref: "#/definitions/relationship"
47190 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
47195 $ref: "#/definitions/license"
47198 describes a line-of-business
47199 ###### Related Nodes
47200 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
47203 - line-of-business-name
47205 line-of-business-name:
47207 description: Name of the line-of-business (product)
47210 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47214 $ref: "#/definitions/relationship"
47217 Collection of lines-of-business
47222 $ref: "#/definitions/line-of-business"
47225 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
47226 ###### Related Nodes
47227 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
47228 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
47229 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
47230 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
47231 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
47232 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
47233 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
47234 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
47235 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
47236 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
47237 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
47238 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
47239 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
47240 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
47241 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
47243 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
47251 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
47254 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
47257 description: Type of logical link, e.g., evc
47260 description: Captures the numeric part of the speed
47263 description: Captures the units corresponding to the speed
47266 description: v4, v6, or ds for dual stack
47269 description: For example, static or BGP
47272 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47273 model-invariant-id:
47275 description: the ASDC model id for this resource or service model.
47278 description: the ASDC model version for this resource or service model.
47279 persona-model-version:
47281 description: the ASDC model version for this resource or service model.
47284 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47285 widget-model-version:
47287 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47288 operational-status:
47290 description: Indication of operational status of the logical link.
47293 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
47296 description: Indication of the network use of the logical link.
47299 description: Alias or alternate name (CLCI or D1 name).
47302 description: UUID of the logical-link, SDNC generates this.
47305 description: Circuit id
47308 description: Reason for this entity, role it is playing
47312 $ref: "#/definitions/relationship"
47315 Collection of logical connections
47320 $ref: "#/definitions/logical-link"
47323 Collection of metadatum (key/value pairs)
47328 $ref: "#/definitions/metadatum"
47332 ###### Related Nodes
47333 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
47334 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
47335 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
47336 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
47337 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
47339 -(4) IF this TO node is deleted, this METADATUM is DELETED also
47350 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47353 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
47354 ###### Related Nodes
47355 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
47356 - FROM instance-group( instance-group Targets model, MANY2MANY)
47357 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
47358 - FROM named-query( named-query AppliesTo model, ONE2MANY)
47359 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
47361 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
47362 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
47365 - model-invariant-id
47368 model-invariant-id:
47370 description: Unique identifier corresponding to the main definition of a model in ASDC
47373 description: Type of the model, e.g., service, resource, widget, etc.
47376 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47380 $ref: "#/definitions/model-ver"
47384 $ref: "#/definitions/relationship"
47385 model-and-named-query-search:
47387 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
47391 $ref: "#/definitions/query-parameters"
47394 $ref: "#/definitions/instance-filters"
47397 $ref: "#/definitions/secondary-filts"
47400 secondary-filter-cut-point:
47404 This is how we would capture constraints defining allowed sets of elements.
47405 ###### Related Nodes
47406 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
47407 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
47409 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
47410 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
47412 - model-constraint-uuid
47413 - constrained-element-set-uuid-to-replace
47415 model-constraint-uuid:
47417 constrained-element-set-uuid-to-replace:
47419 constrained-element-sets:
47422 $ref: "#/definitions/constrained-element-set"
47425 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47431 $ref: "#/definitions/model-constraint"
47434 Defines how other models combine to make up a higher-level model.
47435 ###### Related Nodes
47436 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
47437 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
47438 - TO model-ver( model-element IsA model-ver, MANY2ONE)
47439 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
47440 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
47441 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
47442 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
47444 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
47445 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
47447 - model-element-uuid
47448 - new-data-del-flag
47451 model-element-uuid:
47455 description: Indicates whether this element was created as part of instantiation from this model
47458 description: How many of this type of element are required/allowed
47463 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47467 $ref: "#/definitions/model-element"
47468 description: Defines how other models combine to make up a higher-level model
47472 $ref: "#/definitions/model-constraint"
47473 description: Describes new constraints on this model element that are not part of that model's definition
47477 $ref: "#/definitions/relationship"
47483 $ref: "#/definitions/model-element"
47486 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
47487 ###### Related Nodes
47488 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
47489 - FROM model-element( model-element IsA model-ver, MANY2ONE)
47490 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
47491 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
47493 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
47494 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
47495 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
47504 description: Unique identifier corresponding to one version of a model in ASDC
47507 description: Name of the model, which can change from version to version.
47510 description: Version
47513 description: Description
47516 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47520 $ref: "#/definitions/model-element"
47524 $ref: "#/definitions/metadatum"
47528 $ref: "#/definitions/relationship"
47534 $ref: "#/definitions/model-ver"
47537 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
47542 $ref: "#/definitions/model"
47543 multicast-configuration:
47545 ###### Related Nodes
47546 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
47549 - multicast-configuration-id
47550 - multicast-protocol
47553 multicast-configuration-id:
47555 description: Unique id of multicast configuration.
47556 multicast-protocol:
47558 description: protocol of multicast configuration
47561 description: rp type of multicast configuration
47564 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47568 $ref: "#/definitions/relationship"
47569 multicast-configurations:
47571 multicast configuration of generic-vnf ip-address
47573 multicast-configuration:
47576 $ref: "#/definitions/multicast-configuration"
47582 $ref: "#/definitions/named-query"
47586 ###### Related Nodes
47587 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
47588 - TO model( named-query AppliesTo model, ONE2MANY)
47589 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
47591 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
47595 - named-query-version
47601 named-query-version:
47603 required-input-param:
47609 named-query-elements:
47612 $ref: "#/definitions/named-query-element"
47616 $ref: "#/definitions/relationship"
47617 named-query-element:
47620 ###### Related Nodes
47621 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
47622 - TO model( named-query-element IsA model, MANY2ONE)
47623 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
47624 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
47625 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
47626 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
47628 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
47629 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
47631 - named-query-element-uuid
47633 named-query-element-uuid:
47635 property-collect-list:
47639 property-limit-desc:
47643 named-query-elements:
47646 $ref: "#/definitions/named-query-element"
47650 $ref: "#/definitions/related-lookup"
47651 property-constraints:
47654 $ref: "#/definitions/property-constraint"
47658 $ref: "#/definitions/relationship"
47659 named-query-elements:
47661 named-query-element:
47664 $ref: "#/definitions/named-query-element"
47667 Namespace for network inventory resources.
47672 $ref: "#/definitions/logical-link"
47676 $ref: "#/definitions/site-pair-set"
47680 $ref: "#/definitions/vpn-binding"
47684 $ref: "#/definitions/vpls-pe"
47685 multicast-configurations:
47688 $ref: "#/definitions/multicast-configuration"
47692 $ref: "#/definitions/vce"
47696 $ref: "#/definitions/vnfc"
47700 $ref: "#/definitions/l3-network"
47704 $ref: "#/definitions/network-policy"
47708 $ref: "#/definitions/generic-vnf"
47712 $ref: "#/definitions/lag-link"
47716 $ref: "#/definitions/newvce"
47720 $ref: "#/definitions/pnf"
47724 $ref: "#/definitions/physical-link"
47725 ipsec-configurations:
47728 $ref: "#/definitions/ipsec-configuration"
47729 route-table-references:
47732 $ref: "#/definitions/route-table-reference"
47736 $ref: "#/definitions/instance-group"
47740 $ref: "#/definitions/zone"
47744 $ref: "#/definitions/configurations"
47750 $ref: "#/definitions/network-policy"
47753 ###### Related Nodes
47754 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
47755 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
47758 - network-policy-id
47762 description: UUID representing unique key to this instance
47763 network-policy-fqdn:
47765 description: Contrail FQDN for the policy
47768 description: ID for the openStack Heat instance
47771 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47775 $ref: "#/definitions/relationship"
47778 Network profile populated by SDN-GP for SNMP
47779 ###### Related Nodes
47780 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
47787 description: Unique name of network profile.
47790 description: Encrypted SNMP community string
47793 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47797 $ref: "#/definitions/relationship"
47800 Collection of network profiles
47805 $ref: "#/definitions/network-profile"
47808 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
47809 ###### Related Nodes
47810 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
47812 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
47820 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
47823 description: Name of VNF.
47826 description: Alternate name of VNF.
47829 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
47832 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
47833 operational-status:
47835 description: Indicator for whether the resource is considered operational
47838 description: OBSOLETE - do not use
47841 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
47844 description: Client should send valid enumerated value.
47847 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47848 ipv4-loopback0-address:
47850 description: v4 Loopback0 address
47851 orchestration-status:
47853 description: Orchestration status of this VNF, mastered by MSO.
47856 description: Heat stack id corresponding to this instance, managed by MSO
47859 description: Corresponds to the SDN-C catalog id used to configure this VCE
47863 $ref: "#/definitions/relationship"
47867 $ref: "#/definitions/l-interface"
47870 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
47875 $ref: "#/definitions/newvce"
47878 inventory-item-data:
47881 $ref: "#/definitions/inventory-item-data"
47882 notification-event:
47886 notification-event-header:
47888 $ref: "#/definitions/notification-event-header"
47889 notification-event-header:
47930 $ref: "#/definitions/key-data"
47935 OAM network, to be deprecated shortly. Do not use for new purposes.
47936 ###### Related Nodes
47937 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
47938 - TO complex( oam-network AppliesTo complex, MANY2MANY)
47939 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
47948 description: UUID of the network. Unique across a cloud-region
47951 description: Name of the network.
47955 description: cvlan-id
47956 ipv4-oam-gateway-address:
47958 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
47959 ipv4-oam-gateway-address-prefix-length:
47962 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
47965 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47969 $ref: "#/definitions/relationship"
47972 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
47977 $ref: "#/definitions/oam-network"
47978 operational-environment:
47980 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
47981 ###### Related Nodes
47982 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
47983 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
47986 - operational-environment-id
47987 - operational-environment-name
47988 - operational-environment-type
47989 - operational-environment-status
47993 operational-environment-id:
47995 description: UUID of an operational environment
47996 operational-environment-name:
47998 description: Operational Environment name
47999 operational-environment-type:
48001 description: Operational Environment Type.
48002 operational-environment-status:
48004 description: Status
48007 description: Tenant Context.
48010 description: Workload Context.
48013 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48017 $ref: "#/definitions/relationship"
48018 operational-environments:
48020 a logical partition of the cloud which allows to have multiple environments in the production AIC.
48022 operational-environment:
48025 $ref: "#/definitions/operational-environment"
48028 Allows for legacy POST of old-style and new-style models
48030 - model-invariant-id
48031 - model-name-version-id
48037 model-invariant-id:
48039 description: Unique identifier corresponding to the main definition of a model in ASDC
48040 model-name-version-id:
48042 description: Unique identifier corresponding to one version of a model in ASDC
48045 description: Type of the model, e.g., service, resource, widget, etc.
48048 description: Name of the model, which can change from version to version.
48051 description: Invariant unique ID which does not change from version to version
48054 description: Version
48057 description: Description
48060 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48063 $ref: "#/definitions/model-vers"
48066 $ref: "#/definitions/relationship-list"
48069 Collection of owning-entities
48074 $ref: "#/definitions/owning-entity"
48077 describes an owning-entity
48078 ###### Related Nodes
48079 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
48083 - owning-entity-name
48087 description: UUID of an owning entity
48088 owning-entity-name:
48090 description: Owning entity name
48093 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48097 $ref: "#/definitions/relationship"
48100 Physical interface (e.g., nic)
48101 ###### Related Nodes
48102 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
48103 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
48104 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
48105 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
48106 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
48107 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
48108 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
48109 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
48111 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
48112 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
48113 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
48120 description: Name that identifies the physical interface
48123 description: Captures the numeric part of the speed
48126 description: Captures the units corresponding to the speed
48129 description: Nature of the services and connectivity on this port.
48130 equipment-identifier:
48132 description: CLEI or other specification for p-interface hardware.
48135 description: Role specification for p-interface hardware.
48138 description: Indicates the physical properties of the interface.
48141 description: Trigger for operational monitoring of this resource by Service Assurance systems.
48144 description: MAC Address of the p-interface.
48147 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48150 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
48153 description: inventory status
48157 $ref: "#/definitions/relationship"
48161 $ref: "#/definitions/sriov-pf"
48165 $ref: "#/definitions/l-interface"
48168 Collection of physical interfaces.
48173 $ref: "#/definitions/p-interface"
48176 Collection of physical connections, typically between p-interfaces
48177 ###### Related Nodes
48178 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
48180 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
48186 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
48189 description: Captures the numeric part of the speed
48192 description: Captures the units corresponding to the speed
48195 description: Circuit it
48198 description: Dual access mode (e.g., primary, secondary
48201 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
48202 service-provider-name:
48204 description: Name of the service Provider on this link.
48205 service-provider-bandwidth-up-value:
48208 description: Upstream Bandwidth value agreed with the service provider
48209 service-provider-bandwidth-up-units:
48211 description: Units for the upstream BW value
48212 service-provider-bandwidth-down-value:
48215 description: Downstream Bandwidth value agreed with the service provider
48216 service-provider-bandwidth-down-units:
48218 description: Units for downstream BW value
48221 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48225 $ref: "#/definitions/relationship"
48228 Collection of physical connections, typically between p-interfaces
48233 $ref: "#/definitions/physical-link"
48236 describes a platform
48237 ###### Related Nodes
48238 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
48245 description: Name of the platform
48248 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48252 $ref: "#/definitions/relationship"
48255 Collection of platforms
48260 $ref: "#/definitions/platform"
48263 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
48264 ###### Related Nodes
48265 - TO complex( pnf LocatedIn complex, MANY2ONE)
48266 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
48267 - TO zone( pnf LocatedIn zone, MANY2ONE)
48268 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
48269 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
48270 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
48271 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
48272 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
48273 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
48275 -(1) IF this PNF node is deleted, this FROM node is DELETED also
48282 description: unique name of Physical Network Function.
48285 description: name of Physical Network Function.
48288 description: source of name2
48291 description: id of pnf
48294 description: Equipment type. Source of truth should define valid values.
48297 description: Equipment vendor. Source of truth should define valid values.
48300 description: Equipment model. Source of truth should define valid values.
48303 description: identifier of managed by ATT or customer
48306 description: ipv4-oam-address with new naming convention for IP addresses
48309 description: sw-version is the version of SW for the hosted application on the PNF.
48312 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
48315 description: ID of the physical frame (relay rack) where pnf is installed.
48318 description: Serial number of the device
48319 ipaddress-v4-loopback-0:
48321 description: IPV4 Loopback 0 address
48322 ipaddress-v6-loopback-0:
48324 description: IPV6 Loopback 0 address
48327 description: IPV4 AIM address
48330 description: IPV6 AIM address
48333 description: IPV6 OAM address
48336 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
48339 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48342 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
48345 description: Nf Role is the role performed by this instance in the network.
48349 $ref: "#/definitions/relationship"
48353 $ref: "#/definitions/p-interface"
48357 $ref: "#/definitions/lag-interface"
48360 Collection of Physical Network Functions.
48365 $ref: "#/definitions/pnf"
48368 Used to capture the network interfaces of this VCE
48369 ###### Related Nodes
48370 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
48371 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
48373 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
48374 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
48377 - orchestration-status
48381 description: Unique ID of the interface
48382 neutron-network-id:
48384 description: Neutron network id of this Interface
48385 neutron-network-name:
48387 description: Neutron network name of this Interface
48390 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48393 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48396 description: Unique ID for port group in vmware
48399 description: Likely to duplicate value of neutron network name
48402 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
48403 orchestration-status:
48405 description: Orchestration status of this VNF, mastered by MSO
48408 description: Heat stack id corresponding to this instance, managed by MSO
48411 description: Corresponds to the SDN-C catalog id used to configure this VCE
48415 $ref: "#/definitions/cvlan-tag-entry"
48419 $ref: "#/definitions/relationship"
48425 $ref: "#/definitions/port-group"
48428 describes the project
48429 ###### Related Nodes
48430 - TO service-instance( project Uses service-instance, ONE2MANY)
48437 description: Name of the project deploying a service
48440 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48444 $ref: "#/definitions/relationship"
48447 Collection of projects
48452 $ref: "#/definitions/project"
48455 Property holder for query properties or instance properties
48461 property-constraint:
48464 ###### Related Nodes
48465 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
48467 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
48469 - property-constraint-uuid
48474 property-constraint-uuid:
48484 property-constraints:
48486 property-constraint:
48489 $ref: "#/definitions/property-constraint"
48492 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
48493 ###### Related Nodes
48494 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
48495 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
48496 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
48497 - TO complex( pserver LocatedIn complex, MANY2ONE)
48498 - TO zone( pserver LocatedIn zone, MANY2ONE)
48499 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
48500 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
48501 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
48502 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
48503 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
48505 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
48506 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
48514 description: Value from executing hostname on the compute node.
48517 description: PTNII name
48521 description: Number of cpus
48525 description: Disk size, in GBs
48529 description: RAM size, in MBs
48532 description: Equipment type. Source of truth should define valid values.
48535 description: Equipment vendor. Source of truth should define valid values.
48538 description: Equipment model. Source of truth should define valid values.
48541 description: Fully-qualified domain name
48544 description: URL to endpoint where AAI can get more details
48547 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
48550 description: Serial number, may be queried
48551 ipaddress-v4-loopback-0:
48553 description: IPV4 Loopback 0 address
48554 ipaddress-v6-loopback-0:
48556 description: IPV6 Loopback 0 address
48559 description: IPV4 AIM address
48562 description: IPV6 AIM address
48565 description: IPV6 OAM address
48568 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
48571 description: ID of Pserver
48574 description: internet topology of Pserver
48577 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
48580 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48583 description: alternative pserver name
48586 description: purpose of pserver
48589 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
48592 description: Indicates who owns and or manages the device.
48595 description: The host profile that defines the configuration of the pserver.
48599 $ref: "#/definitions/relationship"
48603 $ref: "#/definitions/p-interface"
48607 $ref: "#/definitions/lag-interface"
48610 Collection of compute hosts.
48615 $ref: "#/definitions/pserver"
48618 QueryParameters for performing a named-query or model query
48622 $ref: "#/definitions/named-query"
48625 $ref: "#/definitions/overloaded-model"
48629 ###### Related Nodes
48630 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
48632 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
48634 - related-lookup-uuid
48636 - source-node-property
48638 - target-node-property
48640 related-lookup-uuid:
48644 source-node-property:
48648 target-node-property:
48650 property-collect-list:
48657 $ref: "#/definitions/relationship"
48663 $ref: "#/definitions/related-lookup"
48664 related-to-property:
48668 description: Key part of a key/value pair
48671 description: Value part of a key/value pair
48676 description: A keyword provided by A&AI to indicate type of node.
48679 description: URL to the object in A&AI.
48683 $ref: "#/definitions/relationship-data"
48687 - relationship-value
48691 description: A keyword provided by A&AI to indicate an attribute.
48692 relationship-value:
48694 description: Value of the attribute.
48700 $ref: "#/definitions/relationship"
48701 reserved-prop-names:
48703 Internal map to define some reserved properties of a vertex
48705 last-mod-source-of-truth:
48723 Response container for the results of a named-query or model query
48725 inventory-response-items:
48727 $ref: "#/definitions/inventory-response-items"
48732 description: The specific type of node in the A&AI graph
48735 description: The URL to the specific resource
48736 route-table-reference:
48738 Openstack route table reference.
48739 ###### Related Nodes
48740 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
48743 - route-table-reference-id
48744 - route-table-reference-fqdn
48746 route-table-reference-id:
48748 description: Route Table Reference id, UUID assigned to this instance.
48749 route-table-reference-fqdn:
48751 description: FQDN entry in the route table.
48754 description: Concurrency value
48758 $ref: "#/definitions/relationship"
48759 route-table-references:
48761 Collection of openstack route table references
48763 route-table-reference:
48766 $ref: "#/definitions/route-table-reference"
48769 Route target information
48770 ###### Related Nodes
48771 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
48773 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
48775 - global-route-target
48776 - route-target-role
48778 global-route-target:
48780 description: Number used to identify an RT, globally unique in the network
48783 description: Role assigned to this route target
48786 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48790 $ref: "#/definitions/relationship"
48793 Collection of route target information
48798 $ref: "#/definitions/route-target"
48801 ###### Related Nodes
48802 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
48803 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
48805 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
48806 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
48808 - routing-instance-id
48810 routing-instance-id:
48812 description: Unique id of routing instance
48815 description: rpm owner
48818 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48822 $ref: "#/definitions/site-pair"
48826 $ref: "#/definitions/relationship"
48829 set of probes related to generic-vnf routing instance
48834 $ref: "#/definitions/routing-instance"
48839 $ref: "#/definitions/oam-networks"
48840 az-and-dvs-switches:
48843 $ref: "#/definitions/az-and-dvs-switches"
48846 edge-tag-query-result:
48848 $ref: "#/definitions/edge-tag-query-result"
48849 edge-tag-query-request:
48851 $ref: "#/definitions/edge-tag-query-request"
48854 $ref: "#/definitions/search-results"
48857 $ref: "#/definitions/sdn-zone-response"
48863 $ref: "#/definitions/result-data"
48866 SecondaryFilt for performing a named-query or model query
48877 SecondaryFilts for performing a named-query or model query
48882 $ref: "#/definitions/secondary-filt"
48883 segmentation-assignment:
48885 Openstack segmentation assignment.
48886 ###### Related Nodes
48887 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
48889 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
48895 description: Route Table Reference id, UUID assigned to this instance.
48898 description: Concurrency value
48902 $ref: "#/definitions/relationship"
48903 segmentation-assignments:
48905 Collection of openstack segmentation assignments
48907 segmentation-assignment:
48910 $ref: "#/definitions/segmentation-assignment"
48913 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
48916 - service-description
48920 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
48921 service-description:
48923 description: Description of the service
48926 description: URL to endpoint where AAI can get more details
48929 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48932 description: service version
48936 $ref: "#/definitions/relationship"
48937 service-capabilities:
48939 Collection of service capabilities.
48941 service-capability:
48944 $ref: "#/definitions/service-capability"
48945 service-capability:
48947 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
48948 ###### Related Nodes
48949 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
48950 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
48952 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
48960 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
48963 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
48966 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48970 $ref: "#/definitions/relationship"
48971 service-design-and-creation:
48973 Namespace for objects managed by ASDC
48978 $ref: "#/definitions/vnf-image"
48982 $ref: "#/definitions/service"
48983 service-capabilities:
48986 $ref: "#/definitions/service-capability"
48990 $ref: "#/definitions/model"
48994 $ref: "#/definitions/named-query"
48997 Instance of a service
48998 ###### Related Nodes
48999 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
49000 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
49001 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
49002 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
49003 - TO configuration( service-instance Uses configuration, ONE2MANY)
49004 - TO connector( service-instance Uses connector, MANY2MANY)
49005 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
49006 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
49007 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
49008 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
49009 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
49010 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49011 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
49012 - TO zone( service-instance LocatedIn zone, MANY2ONE)
49013 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
49014 - TO vce( service-instance ComposedOf vce, ONE2MANY)
49015 - FROM project( project Uses service-instance, ONE2MANY)
49016 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
49017 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
49018 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49020 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
49021 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
49022 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
49024 - service-instance-id
49026 service-instance-id:
49028 description: Uniquely identifies this instance of a service
49029 service-instance-name:
49031 description: This field will store a name assigned to the service-instance.
49034 description: String capturing type of service.
49037 description: String capturing the service role.
49038 environment-context:
49040 description: This field will store the environment context assigned to the service-instance.
49043 description: This field will store the workload context assigned to the service-instance.
49046 description: create time of Network Service.
49049 description: last update of Network Service.
49052 description: short description for service-instance.
49053 model-invariant-id:
49055 description: the ASDC model id for this resource or service model.
49058 description: the ASDC model version for this resource or service model.
49059 persona-model-version:
49061 description: the ASDC model version for this resource or service model.
49064 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49065 widget-model-version:
49067 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49070 description: Indicates the total bandwidth to be used for this service.
49073 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
49074 bandwidth-down-wan1:
49076 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
49079 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
49080 bandwidth-down-wan2:
49082 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
49085 description: URL customers will use to access the vHN Portal.
49086 service-instance-location-id:
49088 description: An identifier that customers assign to the location where this service is being used.
49091 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49094 description: Path to the controller object.
49095 orchestration-status:
49097 description: Orchestration status of this service.
49101 $ref: "#/definitions/relationship"
49105 $ref: "#/definitions/metadatum"
49106 allotted-resources:
49109 $ref: "#/definitions/allotted-resource"
49112 Collection of service instances
49117 $ref: "#/definitions/service-instance"
49118 service-subscription:
49120 Object that group service instances.
49121 ###### Related Nodes
49122 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
49123 - TO tenant( service-subscription Uses tenant, MANY2MANY)
49124 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
49126 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
49127 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
49133 description: Value defined by orchestration to identify this service across ECOMP.
49134 temp-ub-sub-account-id:
49136 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
49139 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49143 $ref: "#/definitions/service-instance"
49147 $ref: "#/definitions/relationship"
49148 service-subscriptions:
49150 Collection of objects that group service instances.
49152 service-subscription:
49155 $ref: "#/definitions/service-subscription"
49158 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
49163 $ref: "#/definitions/service"
49166 ###### Related Nodes
49167 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
49168 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
49170 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
49171 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
49177 description: unique identifier of probe
49180 description: Prefix address
49183 description: Prefix address
49186 description: ip version, v4, v6
49187 destination-hostname:
49189 description: Hostname of the destination equipment to which SLAs are measured against.
49190 destination-equip-type:
49192 description: The type of destinatination equipment. Could be Router, UCPE, etc.
49195 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49196 classes-of-service:
49199 $ref: "#/definitions/class-of-service"
49203 $ref: "#/definitions/relationship"
49206 Set of instances for probes used to measure service level agreements
49207 ###### Related Nodes
49208 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
49209 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
49211 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
49217 description: Unique id of site pair set.
49220 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49224 $ref: "#/definitions/routing-instance"
49228 $ref: "#/definitions/relationship"
49231 Collection of sets of instances for probes related to generic-vnf
49236 $ref: "#/definitions/site-pair-set"
49244 $ref: "#/definitions/site-pair"
49248 ###### Related Nodes
49249 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
49250 - FROM vserver( vserver Uses snapshot, ONE2ONE)
49257 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
49260 description: Snapshot name
49261 snapshot-architecture:
49263 description: Operating system architecture
49264 snapshot-os-distro:
49266 description: The common name of the operating system distribution in lowercase
49267 snapshot-os-version:
49269 description: The operating system version as specified by the distributor.
49272 description: The application that the image instantiates.
49273 application-vendor:
49275 description: The vendor of the application.
49276 application-version:
49278 description: The version of the application.
49281 description: URL to endpoint where AAI can get more details
49284 description: This field contains the UUID of the previous snapshot (if any).
49287 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49291 $ref: "#/definitions/relationship"
49294 Collection of openstack snapshots
49299 $ref: "#/definitions/snapshot"
49302 SR-IOV Physical Function
49303 ###### Related Nodes
49304 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
49305 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
49307 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
49313 description: Identifier for the sriov-pf
49316 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49320 $ref: "#/definitions/relationship"
49323 Collection of SR-IOV Physical Functions.
49328 $ref: "#/definitions/sriov-pf"
49331 SR-IOV Virtual Function (not to be confused with virtual network function)
49332 ###### Related Nodes
49333 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
49334 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
49336 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
49342 description: PCI ID used to identify the sriov-vf
49345 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
49348 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
49351 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
49352 vf-vlan-anti-spoof-check:
49354 description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
49355 vf-mac-anti-spoof-check:
49357 description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
49360 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
49361 vf-broadcast-allow:
49363 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
49364 vf-unknown-multicast-allow:
49366 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
49367 vf-unknown-unicast-allow:
49369 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
49372 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
49375 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
49378 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49379 neutron-network-id:
49381 description: Neutron network id of the interface
49385 $ref: "#/definitions/relationship"
49388 Collection of SR-IOV Virtual Functions.
49393 $ref: "#/definitions/sriov-vf"
49402 ###### Related Nodes
49403 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
49404 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
49405 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
49406 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
49407 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
49408 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
49410 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
49411 -(4) IF this TO node is deleted, this SUBNET is DELETED also
49412 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
49420 description: Subnet ID, should be UUID.
49423 description: Name associated with the subnet.
49426 description: Neutron id of this subnet
49429 description: gateway ip address
49430 network-start-address:
49432 description: network start address
49435 description: cidr mask
49438 description: ip version
49439 orchestration-status:
49441 description: Orchestration status of this VNF, mastered by MSO
49444 description: dhcp enabled
49447 description: the start address reserved for use by dhcp
49450 description: the last address reserved for use by dhcp
49453 description: role of the subnet, referenced when assigning IPs
49454 ip-assignment-direction:
49456 description: ip address assignment direction of the subnet
49459 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49463 description: sequence of the subnet
49467 $ref: "#/definitions/host-route"
49471 $ref: "#/definitions/relationship"
49477 $ref: "#/definitions/subnet"
49478 tagged-inventory-item-list:
49483 $ref: "#/definitions/inventory-item"
49487 ###### Related Nodes
49488 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
49489 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
49490 - TO l3-network( tenant Uses l3-network, MANY2MANY)
49491 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
49492 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
49493 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
49495 -TENANT cannot be deleted if related to VSERVER
49503 description: Unique id relative to the cloud-region.
49506 description: Readable name of tenant
49509 description: This field will store the tenant context.
49512 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49516 $ref: "#/definitions/vserver"
49520 $ref: "#/definitions/relationship"
49523 Collection of openstack tenants.
49528 $ref: "#/definitions/tenant"
49531 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
49532 ###### Related Nodes
49533 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
49535 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
49538 - bandwidth-up-wan1
49539 - bandwidth-down-wan1
49540 - bandwidth-up-wan2
49541 - bandwidth-down-wan2
49545 description: Allotted Resource id UUID assigned to this instance.
49548 description: The WAN uplink bandwidth for WAN1
49549 bandwidth-down-wan1:
49551 description: The WAN downlink bandwidth for WAN1
49554 description: The WAN uplink bandwidth for WAN2
49555 bandwidth-down-wan2:
49557 description: The WAN downlink bandwidth for WAN2
49560 description: Concurrency value
49564 $ref: "#/definitions/relationship"
49567 This object is used to store the specific tunnel cross connect aspects of an allotted resource
49572 $ref: "#/definitions/tunnel-xconnect"
49575 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
49584 $ref: "#/definitions/update-node-key"
49590 $ref: "#/definitions/action"
49599 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
49600 ###### Related Nodes
49601 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
49602 - TO complex( vce LocatedIn complex, MANY2MANY)
49603 - TO vserver( vce HostedOn vserver, ONE2MANY)
49604 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
49605 - FROM license( license BelongsTo vce, MANY2ONE)(1)
49606 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
49607 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
49609 -(1) IF this VCE node is deleted, this FROM node is DELETED also
49617 description: Unique id of VNF. This is unique across the graph.
49620 description: Name of VNF.
49623 description: Alternate name of VNF.
49626 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
49629 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
49630 regional-resource-zone:
49632 description: Regional way of organizing pservers, source of truth should define values
49635 description: Trigger for operational monitoring of this resource by Service Assurance systems.
49636 operational-status:
49638 description: Indicator for whether the resource is considered operational
49641 description: OBSOLETE - do not use
49644 description: Network role being played by this VNF
49645 orchestration-status:
49647 description: Orchestration status of this VNF, mastered by MSO
49650 description: Heat stack id corresponding to this instance, managed by MSO
49653 description: Corresponds to the SDN-C catalog id used to configure this VCE
49656 description: Unique ID of VPE connected to this VCE.
49657 v6-vce-wan-address:
49659 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
49662 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
49665 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49666 ipv4-loopback0-address:
49668 description: Loopback0 address
49669 entitlement-resource-uuid:
49671 description: OBSOLETE - see child relationships
49675 $ref: "#/definitions/port-group"
49679 $ref: "#/definitions/license"
49683 $ref: "#/definitions/entitlement"
49687 $ref: "#/definitions/relationship"
49690 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
49695 $ref: "#/definitions/vce"
49698 a deployment unit of VNFCs
49699 ###### Related Nodes
49700 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
49701 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
49702 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
49703 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
49704 - TO vserver( vf-module Uses vserver, ONE2MANY)
49706 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
49707 -VF-MODULE cannot be deleted if related to VNFC
49711 - is-base-vf-module
49715 description: Unique ID of vf-module.
49718 description: Name of vf-module
49721 description: Heat stack id corresponding to this instance.
49722 orchestration-status:
49724 description: orchestration status of this vf-module, mastered by MSO
49727 description: used to indicate whether or not this object is base vf module
49730 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49731 model-invariant-id:
49733 description: the ASDC model id for this resource or service model.
49736 description: the ASDC model version for this resource or service model.
49737 persona-model-version:
49739 description: the ASDC model version for this resource or service model.
49740 model-customization-id:
49742 description: captures the id of all the configuration used to customize the resource for the service.
49745 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49746 widget-model-version:
49748 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49749 contrail-service-instance-fqdn:
49751 description: the Contrail unique ID for a service-instance
49755 description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
49758 description: Path to the controller object.
49762 $ref: "#/definitions/relationship"
49765 Collection of vf-modules, a deployment unit of VNFCs
49770 $ref: "#/definitions/vf-module"
49773 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
49774 ###### Related Nodes
49775 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
49777 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
49783 description: indicates whether the VIG is for AVPN or INTERNET
49786 description: v4 IP of the vig server
49789 description: v6 IP of the vig server
49792 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49796 $ref: "#/definitions/relationship"
49802 $ref: "#/definitions/vig-server"
49803 vip-ipv4-address-list:
49806 ###### Related Nodes
49807 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
49808 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
49809 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
49810 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
49817 description: IP address
49818 vip-ipv4-prefix-length:
49821 description: Prefix length, 32 for single address
49825 description: Inner VLAN tag
49829 description: Outer VLAN tag
49832 description: Indicator of fixed or floating address
49835 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49836 neutron-network-id:
49838 description: Neutron network id of the interface that address belongs to
49841 description: Neutron id of subnet that address belongs to
49845 $ref: "#/definitions/relationship"
49846 vip-ipv6-address-list:
49849 ###### Related Nodes
49850 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
49851 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
49852 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
49853 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
49860 description: IP address
49861 vip-ipv6-prefix-length:
49864 description: Prefix length, 128 for single address
49868 description: Inner VLAN tag
49872 description: Outer VLAN tag
49875 description: Indicator of fixed or floating address
49878 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49879 neutron-network-id:
49881 description: Neutron network id of the interface that address belongs to
49884 description: Neutron id of subnet that address belongs to
49888 $ref: "#/definitions/relationship"
49889 virtual-data-center:
49891 Virtual organization of cloud infrastructure elements in a data center context
49892 ###### Related Nodes
49893 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
49894 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
49895 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
49903 description: Unique ID of the vdc
49906 description: Name of the virtual data center
49909 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49913 $ref: "#/definitions/relationship"
49914 virtual-data-centers:
49916 Virtual organization of cloud infrastructure elements in a data center context
49918 virtual-data-center:
49921 $ref: "#/definitions/virtual-data-center"
49925 ###### Related Nodes
49926 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
49927 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
49928 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
49929 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
49930 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
49931 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
49932 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
49934 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
49935 -(2) IF this VLAN node is deleted, this TO node is DELETED also
49936 -(4) IF this TO node is deleted, this VLAN is DELETED also
49944 description: String that identifies the interface
49948 description: Inner VLAN tag
49952 description: Outer VLAN tag
49955 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49958 description: Captures the numeric part of the speed
49961 description: Captures the units corresponding to the speed
49964 description: Used to describe (the service associated with) the vlan
49965 backdoor-connection:
49967 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
49970 description: This indicates the customers VPN ID associated with this vlan
49971 orchestration-status:
49973 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
49976 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
49979 description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
49982 description: Flag indicating the interface uses the IP Unnumbered configuration.
49986 $ref: "#/definitions/relationship"
49987 l3-interface-ipv4-address-list:
49990 $ref: "#/definitions/l3-interface-ipv4-address-list"
49991 l3-interface-ipv6-address-list:
49994 $ref: "#/definitions/l3-interface-ipv6-address-list"
50000 $ref: "#/definitions/vlan"
50009 description: Unique id of VNF. This is unique across the graph.
50012 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
50013 ###### Related Nodes
50014 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
50016 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
50021 - application-vendor
50025 description: Unique ID of this asset
50028 description: The application that the image instantiates.
50029 application-vendor:
50031 description: The vendor of the application.
50032 application-version:
50034 description: The version of the application.
50037 description: URL to endpoint where AAI can get more details
50040 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50044 $ref: "#/definitions/relationship"
50047 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
50052 $ref: "#/definitions/vnf-image"
50055 ###### Related Nodes
50056 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
50057 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
50058 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
50059 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
50060 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
50061 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
50062 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
50063 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
50065 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
50066 -(4) IF this TO node is deleted, this VNFC is DELETED also
50072 - is-closed-loop-disabled
50076 description: Unique ID of vnfc.
50079 description: Short code that is used in naming instances of the item being modeled
50082 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
50085 description: prov status of this vnfc
50086 orchestration-status:
50088 description: Orchestration status of this VNF, mastered by APP-C
50089 ipaddress-v4-oam-vip:
50091 description: Oam V4 vip address of this vnfc
50094 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50095 is-closed-loop-disabled:
50097 description: used to indicate whether closed loop function is enabled on this node
50100 description: Group notation of VNFC
50101 model-invariant-id:
50103 description: the ASDC model id for this resource or service model.
50106 description: the ASDC model version for this resource or service model.
50109 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50113 $ref: "#/definitions/relationship"
50114 l3-interface-ipv4-address-list:
50117 $ref: "#/definitions/l3-interface-ipv4-address-list"
50118 l3-interface-ipv6-address-list:
50121 $ref: "#/definitions/l3-interface-ipv6-address-list"
50124 virtual network components associated with a vserver from application controller.
50129 $ref: "#/definitions/vnfc"
50132 Ephemeral Block storage volume.
50133 ###### Related Nodes
50134 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
50136 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
50143 description: Unique ID of block storage volume relative to the vserver.
50146 description: URL to endpoint where AAI can get more details
50149 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50153 $ref: "#/definitions/relationship"
50156 Persistent block-level storage.
50157 ###### Related Nodes
50158 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
50159 - TO complex( volume-group LocatedIn complex, MANY2ONE)
50160 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
50161 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
50162 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
50166 - volume-group-name
50171 description: Unique ID of volume-group.
50174 description: Name of the volume group.
50177 description: Heat stack id corresponding to this volume-group
50180 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
50181 orchestration-status:
50183 description: Orchestration status of this volume-group
50184 model-customization-id:
50186 description: captures the id of all the configuration used to customize the resource for the service.
50187 vf-module-model-customization-id:
50189 description: helps relate the volume group to the vf-module whose components will require the volume group
50192 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50196 $ref: "#/definitions/relationship"
50199 Collection of persistent block-level storage.
50204 $ref: "#/definitions/volume-group"
50207 Collection of ephemeral Block storage volumes.
50212 $ref: "#/definitions/volume"
50215 VPLS Provider Edge routers.
50216 ###### Related Nodes
50217 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
50218 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
50219 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
50220 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
50222 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
50230 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50233 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
50236 description: Client should send valid enumerated value, e.g., VPLS-PE.
50240 description: Temporary location for stag to get to VCE
50243 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50247 $ref: "#/definitions/relationship"
50251 $ref: "#/definitions/p-interface"
50255 $ref: "#/definitions/lag-interface"
50258 Collection of VPLS Provider Edge routers
50263 $ref: "#/definitions/vpls-pe"
50267 ###### Related Nodes
50268 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
50269 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
50270 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
50271 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
50273 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
50274 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
50282 description: VPN ID, globally unique within A&AI
50285 description: VPN Name
50288 description: the platform associated with the VPN example AVPN, Mobility
50291 description: Type of the vpn, should be taken from enumerated/valid values
50294 description: region of customer vpn
50297 description: id for this customer vpn
50298 route-distinguisher:
50300 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
50303 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50307 $ref: "#/definitions/route-target"
50311 $ref: "#/definitions/relationship"
50312 description: l3-networks relate to vpn-bindings
50318 $ref: "#/definitions/vpn-binding"
50321 Virtual Servers, aka virtual machine or VM.
50322 ###### Related Nodes
50323 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
50324 - TO flavor( vserver Uses flavor, MANY2ONE)
50325 - TO image( vserver Uses image, MANY2ONE)
50326 - TO pserver( vserver HostedOn pserver, MANY2ONE)
50327 - TO snapshot( vserver Uses snapshot, ONE2ONE)
50328 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
50329 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
50330 - FROM vce( vce HostedOn vserver, ONE2MANY)
50331 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
50332 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
50333 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
50335 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
50336 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
50342 - is-closed-loop-disabled
50346 description: Unique identifier for this vserver relative to its tenant
50349 description: Name of vserver
50352 description: Alternative name of vserver
50355 description: Trigger for operational monitoring of this resource by Service Assurance systems.
50358 description: URL to endpoint where AAI can get more details
50361 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
50362 is-closed-loop-disabled:
50364 description: Used to indicate whether closed loop function is enabled on this node
50367 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50371 $ref: "#/definitions/volume"
50375 $ref: "#/definitions/relationship"
50379 $ref: "#/definitions/l-interface"
50382 Collection of virtual Servers, aka virtual machines or VMs.
50387 $ref: "#/definitions/vserver"
50390 A zone is a grouping of assets in a location homing to the same connections into the CBB
50391 ###### Related Nodes
50392 - TO complex( zone LocatedIn complex, MANY2ONE)
50393 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
50394 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
50395 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
50396 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
50406 description: Code assigned by AIC to the zone
50409 description: English name associated with the zone
50412 description: Design of zone [Medium/Large?]
50415 description: Context of zone [production/test]
50418 description: Status of a zone.
50421 description: Concurrency value
50425 $ref: "#/definitions/relationship"
50428 Collection of zones
50433 $ref: "#/definitions/zone"
50442 $ref: "#/patchDefinitions/action-data"
50451 APIs that are more action related than REST (e.g., notify, update).
50455 $ref: "#/patchDefinitions/update"
50458 $ref: "#/patchDefinitions/notify"
50461 Represents a slice or partial piece of a resource that gets separately allotted
50462 ###### Related Nodes
50463 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
50464 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
50465 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
50466 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
50467 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
50468 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
50469 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
50470 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
50471 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
50472 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
50473 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
50474 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
50475 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
50477 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
50478 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
50479 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
50485 description: Allotted Resource id UUID assigned to this instance.
50488 description: The descriptive information assigned to this allotted resource instance
50491 description: Link back to more information in the controller
50492 model-invariant-id:
50494 description: the ASDC model id for this resource or service model.
50497 description: the ASDC model version for this resource or service model.
50498 persona-model-version:
50500 description: the ASDC model version for this resource or service model.
50501 allotted-resources:
50503 This object is used to store slices of services being offered
50508 $ref: "#/patchDefinitions/allotted-resource"
50511 Availability zone, a collection of compute hosts/pservers
50512 ###### Related Nodes
50513 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
50514 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
50515 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
50516 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
50517 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
50518 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
50519 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
50520 - FROM vce( vce Uses availability-zone, MANY2MANY)
50522 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
50523 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
50526 - availability-zone-name
50529 availability-zone-name:
50531 description: Name of the availability zone. Unique across a cloud region
50534 description: Type of hypervisor. Source of truth should define valid values.
50535 operational-status:
50537 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
50538 availability-zones:
50540 Collection of availability zones
50545 $ref: "#/patchDefinitions/availability-zone"
50546 az-and-dvs-switches:
50550 $ref: "#/patchDefinitions/dvs-switches"
50553 $ref: "#/patchDefinitions/availability-zone"
50556 Namespace for business related constructs
50561 $ref: "#/patchDefinitions/connector"
50565 $ref: "#/patchDefinitions/customer"
50569 $ref: "#/patchDefinitions/line-of-business"
50573 $ref: "#/patchDefinitions/owning-entity"
50577 $ref: "#/patchDefinitions/platform"
50581 $ref: "#/patchDefinitions/project"
50584 ###### Related Nodes
50585 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
50587 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
50593 description: unique identifier of probe
50596 description: identifier of probe
50599 description: type of probe
50600 classes-of-service:
50602 class-of-service of probe
50607 $ref: "#/patchDefinitions/class-of-service"
50608 cloud-infrastructure:
50610 Namespace for cloud infrastructure.
50615 $ref: "#/patchDefinitions/complex"
50619 $ref: "#/patchDefinitions/cloud-region"
50623 $ref: "#/patchDefinitions/network-profile"
50627 $ref: "#/patchDefinitions/pserver"
50628 virtual-data-centers:
50631 $ref: "#/patchDefinitions/virtual-data-center"
50634 cloud-region designates an installation of a cloud cluster or region or instantiation.
50635 ###### Related Nodes
50636 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
50637 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
50638 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
50639 - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
50640 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
50641 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
50642 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
50643 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
50644 - FROM image( image BelongsTo cloud-region, MANY2ONE)
50645 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
50646 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
50647 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
50648 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
50649 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
50650 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
50651 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
50652 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
50654 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
50655 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
50664 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
50667 description: Identifier used by the vendor for the region. Second part of composite key
50670 description: Type of the cloud (e.g., openstack)
50671 owner-defined-type:
50673 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
50674 cloud-region-version:
50676 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
50679 description: URL of the keystone identity service
50682 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
50685 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
50688 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
50691 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
50694 description: MultiVIM will discover and expose EPA capabilities.
50700 $ref: "#/patchDefinitions/cloud-region"
50703 Collection of physical locations that can house cloud-regions.
50704 ###### Related Nodes
50705 - TO l3-network( complex Uses l3-network, MANY2MANY)
50706 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
50707 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
50708 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
50709 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
50710 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
50711 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
50712 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
50713 - FROM vce( vce LocatedIn complex, MANY2MANY)
50714 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
50715 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
50716 - FROM zone( zone LocatedIn complex, MANY2ONE)
50718 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
50719 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
50722 - physical-location-id
50723 - physical-location-type
50730 physical-location-id:
50732 description: Unique identifier for physical location, e.g., CLLI
50735 description: Data center code which can be an alternate way to identify a complex
50738 description: Gamma complex name for LCP instance.
50741 description: URL of the keystone identity service
50744 Collection of physical locations that can house cloud-regions.
50749 $ref: "#/patchDefinitions/complex"
50752 Port Mirror Configuration.
50753 ###### Related Nodes
50754 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
50755 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
50756 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
50757 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
50758 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
50760 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
50761 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
50762 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
50765 - configuration-type
50766 - configuration-sub-type
50767 - orchestration-status
50768 - operational-status
50769 - configuration-selflink
50770 - model-customization-id
50774 description: UUID assigned to configuration.
50777 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
50778 configuration-name:
50780 description: Name of the configuration.
50781 configuration-type:
50783 description: port-mirroring-configuration.
50784 configuration-sub-type:
50786 description: vprobe, pprobe.
50787 model-invariant-id:
50789 description: the ASDC model id for this resource or service model.
50792 description: the ASDC model version for this resource or service model.
50793 orchestration-status:
50795 description: Orchestration status of the configuration.
50796 operational-status:
50798 description: Indicator for whether the resource is considered operational.
50799 configuration-selflink:
50801 description: URL to endpoint where AAI can get more details from SDN-GC.
50802 model-customization-id:
50804 description: id of the configuration used to customize the resource
50807 Collection of configurations
50812 $ref: "#/patchDefinitions/configuration"
50815 Collection of resource instances used to connect a variety of disparate inventory widgets
50816 ###### Related Nodes
50817 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
50818 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
50819 - FROM service-instance( service-instance Uses connector, MANY2MANY)
50821 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
50823 - resource-instance-id
50825 resource-instance-id:
50827 description: Unique id of resource instance.
50830 Collection of resource instances used to connect a variety of disparate inventory widgets
50835 $ref: "#/patchDefinitions/connector"
50836 constrained-element-set:
50838 This is how we would capture constraints defining allowed sets of elements.
50839 ###### Related Nodes
50840 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
50841 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
50842 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
50844 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
50845 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
50847 - constrained-element-set-uuid
50851 constrained-element-set-uuid:
50857 constrained-element-sets:
50859 constrained-element-set:
50862 $ref: "#/patchDefinitions/constrained-element-set"
50865 ###### Related Nodes
50866 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
50867 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
50869 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
50882 $ref: "#/patchDefinitions/ctag-assignment"
50885 A collection of C tags (vlan tags) grouped for a specific purpose.
50886 ###### Related Nodes
50887 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
50888 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
50889 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
50890 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
50892 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
50895 - availability-zone-name
50896 - ctag-pool-purpose
50900 description: The Target provider edge router
50901 availability-zone-name:
50903 description: Name of the availability zone
50906 description: Describes what the intended purpose of this pool is.
50909 description: Comma separated list of ctags
50915 $ref: "#/patchDefinitions/ctag-pool"
50918 customer identifiers to provide linkage back to BSS information.
50919 ###### Related Nodes
50920 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
50922 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
50924 - global-customer-id
50928 global-customer-id:
50930 description: Global customer id used across ECOMP to uniquely identify customer.
50933 description: Subscriber name, an alternate way to retrieve a customer.
50936 description: Subscriber type, a way to provide VID with only the INFRA customers.
50939 Collection of customer identifiers to provide linkage back to BSS information.
50944 $ref: "#/patchDefinitions/customer"
50952 description: See mis-na-virtualization-platform.yang
50958 $ref: "#/patchDefinitions/cvlan-tag-entry"
50961 Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
50962 ###### Related Nodes
50963 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
50964 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
50972 description: DVS switch name
50975 description: URL used to reach the vcenter
50978 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
50983 $ref: "#/patchDefinitions/dvs-switch"
50986 Internal map to define the properties of an edge and interpret the map EdgeRules
51002 edge-tag-query-request:
51013 $ref: "#/patchDefinitions/start-node-filter"
51014 include-node-filter:
51017 $ref: "#/patchDefinitions/include-node-filter"
51021 $ref: "#/patchDefinitions/secondary-filter"
51022 edge-tag-query-result:
51024 tagged-inventory-item-list:
51027 $ref: "#/patchDefinitions/tagged-inventory-item-list"
51028 element-choice-set:
51030 This is how we would capture constraints defining allowed sets of elements.
51031 ###### Related Nodes
51032 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
51033 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
51035 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
51036 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
51038 - element-choice-set-uuid
51039 - element-choice-set-name
51041 element-choice-set-uuid:
51043 element-choice-set-name:
51047 element-choice-sets:
51049 element-choice-set:
51052 $ref: "#/patchDefinitions/element-choice-set"
51055 Metadata for entitlement group.
51056 ###### Related Nodes
51057 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
51058 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
51060 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
51067 description: Unique ID for the entitlement group the resource comes from, should be uuid.
51070 description: Unique ID of an entitlement resource.
51073 Entitlements, keyed by group-uuid and resource-uuid, related to license management
51078 $ref: "#/patchDefinitions/entitlement"
51081 Persist EMS address information used by EMS driver.
51082 ###### Related Nodes
51083 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
51085 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
51091 description: Unique ID of EMS.
51097 $ref: "#/patchDefinitions/esr-ems"
51100 Persist common address information of external systems.
51101 ###### Related Nodes
51102 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
51103 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
51104 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
51105 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
51107 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
51109 - esr-system-info-id
51114 esr-system-info-id:
51116 description: Unique ID of esr system info.
51119 description: name of external system.
51122 description: type of external systems.
51125 description: vendor of external systems.
51128 description: version of external systems.
51131 description: url used to access external systems.
51134 description: username used to access external systems.
51137 description: password used to access external systems.
51140 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
51143 description: protocol of third party SDNC, for example netconf/snmp.
51146 description: ca file content if enabled ssl on auth-url.
51149 description: Whether to verify VIM's certificate.
51152 description: service IP of ftp server.
51155 description: service port of ftp server.
51158 description: domain info for authentication.
51161 description: default tenant of VIM.
51164 description: ftp passive mode or not.
51167 description: resource or performance data file path.
51170 description: the status of external system.
51171 esr-system-info-list:
51173 Collection of persistent block-level external system auth info.
51178 $ref: "#/patchDefinitions/esr-system-info"
51179 esr-thirdparty-sdnc:
51181 Persist SDNC address information used by ONAP SDNC.
51182 ###### Related Nodes
51183 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
51184 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
51186 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
51188 - thirdparty-sdnc-id
51190 thirdparty-sdnc-id:
51192 description: Unique ID of SDNC.
51195 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
51198 description: password used to access SDNC server.
51199 esr-thirdparty-sdnc-list:
51201 esr-thirdparty-sdnc:
51204 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
51207 Persist VNFM address information used by VF-C.
51208 ###### Related Nodes
51209 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
51211 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
51217 description: Unique ID of VNFM.
51220 description: indecate the VIM to deploy VNF.
51223 description: certificate url of VNFM.
51229 $ref: "#/patchDefinitions/esr-vnfm"
51232 evc object is an optional child object of the Configuration object.
51233 ###### Related Nodes
51234 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
51236 -(4) IF this TO node is deleted, this EVC is DELETED also
51242 description: Unique/key field for the evc object
51243 forwarding-path-topology:
51245 description: Point-to-Point, Multi-Point
51248 description: Commited Information Rate
51251 description: CIR units
51252 connection-diversity-group-id:
51254 description: Diversity Group ID
51257 description: formerly Performance Group
51258 esp-evc-circuit-id:
51260 description: EVC Circuit ID of ESP EVC
51263 description: Committed Information Rate (For ESP)
51266 description: CIR units (For ESP)
51269 description: Identifies ESP
51270 collector-pop-clli:
51272 description: Collector POP CLLI (from the hostname of the access pnf)
51273 inter-connect-type-ingress:
51275 description: Interconnect type on ingress side of EVC.
51276 tagmode-access-ingress:
51278 description: tagode for collector side of EVC
51279 tagmode-access-egress:
51281 description: tagMode for network side of EVC
51287 $ref: "#/patchDefinitions/evc"
51290 Namespace for external system.
51294 $ref: "#/patchDefinitions/esr-ems-list"
51297 $ref: "#/patchDefinitions/esr-vnfm-list"
51298 esr-thirdparty-sdnc-list:
51300 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
51303 Extra properties for inventory item for response list
51308 $ref: "#/patchDefinitions/extra-property"
51318 ###### Related Nodes
51319 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
51320 - FROM vserver( vserver Uses flavor, MANY2ONE)
51322 -FLAVOR cannot be deleted if related to VSERVER
51331 description: Flavor id, expected to be unique across cloud-region.
51334 description: Flavor name
51338 description: Number of CPUs
51342 description: Amount of memory
51346 description: Disk space
51350 description: Amount of ephemeral disk space
51353 description: amount of swap space allocation
51356 description: whether flavor is available to all users or private to the tenant it was created in.
51359 description: URL to endpoint where AAI can get more details
51362 description: Boolean as to whether this flavor is no longer enabled
51365 Collection of openstack flavors.
51370 $ref: "#/patchDefinitions/flavor"
51373 Entity describing a sequenced segment of forwarding path
51374 ###### Related Nodes
51375 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
51376 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
51377 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
51378 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
51379 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
51381 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
51382 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
51389 description: Unique ID of this segmentation
51392 description: ingress, intermediate, egress
51395 forwarder object is an optional child object of the Configuration object.
51396 ###### Related Nodes
51397 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
51399 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
51405 description: Key for forwarder-evc object
51408 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
51411 description: Internal VLAN.
51414 description: SVLAN value for ingress of egress forwarder.
51417 description: CVLAN value for ingress of egress forwarder.
51423 $ref: "#/patchDefinitions/forwarder-evc"
51429 $ref: "#/patchDefinitions/forwarder"
51432 Entity that describes the sequenced forwarding path between interfaces of services or resources
51433 ###### Related Nodes
51434 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
51435 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
51436 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
51438 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
51439 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
51440 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
51442 - forwarding-path-id
51443 - forwarding-path-name
51445 forwarding-path-id:
51447 description: Unique ID of this FP
51448 forwarding-path-name:
51450 description: Name of the FP
51456 $ref: "#/patchDefinitions/forwarding-path"
51459 General purpose VNF
51460 ###### Related Nodes
51461 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
51462 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
51463 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
51464 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
51465 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
51466 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
51467 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
51468 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
51469 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
51470 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
51471 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
51472 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
51473 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
51474 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
51475 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
51476 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
51477 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
51478 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
51479 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
51480 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
51481 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
51482 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
51483 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51484 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
51485 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
51486 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
51487 - FROM platform( platform Uses generic-vnf, MANY2MANY)
51489 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
51490 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
51496 - is-closed-loop-disabled
51500 description: Unique id of VNF. This is unique across the graph.
51503 description: vnf instance id.
51506 description: Name of VNF.
51509 description: Alternate name of VNF.
51512 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
51515 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
51516 regional-resource-zone:
51518 description: Regional way of organizing pservers, source of truth should define values
51521 description: Trigger for operational monitoring of this resource by Service Assurance systems.
51522 operational-status:
51524 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
51527 description: OBSOLETE - do not use
51530 description: Client should send valid enumerated value
51531 orchestration-status:
51533 description: Orchestration status of this VNF, used by MSO.
51536 vnf-discriptor-name:
51538 description: vnf discriptor name
51541 description: job id corresponding to vnf
51544 description: Heat stack id corresponding to this instance, managed by MSO
51547 description: Corresponds to the SDN-C catalog id used to configure this VCE
51550 description: identifier of managed by ATT or customer
51553 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
51554 ipv4-loopback0-address:
51556 description: v4 Loopback0 address
51559 description: v6 Loopback address
51560 management-v6-address:
51562 description: v6 management address
51566 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
51569 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
51573 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
51576 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
51580 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
51583 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
51587 description: number of associated SHD in vnf.
51591 description: number of vms in vnf.
51595 description: number of network in vnf.
51598 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
51599 is-closed-loop-disabled:
51601 description: used to indicate whether closed loop function is enabled on this node
51609 $ref: "#/patchDefinitions/generic-vnf"
51612 Openstack group-assignment used to store exclusivity groups (EG).
51613 ###### Related Nodes
51614 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
51615 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
51616 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
51625 description: Group id, expected to be unique across cloud-region.
51628 description: Group type - the type of group this instance refers to
51631 description: Group name - name assigned to the group
51634 description: Group description - description of the group
51637 Collection of openstack group assignments
51642 $ref: "#/patchDefinitions/group-assignment"
51645 ###### Related Nodes
51646 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
51648 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
51656 description: host-route id
51659 description: subnet prefix
51662 description: Could be ip-address, hostname, or service-instance
51665 description: Should be ip-address, hostname, or service-instance to match next-hop
51671 $ref: "#/patchDefinitions/host-route"
51674 Collection of HPA Capabilities
51679 $ref: "#/patchDefinitions/hpa-capability"
51682 Represents a HPA capability
51683 ###### Related Nodes
51684 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
51685 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
51686 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
51688 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
51690 - hpa-capability-id
51695 description: UUID to uniquely identify a HPA capability
51698 description: Name of the HPACapability
51701 description: HPA schema version
51704 description: Hardware architecture
51705 hpa-feature-attributes:
51707 HPA Capability Feature attributes
51708 ###### Related Nodes
51709 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
51711 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
51713 - hpa-attribute-key
51717 description: name of the specific HPA attribute
51718 hpa-attribute-value:
51720 description: JSON string specifying the value, unit and type of the specific HPA attribute
51724 ###### Related Nodes
51725 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
51726 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
51727 - FROM vserver( vserver Uses image, MANY2ONE)
51729 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
51730 -IMAGE cannot be deleted if related to VSERVER
51741 description: Image id, expected to be unique across cloud region
51744 description: Image name
51745 image-architecture:
51747 description: Operating system architecture.
51750 description: The common name of the operating system distribution in lowercase
51753 description: The operating system version as specified by the distributor.
51756 description: The application that the image instantiates.
51757 application-vendor:
51759 description: The vendor of the application.
51760 application-version:
51762 description: The version of the application.
51765 description: URL to endpoint where AAI can get more details
51768 Collectio of Openstack images.
51773 $ref: "#/patchDefinitions/image"
51774 include-node-filter:
51780 InstanceFilter for performing a named-query or model query
51783 InstanceFilters for performing a named-query or model query
51788 $ref: "#/patchDefinitions/instance-filter"
51791 General mechanism for grouping instances
51792 ###### Related Nodes
51793 - TO model( instance-group Targets model, MANY2MANY)
51794 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
51795 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
51796 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
51797 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
51798 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
51799 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
51800 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
51801 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
51802 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
51803 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
51804 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
51811 instance-group-role:
51813 description: role of the instance group.
51814 model-invariant-id:
51816 description: ASDC model id for this resource or service model.
51819 description: ASDC model version uid for this resource model.
51822 description: Instance Group ID, UUID assigned to this instance.
51825 description: Descriptive text to help identify the usage of this instance-group
51828 description: Only valid value today is lower case ha for high availability
51831 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
51834 Collection of openstack route table references
51839 $ref: "#/patchDefinitions/instance-group"
51844 $ref: "#/patchDefinitions/search"
51847 $ref: "#/patchDefinitions/actions"
51848 cloud-infrastructure:
51850 $ref: "#/patchDefinitions/cloud-infrastructure"
51853 $ref: "#/patchDefinitions/external-system"
51856 $ref: "#/patchDefinitions/business"
51857 service-design-and-creation:
51859 $ref: "#/patchDefinitions/service-design-and-creation"
51862 $ref: "#/patchDefinitions/network"
51865 $ref: "#/patchDefinitions/nodes"
51868 inventory-item-type:
51870 inventory-item-link:
51872 inventory-item-data:
51875 $ref: "#/patchDefinitions/inventory-item-data"
51876 tagged-inventory-item-list:
51879 $ref: "#/patchDefinitions/tagged-inventory-item-list"
51880 inventory-item-data:
51886 inventory-response-item:
51888 Inventory item for response list
51894 $ref: "#/patchDefinitions/extra-properties"
51895 inventory-response-items:
51897 $ref: "#/patchDefinitions/inventory-response-items"
51898 inventory-response-items:
51900 Container for inventory items in response list
51902 inventory-response-item:
51905 $ref: "#/patchDefinitions/inventory-response-item"
51906 ipsec-configuration:
51908 IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
51909 ###### Related Nodes
51910 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
51911 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
51913 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
51915 - ipsec-configuration-id
51917 ipsec-configuration-id:
51919 description: UUID of this configuration
51920 requested-vig-address-type:
51922 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
51923 requested-encryption-strength:
51925 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
51926 requested-dmz-type:
51928 description: ATT can offer a shared DMZ or a DMZ specific to a customer
51929 shared-dmz-network-address:
51931 description: Network address of shared DMZ
51932 requested-customer-name:
51934 description: If the DMZ is a custom DMZ, this field will indicate the customer information
51937 description: can be 1 or 2
51938 ikev1-authentication:
51940 description: Contains values like md5, sha1, sha256, sha384
51943 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
51946 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
51949 description: Group name defined in VIG for clients using aggressive mode
51952 description: pre-shared key for the above group name
51955 description: Lifetime for IKEv1 SA
51956 ipsec-authentication:
51958 description: md5, sha1, sha256, sha384
51961 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
51964 description: Life time for IPSec SA
51967 description: enable PFS or not
51970 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
51971 xauth-user-password:
51973 description: Encrypted using the Juniper $9$ algorithm
51976 description: The time between DPD probe
51979 description: Maximum number of DPD before claiming the tunnel is down
51980 ipsec-configurations:
51982 ipsec-configuration:
51985 $ref: "#/patchDefinitions/ipsec-configuration"
51994 Logical interfaces, e.g., a vnic.
51995 ###### Related Nodes
51996 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
51997 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
51998 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
51999 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
52000 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
52001 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
52002 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
52003 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
52004 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
52005 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
52006 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
52007 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
52008 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
52009 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
52011 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
52012 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
52013 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
52022 description: Name given to the interface
52025 description: E.g., CUSTOMER, UPLINK, etc.
52028 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
52031 description: URL to endpoint where AAI can get more details
52034 description: ID of interface
52037 description: MAC address for the interface
52040 description: Name of the network
52043 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
52044 interface-description:
52046 description: Human friendly text regarding this interface.
52049 description: boolean indicatating whether or not port is a mirrored.
52052 Collection of logical interfaces.
52057 $ref: "#/patchDefinitions/l-interface"
52058 l3-interface-ipv4-address-list:
52061 ###### Related Nodes
52062 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
52063 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52064 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
52065 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
52066 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
52067 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
52069 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
52071 - l3-interface-ipv4-address
52073 l3-interface-ipv4-address:
52075 description: IP address
52076 l3-interface-ipv4-prefix-length:
52079 description: Prefix length, 32 for single address
52083 description: Inner VLAN tag
52087 description: Outer VLAN tag
52090 description: Indicator of fixed or floating address
52091 l3-interface-ipv6-address-list:
52094 ###### Related Nodes
52095 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
52096 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52097 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
52098 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
52099 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
52100 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
52102 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
52104 - l3-interface-ipv6-address
52106 l3-interface-ipv6-address:
52108 description: IP address
52109 l3-interface-ipv6-prefix-length:
52112 description: Prefix length, 128 for single address
52116 description: Inner VLAN tag
52120 description: Outer VLAN tag
52123 description: Indicator of fixed or floating address
52126 Generic network definition
52127 ###### Related Nodes
52128 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
52129 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
52130 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
52131 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
52132 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
52133 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
52134 - FROM complex( complex Uses l3-network, MANY2MANY)
52135 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
52136 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52137 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52138 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
52139 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
52140 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
52141 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
52142 - FROM tenant( tenant Uses l3-network, MANY2MANY)
52143 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
52145 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
52150 - is-provider-network
52151 - is-shared-network
52152 - is-external-network
52156 description: Network ID, should be uuid. Unique across A&AI.
52159 description: Name of the network, governed by some naming convention..
52162 description: Type of the network - who defines these values?
52165 description: Role the network plans - who defines these values?
52166 network-technology:
52168 description: Network technology - who defines these values?
52169 neutron-network-id:
52171 description: Neutron network id of this Interface
52174 description: Set to true if bound to VPN
52177 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
52178 network-role-instance:
52181 description: network role instance
52187 $ref: "#/patchDefinitions/l3-network"
52190 Link aggregate interface
52191 ###### Related Nodes
52192 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
52193 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
52194 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
52195 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
52196 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
52197 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
52198 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
52199 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
52201 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
52202 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
52203 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
52210 description: Name that identifies the link aggregate interface
52211 interface-description:
52213 description: Human friendly text regarding this interface.
52216 Collection of link aggregate interfaces.
52221 $ref: "#/patchDefinitions/lag-interface"
52224 LAG links can connect lag-interfaces
52225 ###### Related Nodes
52226 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
52227 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
52229 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
52235 description: Alphabetical concatenation of lag-interface names
52238 Collection of link aggregation connections
52243 $ref: "#/patchDefinitions/lag-link"
52246 Metadata for license group.
52247 ###### Related Nodes
52248 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
52249 - TO vce( license BelongsTo vce, MANY2ONE)(4)
52251 -(4) IF this TO node is deleted, this LICENSE is DELETED also
52258 description: Unique ID for the license group the resource belongs to, should be uuid.
52261 description: Unique ID of a license resource.
52264 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
52269 $ref: "#/patchDefinitions/license"
52272 describes a line-of-business
52273 ###### Related Nodes
52274 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
52277 - line-of-business-name
52279 line-of-business-name:
52281 description: Name of the line-of-business (product)
52284 Collection of lines-of-business
52289 $ref: "#/patchDefinitions/line-of-business"
52292 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
52293 ###### Related Nodes
52294 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
52295 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
52296 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
52297 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
52298 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
52299 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
52300 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
52301 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
52302 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
52303 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
52304 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
52305 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
52306 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
52307 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
52308 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
52310 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
52318 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
52321 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
52324 description: Type of logical link, e.g., evc
52327 description: Captures the numeric part of the speed
52330 description: Captures the units corresponding to the speed
52333 description: v4, v6, or ds for dual stack
52336 description: For example, static or BGP
52339 Collection of logical connections
52344 $ref: "#/patchDefinitions/logical-link"
52347 Collection of metadatum (key/value pairs)
52352 $ref: "#/patchDefinitions/metadatum"
52356 ###### Related Nodes
52357 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
52358 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
52359 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
52360 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
52361 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
52363 -(4) IF this TO node is deleted, this METADATUM is DELETED also
52374 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
52375 ###### Related Nodes
52376 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
52377 - FROM instance-group( instance-group Targets model, MANY2MANY)
52378 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
52379 - FROM named-query( named-query AppliesTo model, ONE2MANY)
52380 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
52382 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
52383 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
52386 - model-invariant-id
52389 model-invariant-id:
52391 description: Unique identifier corresponding to the main definition of a model in ASDC
52394 description: Type of the model, e.g., service, resource, widget, etc.
52395 model-and-named-query-search:
52397 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
52401 $ref: "#/patchDefinitions/query-parameters"
52404 $ref: "#/patchDefinitions/instance-filters"
52407 $ref: "#/patchDefinitions/secondary-filts"
52410 secondary-filter-cut-point:
52414 This is how we would capture constraints defining allowed sets of elements.
52415 ###### Related Nodes
52416 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
52417 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
52419 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
52420 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
52422 - model-constraint-uuid
52423 - constrained-element-set-uuid-to-replace
52425 model-constraint-uuid:
52427 constrained-element-set-uuid-to-replace:
52429 constrained-element-sets:
52432 $ref: "#/patchDefinitions/constrained-element-set"
52438 $ref: "#/patchDefinitions/model-constraint"
52441 Defines how other models combine to make up a higher-level model.
52442 ###### Related Nodes
52443 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
52444 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
52445 - TO model-ver( model-element IsA model-ver, MANY2ONE)
52446 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
52447 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
52448 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
52449 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
52451 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
52452 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
52454 - model-element-uuid
52455 - new-data-del-flag
52458 model-element-uuid:
52462 description: Indicates whether this element was created as part of instantiation from this model
52465 description: How many of this type of element are required/allowed
52473 $ref: "#/patchDefinitions/model-element"
52476 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
52477 ###### Related Nodes
52478 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
52479 - FROM model-element( model-element IsA model-ver, MANY2ONE)
52480 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
52481 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
52483 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
52484 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
52485 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
52494 description: Unique identifier corresponding to one version of a model in ASDC
52497 description: Name of the model, which can change from version to version.
52500 description: Version
52503 description: Description
52509 $ref: "#/patchDefinitions/model-ver"
52512 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
52517 $ref: "#/patchDefinitions/model"
52518 multicast-configuration:
52520 ###### Related Nodes
52521 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
52524 - multicast-configuration-id
52525 - multicast-protocol
52528 multicast-configuration-id:
52530 description: Unique id of multicast configuration.
52531 multicast-protocol:
52533 description: protocol of multicast configuration
52536 description: rp type of multicast configuration
52537 multicast-configurations:
52539 multicast configuration of generic-vnf ip-address
52541 multicast-configuration:
52544 $ref: "#/patchDefinitions/multicast-configuration"
52550 $ref: "#/patchDefinitions/named-query"
52554 ###### Related Nodes
52555 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
52556 - TO model( named-query AppliesTo model, ONE2MANY)
52557 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
52559 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
52563 - named-query-version
52569 named-query-version:
52571 required-input-param:
52575 named-query-element:
52578 ###### Related Nodes
52579 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
52580 - TO model( named-query-element IsA model, MANY2ONE)
52581 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
52582 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
52583 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
52584 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
52586 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
52587 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
52589 - named-query-element-uuid
52591 named-query-element-uuid:
52593 property-collect-list:
52595 named-query-elements:
52597 named-query-element:
52600 $ref: "#/patchDefinitions/named-query-element"
52603 Namespace for network inventory resources.
52608 $ref: "#/patchDefinitions/logical-link"
52612 $ref: "#/patchDefinitions/site-pair-set"
52616 $ref: "#/patchDefinitions/vpn-binding"
52620 $ref: "#/patchDefinitions/vpls-pe"
52621 multicast-configurations:
52624 $ref: "#/patchDefinitions/multicast-configuration"
52628 $ref: "#/patchDefinitions/vce"
52632 $ref: "#/patchDefinitions/vnfc"
52636 $ref: "#/patchDefinitions/l3-network"
52640 $ref: "#/patchDefinitions/network-policy"
52644 $ref: "#/patchDefinitions/generic-vnf"
52648 $ref: "#/patchDefinitions/lag-link"
52652 $ref: "#/patchDefinitions/newvce"
52656 $ref: "#/patchDefinitions/pnf"
52660 $ref: "#/patchDefinitions/physical-link"
52661 ipsec-configurations:
52664 $ref: "#/patchDefinitions/ipsec-configuration"
52665 route-table-references:
52668 $ref: "#/patchDefinitions/route-table-reference"
52672 $ref: "#/patchDefinitions/instance-group"
52676 $ref: "#/patchDefinitions/zone"
52680 $ref: "#/patchDefinitions/configurations"
52686 $ref: "#/patchDefinitions/network-policy"
52689 ###### Related Nodes
52690 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
52691 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
52694 - network-policy-id
52698 description: UUID representing unique key to this instance
52699 network-policy-fqdn:
52701 description: Contrail FQDN for the policy
52704 description: ID for the openStack Heat instance
52707 Network profile populated by SDN-GP for SNMP
52708 ###### Related Nodes
52709 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
52716 description: Unique name of network profile.
52719 description: Encrypted SNMP community string
52722 Collection of network profiles
52727 $ref: "#/patchDefinitions/network-profile"
52730 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
52731 ###### Related Nodes
52732 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
52734 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
52742 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
52745 description: Name of VNF.
52748 description: Alternate name of VNF.
52751 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52754 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52755 operational-status:
52757 description: Indicator for whether the resource is considered operational
52760 description: OBSOLETE - do not use
52763 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
52766 description: Client should send valid enumerated value.
52769 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
52774 $ref: "#/patchDefinitions/newvce"
52777 inventory-item-data:
52780 $ref: "#/patchDefinitions/inventory-item-data"
52781 notification-event:
52785 notification-event-header:
52787 $ref: "#/patchDefinitions/notification-event-header"
52788 notification-event-header:
52829 $ref: "#/patchDefinitions/key-data"
52834 OAM network, to be deprecated shortly. Do not use for new purposes.
52835 ###### Related Nodes
52836 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
52837 - TO complex( oam-network AppliesTo complex, MANY2MANY)
52838 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
52847 description: UUID of the network. Unique across a cloud-region
52850 description: Name of the network.
52854 description: cvlan-id
52855 ipv4-oam-gateway-address:
52857 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
52858 ipv4-oam-gateway-address-prefix-length:
52861 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
52864 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
52869 $ref: "#/patchDefinitions/oam-network"
52870 operational-environment:
52872 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
52873 ###### Related Nodes
52874 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
52875 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
52878 - operational-environment-id
52879 - operational-environment-name
52880 - operational-environment-type
52881 - operational-environment-status
52885 operational-environment-id:
52887 description: UUID of an operational environment
52888 operational-environment-name:
52890 description: Operational Environment name
52891 operational-environment-type:
52893 description: Operational Environment Type.
52894 operational-environment-status:
52896 description: Status
52899 description: Tenant Context.
52902 description: Workload Context.
52903 operational-environments:
52905 a logical partition of the cloud which allows to have multiple environments in the production AIC.
52907 operational-environment:
52910 $ref: "#/patchDefinitions/operational-environment"
52913 Allows for legacy POST of old-style and new-style models
52915 - model-invariant-id
52916 - model-name-version-id
52922 model-invariant-id:
52924 description: Unique identifier corresponding to the main definition of a model in ASDC
52925 model-name-version-id:
52927 description: Unique identifier corresponding to one version of a model in ASDC
52930 description: Type of the model, e.g., service, resource, widget, etc.
52933 description: Name of the model, which can change from version to version.
52936 description: Invariant unique ID which does not change from version to version
52939 description: Version
52942 description: Description
52945 Collection of owning-entities
52950 $ref: "#/patchDefinitions/owning-entity"
52953 describes an owning-entity
52954 ###### Related Nodes
52955 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
52959 - owning-entity-name
52963 description: UUID of an owning entity
52964 owning-entity-name:
52966 description: Owning entity name
52969 Physical interface (e.g., nic)
52970 ###### Related Nodes
52971 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
52972 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
52973 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
52974 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
52975 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
52976 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
52977 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
52978 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
52980 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
52981 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
52982 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
52989 description: Name that identifies the physical interface
52992 description: Captures the numeric part of the speed
52995 description: Captures the units corresponding to the speed
52998 description: Nature of the services and connectivity on this port.
52999 equipment-identifier:
53001 description: CLEI or other specification for p-interface hardware.
53004 description: Role specification for p-interface hardware.
53007 description: Indicates the physical properties of the interface.
53010 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53013 description: MAC Address of the p-interface.
53016 Collection of physical interfaces.
53021 $ref: "#/patchDefinitions/p-interface"
53024 Collection of physical connections, typically between p-interfaces
53025 ###### Related Nodes
53026 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
53028 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
53034 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
53037 description: Captures the numeric part of the speed
53040 description: Captures the units corresponding to the speed
53043 description: Circuit it
53046 description: Dual access mode (e.g., primary, secondary
53049 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
53050 service-provider-name:
53052 description: Name of the service Provider on this link.
53053 service-provider-bandwidth-up-value:
53056 description: Upstream Bandwidth value agreed with the service provider
53057 service-provider-bandwidth-up-units:
53059 description: Units for the upstream BW value
53060 service-provider-bandwidth-down-value:
53063 description: Downstream Bandwidth value agreed with the service provider
53064 service-provider-bandwidth-down-units:
53066 description: Units for downstream BW value
53069 Collection of physical connections, typically between p-interfaces
53074 $ref: "#/patchDefinitions/physical-link"
53077 describes a platform
53078 ###### Related Nodes
53079 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
53086 description: Name of the platform
53089 Collection of platforms
53094 $ref: "#/patchDefinitions/platform"
53097 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
53098 ###### Related Nodes
53099 - TO complex( pnf LocatedIn complex, MANY2ONE)
53100 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
53101 - TO zone( pnf LocatedIn zone, MANY2ONE)
53102 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
53103 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
53104 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
53105 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
53106 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
53107 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
53109 -(1) IF this PNF node is deleted, this FROM node is DELETED also
53116 description: unique name of Physical Network Function.
53119 description: name of Physical Network Function.
53122 description: source of name2
53125 description: id of pnf
53128 description: Equipment type. Source of truth should define valid values.
53131 description: Equipment vendor. Source of truth should define valid values.
53134 description: Equipment model. Source of truth should define valid values.
53137 description: identifier of managed by ATT or customer
53140 description: ipv4-oam-address with new naming convention for IP addresses
53143 description: sw-version is the version of SW for the hosted application on the PNF.
53146 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
53149 description: ID of the physical frame (relay rack) where pnf is installed.
53152 description: Serial number of the device
53153 ipaddress-v4-loopback-0:
53155 description: IPV4 Loopback 0 address
53156 ipaddress-v6-loopback-0:
53158 description: IPV6 Loopback 0 address
53161 description: IPV4 AIM address
53164 description: IPV6 AIM address
53167 description: IPV6 OAM address
53170 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
53173 Collection of Physical Network Functions.
53178 $ref: "#/patchDefinitions/pnf"
53181 Used to capture the network interfaces of this VCE
53182 ###### Related Nodes
53183 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
53184 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
53186 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
53187 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
53190 - orchestration-status
53194 description: Unique ID of the interface
53195 neutron-network-id:
53197 description: Neutron network id of this Interface
53198 neutron-network-name:
53200 description: Neutron network name of this Interface
53203 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
53209 $ref: "#/patchDefinitions/port-group"
53212 describes the project
53213 ###### Related Nodes
53214 - TO service-instance( project Uses service-instance, ONE2MANY)
53221 description: Name of the project deploying a service
53224 Collection of projects
53229 $ref: "#/patchDefinitions/project"
53232 Property holder for query properties or instance properties
53238 property-constraint:
53241 ###### Related Nodes
53242 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
53244 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
53246 - property-constraint-uuid
53251 property-constraint-uuid:
53259 property-constraints:
53261 property-constraint:
53264 $ref: "#/patchDefinitions/property-constraint"
53267 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
53268 ###### Related Nodes
53269 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
53270 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
53271 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
53272 - TO complex( pserver LocatedIn complex, MANY2ONE)
53273 - TO zone( pserver LocatedIn zone, MANY2ONE)
53274 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
53275 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
53276 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
53277 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
53278 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
53280 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
53281 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
53289 description: Value from executing hostname on the compute node.
53292 description: PTNII name
53296 description: Number of cpus
53300 description: Disk size, in GBs
53304 description: RAM size, in MBs
53307 description: Equipment type. Source of truth should define valid values.
53310 description: Equipment vendor. Source of truth should define valid values.
53313 description: Equipment model. Source of truth should define valid values.
53316 description: Fully-qualified domain name
53319 description: URL to endpoint where AAI can get more details
53322 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
53325 description: Serial number, may be queried
53326 ipaddress-v4-loopback-0:
53328 description: IPV4 Loopback 0 address
53329 ipaddress-v6-loopback-0:
53331 description: IPV6 Loopback 0 address
53334 description: IPV4 AIM address
53337 description: IPV6 AIM address
53340 description: IPV6 OAM address
53343 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
53346 description: ID of Pserver
53349 description: internet topology of Pserver
53352 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
53355 Collection of compute hosts.
53360 $ref: "#/patchDefinitions/pserver"
53363 QueryParameters for performing a named-query or model query
53367 $ref: "#/patchDefinitions/named-query"
53370 $ref: "#/patchDefinitions/overloaded-model"
53374 ###### Related Nodes
53375 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
53377 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
53379 - related-lookup-uuid
53381 - source-node-property
53383 - target-node-property
53385 related-lookup-uuid:
53389 source-node-property:
53393 target-node-property:
53395 property-collect-list:
53402 $ref: "#/patchDefinitions/related-lookup"
53403 related-to-property:
53407 description: Key part of a key/value pair
53410 description: Value part of a key/value pair
53415 description: A keyword provided by A&AI to indicate type of node.
53418 description: URL to the object in A&AI.
53422 $ref: "#/patchDefinitions/relationship-data"
53423 related-to-property:
53426 $ref: "#/patchDefinitions/related-to-property"
53430 - relationship-value
53434 description: A keyword provided by A&AI to indicate an attribute.
53435 relationship-value:
53437 description: Value of the attribute.
53438 reserved-prop-names:
53440 Internal map to define some reserved properties of a vertex
53442 last-mod-source-of-truth:
53460 Response container for the results of a named-query or model query
53462 inventory-response-items:
53464 $ref: "#/patchDefinitions/inventory-response-items"
53469 description: The specific type of node in the A&AI graph
53472 description: The URL to the specific resource
53473 route-table-reference:
53475 Openstack route table reference.
53476 ###### Related Nodes
53477 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
53480 - route-table-reference-id
53481 - route-table-reference-fqdn
53483 route-table-reference-id:
53485 description: Route Table Reference id, UUID assigned to this instance.
53486 route-table-reference-fqdn:
53488 description: FQDN entry in the route table.
53489 route-table-references:
53491 Collection of openstack route table references
53493 route-table-reference:
53496 $ref: "#/patchDefinitions/route-table-reference"
53499 Route target information
53500 ###### Related Nodes
53501 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
53503 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
53505 - global-route-target
53506 - route-target-role
53508 global-route-target:
53510 description: Number used to identify an RT, globally unique in the network
53513 description: Role assigned to this route target
53516 Collection of route target information
53521 $ref: "#/patchDefinitions/route-target"
53524 ###### Related Nodes
53525 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
53526 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
53528 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
53529 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
53531 - routing-instance-id
53533 routing-instance-id:
53535 description: Unique id of routing instance
53538 description: rpm owner
53541 set of probes related to generic-vnf routing instance
53546 $ref: "#/patchDefinitions/routing-instance"
53551 $ref: "#/patchDefinitions/oam-networks"
53552 az-and-dvs-switches:
53555 $ref: "#/patchDefinitions/az-and-dvs-switches"
53558 edge-tag-query-result:
53560 $ref: "#/patchDefinitions/edge-tag-query-result"
53561 edge-tag-query-request:
53563 $ref: "#/patchDefinitions/edge-tag-query-request"
53566 $ref: "#/patchDefinitions/search-results"
53569 $ref: "#/patchDefinitions/sdn-zone-response"
53575 $ref: "#/patchDefinitions/result-data"
53578 SecondaryFilt for performing a named-query or model query
53589 SecondaryFilts for performing a named-query or model query
53594 $ref: "#/patchDefinitions/secondary-filt"
53595 segmentation-assignment:
53597 Openstack segmentation assignment.
53598 ###### Related Nodes
53599 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
53601 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
53607 description: Route Table Reference id, UUID assigned to this instance.
53608 segmentation-assignments:
53610 Collection of openstack segmentation assignments
53612 segmentation-assignment:
53615 $ref: "#/patchDefinitions/segmentation-assignment"
53618 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
53621 - service-description
53625 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
53626 service-description:
53628 description: Description of the service
53631 description: URL to endpoint where AAI can get more details
53632 service-capabilities:
53634 Collection of service capabilities.
53636 service-capability:
53639 $ref: "#/patchDefinitions/service-capability"
53640 service-capability:
53642 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
53643 ###### Related Nodes
53644 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
53645 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
53647 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
53655 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
53658 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
53659 service-design-and-creation:
53661 Namespace for objects managed by ASDC
53666 $ref: "#/patchDefinitions/vnf-image"
53670 $ref: "#/patchDefinitions/service"
53671 service-capabilities:
53674 $ref: "#/patchDefinitions/service-capability"
53678 $ref: "#/patchDefinitions/model"
53682 $ref: "#/patchDefinitions/named-query"
53685 Instance of a service
53686 ###### Related Nodes
53687 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
53688 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
53689 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
53690 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
53691 - TO configuration( service-instance Uses configuration, ONE2MANY)
53692 - TO connector( service-instance Uses connector, MANY2MANY)
53693 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
53694 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
53695 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
53696 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
53697 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
53698 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
53699 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
53700 - TO zone( service-instance LocatedIn zone, MANY2ONE)
53701 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
53702 - TO vce( service-instance ComposedOf vce, ONE2MANY)
53703 - FROM project( project Uses service-instance, ONE2MANY)
53704 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
53705 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
53706 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
53708 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
53709 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
53710 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
53712 - service-instance-id
53714 service-instance-id:
53716 description: Uniquely identifies this instance of a service
53717 service-instance-name:
53719 description: This field will store a name assigned to the service-instance.
53722 description: String capturing type of service.
53725 description: String capturing the service role.
53726 environment-context:
53728 description: This field will store the environment context assigned to the service-instance.
53731 description: This field will store the workload context assigned to the service-instance.
53734 description: create time of Network Service.
53737 description: last update of Network Service.
53740 description: short description for service-instance.
53741 model-invariant-id:
53743 description: the ASDC model id for this resource or service model.
53746 description: the ASDC model version for this resource or service model.
53747 persona-model-version:
53749 description: the ASDC model version for this resource or service model.
53752 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53753 widget-model-version:
53755 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53758 description: Indicates the total bandwidth to be used for this service.
53761 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
53762 bandwidth-down-wan1:
53764 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
53767 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
53768 bandwidth-down-wan2:
53770 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
53773 description: URL customers will use to access the vHN Portal.
53774 service-instance-location-id:
53776 description: An identifier that customers assign to the location where this service is being used.
53779 Collection of service instances
53784 $ref: "#/patchDefinitions/service-instance"
53785 service-subscription:
53787 Object that group service instances.
53788 ###### Related Nodes
53789 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
53790 - TO tenant( service-subscription Uses tenant, MANY2MANY)
53791 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
53793 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
53794 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
53800 description: Value defined by orchestration to identify this service across ECOMP.
53801 temp-ub-sub-account-id:
53803 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
53804 service-subscriptions:
53806 Collection of objects that group service instances.
53808 service-subscription:
53811 $ref: "#/patchDefinitions/service-subscription"
53814 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
53819 $ref: "#/patchDefinitions/service"
53822 ###### Related Nodes
53823 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
53824 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
53826 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
53827 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
53833 description: unique identifier of probe
53836 description: Prefix address
53839 description: Prefix address
53842 description: ip version, v4, v6
53843 destination-hostname:
53845 description: Hostname of the destination equipment to which SLAs are measured against.
53846 destination-equip-type:
53848 description: The type of destinatination equipment. Could be Router, UCPE, etc.
53851 Set of instances for probes used to measure service level agreements
53852 ###### Related Nodes
53853 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
53854 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
53856 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
53862 description: Unique id of site pair set.
53865 Collection of sets of instances for probes related to generic-vnf
53870 $ref: "#/patchDefinitions/site-pair-set"
53878 $ref: "#/patchDefinitions/site-pair"
53882 ###### Related Nodes
53883 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
53884 - FROM vserver( vserver Uses snapshot, ONE2ONE)
53891 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
53894 description: Snapshot name
53895 snapshot-architecture:
53897 description: Operating system architecture
53898 snapshot-os-distro:
53900 description: The common name of the operating system distribution in lowercase
53901 snapshot-os-version:
53903 description: The operating system version as specified by the distributor.
53906 description: The application that the image instantiates.
53907 application-vendor:
53909 description: The vendor of the application.
53910 application-version:
53912 description: The version of the application.
53915 description: URL to endpoint where AAI can get more details
53918 description: This field contains the UUID of the previous snapshot (if any).
53921 Collection of openstack snapshots
53926 $ref: "#/patchDefinitions/snapshot"
53929 SR-IOV Physical Function
53930 ###### Related Nodes
53931 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
53932 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
53934 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
53940 description: Identifier for the sriov-pf
53943 Collection of SR-IOV Physical Functions.
53948 $ref: "#/patchDefinitions/sriov-pf"
53951 SR-IOV Virtual Function (not to be confused with virtual network function)
53952 ###### Related Nodes
53953 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
53954 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
53956 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
53962 description: PCI ID used to identify the sriov-vf
53965 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
53968 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
53971 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
53972 vf-vlan-anti-spoof-check:
53974 description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
53975 vf-mac-anti-spoof-check:
53977 description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
53980 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
53981 vf-broadcast-allow:
53983 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
53984 vf-unknown-multicast-allow:
53986 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
53987 vf-unknown-unicast-allow:
53989 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
53992 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
53995 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
53998 Collection of SR-IOV Virtual Functions.
54003 $ref: "#/patchDefinitions/sriov-vf"
54012 ###### Related Nodes
54013 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
54014 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
54015 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
54016 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
54017 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
54018 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
54020 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
54021 -(4) IF this TO node is deleted, this SUBNET is DELETED also
54022 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
54030 description: Subnet ID, should be UUID.
54033 description: Name associated with the subnet.
54036 description: Neutron id of this subnet
54039 description: gateway ip address
54040 network-start-address:
54042 description: network start address
54045 description: cidr mask
54048 description: ip version
54049 orchestration-status:
54051 description: Orchestration status of this VNF, mastered by MSO
54054 description: dhcp enabled
54057 description: the start address reserved for use by dhcp
54060 description: the last address reserved for use by dhcp
54063 description: role of the subnet, referenced when assigning IPs
54064 ip-assignment-direction:
54066 description: ip address assignment direction of the subnet
54072 $ref: "#/patchDefinitions/subnet"
54073 tagged-inventory-item-list:
54078 $ref: "#/patchDefinitions/inventory-item"
54082 ###### Related Nodes
54083 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
54084 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
54085 - TO l3-network( tenant Uses l3-network, MANY2MANY)
54086 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
54087 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
54088 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
54090 -TENANT cannot be deleted if related to VSERVER
54098 description: Unique id relative to the cloud-region.
54101 description: Readable name of tenant
54104 description: This field will store the tenant context.
54107 Collection of openstack tenants.
54112 $ref: "#/patchDefinitions/tenant"
54115 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
54116 ###### Related Nodes
54117 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
54119 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
54122 - bandwidth-up-wan1
54123 - bandwidth-down-wan1
54124 - bandwidth-up-wan2
54125 - bandwidth-down-wan2
54129 description: Allotted Resource id UUID assigned to this instance.
54132 description: The WAN uplink bandwidth for WAN1
54133 bandwidth-down-wan1:
54135 description: The WAN downlink bandwidth for WAN1
54138 description: The WAN uplink bandwidth for WAN2
54139 bandwidth-down-wan2:
54141 description: The WAN downlink bandwidth for WAN2
54144 This object is used to store the specific tunnel cross connect aspects of an allotted resource
54149 $ref: "#/patchDefinitions/tunnel-xconnect"
54152 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
54161 $ref: "#/patchDefinitions/update-node-key"
54167 $ref: "#/patchDefinitions/action"
54176 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
54177 ###### Related Nodes
54178 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
54179 - TO complex( vce LocatedIn complex, MANY2MANY)
54180 - TO vserver( vce HostedOn vserver, ONE2MANY)
54181 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
54182 - FROM license( license BelongsTo vce, MANY2ONE)(1)
54183 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
54184 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
54186 -(1) IF this VCE node is deleted, this FROM node is DELETED also
54194 description: Unique id of VNF. This is unique across the graph.
54197 description: Name of VNF.
54200 description: Alternate name of VNF.
54203 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
54206 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
54207 regional-resource-zone:
54209 description: Regional way of organizing pservers, source of truth should define values
54212 description: Trigger for operational monitoring of this resource by Service Assurance systems.
54213 operational-status:
54215 description: Indicator for whether the resource is considered operational
54218 description: OBSOLETE - do not use
54221 description: Network role being played by this VNF
54222 orchestration-status:
54224 description: Orchestration status of this VNF, mastered by MSO
54227 description: Heat stack id corresponding to this instance, managed by MSO
54230 description: Corresponds to the SDN-C catalog id used to configure this VCE
54233 description: Unique ID of VPE connected to this VCE.
54234 v6-vce-wan-address:
54236 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
54239 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
54242 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
54247 $ref: "#/patchDefinitions/vce"
54250 a deployment unit of VNFCs
54251 ###### Related Nodes
54252 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
54253 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
54254 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
54255 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
54256 - TO vserver( vf-module Uses vserver, ONE2MANY)
54258 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
54259 -VF-MODULE cannot be deleted if related to VNFC
54263 - is-base-vf-module
54267 description: Unique ID of vf-module.
54270 description: Name of vf-module
54273 description: Heat stack id corresponding to this instance.
54274 orchestration-status:
54276 description: orchestration status of this vf-module, mastered by MSO
54279 description: used to indicate whether or not this object is base vf module
54282 Collection of vf-modules, a deployment unit of VNFCs
54287 $ref: "#/patchDefinitions/vf-module"
54290 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
54291 ###### Related Nodes
54292 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
54294 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
54300 description: indicates whether the VIG is for AVPN or INTERNET
54303 description: v4 IP of the vig server
54306 description: v6 IP of the vig server
54312 $ref: "#/patchDefinitions/vig-server"
54313 vip-ipv4-address-list:
54316 ###### Related Nodes
54317 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
54318 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
54319 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
54320 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
54327 description: IP address
54328 vip-ipv4-prefix-length:
54331 description: Prefix length, 32 for single address
54335 description: Inner VLAN tag
54339 description: Outer VLAN tag
54342 description: Indicator of fixed or floating address
54343 vip-ipv6-address-list:
54346 ###### Related Nodes
54347 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
54348 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
54349 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
54350 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
54357 description: IP address
54358 vip-ipv6-prefix-length:
54361 description: Prefix length, 128 for single address
54365 description: Inner VLAN tag
54369 description: Outer VLAN tag
54372 description: Indicator of fixed or floating address
54373 virtual-data-center:
54375 Virtual organization of cloud infrastructure elements in a data center context
54376 ###### Related Nodes
54377 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
54378 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
54379 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
54387 description: Unique ID of the vdc
54390 description: Name of the virtual data center
54391 virtual-data-centers:
54393 Virtual organization of cloud infrastructure elements in a data center context
54395 virtual-data-center:
54398 $ref: "#/patchDefinitions/virtual-data-center"
54402 ###### Related Nodes
54403 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
54404 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
54405 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
54406 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
54407 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
54408 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
54409 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
54411 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
54412 -(2) IF this VLAN node is deleted, this TO node is DELETED also
54413 -(4) IF this TO node is deleted, this VLAN is DELETED also
54421 description: String that identifies the interface
54425 description: Inner VLAN tag
54429 description: Outer VLAN tag
54435 $ref: "#/patchDefinitions/vlan"
54444 description: Unique id of VNF. This is unique across the graph.
54447 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
54448 ###### Related Nodes
54449 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
54451 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
54456 - application-vendor
54460 description: Unique ID of this asset
54463 description: The application that the image instantiates.
54464 application-vendor:
54466 description: The vendor of the application.
54467 application-version:
54469 description: The version of the application.
54472 description: URL to endpoint where AAI can get more details
54475 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
54480 $ref: "#/patchDefinitions/vnf-image"
54483 ###### Related Nodes
54484 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
54485 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
54486 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
54487 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
54488 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
54489 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
54490 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
54491 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
54493 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
54494 -(4) IF this TO node is deleted, this VNFC is DELETED also
54500 - is-closed-loop-disabled
54504 description: Unique ID of vnfc.
54507 description: Short code that is used in naming instances of the item being modeled
54510 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
54513 description: prov status of this vnfc
54514 orchestration-status:
54516 description: Orchestration status of this VNF, mastered by APP-C
54517 ipaddress-v4-oam-vip:
54519 description: Oam V4 vip address of this vnfc
54522 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
54523 is-closed-loop-disabled:
54525 description: used to indicate whether closed loop function is enabled on this node
54528 description: Group notation of VNFC
54529 model-invariant-id:
54531 description: the ASDC model id for this resource or service model.
54534 description: the ASDC model version for this resource or service model.
54537 virtual network components associated with a vserver from application controller.
54542 $ref: "#/patchDefinitions/vnfc"
54545 Ephemeral Block storage volume.
54546 ###### Related Nodes
54547 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
54549 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
54556 description: Unique ID of block storage volume relative to the vserver.
54559 description: URL to endpoint where AAI can get more details
54562 Persistent block-level storage.
54563 ###### Related Nodes
54564 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
54565 - TO complex( volume-group LocatedIn complex, MANY2ONE)
54566 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
54567 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
54568 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
54572 - volume-group-name
54577 description: Unique ID of volume-group.
54580 description: Name of the volume group.
54583 description: Heat stack id corresponding to this volume-group
54586 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
54587 orchestration-status:
54589 description: Orchestration status of this volume-group
54590 model-customization-id:
54592 description: captures the id of all the configuration used to customize the resource for the service.
54593 vf-module-model-customization-id:
54595 description: helps relate the volume group to the vf-module whose components will require the volume group
54598 Collection of persistent block-level storage.
54603 $ref: "#/patchDefinitions/volume-group"
54606 Collection of ephemeral Block storage volumes.
54611 $ref: "#/patchDefinitions/volume"
54614 VPLS Provider Edge routers.
54615 ###### Related Nodes
54616 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
54617 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
54618 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
54619 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
54621 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
54629 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
54632 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
54635 description: Client should send valid enumerated value, e.g., VPLS-PE.
54639 description: Temporary location for stag to get to VCE
54642 Collection of VPLS Provider Edge routers
54647 $ref: "#/patchDefinitions/vpls-pe"
54651 ###### Related Nodes
54652 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
54653 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
54654 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
54655 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
54657 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
54658 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
54666 description: VPN ID, globally unique within A&AI
54669 description: VPN Name
54672 description: the platform associated with the VPN example AVPN, Mobility
54675 description: Type of the vpn, should be taken from enumerated/valid values
54678 description: region of customer vpn
54681 description: id for this customer vpn
54682 route-distinguisher:
54684 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
54690 $ref: "#/patchDefinitions/vpn-binding"
54693 Virtual Servers, aka virtual machine or VM.
54694 ###### Related Nodes
54695 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
54696 - TO flavor( vserver Uses flavor, MANY2ONE)
54697 - TO image( vserver Uses image, MANY2ONE)
54698 - TO pserver( vserver HostedOn pserver, MANY2ONE)
54699 - TO snapshot( vserver Uses snapshot, ONE2ONE)
54700 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
54701 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
54702 - FROM vce( vce HostedOn vserver, ONE2MANY)
54703 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
54704 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
54705 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
54707 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
54708 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
54714 - is-closed-loop-disabled
54718 description: Unique identifier for this vserver relative to its tenant
54721 description: Name of vserver
54724 description: Alternative name of vserver
54727 description: Trigger for operational monitoring of this resource by Service Assurance systems.
54730 description: URL to endpoint where AAI can get more details
54733 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
54734 is-closed-loop-disabled:
54736 description: Used to indicate whether closed loop function is enabled on this node
54739 Collection of virtual Servers, aka virtual machines or VMs.
54744 $ref: "#/patchDefinitions/vserver"
54747 A zone is a grouping of assets in a location homing to the same connections into the CBB
54748 ###### Related Nodes
54749 - TO complex( zone LocatedIn complex, MANY2ONE)
54750 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
54751 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
54752 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
54753 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
54763 description: Code assigned by AIC to the zone
54766 description: English name associated with the zone
54769 description: Design of zone [Medium/Large?]
54772 description: Context of zone [production/test]
54775 description: Status of a zone.
54778 Collection of zones
54783 $ref: "#/patchDefinitions/zone"
54792 $ref: "#/getDefinitions/action-data"
54801 APIs that are more action related than REST (e.g., notify, update).
54805 $ref: "#/getDefinitions/update"
54808 $ref: "#/getDefinitions/notify"
54811 Represents a slice or partial piece of a resource that gets separately allotted
54812 ###### Related Nodes
54813 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
54814 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
54815 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
54816 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
54817 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
54818 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
54819 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
54820 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
54821 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
54822 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
54823 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
54824 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
54825 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
54827 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
54828 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
54829 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
54835 description: Allotted Resource id UUID assigned to this instance.
54838 description: The descriptive information assigned to this allotted resource instance
54841 description: Link back to more information in the controller
54842 model-invariant-id:
54844 description: the ASDC model id for this resource or service model.
54847 description: the ASDC model version for this resource or service model.
54848 persona-model-version:
54850 description: the ASDC model version for this resource or service model.
54853 description: Concurrency value
54854 orchestration-status:
54856 description: Orchestration status
54857 operational-status:
54859 description: Indicator for whether the resource is considered operational
54862 description: Generic description of the type of allotted resource.
54865 description: role in the network that this resource will be providing.
54869 $ref: "#/getDefinitions/tunnel-xconnect"
54873 $ref: "#/getDefinitions/relationship"
54874 allotted-resources:
54876 This object is used to store slices of services being offered
54881 $ref: "#/getDefinitions/allotted-resource"
54884 Availability zone, a collection of compute hosts/pservers
54885 ###### Related Nodes
54886 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
54887 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
54888 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
54889 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
54890 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
54891 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
54892 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
54893 - FROM vce( vce Uses availability-zone, MANY2MANY)
54895 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
54896 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
54899 - availability-zone-name
54902 availability-zone-name:
54904 description: Name of the availability zone. Unique across a cloud region
54907 description: Type of hypervisor. Source of truth should define valid values.
54908 operational-status:
54910 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
54913 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54917 $ref: "#/getDefinitions/relationship"
54918 availability-zones:
54920 Collection of availability zones
54925 $ref: "#/getDefinitions/availability-zone"
54926 az-and-dvs-switches:
54930 $ref: "#/getDefinitions/dvs-switches"
54933 $ref: "#/getDefinitions/availability-zone"
54936 Namespace for business related constructs
54941 $ref: "#/getDefinitions/connector"
54945 $ref: "#/getDefinitions/customer"
54949 $ref: "#/getDefinitions/line-of-business"
54953 $ref: "#/getDefinitions/owning-entity"
54957 $ref: "#/getDefinitions/platform"
54961 $ref: "#/getDefinitions/project"
54964 ###### Related Nodes
54965 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
54967 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
54973 description: unique identifier of probe
54976 description: identifier of probe
54979 description: type of probe
54982 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54986 $ref: "#/getDefinitions/relationship"
54987 classes-of-service:
54989 class-of-service of probe
54994 $ref: "#/getDefinitions/class-of-service"
54995 cloud-infrastructure:
54997 Namespace for cloud infrastructure.
55002 $ref: "#/getDefinitions/complex"
55006 $ref: "#/getDefinitions/cloud-region"
55010 $ref: "#/getDefinitions/network-profile"
55014 $ref: "#/getDefinitions/pserver"
55015 virtual-data-centers:
55018 $ref: "#/getDefinitions/virtual-data-center"
55021 cloud-region designates an installation of a cloud cluster or region or instantiation.
55022 ###### Related Nodes
55023 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
55024 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
55025 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
55026 - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
55027 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
55028 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
55029 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
55030 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
55031 - FROM image( image BelongsTo cloud-region, MANY2ONE)
55032 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
55033 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
55034 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
55035 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
55036 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
55037 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
55038 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
55039 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
55041 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
55042 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
55051 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
55054 description: Identifier used by the vendor for the region. Second part of composite key
55057 description: Type of the cloud (e.g., openstack)
55058 owner-defined-type:
55060 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
55061 cloud-region-version:
55063 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
55066 description: URL of the keystone identity service
55069 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
55072 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
55075 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
55078 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
55081 description: MultiVIM will discover and expose EPA capabilities.
55084 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55088 $ref: "#/getDefinitions/volume-group"
55092 $ref: "#/getDefinitions/tenant"
55096 $ref: "#/getDefinitions/flavor"
55100 $ref: "#/getDefinitions/group-assignment"
55104 $ref: "#/getDefinitions/snapshot"
55108 $ref: "#/getDefinitions/image"
55112 $ref: "#/getDefinitions/dvs-switch"
55116 $ref: "#/getDefinitions/oam-network"
55117 availability-zones:
55120 $ref: "#/getDefinitions/availability-zone"
55124 $ref: "#/getDefinitions/relationship"
55125 esr-system-info-list:
55128 $ref: "#/getDefinitions/esr-system-info"
55129 vip-ipv4-address-list:
55132 $ref: "#/getDefinitions/vip-ipv4-address-list"
55133 vip-ipv6-address-list:
55136 $ref: "#/getDefinitions/vip-ipv6-address-list"
55142 $ref: "#/getDefinitions/cloud-region"
55145 Collection of physical locations that can house cloud-regions.
55146 ###### Related Nodes
55147 - TO l3-network( complex Uses l3-network, MANY2MANY)
55148 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
55149 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
55150 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
55151 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
55152 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
55153 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
55154 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
55155 - FROM vce( vce LocatedIn complex, MANY2MANY)
55156 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
55157 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
55158 - FROM zone( zone LocatedIn complex, MANY2ONE)
55160 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
55161 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
55164 - physical-location-id
55165 - physical-location-type
55172 physical-location-id:
55174 description: Unique identifier for physical location, e.g., CLLI
55177 description: Data center code which can be an alternate way to identify a complex
55180 description: Gamma complex name for LCP instance.
55183 description: URL of the keystone identity service
55186 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55187 physical-location-type:
55189 description: Type, e.g., central office, data center.
55215 $ref: "#/getDefinitions/ctag-pool"
55219 $ref: "#/getDefinitions/relationship"
55222 Collection of physical locations that can house cloud-regions.
55227 $ref: "#/getDefinitions/complex"
55230 Port Mirror Configuration.
55231 ###### Related Nodes
55232 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
55233 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
55234 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
55235 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
55236 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
55238 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
55239 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
55240 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
55243 - configuration-type
55244 - configuration-sub-type
55245 - orchestration-status
55246 - operational-status
55247 - configuration-selflink
55248 - model-customization-id
55252 description: UUID assigned to configuration.
55255 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
55256 configuration-name:
55258 description: Name of the configuration.
55259 configuration-type:
55261 description: port-mirroring-configuration.
55262 configuration-sub-type:
55264 description: vprobe, pprobe.
55265 model-invariant-id:
55267 description: the ASDC model id for this resource or service model.
55270 description: the ASDC model version for this resource or service model.
55271 orchestration-status:
55273 description: Orchestration status of the configuration.
55274 operational-status:
55276 description: Indicator for whether the resource is considered operational.
55277 configuration-selflink:
55279 description: URL to endpoint where AAI can get more details from SDN-GC.
55280 model-customization-id:
55282 description: id of the configuration used to customize the resource
55285 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55289 $ref: "#/getDefinitions/relationship"
55293 $ref: "#/getDefinitions/metadatum"
55296 Collection of configurations
55301 $ref: "#/getDefinitions/configuration"
55304 Collection of resource instances used to connect a variety of disparate inventory widgets
55305 ###### Related Nodes
55306 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
55307 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
55308 - FROM service-instance( service-instance Uses connector, MANY2MANY)
55310 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
55312 - resource-instance-id
55314 resource-instance-id:
55316 description: Unique id of resource instance.
55319 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55320 model-invariant-id:
55322 description: the ASDC model id for this resource or service model.
55325 description: the ASDC model version for this resource or service model.
55326 persona-model-version:
55328 description: the ASDC model version for this resource or service model.
55331 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55332 widget-model-version:
55334 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55338 $ref: "#/getDefinitions/relationship"
55342 $ref: "#/getDefinitions/metadatum"
55345 Collection of resource instances used to connect a variety of disparate inventory widgets
55350 $ref: "#/getDefinitions/connector"
55351 constrained-element-set:
55353 This is how we would capture constraints defining allowed sets of elements.
55354 ###### Related Nodes
55355 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
55356 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
55357 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
55359 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
55360 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
55362 - constrained-element-set-uuid
55366 constrained-element-set-uuid:
55374 element-choice-sets:
55377 $ref: "#/getDefinitions/element-choice-set"
55381 $ref: "#/getDefinitions/relationship"
55382 constrained-element-sets:
55384 constrained-element-set:
55387 $ref: "#/getDefinitions/constrained-element-set"
55390 ###### Related Nodes
55391 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
55392 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
55394 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
55404 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55408 $ref: "#/getDefinitions/relationship"
55414 $ref: "#/getDefinitions/ctag-assignment"
55417 A collection of C tags (vlan tags) grouped for a specific purpose.
55418 ###### Related Nodes
55419 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
55420 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
55421 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
55422 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
55424 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
55427 - availability-zone-name
55428 - ctag-pool-purpose
55432 description: The Target provider edge router
55433 availability-zone-name:
55435 description: Name of the availability zone
55438 description: Describes what the intended purpose of this pool is.
55441 description: Comma separated list of ctags
55444 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55448 $ref: "#/getDefinitions/relationship"
55454 $ref: "#/getDefinitions/ctag-pool"
55457 customer identifiers to provide linkage back to BSS information.
55458 ###### Related Nodes
55459 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
55461 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
55463 - global-customer-id
55467 global-customer-id:
55469 description: Global customer id used across ECOMP to uniquely identify customer.
55472 description: Subscriber name, an alternate way to retrieve a customer.
55475 description: Subscriber type, a way to provide VID with only the INFRA customers.
55478 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55479 service-subscriptions:
55482 $ref: "#/getDefinitions/service-subscription"
55486 $ref: "#/getDefinitions/relationship"
55489 Collection of customer identifiers to provide linkage back to BSS information.
55494 $ref: "#/getDefinitions/customer"
55502 description: See mis-na-virtualization-platform.yang
55505 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55509 $ref: "#/getDefinitions/relationship"
55515 $ref: "#/getDefinitions/cvlan-tag-entry"
55518 Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
55519 ###### Related Nodes
55520 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
55521 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
55529 description: DVS switch name
55532 description: URL used to reach the vcenter
55535 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55539 $ref: "#/getDefinitions/relationship"
55542 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
55547 $ref: "#/getDefinitions/dvs-switch"
55550 Internal map to define the properties of an edge and interpret the map EdgeRules
55566 edge-tag-query-request:
55577 $ref: "#/getDefinitions/start-node-filter"
55578 include-node-filter:
55581 $ref: "#/getDefinitions/include-node-filter"
55585 $ref: "#/getDefinitions/secondary-filter"
55586 edge-tag-query-result:
55588 tagged-inventory-item-list:
55591 $ref: "#/getDefinitions/tagged-inventory-item-list"
55592 element-choice-set:
55594 This is how we would capture constraints defining allowed sets of elements.
55595 ###### Related Nodes
55596 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
55597 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
55599 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
55600 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
55602 - element-choice-set-uuid
55603 - element-choice-set-name
55605 element-choice-set-uuid:
55607 element-choice-set-name:
55616 $ref: "#/getDefinitions/model-element"
55620 $ref: "#/getDefinitions/relationship"
55621 element-choice-sets:
55623 element-choice-set:
55626 $ref: "#/getDefinitions/element-choice-set"
55629 Metadata for entitlement group.
55630 ###### Related Nodes
55631 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
55632 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
55634 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
55641 description: Unique ID for the entitlement group the resource comes from, should be uuid.
55644 description: Unique ID of an entitlement resource.
55647 description: Concurrency value
55651 $ref: "#/getDefinitions/relationship"
55654 Entitlements, keyed by group-uuid and resource-uuid, related to license management
55659 $ref: "#/getDefinitions/entitlement"
55662 Persist EMS address information used by EMS driver.
55663 ###### Related Nodes
55664 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
55666 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
55672 description: Unique ID of EMS.
55675 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55676 esr-system-info-list:
55678 $ref: "#/getDefinitions/esr-system-info-list"
55681 $ref: "#/getDefinitions/relationship-list"
55687 $ref: "#/getDefinitions/esr-ems"
55690 Persist common address information of external systems.
55691 ###### Related Nodes
55692 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
55693 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
55694 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
55695 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
55697 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
55699 - esr-system-info-id
55704 esr-system-info-id:
55706 description: Unique ID of esr system info.
55709 description: name of external system.
55712 description: type of external systems.
55715 description: vendor of external systems.
55718 description: version of external systems.
55721 description: url used to access external systems.
55724 description: username used to access external systems.
55727 description: password used to access external systems.
55730 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
55733 description: protocol of third party SDNC, for example netconf/snmp.
55736 description: ca file content if enabled ssl on auth-url.
55739 description: Whether to verify VIM's certificate.
55742 description: service IP of ftp server.
55745 description: service port of ftp server.
55748 description: domain info for authentication.
55751 description: default tenant of VIM.
55754 description: ftp passive mode or not.
55757 description: resource or performance data file path.
55760 description: the status of external system.
55763 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55767 $ref: "#/getDefinitions/relationship"
55768 esr-system-info-list:
55770 Collection of persistent block-level external system auth info.
55775 $ref: "#/getDefinitions/esr-system-info"
55776 esr-thirdparty-sdnc:
55778 Persist SDNC address information used by ONAP SDNC.
55779 ###### Related Nodes
55780 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
55781 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
55783 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
55785 - thirdparty-sdnc-id
55787 thirdparty-sdnc-id:
55789 description: Unique ID of SDNC.
55792 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
55795 description: password used to access SDNC server.
55798 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55799 esr-system-info-list:
55801 $ref: "#/getDefinitions/esr-system-info-list"
55804 $ref: "#/getDefinitions/relationship-list"
55805 esr-thirdparty-sdnc-list:
55807 esr-thirdparty-sdnc:
55810 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
55813 Persist VNFM address information used by VF-C.
55814 ###### Related Nodes
55815 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
55817 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
55823 description: Unique ID of VNFM.
55826 description: indecate the VIM to deploy VNF.
55829 description: certificate url of VNFM.
55832 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55833 esr-system-info-list:
55835 $ref: "#/getDefinitions/esr-system-info-list"
55838 $ref: "#/getDefinitions/relationship-list"
55844 $ref: "#/getDefinitions/esr-vnfm"
55847 evc object is an optional child object of the Configuration object.
55848 ###### Related Nodes
55849 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
55851 -(4) IF this TO node is deleted, this EVC is DELETED also
55857 description: Unique/key field for the evc object
55858 forwarding-path-topology:
55860 description: Point-to-Point, Multi-Point
55863 description: Commited Information Rate
55866 description: CIR units
55867 connection-diversity-group-id:
55869 description: Diversity Group ID
55872 description: formerly Performance Group
55873 esp-evc-circuit-id:
55875 description: EVC Circuit ID of ESP EVC
55878 description: Committed Information Rate (For ESP)
55881 description: CIR units (For ESP)
55884 description: Identifies ESP
55885 collector-pop-clli:
55887 description: Collector POP CLLI (from the hostname of the access pnf)
55888 inter-connect-type-ingress:
55890 description: Interconnect type on ingress side of EVC.
55891 tagmode-access-ingress:
55893 description: tagode for collector side of EVC
55894 tagmode-access-egress:
55896 description: tagMode for network side of EVC
55900 $ref: "#/getDefinitions/relationship"
55903 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55909 $ref: "#/getDefinitions/evc"
55912 Namespace for external system.
55916 $ref: "#/getDefinitions/esr-ems-list"
55919 $ref: "#/getDefinitions/esr-vnfm-list"
55920 esr-thirdparty-sdnc-list:
55922 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
55925 Extra properties for inventory item for response list
55930 $ref: "#/getDefinitions/extra-property"
55940 ###### Related Nodes
55941 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
55942 - FROM vserver( vserver Uses flavor, MANY2ONE)
55944 -FLAVOR cannot be deleted if related to VSERVER
55953 description: Flavor id, expected to be unique across cloud-region.
55956 description: Flavor name
55960 description: Number of CPUs
55964 description: Amount of memory
55968 description: Disk space
55972 description: Amount of ephemeral disk space
55975 description: amount of swap space allocation
55978 description: whether flavor is available to all users or private to the tenant it was created in.
55981 description: URL to endpoint where AAI can get more details
55984 description: Boolean as to whether this flavor is no longer enabled
55987 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55991 $ref: "#/getDefinitions/relationship"
55994 Collection of openstack flavors.
55999 $ref: "#/getDefinitions/flavor"
56002 Entity describing a sequenced segment of forwarding path
56003 ###### Related Nodes
56004 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
56005 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
56006 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
56007 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
56008 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
56010 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
56011 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
56018 description: Unique ID of this segmentation
56021 description: ingress, intermediate, egress
56025 $ref: "#/getDefinitions/relationship"
56028 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56031 forwarder object is an optional child object of the Configuration object.
56032 ###### Related Nodes
56033 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
56035 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
56041 description: Key for forwarder-evc object
56044 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
56047 description: Internal VLAN.
56050 description: SVLAN value for ingress of egress forwarder.
56053 description: CVLAN value for ingress of egress forwarder.
56057 $ref: "#/getDefinitions/relationship"
56060 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56066 $ref: "#/getDefinitions/forwarder-evc"
56072 $ref: "#/getDefinitions/forwarder"
56075 Entity that describes the sequenced forwarding path between interfaces of services or resources
56076 ###### Related Nodes
56077 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
56078 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
56079 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
56081 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
56082 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
56083 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
56085 - forwarding-path-id
56086 - forwarding-path-name
56088 forwarding-path-id:
56090 description: Unique ID of this FP
56091 forwarding-path-name:
56093 description: Name of the FP
56097 $ref: "#/getDefinitions/relationship"
56100 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56103 description: the self link for this FP
56107 $ref: "#/getDefinitions/forwarder"
56113 $ref: "#/getDefinitions/forwarding-path"
56116 General purpose VNF
56117 ###### Related Nodes
56118 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
56119 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
56120 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
56121 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
56122 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
56123 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
56124 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
56125 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
56126 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
56127 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
56128 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
56129 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
56130 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
56131 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
56132 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
56133 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
56134 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
56135 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
56136 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
56137 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
56138 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
56139 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
56140 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
56141 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
56142 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
56143 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
56144 - FROM platform( platform Uses generic-vnf, MANY2MANY)
56146 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
56147 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
56153 - is-closed-loop-disabled
56157 description: Unique id of VNF. This is unique across the graph.
56160 description: vnf instance id.
56163 description: Name of VNF.
56166 description: Alternate name of VNF.
56169 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56172 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
56173 regional-resource-zone:
56175 description: Regional way of organizing pservers, source of truth should define values
56178 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56179 operational-status:
56181 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
56184 description: OBSOLETE - do not use
56187 description: Client should send valid enumerated value
56188 orchestration-status:
56190 description: Orchestration status of this VNF, used by MSO.
56193 vnf-discriptor-name:
56195 description: vnf discriptor name
56198 description: job id corresponding to vnf
56201 description: Heat stack id corresponding to this instance, managed by MSO
56204 description: Corresponds to the SDN-C catalog id used to configure this VCE
56207 description: identifier of managed by ATT or customer
56210 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
56211 ipv4-loopback0-address:
56213 description: v4 Loopback0 address
56216 description: v6 Loopback address
56217 management-v6-address:
56219 description: v6 management address
56223 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
56226 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
56230 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
56233 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
56237 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
56240 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
56244 description: number of associated SHD in vnf.
56248 description: number of vms in vnf.
56252 description: number of network in vnf.
56255 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
56256 is-closed-loop-disabled:
56258 description: used to indicate whether closed loop function is enabled on this node
56261 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56264 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
56265 encrypted-access-flag:
56267 description: indicates whether generic-vnf access uses SSH
56268 entitlement-assignment-group-uuid:
56270 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
56271 entitlement-resource-uuid:
56273 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
56274 license-assignment-group-uuid:
56276 description: UUID of the license assignment group. OBSOLETE - See child relationships.
56279 description: UUID of the actual license resource. OBSOLETE - See child relationships.
56280 model-invariant-id:
56282 description: the ASDC model id for this resource or service model.
56285 description: the ASDC model version for this resource or service model.
56286 persona-model-version:
56288 description: the ASDC model version for this resource or service model.
56289 model-customization-id:
56291 description: captures the id of all the configuration used to customize the resource for the service.
56294 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56295 widget-model-version:
56297 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56300 description: as-number of the VNF
56301 regional-resource-subzone:
56303 description: represents sub zone of the rr plane
56306 description: Generic description of the type of NF
56309 description: English description of Network function that the specific VNF deployment is providing
56312 description: role in the network that this model will be providing
56315 description: string assigned to this model used for naming purposes
56318 description: Path to the controller object.
56319 ipv4-oam-gateway-address:
56321 description: Gateway address
56322 ipv4-oam-gateway-address-prefix-length:
56325 description: Prefix length for oam-address
56329 description: Temporary location for S-TAG to get to VCE
56332 description: Network Management profile of this VNF
56336 $ref: "#/getDefinitions/relationship"
56340 $ref: "#/getDefinitions/l-interface"
56344 $ref: "#/getDefinitions/lag-interface"
56348 $ref: "#/getDefinitions/vf-module"
56352 $ref: "#/getDefinitions/license"
56356 $ref: "#/getDefinitions/entitlement"
56364 $ref: "#/getDefinitions/generic-vnf"
56367 Openstack group-assignment used to store exclusivity groups (EG).
56368 ###### Related Nodes
56369 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
56370 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
56371 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
56380 description: Group id, expected to be unique across cloud-region.
56383 description: Group type - the type of group this instance refers to
56386 description: Group name - name assigned to the group
56389 description: Group description - description of the group
56392 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56396 $ref: "#/getDefinitions/relationship"
56399 Collection of openstack group assignments
56404 $ref: "#/getDefinitions/group-assignment"
56407 ###### Related Nodes
56408 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
56410 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
56418 description: host-route id
56421 description: subnet prefix
56424 description: Could be ip-address, hostname, or service-instance
56427 description: Should be ip-address, hostname, or service-instance to match next-hop
56430 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56434 $ref: "#/getDefinitions/relationship"
56440 $ref: "#/getDefinitions/host-route"
56443 Collection of HPA Capabilities
56448 $ref: "#/getDefinitions/hpa-capability"
56451 Represents a HPA capability
56452 ###### Related Nodes
56453 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
56454 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
56455 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
56457 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
56459 - hpa-capability-id
56464 description: UUID to uniquely identify a HPA capability
56467 description: Name of the HPACapability
56470 description: HPA schema version
56473 description: Hardware architecture
56476 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56480 $ref: "#/getDefinitions/relationship"
56481 hpa-feature-attributes:
56484 $ref: "#/getDefinitions/hpa-feature-attributes"
56485 hpa-feature-attributes:
56487 HPA Capability Feature attributes
56488 ###### Related Nodes
56489 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
56491 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
56493 - hpa-attribute-key
56497 description: name of the specific HPA attribute
56498 hpa-attribute-value:
56500 description: JSON string specifying the value, unit and type of the specific HPA attribute
56503 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56507 $ref: "#/getDefinitions/relationship"
56511 ###### Related Nodes
56512 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
56513 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
56514 - FROM vserver( vserver Uses image, MANY2ONE)
56516 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
56517 -IMAGE cannot be deleted if related to VSERVER
56528 description: Image id, expected to be unique across cloud region
56531 description: Image name
56532 image-architecture:
56534 description: Operating system architecture.
56537 description: The common name of the operating system distribution in lowercase
56540 description: The operating system version as specified by the distributor.
56543 description: The application that the image instantiates.
56544 application-vendor:
56546 description: The vendor of the application.
56547 application-version:
56549 description: The version of the application.
56552 description: URL to endpoint where AAI can get more details
56555 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56559 $ref: "#/getDefinitions/relationship"
56563 $ref: "#/getDefinitions/metadatum"
56566 Collectio of Openstack images.
56571 $ref: "#/getDefinitions/image"
56572 include-node-filter:
56578 InstanceFilter for performing a named-query or model query
56581 InstanceFilters for performing a named-query or model query
56586 $ref: "#/getDefinitions/instance-filter"
56589 General mechanism for grouping instances
56590 ###### Related Nodes
56591 - TO model( instance-group Targets model, MANY2MANY)
56592 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
56593 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
56594 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
56595 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
56596 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
56597 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
56598 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
56599 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
56600 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
56601 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
56602 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
56609 instance-group-role:
56611 description: role of the instance group.
56612 model-invariant-id:
56614 description: ASDC model id for this resource or service model.
56617 description: ASDC model version uid for this resource model.
56620 description: Instance Group ID, UUID assigned to this instance.
56623 description: Descriptive text to help identify the usage of this instance-group
56626 description: Only valid value today is lower case ha for high availability
56629 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
56632 description: Concurrency value
56636 $ref: "#/getDefinitions/relationship"
56639 Collection of openstack route table references
56644 $ref: "#/getDefinitions/instance-group"
56649 $ref: "#/getDefinitions/search"
56652 $ref: "#/getDefinitions/actions"
56653 cloud-infrastructure:
56655 $ref: "#/getDefinitions/cloud-infrastructure"
56658 $ref: "#/getDefinitions/external-system"
56661 $ref: "#/getDefinitions/business"
56662 service-design-and-creation:
56664 $ref: "#/getDefinitions/service-design-and-creation"
56667 $ref: "#/getDefinitions/network"
56670 $ref: "#/getDefinitions/nodes"
56673 inventory-item-type:
56675 inventory-item-link:
56677 inventory-item-data:
56680 $ref: "#/getDefinitions/inventory-item-data"
56681 tagged-inventory-item-list:
56684 $ref: "#/getDefinitions/tagged-inventory-item-list"
56685 inventory-item-data:
56691 inventory-response-item:
56693 Inventory item for response list
56699 $ref: "#/getDefinitions/extra-properties"
56700 inventory-response-items:
56702 $ref: "#/getDefinitions/inventory-response-items"
56703 inventory-response-items:
56705 Container for inventory items in response list
56707 inventory-response-item:
56710 $ref: "#/getDefinitions/inventory-response-item"
56711 ipsec-configuration:
56713 IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
56714 ###### Related Nodes
56715 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
56716 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
56718 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
56720 - ipsec-configuration-id
56722 ipsec-configuration-id:
56724 description: UUID of this configuration
56725 requested-vig-address-type:
56727 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
56728 requested-encryption-strength:
56730 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
56731 requested-dmz-type:
56733 description: ATT can offer a shared DMZ or a DMZ specific to a customer
56734 shared-dmz-network-address:
56736 description: Network address of shared DMZ
56737 requested-customer-name:
56739 description: If the DMZ is a custom DMZ, this field will indicate the customer information
56742 description: can be 1 or 2
56743 ikev1-authentication:
56745 description: Contains values like md5, sha1, sha256, sha384
56748 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
56751 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
56754 description: Group name defined in VIG for clients using aggressive mode
56757 description: pre-shared key for the above group name
56760 description: Lifetime for IKEv1 SA
56761 ipsec-authentication:
56763 description: md5, sha1, sha256, sha384
56766 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
56769 description: Life time for IPSec SA
56772 description: enable PFS or not
56775 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
56776 xauth-user-password:
56778 description: Encrypted using the Juniper $9$ algorithm
56781 description: The time between DPD probe
56784 description: Maximum number of DPD before claiming the tunnel is down
56787 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56791 $ref: "#/getDefinitions/relationship"
56795 $ref: "#/getDefinitions/vig-server"
56796 ipsec-configurations:
56798 ipsec-configuration:
56801 $ref: "#/getDefinitions/ipsec-configuration"
56810 Logical interfaces, e.g., a vnic.
56811 ###### Related Nodes
56812 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
56813 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
56814 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
56815 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
56816 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
56817 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
56818 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
56819 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
56820 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
56821 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
56822 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
56823 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
56824 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
56825 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
56827 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
56828 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
56829 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
56838 description: Name given to the interface
56841 description: E.g., CUSTOMER, UPLINK, etc.
56844 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
56847 description: URL to endpoint where AAI can get more details
56850 description: ID of interface
56853 description: MAC address for the interface
56856 description: Name of the network
56859 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
56860 interface-description:
56862 description: Human friendly text regarding this interface.
56865 description: boolean indicatating whether or not port is a mirrored.
56868 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56871 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
56874 description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
56877 description: Flag indicating the interface uses the IP Unnumbered configuration.
56878 allowed-address-pairs:
56880 description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
56884 $ref: "#/getDefinitions/vlan"
56888 $ref: "#/getDefinitions/sriov-vf"
56892 $ref: "#/getDefinitions/l-interface"
56896 $ref: "#/getDefinitions/relationship"
56897 l3-interface-ipv4-address-list:
56900 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
56901 l3-interface-ipv6-address-list:
56904 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
56907 Collection of logical interfaces.
56912 $ref: "#/getDefinitions/l-interface"
56913 l3-interface-ipv4-address-list:
56916 ###### Related Nodes
56917 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
56918 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
56919 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
56920 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
56921 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
56922 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
56924 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
56926 - l3-interface-ipv4-address
56928 l3-interface-ipv4-address:
56930 description: IP address
56931 l3-interface-ipv4-prefix-length:
56934 description: Prefix length, 32 for single address
56938 description: Inner VLAN tag
56942 description: Outer VLAN tag
56945 description: Indicator of fixed or floating address
56948 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56949 neutron-network-id:
56951 description: Neutron network id of the interface that address belongs to
56954 description: Neutron id of subnet that address belongs to
56958 $ref: "#/getDefinitions/relationship"
56959 l3-interface-ipv6-address-list:
56962 ###### Related Nodes
56963 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
56964 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
56965 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
56966 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
56967 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
56968 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
56970 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
56972 - l3-interface-ipv6-address
56974 l3-interface-ipv6-address:
56976 description: IP address
56977 l3-interface-ipv6-prefix-length:
56980 description: Prefix length, 128 for single address
56984 description: Inner VLAN tag
56988 description: Outer VLAN tag
56991 description: Indicator of fixed or floating address
56994 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56995 neutron-network-id:
56997 description: Neutron network id of the interface that address belongs to
57000 description: Neutron id of subnet that address belongs to
57004 $ref: "#/getDefinitions/relationship"
57007 Generic network definition
57008 ###### Related Nodes
57009 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
57010 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
57011 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
57012 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
57013 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
57014 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
57015 - FROM complex( complex Uses l3-network, MANY2MANY)
57016 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
57017 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
57018 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
57019 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
57020 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
57021 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
57022 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
57023 - FROM tenant( tenant Uses l3-network, MANY2MANY)
57024 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
57026 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
57031 - is-provider-network
57032 - is-shared-network
57033 - is-external-network
57037 description: Network ID, should be uuid. Unique across A&AI.
57040 description: Name of the network, governed by some naming convention..
57043 description: Type of the network - who defines these values?
57046 description: Role the network plans - who defines these values?
57047 network-technology:
57049 description: Network technology - who defines these values?
57050 neutron-network-id:
57052 description: Neutron network id of this Interface
57055 description: Set to true if bound to VPN
57058 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
57059 network-role-instance:
57062 description: network role instance
57065 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57066 orchestration-status:
57068 description: Orchestration status of this VNF, mastered by MSO
57071 description: Heat stack id corresponding to this instance, managed by MSO
57074 description: Corresponds to the SDN-C catalog id used to configure this VCE
57075 contrail-network-fqdn:
57077 description: Contrail FQDN for the network
57078 model-invariant-id:
57080 description: the ASDC model id for this resource or service model.
57083 description: the ASDC model version for this resource or service model.
57084 persona-model-version:
57086 description: the ASDC model version for this resource or service model.
57087 model-customization-id:
57089 description: captures the id of all the configuration used to customize the resource for the service.
57092 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57093 widget-model-version:
57095 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57096 physical-network-name:
57098 description: Name associated with the physical network.
57099 is-provider-network:
57101 description: boolean indicatating whether or not network is a provider network.
57104 description: boolean indicatating whether or not network is a shared network.
57105 is-external-network:
57107 description: boolean indicatating whether or not network is an external network.
57110 description: Path to the controller object.
57111 operational-status:
57113 description: Indicator for whether the resource is considered operational.
57117 $ref: "#/getDefinitions/subnet"
57121 $ref: "#/getDefinitions/ctag-assignment"
57122 segmentation-assignments:
57125 $ref: "#/getDefinitions/segmentation-assignment"
57129 $ref: "#/getDefinitions/relationship"
57130 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
57136 $ref: "#/getDefinitions/l3-network"
57139 Link aggregate interface
57140 ###### Related Nodes
57141 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
57142 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
57143 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
57144 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
57145 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
57146 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
57147 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
57148 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
57150 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
57151 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
57152 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
57159 description: Name that identifies the link aggregate interface
57160 interface-description:
57162 description: Human friendly text regarding this interface.
57165 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57168 description: Captures the numeric part of the speed
57171 description: Captures the units corresponding to the speed
57174 description: ID of interface
57177 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
57180 description: Trigger for operational monitoring of this resource by Service Assurance systems.
57183 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
57187 $ref: "#/getDefinitions/relationship"
57191 $ref: "#/getDefinitions/l-interface"
57194 Collection of link aggregate interfaces.
57199 $ref: "#/getDefinitions/lag-interface"
57202 LAG links can connect lag-interfaces
57203 ###### Related Nodes
57204 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
57205 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
57207 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
57213 description: Alphabetical concatenation of lag-interface names
57216 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57220 $ref: "#/getDefinitions/relationship"
57223 Collection of link aggregation connections
57228 $ref: "#/getDefinitions/lag-link"
57231 Metadata for license group.
57232 ###### Related Nodes
57233 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
57234 - TO vce( license BelongsTo vce, MANY2ONE)(4)
57236 -(4) IF this TO node is deleted, this LICENSE is DELETED also
57243 description: Unique ID for the license group the resource belongs to, should be uuid.
57246 description: Unique ID of a license resource.
57249 description: Concurrency value
57253 $ref: "#/getDefinitions/relationship"
57256 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
57261 $ref: "#/getDefinitions/license"
57264 describes a line-of-business
57265 ###### Related Nodes
57266 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
57269 - line-of-business-name
57271 line-of-business-name:
57273 description: Name of the line-of-business (product)
57276 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57280 $ref: "#/getDefinitions/relationship"
57283 Collection of lines-of-business
57288 $ref: "#/getDefinitions/line-of-business"
57291 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
57292 ###### Related Nodes
57293 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
57294 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
57295 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
57296 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
57297 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
57298 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
57299 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
57300 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
57301 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
57302 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
57303 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
57304 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
57305 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
57306 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
57307 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
57309 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
57317 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
57320 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
57323 description: Type of logical link, e.g., evc
57326 description: Captures the numeric part of the speed
57329 description: Captures the units corresponding to the speed
57332 description: v4, v6, or ds for dual stack
57335 description: For example, static or BGP
57338 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57339 model-invariant-id:
57341 description: the ASDC model id for this resource or service model.
57344 description: the ASDC model version for this resource or service model.
57345 persona-model-version:
57347 description: the ASDC model version for this resource or service model.
57350 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57351 widget-model-version:
57353 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57354 operational-status:
57356 description: Indication of operational status of the logical link.
57359 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57362 description: Indication of the network use of the logical link.
57365 description: Alias or alternate name (CLCI or D1 name).
57368 description: UUID of the logical-link, SDNC generates this.
57371 description: Circuit id
57374 description: Reason for this entity, role it is playing
57378 $ref: "#/getDefinitions/relationship"
57381 Collection of logical connections
57386 $ref: "#/getDefinitions/logical-link"
57389 Collection of metadatum (key/value pairs)
57394 $ref: "#/getDefinitions/metadatum"
57398 ###### Related Nodes
57399 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
57400 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
57401 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
57402 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
57403 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
57405 -(4) IF this TO node is deleted, this METADATUM is DELETED also
57416 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57419 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
57420 ###### Related Nodes
57421 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
57422 - FROM instance-group( instance-group Targets model, MANY2MANY)
57423 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
57424 - FROM named-query( named-query AppliesTo model, ONE2MANY)
57425 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
57427 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
57428 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
57431 - model-invariant-id
57434 model-invariant-id:
57436 description: Unique identifier corresponding to the main definition of a model in ASDC
57439 description: Type of the model, e.g., service, resource, widget, etc.
57442 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57446 $ref: "#/getDefinitions/model-ver"
57450 $ref: "#/getDefinitions/relationship"
57451 model-and-named-query-search:
57453 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
57457 $ref: "#/getDefinitions/query-parameters"
57460 $ref: "#/getDefinitions/instance-filters"
57463 $ref: "#/getDefinitions/secondary-filts"
57466 secondary-filter-cut-point:
57470 This is how we would capture constraints defining allowed sets of elements.
57471 ###### Related Nodes
57472 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
57473 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
57475 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
57476 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
57478 - model-constraint-uuid
57479 - constrained-element-set-uuid-to-replace
57481 model-constraint-uuid:
57483 constrained-element-set-uuid-to-replace:
57485 constrained-element-sets:
57488 $ref: "#/getDefinitions/constrained-element-set"
57491 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57497 $ref: "#/getDefinitions/model-constraint"
57500 Defines how other models combine to make up a higher-level model.
57501 ###### Related Nodes
57502 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
57503 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
57504 - TO model-ver( model-element IsA model-ver, MANY2ONE)
57505 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
57506 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
57507 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
57508 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
57510 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
57511 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
57513 - model-element-uuid
57514 - new-data-del-flag
57517 model-element-uuid:
57521 description: Indicates whether this element was created as part of instantiation from this model
57524 description: How many of this type of element are required/allowed
57529 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57533 $ref: "#/getDefinitions/model-element"
57534 description: Defines how other models combine to make up a higher-level model
57538 $ref: "#/getDefinitions/model-constraint"
57539 description: Describes new constraints on this model element that are not part of that model's definition
57543 $ref: "#/getDefinitions/relationship"
57549 $ref: "#/getDefinitions/model-element"
57552 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
57553 ###### Related Nodes
57554 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
57555 - FROM model-element( model-element IsA model-ver, MANY2ONE)
57556 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
57557 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
57559 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
57560 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
57561 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
57570 description: Unique identifier corresponding to one version of a model in ASDC
57573 description: Name of the model, which can change from version to version.
57576 description: Version
57579 description: Description
57582 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57586 $ref: "#/getDefinitions/model-element"
57590 $ref: "#/getDefinitions/metadatum"
57594 $ref: "#/getDefinitions/relationship"
57600 $ref: "#/getDefinitions/model-ver"
57603 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
57608 $ref: "#/getDefinitions/model"
57609 multicast-configuration:
57611 ###### Related Nodes
57612 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
57615 - multicast-configuration-id
57616 - multicast-protocol
57619 multicast-configuration-id:
57621 description: Unique id of multicast configuration.
57622 multicast-protocol:
57624 description: protocol of multicast configuration
57627 description: rp type of multicast configuration
57630 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57634 $ref: "#/getDefinitions/relationship"
57635 multicast-configurations:
57637 multicast configuration of generic-vnf ip-address
57639 multicast-configuration:
57642 $ref: "#/getDefinitions/multicast-configuration"
57648 $ref: "#/getDefinitions/named-query"
57652 ###### Related Nodes
57653 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
57654 - TO model( named-query AppliesTo model, ONE2MANY)
57655 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
57657 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
57661 - named-query-version
57667 named-query-version:
57669 required-input-param:
57675 named-query-elements:
57678 $ref: "#/getDefinitions/named-query-element"
57682 $ref: "#/getDefinitions/relationship"
57683 named-query-element:
57686 ###### Related Nodes
57687 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
57688 - TO model( named-query-element IsA model, MANY2ONE)
57689 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
57690 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
57691 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
57692 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
57694 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
57695 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
57697 - named-query-element-uuid
57699 named-query-element-uuid:
57701 property-collect-list:
57705 property-limit-desc:
57709 named-query-elements:
57712 $ref: "#/getDefinitions/named-query-element"
57716 $ref: "#/getDefinitions/related-lookup"
57717 property-constraints:
57720 $ref: "#/getDefinitions/property-constraint"
57724 $ref: "#/getDefinitions/relationship"
57725 named-query-elements:
57727 named-query-element:
57730 $ref: "#/getDefinitions/named-query-element"
57733 Namespace for network inventory resources.
57738 $ref: "#/getDefinitions/logical-link"
57742 $ref: "#/getDefinitions/site-pair-set"
57746 $ref: "#/getDefinitions/vpn-binding"
57750 $ref: "#/getDefinitions/vpls-pe"
57751 multicast-configurations:
57754 $ref: "#/getDefinitions/multicast-configuration"
57758 $ref: "#/getDefinitions/vce"
57762 $ref: "#/getDefinitions/vnfc"
57766 $ref: "#/getDefinitions/l3-network"
57770 $ref: "#/getDefinitions/network-policy"
57774 $ref: "#/getDefinitions/generic-vnf"
57778 $ref: "#/getDefinitions/lag-link"
57782 $ref: "#/getDefinitions/newvce"
57786 $ref: "#/getDefinitions/pnf"
57790 $ref: "#/getDefinitions/physical-link"
57791 ipsec-configurations:
57794 $ref: "#/getDefinitions/ipsec-configuration"
57795 route-table-references:
57798 $ref: "#/getDefinitions/route-table-reference"
57802 $ref: "#/getDefinitions/instance-group"
57806 $ref: "#/getDefinitions/zone"
57810 $ref: "#/getDefinitions/configurations"
57816 $ref: "#/getDefinitions/network-policy"
57819 ###### Related Nodes
57820 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
57821 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
57824 - network-policy-id
57828 description: UUID representing unique key to this instance
57829 network-policy-fqdn:
57831 description: Contrail FQDN for the policy
57834 description: ID for the openStack Heat instance
57837 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57841 $ref: "#/getDefinitions/relationship"
57844 Network profile populated by SDN-GP for SNMP
57845 ###### Related Nodes
57846 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
57853 description: Unique name of network profile.
57856 description: Encrypted SNMP community string
57859 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57863 $ref: "#/getDefinitions/relationship"
57866 Collection of network profiles
57871 $ref: "#/getDefinitions/network-profile"
57874 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
57875 ###### Related Nodes
57876 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
57878 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
57886 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
57889 description: Name of VNF.
57892 description: Alternate name of VNF.
57895 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
57898 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57899 operational-status:
57901 description: Indicator for whether the resource is considered operational
57904 description: OBSOLETE - do not use
57907 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
57910 description: Client should send valid enumerated value.
57913 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57914 ipv4-loopback0-address:
57916 description: v4 Loopback0 address
57917 orchestration-status:
57919 description: Orchestration status of this VNF, mastered by MSO.
57922 description: Heat stack id corresponding to this instance, managed by MSO
57925 description: Corresponds to the SDN-C catalog id used to configure this VCE
57929 $ref: "#/getDefinitions/relationship"
57933 $ref: "#/getDefinitions/l-interface"
57936 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
57941 $ref: "#/getDefinitions/newvce"
57944 inventory-item-data:
57947 $ref: "#/getDefinitions/inventory-item-data"
57948 notification-event:
57952 notification-event-header:
57954 $ref: "#/getDefinitions/notification-event-header"
57955 notification-event-header:
57996 $ref: "#/getDefinitions/key-data"
58001 OAM network, to be deprecated shortly. Do not use for new purposes.
58002 ###### Related Nodes
58003 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
58004 - TO complex( oam-network AppliesTo complex, MANY2MANY)
58005 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
58014 description: UUID of the network. Unique across a cloud-region
58017 description: Name of the network.
58021 description: cvlan-id
58022 ipv4-oam-gateway-address:
58024 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
58025 ipv4-oam-gateway-address-prefix-length:
58028 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
58031 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58035 $ref: "#/getDefinitions/relationship"
58038 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
58043 $ref: "#/getDefinitions/oam-network"
58044 operational-environment:
58046 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
58047 ###### Related Nodes
58048 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
58049 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
58052 - operational-environment-id
58053 - operational-environment-name
58054 - operational-environment-type
58055 - operational-environment-status
58059 operational-environment-id:
58061 description: UUID of an operational environment
58062 operational-environment-name:
58064 description: Operational Environment name
58065 operational-environment-type:
58067 description: Operational Environment Type.
58068 operational-environment-status:
58070 description: Status
58073 description: Tenant Context.
58076 description: Workload Context.
58079 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58083 $ref: "#/getDefinitions/relationship"
58084 operational-environments:
58086 a logical partition of the cloud which allows to have multiple environments in the production AIC.
58088 operational-environment:
58091 $ref: "#/getDefinitions/operational-environment"
58094 Allows for legacy POST of old-style and new-style models
58096 - model-invariant-id
58097 - model-name-version-id
58103 model-invariant-id:
58105 description: Unique identifier corresponding to the main definition of a model in ASDC
58106 model-name-version-id:
58108 description: Unique identifier corresponding to one version of a model in ASDC
58111 description: Type of the model, e.g., service, resource, widget, etc.
58114 description: Name of the model, which can change from version to version.
58117 description: Invariant unique ID which does not change from version to version
58120 description: Version
58123 description: Description
58126 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58129 $ref: "#/getDefinitions/model-vers"
58132 $ref: "#/getDefinitions/relationship-list"
58135 Collection of owning-entities
58140 $ref: "#/getDefinitions/owning-entity"
58143 describes an owning-entity
58144 ###### Related Nodes
58145 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
58149 - owning-entity-name
58153 description: UUID of an owning entity
58154 owning-entity-name:
58156 description: Owning entity name
58159 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58163 $ref: "#/getDefinitions/relationship"
58166 Physical interface (e.g., nic)
58167 ###### Related Nodes
58168 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
58169 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
58170 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
58171 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
58172 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
58173 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
58174 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
58175 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
58177 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
58178 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
58179 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
58186 description: Name that identifies the physical interface
58189 description: Captures the numeric part of the speed
58192 description: Captures the units corresponding to the speed
58195 description: Nature of the services and connectivity on this port.
58196 equipment-identifier:
58198 description: CLEI or other specification for p-interface hardware.
58201 description: Role specification for p-interface hardware.
58204 description: Indicates the physical properties of the interface.
58207 description: Trigger for operational monitoring of this resource by Service Assurance systems.
58210 description: MAC Address of the p-interface.
58213 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58216 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
58219 description: inventory status
58223 $ref: "#/getDefinitions/relationship"
58227 $ref: "#/getDefinitions/sriov-pf"
58231 $ref: "#/getDefinitions/l-interface"
58234 Collection of physical interfaces.
58239 $ref: "#/getDefinitions/p-interface"
58242 Collection of physical connections, typically between p-interfaces
58243 ###### Related Nodes
58244 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
58246 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
58252 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
58255 description: Captures the numeric part of the speed
58258 description: Captures the units corresponding to the speed
58261 description: Circuit it
58264 description: Dual access mode (e.g., primary, secondary
58267 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
58268 service-provider-name:
58270 description: Name of the service Provider on this link.
58271 service-provider-bandwidth-up-value:
58274 description: Upstream Bandwidth value agreed with the service provider
58275 service-provider-bandwidth-up-units:
58277 description: Units for the upstream BW value
58278 service-provider-bandwidth-down-value:
58281 description: Downstream Bandwidth value agreed with the service provider
58282 service-provider-bandwidth-down-units:
58284 description: Units for downstream BW value
58287 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58291 $ref: "#/getDefinitions/relationship"
58294 Collection of physical connections, typically between p-interfaces
58299 $ref: "#/getDefinitions/physical-link"
58302 describes a platform
58303 ###### Related Nodes
58304 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
58311 description: Name of the platform
58314 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58318 $ref: "#/getDefinitions/relationship"
58321 Collection of platforms
58326 $ref: "#/getDefinitions/platform"
58329 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
58330 ###### Related Nodes
58331 - TO complex( pnf LocatedIn complex, MANY2ONE)
58332 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
58333 - TO zone( pnf LocatedIn zone, MANY2ONE)
58334 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
58335 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
58336 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
58337 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
58338 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
58339 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
58341 -(1) IF this PNF node is deleted, this FROM node is DELETED also
58348 description: unique name of Physical Network Function.
58351 description: name of Physical Network Function.
58354 description: source of name2
58357 description: id of pnf
58360 description: Equipment type. Source of truth should define valid values.
58363 description: Equipment vendor. Source of truth should define valid values.
58366 description: Equipment model. Source of truth should define valid values.
58369 description: identifier of managed by ATT or customer
58372 description: ipv4-oam-address with new naming convention for IP addresses
58375 description: sw-version is the version of SW for the hosted application on the PNF.
58378 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
58381 description: ID of the physical frame (relay rack) where pnf is installed.
58384 description: Serial number of the device
58385 ipaddress-v4-loopback-0:
58387 description: IPV4 Loopback 0 address
58388 ipaddress-v6-loopback-0:
58390 description: IPV6 Loopback 0 address
58393 description: IPV4 AIM address
58396 description: IPV6 AIM address
58399 description: IPV6 OAM address
58402 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
58405 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58408 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
58411 description: Nf Role is the role performed by this instance in the network.
58415 $ref: "#/getDefinitions/relationship"
58419 $ref: "#/getDefinitions/p-interface"
58423 $ref: "#/getDefinitions/lag-interface"
58426 Collection of Physical Network Functions.
58431 $ref: "#/getDefinitions/pnf"
58434 Used to capture the network interfaces of this VCE
58435 ###### Related Nodes
58436 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
58437 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
58439 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
58440 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
58443 - orchestration-status
58447 description: Unique ID of the interface
58448 neutron-network-id:
58450 description: Neutron network id of this Interface
58451 neutron-network-name:
58453 description: Neutron network name of this Interface
58456 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
58459 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58462 description: Unique ID for port group in vmware
58465 description: Likely to duplicate value of neutron network name
58468 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
58469 orchestration-status:
58471 description: Orchestration status of this VNF, mastered by MSO
58474 description: Heat stack id corresponding to this instance, managed by MSO
58477 description: Corresponds to the SDN-C catalog id used to configure this VCE
58481 $ref: "#/getDefinitions/cvlan-tag-entry"
58485 $ref: "#/getDefinitions/relationship"
58491 $ref: "#/getDefinitions/port-group"
58494 describes the project
58495 ###### Related Nodes
58496 - TO service-instance( project Uses service-instance, ONE2MANY)
58503 description: Name of the project deploying a service
58506 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58510 $ref: "#/getDefinitions/relationship"
58513 Collection of projects
58518 $ref: "#/getDefinitions/project"
58521 Property holder for query properties or instance properties
58527 property-constraint:
58530 ###### Related Nodes
58531 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
58533 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
58535 - property-constraint-uuid
58540 property-constraint-uuid:
58550 property-constraints:
58552 property-constraint:
58555 $ref: "#/getDefinitions/property-constraint"
58558 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
58559 ###### Related Nodes
58560 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
58561 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
58562 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
58563 - TO complex( pserver LocatedIn complex, MANY2ONE)
58564 - TO zone( pserver LocatedIn zone, MANY2ONE)
58565 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
58566 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
58567 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
58568 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
58569 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
58571 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
58572 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
58580 description: Value from executing hostname on the compute node.
58583 description: PTNII name
58587 description: Number of cpus
58591 description: Disk size, in GBs
58595 description: RAM size, in MBs
58598 description: Equipment type. Source of truth should define valid values.
58601 description: Equipment vendor. Source of truth should define valid values.
58604 description: Equipment model. Source of truth should define valid values.
58607 description: Fully-qualified domain name
58610 description: URL to endpoint where AAI can get more details
58613 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
58616 description: Serial number, may be queried
58617 ipaddress-v4-loopback-0:
58619 description: IPV4 Loopback 0 address
58620 ipaddress-v6-loopback-0:
58622 description: IPV6 Loopback 0 address
58625 description: IPV4 AIM address
58628 description: IPV6 AIM address
58631 description: IPV6 OAM address
58634 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
58637 description: ID of Pserver
58640 description: internet topology of Pserver
58643 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
58646 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58649 description: alternative pserver name
58652 description: purpose of pserver
58655 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
58658 description: Indicates who owns and or manages the device.
58661 description: The host profile that defines the configuration of the pserver.
58665 $ref: "#/getDefinitions/relationship"
58669 $ref: "#/getDefinitions/p-interface"
58673 $ref: "#/getDefinitions/lag-interface"
58676 Collection of compute hosts.
58681 $ref: "#/getDefinitions/pserver"
58684 QueryParameters for performing a named-query or model query
58688 $ref: "#/getDefinitions/named-query"
58691 $ref: "#/getDefinitions/overloaded-model"
58695 ###### Related Nodes
58696 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
58698 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
58700 - related-lookup-uuid
58702 - source-node-property
58704 - target-node-property
58706 related-lookup-uuid:
58710 source-node-property:
58714 target-node-property:
58716 property-collect-list:
58723 $ref: "#/getDefinitions/relationship"
58729 $ref: "#/getDefinitions/related-lookup"
58730 related-to-property:
58734 description: Key part of a key/value pair
58737 description: Value part of a key/value pair
58742 description: A keyword provided by A&AI to indicate type of node.
58745 description: URL to the object in A&AI.
58749 $ref: "#/getDefinitions/relationship-data"
58750 related-to-property:
58753 $ref: "#/getDefinitions/related-to-property"
58757 - relationship-value
58761 description: A keyword provided by A&AI to indicate an attribute.
58762 relationship-value:
58764 description: Value of the attribute.
58770 $ref: "#/getDefinitions/relationship"
58771 reserved-prop-names:
58773 Internal map to define some reserved properties of a vertex
58775 last-mod-source-of-truth:
58793 Response container for the results of a named-query or model query
58795 inventory-response-items:
58797 $ref: "#/getDefinitions/inventory-response-items"
58802 description: The specific type of node in the A&AI graph
58805 description: The URL to the specific resource
58806 route-table-reference:
58808 Openstack route table reference.
58809 ###### Related Nodes
58810 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
58813 - route-table-reference-id
58814 - route-table-reference-fqdn
58816 route-table-reference-id:
58818 description: Route Table Reference id, UUID assigned to this instance.
58819 route-table-reference-fqdn:
58821 description: FQDN entry in the route table.
58824 description: Concurrency value
58828 $ref: "#/getDefinitions/relationship"
58829 route-table-references:
58831 Collection of openstack route table references
58833 route-table-reference:
58836 $ref: "#/getDefinitions/route-table-reference"
58839 Route target information
58840 ###### Related Nodes
58841 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
58843 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
58845 - global-route-target
58846 - route-target-role
58848 global-route-target:
58850 description: Number used to identify an RT, globally unique in the network
58853 description: Role assigned to this route target
58856 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58860 $ref: "#/getDefinitions/relationship"
58863 Collection of route target information
58868 $ref: "#/getDefinitions/route-target"
58871 ###### Related Nodes
58872 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
58873 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
58875 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
58876 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
58878 - routing-instance-id
58880 routing-instance-id:
58882 description: Unique id of routing instance
58885 description: rpm owner
58888 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58892 $ref: "#/getDefinitions/site-pair"
58896 $ref: "#/getDefinitions/relationship"
58899 set of probes related to generic-vnf routing instance
58904 $ref: "#/getDefinitions/routing-instance"
58909 $ref: "#/getDefinitions/oam-networks"
58910 az-and-dvs-switches:
58913 $ref: "#/getDefinitions/az-and-dvs-switches"
58916 edge-tag-query-result:
58918 $ref: "#/getDefinitions/edge-tag-query-result"
58919 edge-tag-query-request:
58921 $ref: "#/getDefinitions/edge-tag-query-request"
58924 $ref: "#/getDefinitions/search-results"
58927 $ref: "#/getDefinitions/sdn-zone-response"
58933 $ref: "#/getDefinitions/result-data"
58936 SecondaryFilt for performing a named-query or model query
58947 SecondaryFilts for performing a named-query or model query
58952 $ref: "#/getDefinitions/secondary-filt"
58953 segmentation-assignment:
58955 Openstack segmentation assignment.
58956 ###### Related Nodes
58957 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
58959 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
58965 description: Route Table Reference id, UUID assigned to this instance.
58968 description: Concurrency value
58972 $ref: "#/getDefinitions/relationship"
58973 segmentation-assignments:
58975 Collection of openstack segmentation assignments
58977 segmentation-assignment:
58980 $ref: "#/getDefinitions/segmentation-assignment"
58983 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
58986 - service-description
58990 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
58991 service-description:
58993 description: Description of the service
58996 description: URL to endpoint where AAI can get more details
58999 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59002 description: service version
59006 $ref: "#/getDefinitions/relationship"
59007 service-capabilities:
59009 Collection of service capabilities.
59011 service-capability:
59014 $ref: "#/getDefinitions/service-capability"
59015 service-capability:
59017 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
59018 ###### Related Nodes
59019 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
59020 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
59022 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
59030 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
59033 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
59036 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59040 $ref: "#/getDefinitions/relationship"
59041 service-design-and-creation:
59043 Namespace for objects managed by ASDC
59048 $ref: "#/getDefinitions/vnf-image"
59052 $ref: "#/getDefinitions/service"
59053 service-capabilities:
59056 $ref: "#/getDefinitions/service-capability"
59060 $ref: "#/getDefinitions/model"
59064 $ref: "#/getDefinitions/named-query"
59067 Instance of a service
59068 ###### Related Nodes
59069 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
59070 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
59071 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
59072 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
59073 - TO configuration( service-instance Uses configuration, ONE2MANY)
59074 - TO connector( service-instance Uses connector, MANY2MANY)
59075 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
59076 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
59077 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
59078 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
59079 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
59080 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
59081 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
59082 - TO zone( service-instance LocatedIn zone, MANY2ONE)
59083 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
59084 - TO vce( service-instance ComposedOf vce, ONE2MANY)
59085 - FROM project( project Uses service-instance, ONE2MANY)
59086 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
59087 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
59088 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
59090 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
59091 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
59092 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
59094 - service-instance-id
59096 service-instance-id:
59098 description: Uniquely identifies this instance of a service
59099 service-instance-name:
59101 description: This field will store a name assigned to the service-instance.
59104 description: String capturing type of service.
59107 description: String capturing the service role.
59108 environment-context:
59110 description: This field will store the environment context assigned to the service-instance.
59113 description: This field will store the workload context assigned to the service-instance.
59116 description: create time of Network Service.
59119 description: last update of Network Service.
59122 description: short description for service-instance.
59123 model-invariant-id:
59125 description: the ASDC model id for this resource or service model.
59128 description: the ASDC model version for this resource or service model.
59129 persona-model-version:
59131 description: the ASDC model version for this resource or service model.
59134 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59135 widget-model-version:
59137 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59140 description: Indicates the total bandwidth to be used for this service.
59143 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
59144 bandwidth-down-wan1:
59146 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
59149 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
59150 bandwidth-down-wan2:
59152 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
59155 description: URL customers will use to access the vHN Portal.
59156 service-instance-location-id:
59158 description: An identifier that customers assign to the location where this service is being used.
59161 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59164 description: Path to the controller object.
59165 orchestration-status:
59167 description: Orchestration status of this service.
59171 $ref: "#/getDefinitions/relationship"
59175 $ref: "#/getDefinitions/metadatum"
59176 allotted-resources:
59179 $ref: "#/getDefinitions/allotted-resource"
59182 Collection of service instances
59187 $ref: "#/getDefinitions/service-instance"
59188 service-subscription:
59190 Object that group service instances.
59191 ###### Related Nodes
59192 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
59193 - TO tenant( service-subscription Uses tenant, MANY2MANY)
59194 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
59196 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
59197 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
59203 description: Value defined by orchestration to identify this service across ECOMP.
59204 temp-ub-sub-account-id:
59206 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
59209 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59213 $ref: "#/getDefinitions/service-instance"
59217 $ref: "#/getDefinitions/relationship"
59218 service-subscriptions:
59220 Collection of objects that group service instances.
59222 service-subscription:
59225 $ref: "#/getDefinitions/service-subscription"
59228 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
59233 $ref: "#/getDefinitions/service"
59236 ###### Related Nodes
59237 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
59238 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
59240 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
59241 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
59247 description: unique identifier of probe
59250 description: Prefix address
59253 description: Prefix address
59256 description: ip version, v4, v6
59257 destination-hostname:
59259 description: Hostname of the destination equipment to which SLAs are measured against.
59260 destination-equip-type:
59262 description: The type of destinatination equipment. Could be Router, UCPE, etc.
59265 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59266 classes-of-service:
59269 $ref: "#/getDefinitions/class-of-service"
59273 $ref: "#/getDefinitions/relationship"
59276 Set of instances for probes used to measure service level agreements
59277 ###### Related Nodes
59278 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
59279 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
59281 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
59287 description: Unique id of site pair set.
59290 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59294 $ref: "#/getDefinitions/routing-instance"
59298 $ref: "#/getDefinitions/relationship"
59301 Collection of sets of instances for probes related to generic-vnf
59306 $ref: "#/getDefinitions/site-pair-set"
59314 $ref: "#/getDefinitions/site-pair"
59318 ###### Related Nodes
59319 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
59320 - FROM vserver( vserver Uses snapshot, ONE2ONE)
59327 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
59330 description: Snapshot name
59331 snapshot-architecture:
59333 description: Operating system architecture
59334 snapshot-os-distro:
59336 description: The common name of the operating system distribution in lowercase
59337 snapshot-os-version:
59339 description: The operating system version as specified by the distributor.
59342 description: The application that the image instantiates.
59343 application-vendor:
59345 description: The vendor of the application.
59346 application-version:
59348 description: The version of the application.
59351 description: URL to endpoint where AAI can get more details
59354 description: This field contains the UUID of the previous snapshot (if any).
59357 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59361 $ref: "#/getDefinitions/relationship"
59364 Collection of openstack snapshots
59369 $ref: "#/getDefinitions/snapshot"
59372 SR-IOV Physical Function
59373 ###### Related Nodes
59374 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
59375 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
59377 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
59383 description: Identifier for the sriov-pf
59386 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59390 $ref: "#/getDefinitions/relationship"
59393 Collection of SR-IOV Physical Functions.
59398 $ref: "#/getDefinitions/sriov-pf"
59401 SR-IOV Virtual Function (not to be confused with virtual network function)
59402 ###### Related Nodes
59403 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
59404 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
59406 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
59412 description: PCI ID used to identify the sriov-vf
59415 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
59418 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
59421 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
59422 vf-vlan-anti-spoof-check:
59424 description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
59425 vf-mac-anti-spoof-check:
59427 description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
59430 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
59431 vf-broadcast-allow:
59433 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
59434 vf-unknown-multicast-allow:
59436 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
59437 vf-unknown-unicast-allow:
59439 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
59442 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
59445 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
59448 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59449 neutron-network-id:
59451 description: Neutron network id of the interface
59455 $ref: "#/getDefinitions/relationship"
59458 Collection of SR-IOV Virtual Functions.
59463 $ref: "#/getDefinitions/sriov-vf"
59472 ###### Related Nodes
59473 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
59474 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
59475 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
59476 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
59477 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
59478 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
59480 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
59481 -(4) IF this TO node is deleted, this SUBNET is DELETED also
59482 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
59490 description: Subnet ID, should be UUID.
59493 description: Name associated with the subnet.
59496 description: Neutron id of this subnet
59499 description: gateway ip address
59500 network-start-address:
59502 description: network start address
59505 description: cidr mask
59508 description: ip version
59509 orchestration-status:
59511 description: Orchestration status of this VNF, mastered by MSO
59514 description: dhcp enabled
59517 description: the start address reserved for use by dhcp
59520 description: the last address reserved for use by dhcp
59523 description: role of the subnet, referenced when assigning IPs
59524 ip-assignment-direction:
59526 description: ip address assignment direction of the subnet
59529 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59533 description: sequence of the subnet
59537 $ref: "#/getDefinitions/host-route"
59541 $ref: "#/getDefinitions/relationship"
59547 $ref: "#/getDefinitions/subnet"
59548 tagged-inventory-item-list:
59553 $ref: "#/getDefinitions/inventory-item"
59557 ###### Related Nodes
59558 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
59559 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
59560 - TO l3-network( tenant Uses l3-network, MANY2MANY)
59561 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
59562 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
59563 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
59565 -TENANT cannot be deleted if related to VSERVER
59573 description: Unique id relative to the cloud-region.
59576 description: Readable name of tenant
59579 description: This field will store the tenant context.
59582 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59586 $ref: "#/getDefinitions/vserver"
59590 $ref: "#/getDefinitions/relationship"
59593 Collection of openstack tenants.
59598 $ref: "#/getDefinitions/tenant"
59601 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
59602 ###### Related Nodes
59603 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
59605 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
59608 - bandwidth-up-wan1
59609 - bandwidth-down-wan1
59610 - bandwidth-up-wan2
59611 - bandwidth-down-wan2
59615 description: Allotted Resource id UUID assigned to this instance.
59618 description: The WAN uplink bandwidth for WAN1
59619 bandwidth-down-wan1:
59621 description: The WAN downlink bandwidth for WAN1
59624 description: The WAN uplink bandwidth for WAN2
59625 bandwidth-down-wan2:
59627 description: The WAN downlink bandwidth for WAN2
59630 description: Concurrency value
59634 $ref: "#/getDefinitions/relationship"
59637 This object is used to store the specific tunnel cross connect aspects of an allotted resource
59642 $ref: "#/getDefinitions/tunnel-xconnect"
59645 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
59654 $ref: "#/getDefinitions/update-node-key"
59660 $ref: "#/getDefinitions/action"
59669 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
59670 ###### Related Nodes
59671 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
59672 - TO complex( vce LocatedIn complex, MANY2MANY)
59673 - TO vserver( vce HostedOn vserver, ONE2MANY)
59674 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
59675 - FROM license( license BelongsTo vce, MANY2ONE)(1)
59676 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
59677 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
59679 -(1) IF this VCE node is deleted, this FROM node is DELETED also
59687 description: Unique id of VNF. This is unique across the graph.
59690 description: Name of VNF.
59693 description: Alternate name of VNF.
59696 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
59699 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
59700 regional-resource-zone:
59702 description: Regional way of organizing pservers, source of truth should define values
59705 description: Trigger for operational monitoring of this resource by Service Assurance systems.
59706 operational-status:
59708 description: Indicator for whether the resource is considered operational
59711 description: OBSOLETE - do not use
59714 description: Network role being played by this VNF
59715 orchestration-status:
59717 description: Orchestration status of this VNF, mastered by MSO
59720 description: Heat stack id corresponding to this instance, managed by MSO
59723 description: Corresponds to the SDN-C catalog id used to configure this VCE
59726 description: Unique ID of VPE connected to this VCE.
59727 v6-vce-wan-address:
59729 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
59732 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
59735 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59736 ipv4-loopback0-address:
59738 description: Loopback0 address
59739 entitlement-resource-uuid:
59741 description: OBSOLETE - see child relationships
59745 $ref: "#/getDefinitions/port-group"
59749 $ref: "#/getDefinitions/license"
59753 $ref: "#/getDefinitions/entitlement"
59757 $ref: "#/getDefinitions/relationship"
59760 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
59765 $ref: "#/getDefinitions/vce"
59768 a deployment unit of VNFCs
59769 ###### Related Nodes
59770 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
59771 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
59772 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
59773 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
59774 - TO vserver( vf-module Uses vserver, ONE2MANY)
59776 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
59777 -VF-MODULE cannot be deleted if related to VNFC
59781 - is-base-vf-module
59785 description: Unique ID of vf-module.
59788 description: Name of vf-module
59791 description: Heat stack id corresponding to this instance.
59792 orchestration-status:
59794 description: orchestration status of this vf-module, mastered by MSO
59797 description: used to indicate whether or not this object is base vf module
59800 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59801 model-invariant-id:
59803 description: the ASDC model id for this resource or service model.
59806 description: the ASDC model version for this resource or service model.
59807 persona-model-version:
59809 description: the ASDC model version for this resource or service model.
59810 model-customization-id:
59812 description: captures the id of all the configuration used to customize the resource for the service.
59815 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59816 widget-model-version:
59818 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59819 contrail-service-instance-fqdn:
59821 description: the Contrail unique ID for a service-instance
59825 description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
59828 description: Path to the controller object.
59832 $ref: "#/getDefinitions/relationship"
59835 Collection of vf-modules, a deployment unit of VNFCs
59840 $ref: "#/getDefinitions/vf-module"
59843 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
59844 ###### Related Nodes
59845 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
59847 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
59853 description: indicates whether the VIG is for AVPN or INTERNET
59856 description: v4 IP of the vig server
59859 description: v6 IP of the vig server
59862 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59866 $ref: "#/getDefinitions/relationship"
59872 $ref: "#/getDefinitions/vig-server"
59873 vip-ipv4-address-list:
59876 ###### Related Nodes
59877 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
59878 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
59879 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
59880 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
59887 description: IP address
59888 vip-ipv4-prefix-length:
59891 description: Prefix length, 32 for single address
59895 description: Inner VLAN tag
59899 description: Outer VLAN tag
59902 description: Indicator of fixed or floating address
59905 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59906 neutron-network-id:
59908 description: Neutron network id of the interface that address belongs to
59911 description: Neutron id of subnet that address belongs to
59915 $ref: "#/getDefinitions/relationship"
59916 vip-ipv6-address-list:
59919 ###### Related Nodes
59920 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
59921 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
59922 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
59923 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
59930 description: IP address
59931 vip-ipv6-prefix-length:
59934 description: Prefix length, 128 for single address
59938 description: Inner VLAN tag
59942 description: Outer VLAN tag
59945 description: Indicator of fixed or floating address
59948 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59949 neutron-network-id:
59951 description: Neutron network id of the interface that address belongs to
59954 description: Neutron id of subnet that address belongs to
59958 $ref: "#/getDefinitions/relationship"
59959 virtual-data-center:
59961 Virtual organization of cloud infrastructure elements in a data center context
59962 ###### Related Nodes
59963 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
59964 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
59965 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
59973 description: Unique ID of the vdc
59976 description: Name of the virtual data center
59979 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59983 $ref: "#/getDefinitions/relationship"
59984 virtual-data-centers:
59986 Virtual organization of cloud infrastructure elements in a data center context
59988 virtual-data-center:
59991 $ref: "#/getDefinitions/virtual-data-center"
59995 ###### Related Nodes
59996 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
59997 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
59998 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
59999 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
60000 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
60001 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
60002 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
60004 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
60005 -(2) IF this VLAN node is deleted, this TO node is DELETED also
60006 -(4) IF this TO node is deleted, this VLAN is DELETED also
60014 description: String that identifies the interface
60018 description: Inner VLAN tag
60022 description: Outer VLAN tag
60025 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60028 description: Captures the numeric part of the speed
60031 description: Captures the units corresponding to the speed
60034 description: Used to describe (the service associated with) the vlan
60035 backdoor-connection:
60037 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
60040 description: This indicates the customers VPN ID associated with this vlan
60041 orchestration-status:
60043 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
60046 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
60049 description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
60052 description: Flag indicating the interface uses the IP Unnumbered configuration.
60056 $ref: "#/getDefinitions/relationship"
60057 l3-interface-ipv4-address-list:
60060 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
60061 l3-interface-ipv6-address-list:
60064 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
60070 $ref: "#/getDefinitions/vlan"
60079 description: Unique id of VNF. This is unique across the graph.
60082 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
60083 ###### Related Nodes
60084 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
60086 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
60091 - application-vendor
60095 description: Unique ID of this asset
60098 description: The application that the image instantiates.
60099 application-vendor:
60101 description: The vendor of the application.
60102 application-version:
60104 description: The version of the application.
60107 description: URL to endpoint where AAI can get more details
60110 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60114 $ref: "#/getDefinitions/relationship"
60117 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
60122 $ref: "#/getDefinitions/vnf-image"
60125 ###### Related Nodes
60126 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
60127 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
60128 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
60129 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
60130 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
60131 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
60132 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
60133 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
60135 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
60136 -(4) IF this TO node is deleted, this VNFC is DELETED also
60142 - is-closed-loop-disabled
60146 description: Unique ID of vnfc.
60149 description: Short code that is used in naming instances of the item being modeled
60152 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
60155 description: prov status of this vnfc
60156 orchestration-status:
60158 description: Orchestration status of this VNF, mastered by APP-C
60159 ipaddress-v4-oam-vip:
60161 description: Oam V4 vip address of this vnfc
60164 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
60165 is-closed-loop-disabled:
60167 description: used to indicate whether closed loop function is enabled on this node
60170 description: Group notation of VNFC
60171 model-invariant-id:
60173 description: the ASDC model id for this resource or service model.
60176 description: the ASDC model version for this resource or service model.
60179 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60183 $ref: "#/getDefinitions/relationship"
60184 l3-interface-ipv4-address-list:
60187 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
60188 l3-interface-ipv6-address-list:
60191 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
60194 virtual network components associated with a vserver from application controller.
60199 $ref: "#/getDefinitions/vnfc"
60202 Ephemeral Block storage volume.
60203 ###### Related Nodes
60204 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
60206 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
60213 description: Unique ID of block storage volume relative to the vserver.
60216 description: URL to endpoint where AAI can get more details
60219 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60223 $ref: "#/getDefinitions/relationship"
60226 Persistent block-level storage.
60227 ###### Related Nodes
60228 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
60229 - TO complex( volume-group LocatedIn complex, MANY2ONE)
60230 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
60231 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
60232 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
60236 - volume-group-name
60241 description: Unique ID of volume-group.
60244 description: Name of the volume group.
60247 description: Heat stack id corresponding to this volume-group
60250 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
60251 orchestration-status:
60253 description: Orchestration status of this volume-group
60254 model-customization-id:
60256 description: captures the id of all the configuration used to customize the resource for the service.
60257 vf-module-model-customization-id:
60259 description: helps relate the volume group to the vf-module whose components will require the volume group
60262 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60266 $ref: "#/getDefinitions/relationship"
60269 Collection of persistent block-level storage.
60274 $ref: "#/getDefinitions/volume-group"
60277 Collection of ephemeral Block storage volumes.
60282 $ref: "#/getDefinitions/volume"
60285 VPLS Provider Edge routers.
60286 ###### Related Nodes
60287 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
60288 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
60289 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
60290 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
60292 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
60300 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60303 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
60306 description: Client should send valid enumerated value, e.g., VPLS-PE.
60310 description: Temporary location for stag to get to VCE
60313 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60317 $ref: "#/getDefinitions/relationship"
60321 $ref: "#/getDefinitions/p-interface"
60325 $ref: "#/getDefinitions/lag-interface"
60328 Collection of VPLS Provider Edge routers
60333 $ref: "#/getDefinitions/vpls-pe"
60337 ###### Related Nodes
60338 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
60339 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
60340 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
60341 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
60343 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
60344 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
60352 description: VPN ID, globally unique within A&AI
60355 description: VPN Name
60358 description: the platform associated with the VPN example AVPN, Mobility
60361 description: Type of the vpn, should be taken from enumerated/valid values
60364 description: region of customer vpn
60367 description: id for this customer vpn
60368 route-distinguisher:
60370 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
60373 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60377 $ref: "#/getDefinitions/route-target"
60381 $ref: "#/getDefinitions/relationship"
60382 description: l3-networks relate to vpn-bindings
60388 $ref: "#/getDefinitions/vpn-binding"
60391 Virtual Servers, aka virtual machine or VM.
60392 ###### Related Nodes
60393 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
60394 - TO flavor( vserver Uses flavor, MANY2ONE)
60395 - TO image( vserver Uses image, MANY2ONE)
60396 - TO pserver( vserver HostedOn pserver, MANY2ONE)
60397 - TO snapshot( vserver Uses snapshot, ONE2ONE)
60398 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
60399 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
60400 - FROM vce( vce HostedOn vserver, ONE2MANY)
60401 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
60402 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
60403 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
60405 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
60406 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
60412 - is-closed-loop-disabled
60416 description: Unique identifier for this vserver relative to its tenant
60419 description: Name of vserver
60422 description: Alternative name of vserver
60425 description: Trigger for operational monitoring of this resource by Service Assurance systems.
60428 description: URL to endpoint where AAI can get more details
60431 description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
60432 is-closed-loop-disabled:
60434 description: Used to indicate whether closed loop function is enabled on this node
60437 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60441 $ref: "#/getDefinitions/volume"
60445 $ref: "#/getDefinitions/relationship"
60449 $ref: "#/getDefinitions/l-interface"
60452 Collection of virtual Servers, aka virtual machines or VMs.
60457 $ref: "#/getDefinitions/vserver"
60460 A zone is a grouping of assets in a location homing to the same connections into the CBB
60461 ###### Related Nodes
60462 - TO complex( zone LocatedIn complex, MANY2ONE)
60463 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
60464 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
60465 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
60466 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
60476 description: Code assigned by AIC to the zone
60479 description: English name associated with the zone
60482 description: Design of zone [Medium/Large?]
60485 description: Context of zone [production/test]
60488 description: Status of a zone.
60491 description: Concurrency value
60495 $ref: "#/getDefinitions/relationship"
60498 Collection of zones
60503 $ref: "#/getDefinitions/zone"