5 [Differences versus the previous schema version](apidocs/aai_swagger_v12.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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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/v12/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}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
4498 - CloudInfrastructure
4499 summary: see node definition for valid relationships
4500 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
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__
4529 - name: hpa-capability-id
4531 description: UUID to uniquely identify a HPA capability
4534 example: __HPA-CAPABILITY-ID__
4537 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
4540 $ref: "#/definitions/relationship"
4543 - CloudInfrastructure
4544 summary: delete an existing relationship
4545 description: delete an existing relationship
4546 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
4555 description: Response codes found in [response codes](https://wiki.onap.org/).
4559 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4562 example: __CLOUD-OWNER__
4563 - name: cloud-region-id
4565 description: Identifier used by the vendor for the region. Second part of composite key
4568 example: __CLOUD-REGION-ID__
4571 description: Flavor id, expected to be unique across cloud-region.
4574 example: __FLAVOR-ID__
4575 - name: hpa-capability-id
4577 description: UUID to uniquely identify a HPA capability
4580 example: __HPA-CAPABILITY-ID__
4581 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
4584 - CloudInfrastructure
4585 summary: see node definition for valid relationships
4586 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
4595 description: Response codes found in [response codes](https://wiki.onap.org/).
4599 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4602 example: __CLOUD-OWNER__
4603 - name: cloud-region-id
4605 description: Identifier used by the vendor for the region. Second part of composite key
4608 example: __CLOUD-REGION-ID__
4611 description: Flavor id, expected to be unique across cloud-region.
4614 example: __FLAVOR-ID__
4615 - name: hpa-capability-id
4617 description: UUID to uniquely identify a HPA capability
4620 example: __HPA-CAPABILITY-ID__
4621 - name: hpa-attribute-key
4623 description: name of the specific HPA attribute
4626 example: __HPA-ATTRIBUTE-KEY__
4629 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
4632 $ref: "#/definitions/relationship"
4635 - CloudInfrastructure
4636 summary: delete an existing relationship
4637 description: delete an existing relationship
4638 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
4647 description: Response codes found in [response codes](https://wiki.onap.org/).
4651 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4654 example: __CLOUD-OWNER__
4655 - name: cloud-region-id
4657 description: Identifier used by the vendor for the region. Second part of composite key
4660 example: __CLOUD-REGION-ID__
4663 description: Flavor id, expected to be unique across cloud-region.
4666 example: __FLAVOR-ID__
4667 - name: hpa-capability-id
4669 description: UUID to uniquely identify a HPA capability
4672 example: __HPA-CAPABILITY-ID__
4673 - name: hpa-attribute-key
4675 description: name of the specific HPA attribute
4678 example: __HPA-ATTRIBUTE-KEY__
4679 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
4682 - CloudInfrastructure
4683 summary: returns hpa-feature-attributes
4684 description: returns hpa-feature-attributes
4685 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4691 description: successful operation
4693 $ref: "#/getDefinitions/hpa-feature-attributes"
4695 description: Response codes found in [response codes](https://wiki.onap.org/).
4699 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4702 example: __CLOUD-OWNER__
4703 - name: cloud-region-id
4705 description: Identifier used by the vendor for the region. Second part of composite key
4708 example: __CLOUD-REGION-ID__
4711 description: Flavor id, expected to be unique across cloud-region.
4714 example: __FLAVOR-ID__
4715 - name: hpa-capability-id
4717 description: UUID to uniquely identify a HPA capability
4720 example: __HPA-CAPABILITY-ID__
4721 - name: hpa-attribute-key
4723 description: name of the specific HPA attribute
4726 example: __HPA-ATTRIBUTE-KEY__
4729 - CloudInfrastructure
4730 summary: create or update an existing hpa-feature-attributes
4732 Create or update an existing hpa-feature-attributes.
4734 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4735 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4744 description: Response codes found in [response codes](https://wiki.onap.org/).
4748 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4751 example: __CLOUD-OWNER__
4752 - name: cloud-region-id
4754 description: Identifier used by the vendor for the region. Second part of composite key
4757 example: __CLOUD-REGION-ID__
4760 description: Flavor id, expected to be unique across cloud-region.
4763 example: __FLAVOR-ID__
4764 - name: hpa-capability-id
4766 description: UUID to uniquely identify a HPA capability
4769 example: __HPA-CAPABILITY-ID__
4770 - name: hpa-attribute-key
4772 description: name of the specific HPA attribute
4775 example: __HPA-ATTRIBUTE-KEY__
4778 description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
4781 $ref: "#/definitions/hpa-feature-attributes"
4784 - CloudInfrastructure
4785 summary: update an existing hpa-feature-attributes
4787 Update an existing hpa-feature-attributes
4789 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4790 The PUT operation will entirely replace an existing object.
4791 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4793 Other differences between PUT and PATCH are:
4795 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4796 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4797 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4798 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4807 description: Response codes found in [response codes](https://wiki.onap.org/).
4811 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4814 example: __CLOUD-OWNER__
4815 - name: cloud-region-id
4817 description: Identifier used by the vendor for the region. Second part of composite key
4820 example: __CLOUD-REGION-ID__
4823 description: Flavor id, expected to be unique across cloud-region.
4826 example: __FLAVOR-ID__
4827 - name: hpa-capability-id
4829 description: UUID to uniquely identify a HPA capability
4832 example: __HPA-CAPABILITY-ID__
4833 - name: hpa-attribute-key
4835 description: name of the specific HPA attribute
4838 example: __HPA-ATTRIBUTE-KEY__
4841 description: hpa-feature-attributes object that needs to be updated.
4844 $ref: "#/patchDefinitions/hpa-feature-attributes"
4847 - CloudInfrastructure
4848 summary: delete an existing hpa-feature-attributes
4849 description: delete an existing hpa-feature-attributes
4850 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4859 description: Response codes found in [response codes](https://wiki.onap.org/).
4863 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4866 example: __CLOUD-OWNER__
4867 - name: cloud-region-id
4869 description: Identifier used by the vendor for the region. Second part of composite key
4872 example: __CLOUD-REGION-ID__
4875 description: Flavor id, expected to be unique across cloud-region.
4878 example: __FLAVOR-ID__
4879 - name: hpa-capability-id
4881 description: UUID to uniquely identify a HPA capability
4884 example: __HPA-CAPABILITY-ID__
4885 - name: hpa-attribute-key
4887 description: name of the specific HPA attribute
4890 example: __HPA-ATTRIBUTE-KEY__
4891 - name: resource-version
4893 description: resource-version for concurrency
4896 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
4899 - CloudInfrastructure
4900 summary: returns hpa-capability
4901 description: returns hpa-capability
4902 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
4908 description: successful operation
4910 $ref: "#/getDefinitions/hpa-capability"
4912 description: Response codes found in [response codes](https://wiki.onap.org/).
4916 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4919 example: __CLOUD-OWNER__
4920 - name: cloud-region-id
4922 description: Identifier used by the vendor for the region. Second part of composite key
4925 example: __CLOUD-REGION-ID__
4928 description: Flavor id, expected to be unique across cloud-region.
4931 example: __FLAVOR-ID__
4932 - name: hpa-capability-id
4934 description: UUID to uniquely identify a HPA capability
4937 example: __HPA-CAPABILITY-ID__
4940 - CloudInfrastructure
4941 summary: create or update an existing hpa-capability
4943 Create or update an existing hpa-capability.
4945 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4946 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
4955 description: Response codes found in [response codes](https://wiki.onap.org/).
4959 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4962 example: __CLOUD-OWNER__
4963 - name: cloud-region-id
4965 description: Identifier used by the vendor for the region. Second part of composite key
4968 example: __CLOUD-REGION-ID__
4971 description: Flavor id, expected to be unique across cloud-region.
4974 example: __FLAVOR-ID__
4975 - name: hpa-capability-id
4977 description: UUID to uniquely identify a HPA capability
4980 example: __HPA-CAPABILITY-ID__
4983 description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
4986 $ref: "#/definitions/hpa-capability"
4989 - CloudInfrastructure
4990 summary: update an existing hpa-capability
4992 Update an existing hpa-capability
4994 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4995 The PUT operation will entirely replace an existing object.
4996 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4998 Other differences between PUT and PATCH are:
5000 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5001 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5002 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5003 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5012 description: Response codes found in [response codes](https://wiki.onap.org/).
5016 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5019 example: __CLOUD-OWNER__
5020 - name: cloud-region-id
5022 description: Identifier used by the vendor for the region. Second part of composite key
5025 example: __CLOUD-REGION-ID__
5028 description: Flavor id, expected to be unique across cloud-region.
5031 example: __FLAVOR-ID__
5032 - name: hpa-capability-id
5034 description: UUID to uniquely identify a HPA capability
5037 example: __HPA-CAPABILITY-ID__
5040 description: hpa-capability object that needs to be updated.
5043 $ref: "#/patchDefinitions/hpa-capability"
5046 - CloudInfrastructure
5047 summary: delete an existing hpa-capability
5048 description: delete an existing hpa-capability
5049 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5058 description: Response codes found in [response codes](https://wiki.onap.org/).
5062 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5065 example: __CLOUD-OWNER__
5066 - name: cloud-region-id
5068 description: Identifier used by the vendor for the region. Second part of composite key
5071 example: __CLOUD-REGION-ID__
5074 description: Flavor id, expected to be unique across cloud-region.
5077 example: __FLAVOR-ID__
5078 - name: hpa-capability-id
5080 description: UUID to uniquely identify a HPA capability
5083 example: __HPA-CAPABILITY-ID__
5084 - name: resource-version
5086 description: resource-version for concurrency
5089 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities:
5092 - CloudInfrastructure
5093 summary: returns hpa-capabilities
5094 description: returns hpa-capabilities
5095 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
5101 description: successful operation
5103 $ref: "#/getDefinitions/hpa-capabilities"
5105 description: Response codes found in [response codes](https://wiki.onap.org/).
5109 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5112 example: __CLOUD-OWNER__
5113 - name: cloud-region-id
5115 description: Identifier used by the vendor for the region. Second part of composite key
5118 example: __CLOUD-REGION-ID__
5121 description: Flavor id, expected to be unique across cloud-region.
5124 example: __FLAVOR-ID__
5125 - name: hpa-capability-id
5135 - name: architecture
5140 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5143 - CloudInfrastructure
5144 summary: see node definition for valid relationships
5145 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5154 description: Response codes found in [response codes](https://wiki.onap.org/).
5158 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5161 example: __CLOUD-OWNER__
5162 - name: cloud-region-id
5164 description: Identifier used by the vendor for the region. Second part of composite key
5167 example: __CLOUD-REGION-ID__
5170 description: Flavor id, expected to be unique across cloud-region.
5173 example: __FLAVOR-ID__
5176 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5179 $ref: "#/definitions/relationship"
5182 - CloudInfrastructure
5183 summary: delete an existing relationship
5184 description: delete an existing relationship
5185 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5194 description: Response codes found in [response codes](https://wiki.onap.org/).
5198 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5201 example: __CLOUD-OWNER__
5202 - name: cloud-region-id
5204 description: Identifier used by the vendor for the region. Second part of composite key
5207 example: __CLOUD-REGION-ID__
5210 description: Flavor id, expected to be unique across cloud-region.
5213 example: __FLAVOR-ID__
5214 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5217 - CloudInfrastructure
5218 summary: returns flavor
5219 description: returns flavor
5220 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5226 description: successful operation
5228 $ref: "#/getDefinitions/flavor"
5230 description: Response codes found in [response codes](https://wiki.onap.org/).
5234 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5237 example: __CLOUD-OWNER__
5238 - name: cloud-region-id
5240 description: Identifier used by the vendor for the region. Second part of composite key
5243 example: __CLOUD-REGION-ID__
5246 description: Flavor id, expected to be unique across cloud-region.
5249 example: __FLAVOR-ID__
5252 - CloudInfrastructure
5253 summary: create or update an existing flavor
5255 Create or update an existing flavor.
5257 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5258 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5267 description: Response codes found in [response codes](https://wiki.onap.org/).
5271 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5274 example: __CLOUD-OWNER__
5275 - name: cloud-region-id
5277 description: Identifier used by the vendor for the region. Second part of composite key
5280 example: __CLOUD-REGION-ID__
5283 description: Flavor id, expected to be unique across cloud-region.
5286 example: __FLAVOR-ID__
5289 description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5292 $ref: "#/definitions/flavor"
5295 - CloudInfrastructure
5296 summary: update an existing flavor
5298 Update an existing flavor
5300 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5301 The PUT operation will entirely replace an existing object.
5302 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5304 Other differences between PUT and PATCH are:
5306 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5307 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5308 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5309 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5318 description: Response codes found in [response codes](https://wiki.onap.org/).
5322 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5325 example: __CLOUD-OWNER__
5326 - name: cloud-region-id
5328 description: Identifier used by the vendor for the region. Second part of composite key
5331 example: __CLOUD-REGION-ID__
5334 description: Flavor id, expected to be unique across cloud-region.
5337 example: __FLAVOR-ID__
5340 description: flavor object that needs to be updated.
5343 $ref: "#/patchDefinitions/flavor"
5346 - CloudInfrastructure
5347 summary: delete an existing flavor
5348 description: delete an existing flavor
5349 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5358 description: Response codes found in [response codes](https://wiki.onap.org/).
5362 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5365 example: __CLOUD-OWNER__
5366 - name: cloud-region-id
5368 description: Identifier used by the vendor for the region. Second part of composite key
5371 example: __CLOUD-REGION-ID__
5374 description: Flavor id, expected to be unique across cloud-region.
5377 example: __FLAVOR-ID__
5378 - name: resource-version
5380 description: resource-version for concurrency
5383 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
5386 - CloudInfrastructure
5387 summary: returns flavors
5388 description: returns flavors
5389 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
5395 description: successful operation
5397 $ref: "#/getDefinitions/flavors"
5399 description: Response codes found in [response codes](https://wiki.onap.org/).
5403 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5406 example: __CLOUD-OWNER__
5407 - name: cloud-region-id
5409 description: Identifier used by the vendor for the region. Second part of composite key
5412 example: __CLOUD-REGION-ID__
5423 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
5426 - CloudInfrastructure
5427 summary: see node definition for valid relationships
5428 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5437 description: Response codes found in [response codes](https://wiki.onap.org/).
5441 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5444 example: __CLOUD-OWNER__
5445 - name: cloud-region-id
5447 description: Identifier used by the vendor for the region. Second part of composite key
5450 example: __CLOUD-REGION-ID__
5453 description: Group id, expected to be unique across cloud-region.
5456 example: __GROUP-ID__
5459 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5462 $ref: "#/definitions/relationship"
5465 - CloudInfrastructure
5466 summary: delete an existing relationship
5467 description: delete an existing relationship
5468 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5477 description: Response codes found in [response codes](https://wiki.onap.org/).
5481 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5484 example: __CLOUD-OWNER__
5485 - name: cloud-region-id
5487 description: Identifier used by the vendor for the region. Second part of composite key
5490 example: __CLOUD-REGION-ID__
5493 description: Group id, expected to be unique across cloud-region.
5496 example: __GROUP-ID__
5497 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
5500 - CloudInfrastructure
5501 summary: returns group-assignment
5502 description: returns group-assignment
5503 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5509 description: successful operation
5511 $ref: "#/getDefinitions/group-assignment"
5513 description: Response codes found in [response codes](https://wiki.onap.org/).
5517 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5520 example: __CLOUD-OWNER__
5521 - name: cloud-region-id
5523 description: Identifier used by the vendor for the region. Second part of composite key
5526 example: __CLOUD-REGION-ID__
5529 description: Group id, expected to be unique across cloud-region.
5532 example: __GROUP-ID__
5535 - CloudInfrastructure
5536 summary: create or update an existing group-assignment
5538 Create or update an existing group-assignment.
5540 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5541 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5550 description: Response codes found in [response codes](https://wiki.onap.org/).
5554 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5557 example: __CLOUD-OWNER__
5558 - name: cloud-region-id
5560 description: Identifier used by the vendor for the region. Second part of composite key
5563 example: __CLOUD-REGION-ID__
5566 description: Group id, expected to be unique across cloud-region.
5569 example: __GROUP-ID__
5572 description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5575 $ref: "#/definitions/group-assignment"
5578 - CloudInfrastructure
5579 summary: update an existing group-assignment
5581 Update an existing group-assignment
5583 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5584 The PUT operation will entirely replace an existing object.
5585 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5587 Other differences between PUT and PATCH are:
5589 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5590 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5591 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5592 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5601 description: Response codes found in [response codes](https://wiki.onap.org/).
5605 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5608 example: __CLOUD-OWNER__
5609 - name: cloud-region-id
5611 description: Identifier used by the vendor for the region. Second part of composite key
5614 example: __CLOUD-REGION-ID__
5617 description: Group id, expected to be unique across cloud-region.
5620 example: __GROUP-ID__
5623 description: group-assignment object that needs to be updated.
5626 $ref: "#/patchDefinitions/group-assignment"
5629 - CloudInfrastructure
5630 summary: delete an existing group-assignment
5631 description: delete an existing group-assignment
5632 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5641 description: Response codes found in [response codes](https://wiki.onap.org/).
5645 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5648 example: __CLOUD-OWNER__
5649 - name: cloud-region-id
5651 description: Identifier used by the vendor for the region. Second part of composite key
5654 example: __CLOUD-REGION-ID__
5657 description: Group id, expected to be unique across cloud-region.
5660 example: __GROUP-ID__
5661 - name: resource-version
5663 description: resource-version for concurrency
5666 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5669 - CloudInfrastructure
5670 summary: returns group-assignments
5671 description: returns group-assignments
5672 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5678 description: successful operation
5680 $ref: "#/getDefinitions/group-assignments"
5682 description: Response codes found in [response codes](https://wiki.onap.org/).
5686 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5689 example: __CLOUD-OWNER__
5690 - name: cloud-region-id
5692 description: Identifier used by the vendor for the region. Second part of composite key
5695 example: __CLOUD-REGION-ID__
5711 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5714 - CloudInfrastructure
5715 summary: see node definition for valid relationships
5716 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5725 description: Response codes found in [response codes](https://wiki.onap.org/).
5729 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5732 example: __CLOUD-OWNER__
5733 - name: cloud-region-id
5735 description: Identifier used by the vendor for the region. Second part of composite key
5738 example: __CLOUD-REGION-ID__
5741 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5744 example: __SNAPSHOT-ID__
5747 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5750 $ref: "#/definitions/relationship"
5753 - CloudInfrastructure
5754 summary: delete an existing relationship
5755 description: delete an existing relationship
5756 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5765 description: Response codes found in [response codes](https://wiki.onap.org/).
5769 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5772 example: __CLOUD-OWNER__
5773 - name: cloud-region-id
5775 description: Identifier used by the vendor for the region. Second part of composite key
5778 example: __CLOUD-REGION-ID__
5781 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5784 example: __SNAPSHOT-ID__
5785 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5788 - CloudInfrastructure
5789 summary: returns snapshot
5790 description: returns snapshot
5791 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5797 description: successful operation
5799 $ref: "#/getDefinitions/snapshot"
5801 description: Response codes found in [response codes](https://wiki.onap.org/).
5805 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5808 example: __CLOUD-OWNER__
5809 - name: cloud-region-id
5811 description: Identifier used by the vendor for the region. Second part of composite key
5814 example: __CLOUD-REGION-ID__
5817 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5820 example: __SNAPSHOT-ID__
5823 - CloudInfrastructure
5824 summary: create or update an existing snapshot
5826 Create or update an existing snapshot.
5828 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5829 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5838 description: Response codes found in [response codes](https://wiki.onap.org/).
5842 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5845 example: __CLOUD-OWNER__
5846 - name: cloud-region-id
5848 description: Identifier used by the vendor for the region. Second part of composite key
5851 example: __CLOUD-REGION-ID__
5854 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5857 example: __SNAPSHOT-ID__
5860 description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5863 $ref: "#/definitions/snapshot"
5866 - CloudInfrastructure
5867 summary: update an existing snapshot
5869 Update an existing snapshot
5871 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5872 The PUT operation will entirely replace an existing object.
5873 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5875 Other differences between PUT and PATCH are:
5877 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5878 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5879 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5880 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5889 description: Response codes found in [response codes](https://wiki.onap.org/).
5893 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5896 example: __CLOUD-OWNER__
5897 - name: cloud-region-id
5899 description: Identifier used by the vendor for the region. Second part of composite key
5902 example: __CLOUD-REGION-ID__
5905 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5908 example: __SNAPSHOT-ID__
5911 description: snapshot object that needs to be updated.
5914 $ref: "#/patchDefinitions/snapshot"
5917 - CloudInfrastructure
5918 summary: delete an existing snapshot
5919 description: delete an existing snapshot
5920 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5929 description: Response codes found in [response codes](https://wiki.onap.org/).
5933 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5936 example: __CLOUD-OWNER__
5937 - name: cloud-region-id
5939 description: Identifier used by the vendor for the region. Second part of composite key
5942 example: __CLOUD-REGION-ID__
5945 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5948 example: __SNAPSHOT-ID__
5949 - name: resource-version
5951 description: resource-version for concurrency
5954 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5957 - CloudInfrastructure
5958 summary: returns snapshots
5959 description: returns snapshots
5960 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5966 description: successful operation
5968 $ref: "#/getDefinitions/snapshots"
5970 description: Response codes found in [response codes](https://wiki.onap.org/).
5974 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5977 example: __CLOUD-OWNER__
5978 - name: cloud-region-id
5980 description: Identifier used by the vendor for the region. Second part of composite key
5983 example: __CLOUD-REGION-ID__
5989 - name: snapshot-name
5999 - name: application-vendor
6004 - name: application-version
6009 - name: prev-snapshot-id
6014 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6017 - CloudInfrastructure
6018 summary: see node definition for valid relationships
6019 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6028 description: Response codes found in [response codes](https://wiki.onap.org/).
6032 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6035 example: __CLOUD-OWNER__
6036 - name: cloud-region-id
6038 description: Identifier used by the vendor for the region. Second part of composite key
6041 example: __CLOUD-REGION-ID__
6044 description: Image id, expected to be unique across cloud region
6047 example: __IMAGE-ID__
6050 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6053 $ref: "#/definitions/relationship"
6056 - CloudInfrastructure
6057 summary: delete an existing relationship
6058 description: delete an existing relationship
6059 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6068 description: Response codes found in [response codes](https://wiki.onap.org/).
6072 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6075 example: __CLOUD-OWNER__
6076 - name: cloud-region-id
6078 description: Identifier used by the vendor for the region. Second part of composite key
6081 example: __CLOUD-REGION-ID__
6084 description: Image id, expected to be unique across cloud region
6087 example: __IMAGE-ID__
6088 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6091 - CloudInfrastructure
6092 summary: returns metadatum
6093 description: returns metadatum
6094 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6100 description: successful operation
6102 $ref: "#/getDefinitions/metadatum"
6104 description: Response codes found in [response codes](https://wiki.onap.org/).
6108 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6111 example: __CLOUD-OWNER__
6112 - name: cloud-region-id
6114 description: Identifier used by the vendor for the region. Second part of composite key
6117 example: __CLOUD-REGION-ID__
6120 description: Image id, expected to be unique across cloud region
6123 example: __IMAGE-ID__
6128 example: __METANAME__
6131 - CloudInfrastructure
6132 summary: create or update an existing metadatum
6134 Create or update an existing metadatum.
6136 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6137 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6146 description: Response codes found in [response codes](https://wiki.onap.org/).
6150 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6153 example: __CLOUD-OWNER__
6154 - name: cloud-region-id
6156 description: Identifier used by the vendor for the region. Second part of composite key
6159 example: __CLOUD-REGION-ID__
6162 description: Image id, expected to be unique across cloud region
6165 example: __IMAGE-ID__
6170 example: __METANAME__
6173 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6176 $ref: "#/definitions/metadatum"
6179 - CloudInfrastructure
6180 summary: update an existing metadatum
6182 Update an existing metadatum
6184 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6185 The PUT operation will entirely replace an existing object.
6186 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6188 Other differences between PUT and PATCH are:
6190 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6191 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6192 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6193 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6202 description: Response codes found in [response codes](https://wiki.onap.org/).
6206 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6209 example: __CLOUD-OWNER__
6210 - name: cloud-region-id
6212 description: Identifier used by the vendor for the region. Second part of composite key
6215 example: __CLOUD-REGION-ID__
6218 description: Image id, expected to be unique across cloud region
6221 example: __IMAGE-ID__
6226 example: __METANAME__
6229 description: metadatum object that needs to be updated.
6232 $ref: "#/patchDefinitions/metadatum"
6235 - CloudInfrastructure
6236 summary: delete an existing metadatum
6237 description: delete an existing metadatum
6238 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6247 description: Response codes found in [response codes](https://wiki.onap.org/).
6251 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6254 example: __CLOUD-OWNER__
6255 - name: cloud-region-id
6257 description: Identifier used by the vendor for the region. Second part of composite key
6260 example: __CLOUD-REGION-ID__
6263 description: Image id, expected to be unique across cloud region
6266 example: __IMAGE-ID__
6271 example: __METANAME__
6272 - name: resource-version
6274 description: resource-version for concurrency
6277 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
6280 - CloudInfrastructure
6281 summary: returns metadata
6282 description: returns metadata
6283 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
6289 description: successful operation
6291 $ref: "#/getDefinitions/metadata"
6293 description: Response codes found in [response codes](https://wiki.onap.org/).
6297 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6300 example: __CLOUD-OWNER__
6301 - name: cloud-region-id
6303 description: Identifier used by the vendor for the region. Second part of composite key
6306 example: __CLOUD-REGION-ID__
6309 description: Image id, expected to be unique across cloud region
6312 example: __IMAGE-ID__
6318 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
6321 - CloudInfrastructure
6322 summary: returns image
6323 description: returns image
6324 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
6330 description: successful operation
6332 $ref: "#/getDefinitions/image"
6334 description: Response codes found in [response codes](https://wiki.onap.org/).
6338 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6341 example: __CLOUD-OWNER__
6342 - name: cloud-region-id
6344 description: Identifier used by the vendor for the region. Second part of composite key
6347 example: __CLOUD-REGION-ID__
6350 description: Image id, expected to be unique across cloud region
6353 example: __IMAGE-ID__
6356 - CloudInfrastructure
6357 summary: create or update an existing image
6359 Create or update an existing image.
6361 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6362 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6371 description: Response codes found in [response codes](https://wiki.onap.org/).
6375 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6378 example: __CLOUD-OWNER__
6379 - name: cloud-region-id
6381 description: Identifier used by the vendor for the region. Second part of composite key
6384 example: __CLOUD-REGION-ID__
6387 description: Image id, expected to be unique across cloud region
6390 example: __IMAGE-ID__
6393 description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6396 $ref: "#/definitions/image"
6399 - CloudInfrastructure
6400 summary: update an existing image
6402 Update an existing image
6404 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6405 The PUT operation will entirely replace an existing object.
6406 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6408 Other differences between PUT and PATCH are:
6410 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6411 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6412 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6413 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6422 description: Response codes found in [response codes](https://wiki.onap.org/).
6426 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6429 example: __CLOUD-OWNER__
6430 - name: cloud-region-id
6432 description: Identifier used by the vendor for the region. Second part of composite key
6435 example: __CLOUD-REGION-ID__
6438 description: Image id, expected to be unique across cloud region
6441 example: __IMAGE-ID__
6444 description: image object that needs to be updated.
6447 $ref: "#/patchDefinitions/image"
6450 - CloudInfrastructure
6451 summary: delete an existing image
6452 description: delete an existing image
6453 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
6462 description: Response codes found in [response codes](https://wiki.onap.org/).
6466 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6469 example: __CLOUD-OWNER__
6470 - name: cloud-region-id
6472 description: Identifier used by the vendor for the region. Second part of composite key
6475 example: __CLOUD-REGION-ID__
6478 description: Image id, expected to be unique across cloud region
6481 example: __IMAGE-ID__
6482 - name: resource-version
6484 description: resource-version for concurrency
6487 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
6490 - CloudInfrastructure
6491 summary: returns images
6492 description: returns images
6493 operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
6499 description: successful operation
6501 $ref: "#/getDefinitions/images"
6503 description: Response codes found in [response codes](https://wiki.onap.org/).
6507 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6510 example: __CLOUD-OWNER__
6511 - name: cloud-region-id
6513 description: Identifier used by the vendor for the region. Second part of composite key
6516 example: __CLOUD-REGION-ID__
6532 - name: application-vendor
6537 - name: application-version
6542 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
6545 - CloudInfrastructure
6546 summary: see node definition for valid relationships
6547 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6556 description: Response codes found in [response codes](https://wiki.onap.org/).
6560 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6563 example: __CLOUD-OWNER__
6564 - name: cloud-region-id
6566 description: Identifier used by the vendor for the region. Second part of composite key
6569 example: __CLOUD-REGION-ID__
6572 description: DVS switch name
6575 example: __SWITCH-NAME__
6578 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6581 $ref: "#/definitions/relationship"
6584 - CloudInfrastructure
6585 summary: delete an existing relationship
6586 description: delete an existing relationship
6587 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
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__
6612 description: DVS switch name
6615 example: __SWITCH-NAME__
6616 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
6619 - CloudInfrastructure
6620 summary: returns dvs-switch
6621 description: returns dvs-switch
6622 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6628 description: successful operation
6630 $ref: "#/getDefinitions/dvs-switch"
6632 description: Response codes found in [response codes](https://wiki.onap.org/).
6636 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6639 example: __CLOUD-OWNER__
6640 - name: cloud-region-id
6642 description: Identifier used by the vendor for the region. Second part of composite key
6645 example: __CLOUD-REGION-ID__
6648 description: DVS switch name
6651 example: __SWITCH-NAME__
6654 - CloudInfrastructure
6655 summary: create or update an existing dvs-switch
6657 Create or update an existing dvs-switch.
6659 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6660 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6669 description: Response codes found in [response codes](https://wiki.onap.org/).
6673 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6676 example: __CLOUD-OWNER__
6677 - name: cloud-region-id
6679 description: Identifier used by the vendor for the region. Second part of composite key
6682 example: __CLOUD-REGION-ID__
6685 description: DVS switch name
6688 example: __SWITCH-NAME__
6691 description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6694 $ref: "#/definitions/dvs-switch"
6697 - CloudInfrastructure
6698 summary: update an existing dvs-switch
6700 Update an existing dvs-switch
6702 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6703 The PUT operation will entirely replace an existing object.
6704 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6706 Other differences between PUT and PATCH are:
6708 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6709 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6710 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6711 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6720 description: Response codes found in [response codes](https://wiki.onap.org/).
6724 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6727 example: __CLOUD-OWNER__
6728 - name: cloud-region-id
6730 description: Identifier used by the vendor for the region. Second part of composite key
6733 example: __CLOUD-REGION-ID__
6736 description: DVS switch name
6739 example: __SWITCH-NAME__
6742 description: dvs-switch object that needs to be updated.
6745 $ref: "#/patchDefinitions/dvs-switch"
6748 - CloudInfrastructure
6749 summary: delete an existing dvs-switch
6750 description: delete an existing dvs-switch
6751 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6760 description: Response codes found in [response codes](https://wiki.onap.org/).
6764 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6767 example: __CLOUD-OWNER__
6768 - name: cloud-region-id
6770 description: Identifier used by the vendor for the region. Second part of composite key
6773 example: __CLOUD-REGION-ID__
6776 description: DVS switch name
6779 example: __SWITCH-NAME__
6780 - name: resource-version
6782 description: resource-version for concurrency
6785 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6788 - CloudInfrastructure
6789 summary: returns dvs-switches
6790 description: returns dvs-switches
6791 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6797 description: successful operation
6799 $ref: "#/getDefinitions/dvs-switches"
6801 description: Response codes found in [response codes](https://wiki.onap.org/).
6805 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6808 example: __CLOUD-OWNER__
6809 - name: cloud-region-id
6811 description: Identifier used by the vendor for the region. Second part of composite key
6814 example: __CLOUD-REGION-ID__
6825 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6828 - CloudInfrastructure
6829 summary: see node definition for valid relationships
6830 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6839 description: Response codes found in [response codes](https://wiki.onap.org/).
6843 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6846 example: __CLOUD-OWNER__
6847 - name: cloud-region-id
6849 description: Identifier used by the vendor for the region. Second part of composite key
6852 example: __CLOUD-REGION-ID__
6853 - name: network-uuid
6855 description: UUID of the network. Unique across a cloud-region
6858 example: __NETWORK-UUID__
6861 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6864 $ref: "#/definitions/relationship"
6867 - CloudInfrastructure
6868 summary: delete an existing relationship
6869 description: delete an existing relationship
6870 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6879 description: Response codes found in [response codes](https://wiki.onap.org/).
6883 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6886 example: __CLOUD-OWNER__
6887 - name: cloud-region-id
6889 description: Identifier used by the vendor for the region. Second part of composite key
6892 example: __CLOUD-REGION-ID__
6893 - name: network-uuid
6895 description: UUID of the network. Unique across a cloud-region
6898 example: __NETWORK-UUID__
6899 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6902 - CloudInfrastructure
6903 summary: returns oam-network
6904 description: returns oam-network
6905 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6911 description: successful operation
6913 $ref: "#/getDefinitions/oam-network"
6915 description: Response codes found in [response codes](https://wiki.onap.org/).
6919 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6922 example: __CLOUD-OWNER__
6923 - name: cloud-region-id
6925 description: Identifier used by the vendor for the region. Second part of composite key
6928 example: __CLOUD-REGION-ID__
6929 - name: network-uuid
6931 description: UUID of the network. Unique across a cloud-region
6934 example: __NETWORK-UUID__
6937 - CloudInfrastructure
6938 summary: create or update an existing oam-network
6940 Create or update an existing oam-network.
6942 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6943 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6952 description: Response codes found in [response codes](https://wiki.onap.org/).
6956 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6959 example: __CLOUD-OWNER__
6960 - name: cloud-region-id
6962 description: Identifier used by the vendor for the region. Second part of composite key
6965 example: __CLOUD-REGION-ID__
6966 - name: network-uuid
6968 description: UUID of the network. Unique across a cloud-region
6971 example: __NETWORK-UUID__
6974 description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6977 $ref: "#/definitions/oam-network"
6980 - CloudInfrastructure
6981 summary: update an existing oam-network
6983 Update an existing oam-network
6985 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6986 The PUT operation will entirely replace an existing object.
6987 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6989 Other differences between PUT and PATCH are:
6991 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6992 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6993 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6994 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7003 description: Response codes found in [response codes](https://wiki.onap.org/).
7007 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7010 example: __CLOUD-OWNER__
7011 - name: cloud-region-id
7013 description: Identifier used by the vendor for the region. Second part of composite key
7016 example: __CLOUD-REGION-ID__
7017 - name: network-uuid
7019 description: UUID of the network. Unique across a cloud-region
7022 example: __NETWORK-UUID__
7025 description: oam-network object that needs to be updated.
7028 $ref: "#/patchDefinitions/oam-network"
7031 - CloudInfrastructure
7032 summary: delete an existing oam-network
7033 description: delete an existing oam-network
7034 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7043 description: Response codes found in [response codes](https://wiki.onap.org/).
7047 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7050 example: __CLOUD-OWNER__
7051 - name: cloud-region-id
7053 description: Identifier used by the vendor for the region. Second part of composite key
7056 example: __CLOUD-REGION-ID__
7057 - name: network-uuid
7059 description: UUID of the network. Unique across a cloud-region
7062 example: __NETWORK-UUID__
7063 - name: resource-version
7065 description: resource-version for concurrency
7068 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7071 - CloudInfrastructure
7072 summary: returns oam-networks
7073 description: returns oam-networks
7074 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7080 description: successful operation
7082 $ref: "#/getDefinitions/oam-networks"
7084 description: Response codes found in [response codes](https://wiki.onap.org/).
7088 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7091 example: __CLOUD-OWNER__
7092 - name: cloud-region-id
7094 description: Identifier used by the vendor for the region. Second part of composite key
7097 example: __CLOUD-REGION-ID__
7098 - name: network-uuid
7103 - name: network-name
7114 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7117 - CloudInfrastructure
7118 summary: see node definition for valid relationships
7119 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7128 description: Response codes found in [response codes](https://wiki.onap.org/).
7132 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7135 example: __CLOUD-OWNER__
7136 - name: cloud-region-id
7138 description: Identifier used by the vendor for the region. Second part of composite key
7141 example: __CLOUD-REGION-ID__
7142 - name: availability-zone-name
7144 description: Name of the availability zone. Unique across a cloud region
7147 example: __AVAILABILITY-ZONE-NAME__
7150 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7153 $ref: "#/definitions/relationship"
7156 - CloudInfrastructure
7157 summary: delete an existing relationship
7158 description: delete an existing relationship
7159 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7168 description: Response codes found in [response codes](https://wiki.onap.org/).
7172 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7175 example: __CLOUD-OWNER__
7176 - name: cloud-region-id
7178 description: Identifier used by the vendor for the region. Second part of composite key
7181 example: __CLOUD-REGION-ID__
7182 - name: availability-zone-name
7184 description: Name of the availability zone. Unique across a cloud region
7187 example: __AVAILABILITY-ZONE-NAME__
7188 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7191 - CloudInfrastructure
7192 summary: returns availability-zone
7193 description: returns availability-zone
7194 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7200 description: successful operation
7202 $ref: "#/getDefinitions/availability-zone"
7204 description: Response codes found in [response codes](https://wiki.onap.org/).
7208 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7211 example: __CLOUD-OWNER__
7212 - name: cloud-region-id
7214 description: Identifier used by the vendor for the region. Second part of composite key
7217 example: __CLOUD-REGION-ID__
7218 - name: availability-zone-name
7220 description: Name of the availability zone. Unique across a cloud region
7223 example: __AVAILABILITY-ZONE-NAME__
7226 - CloudInfrastructure
7227 summary: create or update an existing availability-zone
7229 Create or update an existing availability-zone.
7231 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7232 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7241 description: Response codes found in [response codes](https://wiki.onap.org/).
7245 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7248 example: __CLOUD-OWNER__
7249 - name: cloud-region-id
7251 description: Identifier used by the vendor for the region. Second part of composite key
7254 example: __CLOUD-REGION-ID__
7255 - name: availability-zone-name
7257 description: Name of the availability zone. Unique across a cloud region
7260 example: __AVAILABILITY-ZONE-NAME__
7263 description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7266 $ref: "#/definitions/availability-zone"
7269 - CloudInfrastructure
7270 summary: update an existing availability-zone
7272 Update an existing availability-zone
7274 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7275 The PUT operation will entirely replace an existing object.
7276 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7278 Other differences between PUT and PATCH are:
7280 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7281 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7282 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7283 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7292 description: Response codes found in [response codes](https://wiki.onap.org/).
7296 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7299 example: __CLOUD-OWNER__
7300 - name: cloud-region-id
7302 description: Identifier used by the vendor for the region. Second part of composite key
7305 example: __CLOUD-REGION-ID__
7306 - name: availability-zone-name
7308 description: Name of the availability zone. Unique across a cloud region
7311 example: __AVAILABILITY-ZONE-NAME__
7314 description: availability-zone object that needs to be updated.
7317 $ref: "#/patchDefinitions/availability-zone"
7320 - CloudInfrastructure
7321 summary: delete an existing availability-zone
7322 description: delete an existing availability-zone
7323 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7332 description: Response codes found in [response codes](https://wiki.onap.org/).
7336 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7339 example: __CLOUD-OWNER__
7340 - name: cloud-region-id
7342 description: Identifier used by the vendor for the region. Second part of composite key
7345 example: __CLOUD-REGION-ID__
7346 - name: availability-zone-name
7348 description: Name of the availability zone. Unique across a cloud region
7351 example: __AVAILABILITY-ZONE-NAME__
7352 - name: resource-version
7354 description: resource-version for concurrency
7357 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
7360 - CloudInfrastructure
7361 summary: returns availability-zones
7362 description: returns availability-zones
7363 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
7369 description: successful operation
7371 $ref: "#/getDefinitions/availability-zones"
7373 description: Response codes found in [response codes](https://wiki.onap.org/).
7377 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7380 example: __CLOUD-OWNER__
7381 - name: cloud-region-id
7383 description: Identifier used by the vendor for the region. Second part of composite key
7386 example: __CLOUD-REGION-ID__
7387 - name: availability-zone-name
7392 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
7395 - CloudInfrastructure
7396 summary: see node definition for valid relationships
7397 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7406 description: Response codes found in [response codes](https://wiki.onap.org/).
7410 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7413 example: __CLOUD-OWNER__
7414 - name: cloud-region-id
7416 description: Identifier used by the vendor for the region. Second part of composite key
7419 example: __CLOUD-REGION-ID__
7422 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegion.json)
7425 $ref: "#/definitions/relationship"
7428 - CloudInfrastructure
7429 summary: delete an existing relationship
7430 description: delete an existing relationship
7431 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7440 description: Response codes found in [response codes](https://wiki.onap.org/).
7444 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7447 example: __CLOUD-OWNER__
7448 - name: cloud-region-id
7450 description: Identifier used by the vendor for the region. Second part of composite key
7453 example: __CLOUD-REGION-ID__
7454 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
7457 - CloudInfrastructure
7458 summary: see node definition for valid relationships
7459 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7468 description: Response codes found in [response codes](https://wiki.onap.org/).
7472 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7475 example: __CLOUD-OWNER__
7476 - name: cloud-region-id
7478 description: Identifier used by the vendor for the region. Second part of composite key
7481 example: __CLOUD-REGION-ID__
7482 - name: vip-ipv4-address
7484 description: IP address
7487 example: __VIP-IPV4-ADDRESS__
7490 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7493 $ref: "#/definitions/relationship"
7496 - CloudInfrastructure
7497 summary: delete an existing relationship
7498 description: delete an existing relationship
7499 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7508 description: Response codes found in [response codes](https://wiki.onap.org/).
7512 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7515 example: __CLOUD-OWNER__
7516 - name: cloud-region-id
7518 description: Identifier used by the vendor for the region. Second part of composite key
7521 example: __CLOUD-REGION-ID__
7522 - name: vip-ipv4-address
7524 description: IP address
7527 example: __VIP-IPV4-ADDRESS__
7528 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
7531 - CloudInfrastructure
7532 summary: returns vip-ipv4-address-list
7533 description: returns vip-ipv4-address-list
7534 operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7540 description: successful operation
7542 $ref: "#/getDefinitions/vip-ipv4-address-list"
7544 description: Response codes found in [response codes](https://wiki.onap.org/).
7548 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7551 example: __CLOUD-OWNER__
7552 - name: cloud-region-id
7554 description: Identifier used by the vendor for the region. Second part of composite key
7557 example: __CLOUD-REGION-ID__
7558 - name: vip-ipv4-address
7560 description: IP address
7563 example: __VIP-IPV4-ADDRESS__
7566 - CloudInfrastructure
7567 summary: create or update an existing vip-ipv4-address-list
7569 Create or update an existing vip-ipv4-address-list.
7571 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7572 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7581 description: Response codes found in [response codes](https://wiki.onap.org/).
7585 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7588 example: __CLOUD-OWNER__
7589 - name: cloud-region-id
7591 description: Identifier used by the vendor for the region. Second part of composite key
7594 example: __CLOUD-REGION-ID__
7595 - name: vip-ipv4-address
7597 description: IP address
7600 example: __VIP-IPV4-ADDRESS__
7603 description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7606 $ref: "#/definitions/vip-ipv4-address-list"
7609 - CloudInfrastructure
7610 summary: update an existing vip-ipv4-address-list
7612 Update an existing vip-ipv4-address-list
7614 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7615 The PUT operation will entirely replace an existing object.
7616 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7618 Other differences between PUT and PATCH are:
7620 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7621 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7622 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7623 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7632 description: Response codes found in [response codes](https://wiki.onap.org/).
7636 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7639 example: __CLOUD-OWNER__
7640 - name: cloud-region-id
7642 description: Identifier used by the vendor for the region. Second part of composite key
7645 example: __CLOUD-REGION-ID__
7646 - name: vip-ipv4-address
7648 description: IP address
7651 example: __VIP-IPV4-ADDRESS__
7654 description: vip-ipv4-address-list object that needs to be updated.
7657 $ref: "#/patchDefinitions/vip-ipv4-address-list"
7660 - CloudInfrastructure
7661 summary: delete an existing vip-ipv4-address-list
7662 description: delete an existing vip-ipv4-address-list
7663 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7672 description: Response codes found in [response codes](https://wiki.onap.org/).
7676 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7679 example: __CLOUD-OWNER__
7680 - name: cloud-region-id
7682 description: Identifier used by the vendor for the region. Second part of composite key
7685 example: __CLOUD-REGION-ID__
7686 - name: vip-ipv4-address
7688 description: IP address
7691 example: __VIP-IPV4-ADDRESS__
7692 - name: resource-version
7694 description: resource-version for concurrency
7697 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
7700 - CloudInfrastructure
7701 summary: see node definition for valid relationships
7702 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7711 description: Response codes found in [response codes](https://wiki.onap.org/).
7715 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7718 example: __CLOUD-OWNER__
7719 - name: cloud-region-id
7721 description: Identifier used by the vendor for the region. Second part of composite key
7724 example: __CLOUD-REGION-ID__
7725 - name: vip-ipv6-address
7727 description: IP address
7730 example: __VIP-IPV6-ADDRESS__
7733 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7736 $ref: "#/definitions/relationship"
7739 - CloudInfrastructure
7740 summary: delete an existing relationship
7741 description: delete an existing relationship
7742 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7751 description: Response codes found in [response codes](https://wiki.onap.org/).
7755 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7758 example: __CLOUD-OWNER__
7759 - name: cloud-region-id
7761 description: Identifier used by the vendor for the region. Second part of composite key
7764 example: __CLOUD-REGION-ID__
7765 - name: vip-ipv6-address
7767 description: IP address
7770 example: __VIP-IPV6-ADDRESS__
7771 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
7774 - CloudInfrastructure
7775 summary: returns vip-ipv6-address-list
7776 description: returns vip-ipv6-address-list
7777 operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7783 description: successful operation
7785 $ref: "#/getDefinitions/vip-ipv6-address-list"
7787 description: Response codes found in [response codes](https://wiki.onap.org/).
7791 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7794 example: __CLOUD-OWNER__
7795 - name: cloud-region-id
7797 description: Identifier used by the vendor for the region. Second part of composite key
7800 example: __CLOUD-REGION-ID__
7801 - name: vip-ipv6-address
7803 description: IP address
7806 example: __VIP-IPV6-ADDRESS__
7809 - CloudInfrastructure
7810 summary: create or update an existing vip-ipv6-address-list
7812 Create or update an existing vip-ipv6-address-list.
7814 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7815 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7824 description: Response codes found in [response codes](https://wiki.onap.org/).
7828 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7831 example: __CLOUD-OWNER__
7832 - name: cloud-region-id
7834 description: Identifier used by the vendor for the region. Second part of composite key
7837 example: __CLOUD-REGION-ID__
7838 - name: vip-ipv6-address
7840 description: IP address
7843 example: __VIP-IPV6-ADDRESS__
7846 description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7849 $ref: "#/definitions/vip-ipv6-address-list"
7852 - CloudInfrastructure
7853 summary: update an existing vip-ipv6-address-list
7855 Update an existing vip-ipv6-address-list
7857 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7858 The PUT operation will entirely replace an existing object.
7859 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7861 Other differences between PUT and PATCH are:
7863 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7864 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7865 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7866 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7875 description: Response codes found in [response codes](https://wiki.onap.org/).
7879 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7882 example: __CLOUD-OWNER__
7883 - name: cloud-region-id
7885 description: Identifier used by the vendor for the region. Second part of composite key
7888 example: __CLOUD-REGION-ID__
7889 - name: vip-ipv6-address
7891 description: IP address
7894 example: __VIP-IPV6-ADDRESS__
7897 description: vip-ipv6-address-list object that needs to be updated.
7900 $ref: "#/patchDefinitions/vip-ipv6-address-list"
7903 - CloudInfrastructure
7904 summary: delete an existing vip-ipv6-address-list
7905 description: delete an existing vip-ipv6-address-list
7906 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7915 description: Response codes found in [response codes](https://wiki.onap.org/).
7919 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7922 example: __CLOUD-OWNER__
7923 - name: cloud-region-id
7925 description: Identifier used by the vendor for the region. Second part of composite key
7928 example: __CLOUD-REGION-ID__
7929 - name: vip-ipv6-address
7931 description: IP address
7934 example: __VIP-IPV6-ADDRESS__
7935 - name: resource-version
7937 description: resource-version for concurrency
7940 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
7943 - CloudInfrastructure
7944 summary: see node definition for valid relationships
7945 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
7954 description: Response codes found in [response codes](https://wiki.onap.org/).
7958 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7961 example: __CLOUD-OWNER__
7962 - name: cloud-region-id
7964 description: Identifier used by the vendor for the region. Second part of composite key
7967 example: __CLOUD-REGION-ID__
7968 - name: hpa-capability-id
7970 description: UUID to uniquely identify a HPA capability
7973 example: __HPA-CAPABILITY-ID__
7976 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
7979 $ref: "#/definitions/relationship"
7982 - CloudInfrastructure
7983 summary: delete an existing relationship
7984 description: delete an existing relationship
7985 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
7994 description: Response codes found in [response codes](https://wiki.onap.org/).
7998 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8001 example: __CLOUD-OWNER__
8002 - name: cloud-region-id
8004 description: Identifier used by the vendor for the region. Second part of composite key
8007 example: __CLOUD-REGION-ID__
8008 - name: hpa-capability-id
8010 description: UUID to uniquely identify a HPA capability
8013 example: __HPA-CAPABILITY-ID__
8014 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
8017 - CloudInfrastructure
8018 summary: see node definition for valid relationships
8019 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8028 description: Response codes found in [response codes](https://wiki.onap.org/).
8032 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8035 example: __CLOUD-OWNER__
8036 - name: cloud-region-id
8038 description: Identifier used by the vendor for the region. Second part of composite key
8041 example: __CLOUD-REGION-ID__
8042 - name: hpa-capability-id
8044 description: UUID to uniquely identify a HPA capability
8047 example: __HPA-CAPABILITY-ID__
8048 - name: hpa-attribute-key
8050 description: name of the specific HPA attribute
8053 example: __HPA-ATTRIBUTE-KEY__
8056 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8059 $ref: "#/definitions/relationship"
8062 - CloudInfrastructure
8063 summary: delete an existing relationship
8064 description: delete an existing relationship
8065 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8074 description: Response codes found in [response codes](https://wiki.onap.org/).
8078 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8081 example: __CLOUD-OWNER__
8082 - name: cloud-region-id
8084 description: Identifier used by the vendor for the region. Second part of composite key
8087 example: __CLOUD-REGION-ID__
8088 - name: hpa-capability-id
8090 description: UUID to uniquely identify a HPA capability
8093 example: __HPA-CAPABILITY-ID__
8094 - name: hpa-attribute-key
8096 description: name of the specific HPA attribute
8099 example: __HPA-ATTRIBUTE-KEY__
8100 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
8103 - CloudInfrastructure
8104 summary: returns hpa-feature-attributes
8105 description: returns hpa-feature-attributes
8106 operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8112 description: successful operation
8114 $ref: "#/getDefinitions/hpa-feature-attributes"
8116 description: Response codes found in [response codes](https://wiki.onap.org/).
8120 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8123 example: __CLOUD-OWNER__
8124 - name: cloud-region-id
8126 description: Identifier used by the vendor for the region. Second part of composite key
8129 example: __CLOUD-REGION-ID__
8130 - name: hpa-capability-id
8132 description: UUID to uniquely identify a HPA capability
8135 example: __HPA-CAPABILITY-ID__
8136 - name: hpa-attribute-key
8138 description: name of the specific HPA attribute
8141 example: __HPA-ATTRIBUTE-KEY__
8144 - CloudInfrastructure
8145 summary: create or update an existing hpa-feature-attributes
8147 Create or update an existing hpa-feature-attributes.
8149 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8150 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8159 description: Response codes found in [response codes](https://wiki.onap.org/).
8163 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8166 example: __CLOUD-OWNER__
8167 - name: cloud-region-id
8169 description: Identifier used by the vendor for the region. Second part of composite key
8172 example: __CLOUD-REGION-ID__
8173 - name: hpa-capability-id
8175 description: UUID to uniquely identify a HPA capability
8178 example: __HPA-CAPABILITY-ID__
8179 - name: hpa-attribute-key
8181 description: name of the specific HPA attribute
8184 example: __HPA-ATTRIBUTE-KEY__
8187 description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8190 $ref: "#/definitions/hpa-feature-attributes"
8193 - CloudInfrastructure
8194 summary: update an existing hpa-feature-attributes
8196 Update an existing hpa-feature-attributes
8198 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8199 The PUT operation will entirely replace an existing object.
8200 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8202 Other differences between PUT and PATCH are:
8204 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8205 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8206 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8207 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8216 description: Response codes found in [response codes](https://wiki.onap.org/).
8220 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8223 example: __CLOUD-OWNER__
8224 - name: cloud-region-id
8226 description: Identifier used by the vendor for the region. Second part of composite key
8229 example: __CLOUD-REGION-ID__
8230 - name: hpa-capability-id
8232 description: UUID to uniquely identify a HPA capability
8235 example: __HPA-CAPABILITY-ID__
8236 - name: hpa-attribute-key
8238 description: name of the specific HPA attribute
8241 example: __HPA-ATTRIBUTE-KEY__
8244 description: hpa-feature-attributes object that needs to be updated.
8247 $ref: "#/patchDefinitions/hpa-feature-attributes"
8250 - CloudInfrastructure
8251 summary: delete an existing hpa-feature-attributes
8252 description: delete an existing hpa-feature-attributes
8253 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8262 description: Response codes found in [response codes](https://wiki.onap.org/).
8266 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8269 example: __CLOUD-OWNER__
8270 - name: cloud-region-id
8272 description: Identifier used by the vendor for the region. Second part of composite key
8275 example: __CLOUD-REGION-ID__
8276 - name: hpa-capability-id
8278 description: UUID to uniquely identify a HPA capability
8281 example: __HPA-CAPABILITY-ID__
8282 - name: hpa-attribute-key
8284 description: name of the specific HPA attribute
8287 example: __HPA-ATTRIBUTE-KEY__
8288 - name: resource-version
8290 description: resource-version for concurrency
8293 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
8296 - CloudInfrastructure
8297 summary: returns hpa-capability
8298 description: returns hpa-capability
8299 operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8305 description: successful operation
8307 $ref: "#/getDefinitions/hpa-capability"
8309 description: Response codes found in [response codes](https://wiki.onap.org/).
8313 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8316 example: __CLOUD-OWNER__
8317 - name: cloud-region-id
8319 description: Identifier used by the vendor for the region. Second part of composite key
8322 example: __CLOUD-REGION-ID__
8323 - name: hpa-capability-id
8325 description: UUID to uniquely identify a HPA capability
8328 example: __HPA-CAPABILITY-ID__
8331 - CloudInfrastructure
8332 summary: create or update an existing hpa-capability
8334 Create or update an existing hpa-capability.
8336 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8337 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8346 description: Response codes found in [response codes](https://wiki.onap.org/).
8350 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8353 example: __CLOUD-OWNER__
8354 - name: cloud-region-id
8356 description: Identifier used by the vendor for the region. Second part of composite key
8359 example: __CLOUD-REGION-ID__
8360 - name: hpa-capability-id
8362 description: UUID to uniquely identify a HPA capability
8365 example: __HPA-CAPABILITY-ID__
8368 description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
8371 $ref: "#/definitions/hpa-capability"
8374 - CloudInfrastructure
8375 summary: update an existing hpa-capability
8377 Update an existing hpa-capability
8379 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8380 The PUT operation will entirely replace an existing object.
8381 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8383 Other differences between PUT and PATCH are:
8385 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8386 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8387 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8388 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8397 description: Response codes found in [response codes](https://wiki.onap.org/).
8401 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8404 example: __CLOUD-OWNER__
8405 - name: cloud-region-id
8407 description: Identifier used by the vendor for the region. Second part of composite key
8410 example: __CLOUD-REGION-ID__
8411 - name: hpa-capability-id
8413 description: UUID to uniquely identify a HPA capability
8416 example: __HPA-CAPABILITY-ID__
8419 description: hpa-capability object that needs to be updated.
8422 $ref: "#/patchDefinitions/hpa-capability"
8425 - CloudInfrastructure
8426 summary: delete an existing hpa-capability
8427 description: delete an existing hpa-capability
8428 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8437 description: Response codes found in [response codes](https://wiki.onap.org/).
8441 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8444 example: __CLOUD-OWNER__
8445 - name: cloud-region-id
8447 description: Identifier used by the vendor for the region. Second part of composite key
8450 example: __CLOUD-REGION-ID__
8451 - name: hpa-capability-id
8453 description: UUID to uniquely identify a HPA capability
8456 example: __HPA-CAPABILITY-ID__
8457 - name: resource-version
8459 description: resource-version for concurrency
8462 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities:
8465 - CloudInfrastructure
8466 summary: returns hpa-capabilities
8467 description: returns hpa-capabilities
8468 operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities
8474 description: successful operation
8476 $ref: "#/getDefinitions/hpa-capabilities"
8478 description: Response codes found in [response codes](https://wiki.onap.org/).
8482 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8485 example: __CLOUD-OWNER__
8486 - name: cloud-region-id
8488 description: Identifier used by the vendor for the region. Second part of composite key
8491 example: __CLOUD-REGION-ID__
8492 - name: hpa-capability-id
8502 - name: architecture
8507 /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:
8510 - CloudInfrastructure
8511 summary: see node definition for valid relationships
8512 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
8521 description: Response codes found in [response codes](https://wiki.onap.org/).
8525 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8528 example: __CLOUD-OWNER__
8529 - name: cloud-region-id
8531 description: Identifier used by the vendor for the region. Second part of composite key
8534 example: __CLOUD-REGION-ID__
8535 - name: esr-system-info-id
8537 description: Unique ID of esr system info.
8540 example: __ESR-SYSTEM-INFO-ID__
8543 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
8546 $ref: "#/definitions/relationship"
8549 - CloudInfrastructure
8550 summary: delete an existing relationship
8551 description: delete an existing relationship
8552 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
8561 description: Response codes found in [response codes](https://wiki.onap.org/).
8565 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8568 example: __CLOUD-OWNER__
8569 - name: cloud-region-id
8571 description: Identifier used by the vendor for the region. Second part of composite key
8574 example: __CLOUD-REGION-ID__
8575 - name: esr-system-info-id
8577 description: Unique ID of esr system info.
8580 example: __ESR-SYSTEM-INFO-ID__
8581 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
8584 - CloudInfrastructure
8585 summary: returns esr-system-info
8586 description: returns esr-system-info
8587 operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
8593 description: successful operation
8595 $ref: "#/getDefinitions/esr-system-info"
8597 description: Response codes found in [response codes](https://wiki.onap.org/).
8601 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8604 example: __CLOUD-OWNER__
8605 - name: cloud-region-id
8607 description: Identifier used by the vendor for the region. Second part of composite key
8610 example: __CLOUD-REGION-ID__
8611 - name: esr-system-info-id
8613 description: Unique ID of esr system info.
8616 example: __ESR-SYSTEM-INFO-ID__
8619 - CloudInfrastructure
8620 summary: create or update an existing esr-system-info
8622 Create or update an existing esr-system-info.
8624 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8625 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
8634 description: Response codes found in [response codes](https://wiki.onap.org/).
8638 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8641 example: __CLOUD-OWNER__
8642 - name: cloud-region-id
8644 description: Identifier used by the vendor for the region. Second part of composite key
8647 example: __CLOUD-REGION-ID__
8648 - name: esr-system-info-id
8650 description: Unique ID of esr system info.
8653 example: __ESR-SYSTEM-INFO-ID__
8656 description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
8659 $ref: "#/definitions/esr-system-info"
8662 - CloudInfrastructure
8663 summary: update an existing esr-system-info
8665 Update an existing esr-system-info
8667 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8668 The PUT operation will entirely replace an existing object.
8669 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8671 Other differences between PUT and PATCH are:
8673 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8674 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8675 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8676 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
8685 description: Response codes found in [response codes](https://wiki.onap.org/).
8689 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8692 example: __CLOUD-OWNER__
8693 - name: cloud-region-id
8695 description: Identifier used by the vendor for the region. Second part of composite key
8698 example: __CLOUD-REGION-ID__
8699 - name: esr-system-info-id
8701 description: Unique ID of esr system info.
8704 example: __ESR-SYSTEM-INFO-ID__
8707 description: esr-system-info object that needs to be updated.
8710 $ref: "#/patchDefinitions/esr-system-info"
8713 - CloudInfrastructure
8714 summary: delete an existing esr-system-info
8715 description: delete an existing esr-system-info
8716 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
8725 description: Response codes found in [response codes](https://wiki.onap.org/).
8729 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8732 example: __CLOUD-OWNER__
8733 - name: cloud-region-id
8735 description: Identifier used by the vendor for the region. Second part of composite key
8738 example: __CLOUD-REGION-ID__
8739 - name: esr-system-info-id
8741 description: Unique ID of esr system info.
8744 example: __ESR-SYSTEM-INFO-ID__
8745 - name: resource-version
8747 description: resource-version for concurrency
8750 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
8753 - CloudInfrastructure
8754 summary: returns esr-system-info-list
8755 description: returns esr-system-info-list
8756 operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
8762 description: successful operation
8764 $ref: "#/getDefinitions/esr-system-info-list"
8766 description: Response codes found in [response codes](https://wiki.onap.org/).
8770 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8773 example: __CLOUD-OWNER__
8774 - name: cloud-region-id
8776 description: Identifier used by the vendor for the region. Second part of composite key
8779 example: __CLOUD-REGION-ID__
8780 - name: esr-system-info-id
8795 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
8798 - CloudInfrastructure
8799 summary: returns cloud-region
8800 description: returns cloud-region
8801 operationId: getCloudInfrastructureCloudRegionsCloudRegion
8807 description: successful operation
8809 $ref: "#/getDefinitions/cloud-region"
8811 description: Response codes found in [response codes](https://wiki.onap.org/).
8815 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8818 example: __CLOUD-OWNER__
8819 - name: cloud-region-id
8821 description: Identifier used by the vendor for the region. Second part of composite key
8824 example: __CLOUD-REGION-ID__
8827 - CloudInfrastructure
8828 summary: create or update an existing cloud-region
8830 Create or update an existing cloud-region.
8832 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8833 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
8842 description: Response codes found in [response codes](https://wiki.onap.org/).
8846 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8849 example: __CLOUD-OWNER__
8850 - name: cloud-region-id
8852 description: Identifier used by the vendor for the region. Second part of composite key
8855 example: __CLOUD-REGION-ID__
8858 description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegion.json)
8861 $ref: "#/definitions/cloud-region"
8864 - CloudInfrastructure
8865 summary: update an existing cloud-region
8867 Update an existing cloud-region
8869 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8870 The PUT operation will entirely replace an existing object.
8871 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8873 Other differences between PUT and PATCH are:
8875 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8876 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8877 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8878 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
8887 description: Response codes found in [response codes](https://wiki.onap.org/).
8891 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8894 example: __CLOUD-OWNER__
8895 - name: cloud-region-id
8897 description: Identifier used by the vendor for the region. Second part of composite key
8900 example: __CLOUD-REGION-ID__
8903 description: cloud-region object that needs to be updated.
8906 $ref: "#/patchDefinitions/cloud-region"
8909 - CloudInfrastructure
8910 summary: delete an existing cloud-region
8911 description: delete an existing cloud-region
8912 operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
8921 description: Response codes found in [response codes](https://wiki.onap.org/).
8925 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8928 example: __CLOUD-OWNER__
8929 - name: cloud-region-id
8931 description: Identifier used by the vendor for the region. Second part of composite key
8934 example: __CLOUD-REGION-ID__
8935 - name: resource-version
8937 description: resource-version for concurrency
8940 /cloud-infrastructure/cloud-regions:
8943 - CloudInfrastructure
8944 summary: returns cloud-regions
8945 description: returns cloud-regions
8946 operationId: getCloudInfrastructureCloudRegions
8952 description: successful operation
8954 $ref: "#/getDefinitions/cloud-regions"
8956 description: Response codes found in [response codes](https://wiki.onap.org/).
8963 - name: cloud-region-id
8973 - name: owner-defined-type
8978 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
8981 - CloudInfrastructure
8982 summary: see node definition for valid relationships
8983 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8992 description: Response codes found in [response codes](https://wiki.onap.org/).
8994 - name: nm-profile-name
8996 description: Unique name of network profile.
8999 example: __NM-PROFILE-NAME__
9002 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)
9005 $ref: "#/definitions/relationship"
9008 - CloudInfrastructure
9009 summary: delete an existing relationship
9010 description: delete an existing relationship
9011 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
9020 description: Response codes found in [response codes](https://wiki.onap.org/).
9022 - name: nm-profile-name
9024 description: Unique name of network profile.
9027 example: __NM-PROFILE-NAME__
9028 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
9031 - CloudInfrastructure
9032 summary: returns network-profile
9033 description: returns network-profile
9034 operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
9040 description: successful operation
9042 $ref: "#/getDefinitions/network-profile"
9044 description: Response codes found in [response codes](https://wiki.onap.org/).
9046 - name: nm-profile-name
9048 description: Unique name of network profile.
9051 example: __NM-PROFILE-NAME__
9054 - CloudInfrastructure
9055 summary: create or update an existing network-profile
9057 Create or update an existing network-profile.
9059 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9060 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
9069 description: Response codes found in [response codes](https://wiki.onap.org/).
9071 - name: nm-profile-name
9073 description: Unique name of network profile.
9076 example: __NM-PROFILE-NAME__
9079 description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)
9082 $ref: "#/definitions/network-profile"
9085 - CloudInfrastructure
9086 summary: update an existing network-profile
9088 Update an existing network-profile
9090 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9091 The PUT operation will entirely replace an existing object.
9092 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9094 Other differences between PUT and PATCH are:
9096 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9097 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9098 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9099 operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
9108 description: Response codes found in [response codes](https://wiki.onap.org/).
9110 - name: nm-profile-name
9112 description: Unique name of network profile.
9115 example: __NM-PROFILE-NAME__
9118 description: network-profile object that needs to be updated.
9121 $ref: "#/patchDefinitions/network-profile"
9124 - CloudInfrastructure
9125 summary: delete an existing network-profile
9126 description: delete an existing network-profile
9127 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
9136 description: Response codes found in [response codes](https://wiki.onap.org/).
9138 - name: nm-profile-name
9140 description: Unique name of network profile.
9143 example: __NM-PROFILE-NAME__
9144 - name: resource-version
9146 description: resource-version for concurrency
9149 /cloud-infrastructure/network-profiles:
9152 - CloudInfrastructure
9153 summary: returns network-profiles
9154 description: returns network-profiles
9155 operationId: getCloudInfrastructureNetworkProfiles
9161 description: successful operation
9163 $ref: "#/getDefinitions/network-profiles"
9165 description: Response codes found in [response codes](https://wiki.onap.org/).
9167 - name: nm-profile-name
9172 /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
9175 - CloudInfrastructure
9176 summary: see node definition for valid relationships
9177 operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
9186 description: Response codes found in [response codes](https://wiki.onap.org/).
9190 description: Value from executing hostname on the compute node.
9193 example: __HOSTNAME__
9196 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserver.json)
9199 $ref: "#/definitions/relationship"
9202 - CloudInfrastructure
9203 summary: delete an existing relationship
9204 description: delete an existing relationship
9205 operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
9214 description: Response codes found in [response codes](https://wiki.onap.org/).
9218 description: Value from executing hostname on the compute node.
9221 example: __HOSTNAME__
9222 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
9225 - CloudInfrastructure
9226 summary: see node definition for valid relationships
9227 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9236 description: Response codes found in [response codes](https://wiki.onap.org/).
9240 description: Value from executing hostname on the compute node.
9243 example: __HOSTNAME__
9244 - name: interface-name
9246 description: Name that identifies the physical interface
9249 example: __INTERFACE-NAME__
9252 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9255 $ref: "#/definitions/relationship"
9258 - CloudInfrastructure
9259 summary: delete an existing relationship
9260 description: delete an existing relationship
9261 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9270 description: Response codes found in [response codes](https://wiki.onap.org/).
9274 description: Value from executing hostname on the compute node.
9277 example: __HOSTNAME__
9278 - name: interface-name
9280 description: Name that identifies the physical interface
9283 example: __INTERFACE-NAME__
9284 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
9287 - CloudInfrastructure
9288 summary: see node definition for valid relationships
9289 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9298 description: Response codes found in [response codes](https://wiki.onap.org/).
9302 description: Value from executing hostname on the compute node.
9305 example: __HOSTNAME__
9306 - name: interface-name
9308 description: Name that identifies the physical interface
9311 example: __INTERFACE-NAME__
9314 description: Identifier for the sriov-pf
9317 example: __PF-PCI-ID__
9320 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9323 $ref: "#/definitions/relationship"
9326 - CloudInfrastructure
9327 summary: delete an existing relationship
9328 description: delete an existing relationship
9329 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9338 description: Response codes found in [response codes](https://wiki.onap.org/).
9342 description: Value from executing hostname on the compute node.
9345 example: __HOSTNAME__
9346 - name: interface-name
9348 description: Name that identifies the physical interface
9351 example: __INTERFACE-NAME__
9354 description: Identifier for the sriov-pf
9357 example: __PF-PCI-ID__
9358 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
9361 - CloudInfrastructure
9362 summary: returns sriov-pf
9363 description: returns sriov-pf
9364 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9370 description: successful operation
9372 $ref: "#/getDefinitions/sriov-pf"
9374 description: Response codes found in [response codes](https://wiki.onap.org/).
9378 description: Value from executing hostname on the compute node.
9381 example: __HOSTNAME__
9382 - name: interface-name
9384 description: Name that identifies the physical interface
9387 example: __INTERFACE-NAME__
9390 description: Identifier for the sriov-pf
9393 example: __PF-PCI-ID__
9396 - CloudInfrastructure
9397 summary: create or update an existing sriov-pf
9399 Create or update an existing sriov-pf.
9401 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9402 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9411 description: Response codes found in [response codes](https://wiki.onap.org/).
9415 description: Value from executing hostname on the compute node.
9418 example: __HOSTNAME__
9419 - name: interface-name
9421 description: Name that identifies the physical interface
9424 example: __INTERFACE-NAME__
9427 description: Identifier for the sriov-pf
9430 example: __PF-PCI-ID__
9433 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9436 $ref: "#/definitions/sriov-pf"
9439 - CloudInfrastructure
9440 summary: update an existing sriov-pf
9442 Update an existing sriov-pf
9444 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9445 The PUT operation will entirely replace an existing object.
9446 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9448 Other differences between PUT and PATCH are:
9450 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9451 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9452 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9453 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9462 description: Response codes found in [response codes](https://wiki.onap.org/).
9466 description: Value from executing hostname on the compute node.
9469 example: __HOSTNAME__
9470 - name: interface-name
9472 description: Name that identifies the physical interface
9475 example: __INTERFACE-NAME__
9478 description: Identifier for the sriov-pf
9481 example: __PF-PCI-ID__
9484 description: sriov-pf object that needs to be updated.
9487 $ref: "#/patchDefinitions/sriov-pf"
9490 - CloudInfrastructure
9491 summary: delete an existing sriov-pf
9492 description: delete an existing sriov-pf
9493 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9502 description: Response codes found in [response codes](https://wiki.onap.org/).
9506 description: Value from executing hostname on the compute node.
9509 example: __HOSTNAME__
9510 - name: interface-name
9512 description: Name that identifies the physical interface
9515 example: __INTERFACE-NAME__
9518 description: Identifier for the sriov-pf
9521 example: __PF-PCI-ID__
9522 - name: resource-version
9524 description: resource-version for concurrency
9527 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
9530 - CloudInfrastructure
9531 summary: returns sriov-pfs
9532 description: returns sriov-pfs
9533 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
9539 description: successful operation
9541 $ref: "#/getDefinitions/sriov-pfs"
9543 description: Response codes found in [response codes](https://wiki.onap.org/).
9547 description: Value from executing hostname on the compute node.
9550 example: __HOSTNAME__
9551 - name: interface-name
9553 description: Name that identifies the physical interface
9556 example: __INTERFACE-NAME__
9562 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9565 - CloudInfrastructure
9566 summary: see node definition for valid relationships
9567 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9576 description: Response codes found in [response codes](https://wiki.onap.org/).
9580 description: Value from executing hostname on the compute node.
9583 example: __HOSTNAME__
9584 - name: interface-name
9586 description: Name that identifies the physical interface
9589 example: __INTERFACE-NAME__
9590 - name: interface-name
9592 description: Name given to the interface
9595 example: __INTERFACE-NAME__
9596 - name: vlan-interface
9598 description: String that identifies the interface
9601 example: __VLAN-INTERFACE__
9604 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9607 $ref: "#/definitions/relationship"
9610 - CloudInfrastructure
9611 summary: delete an existing relationship
9612 description: delete an existing relationship
9613 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9622 description: Response codes found in [response codes](https://wiki.onap.org/).
9626 description: Value from executing hostname on the compute node.
9629 example: __HOSTNAME__
9630 - name: interface-name
9632 description: Name that identifies the physical interface
9635 example: __INTERFACE-NAME__
9636 - name: interface-name
9638 description: Name given to the interface
9641 example: __INTERFACE-NAME__
9642 - name: vlan-interface
9644 description: String that identifies the interface
9647 example: __VLAN-INTERFACE__
9648 /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:
9651 - CloudInfrastructure
9652 summary: see node definition for valid relationships
9653 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9662 description: Response codes found in [response codes](https://wiki.onap.org/).
9666 description: Value from executing hostname on the compute node.
9669 example: __HOSTNAME__
9670 - name: interface-name
9672 description: Name that identifies the physical interface
9675 example: __INTERFACE-NAME__
9676 - name: interface-name
9678 description: Name given to the interface
9681 example: __INTERFACE-NAME__
9682 - name: vlan-interface
9684 description: String that identifies the interface
9687 example: __VLAN-INTERFACE__
9688 - name: l3-interface-ipv4-address
9690 description: IP address
9693 example: __L3-INTERFACE-IPV4-ADDRESS__
9696 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9699 $ref: "#/definitions/relationship"
9702 - CloudInfrastructure
9703 summary: delete an existing relationship
9704 description: delete an existing relationship
9705 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9714 description: Response codes found in [response codes](https://wiki.onap.org/).
9718 description: Value from executing hostname on the compute node.
9721 example: __HOSTNAME__
9722 - name: interface-name
9724 description: Name that identifies the physical interface
9727 example: __INTERFACE-NAME__
9728 - name: interface-name
9730 description: Name given to the interface
9733 example: __INTERFACE-NAME__
9734 - name: vlan-interface
9736 description: String that identifies the interface
9739 example: __VLAN-INTERFACE__
9740 - name: l3-interface-ipv4-address
9742 description: IP address
9745 example: __L3-INTERFACE-IPV4-ADDRESS__
9746 /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}:
9749 - CloudInfrastructure
9750 summary: returns l3-interface-ipv4-address-list
9751 description: returns l3-interface-ipv4-address-list
9752 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9758 description: successful operation
9760 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9762 description: Response codes found in [response codes](https://wiki.onap.org/).
9766 description: Value from executing hostname on the compute node.
9769 example: __HOSTNAME__
9770 - name: interface-name
9772 description: Name that identifies the physical interface
9775 example: __INTERFACE-NAME__
9776 - name: interface-name
9778 description: Name given to the interface
9781 example: __INTERFACE-NAME__
9782 - name: vlan-interface
9784 description: String that identifies the interface
9787 example: __VLAN-INTERFACE__
9788 - name: l3-interface-ipv4-address
9790 description: IP address
9793 example: __L3-INTERFACE-IPV4-ADDRESS__
9796 - CloudInfrastructure
9797 summary: create or update an existing l3-interface-ipv4-address-list
9799 Create or update an existing l3-interface-ipv4-address-list.
9801 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9802 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9811 description: Response codes found in [response codes](https://wiki.onap.org/).
9815 description: Value from executing hostname on the compute node.
9818 example: __HOSTNAME__
9819 - name: interface-name
9821 description: Name that identifies the physical interface
9824 example: __INTERFACE-NAME__
9825 - name: interface-name
9827 description: Name given to the interface
9830 example: __INTERFACE-NAME__
9831 - name: vlan-interface
9833 description: String that identifies the interface
9836 example: __VLAN-INTERFACE__
9837 - name: l3-interface-ipv4-address
9839 description: IP address
9842 example: __L3-INTERFACE-IPV4-ADDRESS__
9845 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9848 $ref: "#/definitions/l3-interface-ipv4-address-list"
9851 - CloudInfrastructure
9852 summary: update an existing l3-interface-ipv4-address-list
9854 Update an existing l3-interface-ipv4-address-list
9856 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9857 The PUT operation will entirely replace an existing object.
9858 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9860 Other differences between PUT and PATCH are:
9862 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9863 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9864 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9865 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9874 description: Response codes found in [response codes](https://wiki.onap.org/).
9878 description: Value from executing hostname on the compute node.
9881 example: __HOSTNAME__
9882 - name: interface-name
9884 description: Name that identifies the physical interface
9887 example: __INTERFACE-NAME__
9888 - name: interface-name
9890 description: Name given to the interface
9893 example: __INTERFACE-NAME__
9894 - name: vlan-interface
9896 description: String that identifies the interface
9899 example: __VLAN-INTERFACE__
9900 - name: l3-interface-ipv4-address
9902 description: IP address
9905 example: __L3-INTERFACE-IPV4-ADDRESS__
9908 description: l3-interface-ipv4-address-list object that needs to be updated.
9911 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9914 - CloudInfrastructure
9915 summary: delete an existing l3-interface-ipv4-address-list
9916 description: delete an existing l3-interface-ipv4-address-list
9917 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9926 description: Response codes found in [response codes](https://wiki.onap.org/).
9930 description: Value from executing hostname on the compute node.
9933 example: __HOSTNAME__
9934 - name: interface-name
9936 description: Name that identifies the physical interface
9939 example: __INTERFACE-NAME__
9940 - name: interface-name
9942 description: Name given to the interface
9945 example: __INTERFACE-NAME__
9946 - name: vlan-interface
9948 description: String that identifies the interface
9951 example: __VLAN-INTERFACE__
9952 - name: l3-interface-ipv4-address
9954 description: IP address
9957 example: __L3-INTERFACE-IPV4-ADDRESS__
9958 - name: resource-version
9960 description: resource-version for concurrency
9963 /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:
9966 - CloudInfrastructure
9967 summary: see node definition for valid relationships
9968 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9977 description: Response codes found in [response codes](https://wiki.onap.org/).
9981 description: Value from executing hostname on the compute node.
9984 example: __HOSTNAME__
9985 - name: interface-name
9987 description: Name that identifies the physical interface
9990 example: __INTERFACE-NAME__
9991 - name: interface-name
9993 description: Name given to the interface
9996 example: __INTERFACE-NAME__
9997 - name: vlan-interface
9999 description: String that identifies the interface
10002 example: __VLAN-INTERFACE__
10003 - name: l3-interface-ipv6-address
10005 description: IP address
10008 example: __L3-INTERFACE-IPV6-ADDRESS__
10011 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10014 $ref: "#/definitions/relationship"
10017 - CloudInfrastructure
10018 summary: delete an existing relationship
10019 description: delete an existing relationship
10020 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10029 description: Response codes found in [response codes](https://wiki.onap.org/).
10033 description: Value from executing hostname on the compute node.
10036 example: __HOSTNAME__
10037 - name: interface-name
10039 description: Name that identifies the physical interface
10042 example: __INTERFACE-NAME__
10043 - name: interface-name
10045 description: Name given to the interface
10048 example: __INTERFACE-NAME__
10049 - name: vlan-interface
10051 description: String that identifies the interface
10054 example: __VLAN-INTERFACE__
10055 - name: l3-interface-ipv6-address
10057 description: IP address
10060 example: __L3-INTERFACE-IPV6-ADDRESS__
10061 /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}:
10064 - CloudInfrastructure
10065 summary: returns l3-interface-ipv6-address-list
10066 description: returns l3-interface-ipv6-address-list
10067 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10073 description: successful operation
10075 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10077 description: Response codes found in [response codes](https://wiki.onap.org/).
10081 description: Value from executing hostname on the compute node.
10084 example: __HOSTNAME__
10085 - name: interface-name
10087 description: Name that identifies the physical interface
10090 example: __INTERFACE-NAME__
10091 - name: interface-name
10093 description: Name given to the interface
10096 example: __INTERFACE-NAME__
10097 - name: vlan-interface
10099 description: String that identifies the interface
10102 example: __VLAN-INTERFACE__
10103 - name: l3-interface-ipv6-address
10105 description: IP address
10108 example: __L3-INTERFACE-IPV6-ADDRESS__
10111 - CloudInfrastructure
10112 summary: create or update an existing l3-interface-ipv6-address-list
10114 Create or update an existing l3-interface-ipv6-address-list.
10116 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10117 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10126 description: Response codes found in [response codes](https://wiki.onap.org/).
10130 description: Value from executing hostname on the compute node.
10133 example: __HOSTNAME__
10134 - name: interface-name
10136 description: Name that identifies the physical interface
10139 example: __INTERFACE-NAME__
10140 - name: interface-name
10142 description: Name given to the interface
10145 example: __INTERFACE-NAME__
10146 - name: vlan-interface
10148 description: String that identifies the interface
10151 example: __VLAN-INTERFACE__
10152 - name: l3-interface-ipv6-address
10154 description: IP address
10157 example: __L3-INTERFACE-IPV6-ADDRESS__
10160 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10163 $ref: "#/definitions/l3-interface-ipv6-address-list"
10166 - CloudInfrastructure
10167 summary: update an existing l3-interface-ipv6-address-list
10169 Update an existing l3-interface-ipv6-address-list
10171 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10172 The PUT operation will entirely replace an existing object.
10173 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10175 Other differences between PUT and PATCH are:
10177 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10178 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10179 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10180 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10189 description: Response codes found in [response codes](https://wiki.onap.org/).
10193 description: Value from executing hostname on the compute node.
10196 example: __HOSTNAME__
10197 - name: interface-name
10199 description: Name that identifies the physical interface
10202 example: __INTERFACE-NAME__
10203 - name: interface-name
10205 description: Name given to the interface
10208 example: __INTERFACE-NAME__
10209 - name: vlan-interface
10211 description: String that identifies the interface
10214 example: __VLAN-INTERFACE__
10215 - name: l3-interface-ipv6-address
10217 description: IP address
10220 example: __L3-INTERFACE-IPV6-ADDRESS__
10223 description: l3-interface-ipv6-address-list object that needs to be updated.
10226 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10229 - CloudInfrastructure
10230 summary: delete an existing l3-interface-ipv6-address-list
10231 description: delete an existing l3-interface-ipv6-address-list
10232 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10241 description: Response codes found in [response codes](https://wiki.onap.org/).
10245 description: Value from executing hostname on the compute node.
10248 example: __HOSTNAME__
10249 - name: interface-name
10251 description: Name that identifies the physical interface
10254 example: __INTERFACE-NAME__
10255 - name: interface-name
10257 description: Name given to the interface
10260 example: __INTERFACE-NAME__
10261 - name: vlan-interface
10263 description: String that identifies the interface
10266 example: __VLAN-INTERFACE__
10267 - name: l3-interface-ipv6-address
10269 description: IP address
10272 example: __L3-INTERFACE-IPV6-ADDRESS__
10273 - name: resource-version
10275 description: resource-version for concurrency
10278 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10281 - CloudInfrastructure
10282 summary: returns vlan
10283 description: returns vlan
10284 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10290 description: successful operation
10292 $ref: "#/getDefinitions/vlan"
10294 description: Response codes found in [response codes](https://wiki.onap.org/).
10298 description: Value from executing hostname on the compute node.
10301 example: __HOSTNAME__
10302 - name: interface-name
10304 description: Name that identifies the physical interface
10307 example: __INTERFACE-NAME__
10308 - name: interface-name
10310 description: Name given to the interface
10313 example: __INTERFACE-NAME__
10314 - name: vlan-interface
10316 description: String that identifies the interface
10319 example: __VLAN-INTERFACE__
10322 - CloudInfrastructure
10323 summary: create or update an existing vlan
10325 Create or update an existing vlan.
10327 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10328 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10337 description: Response codes found in [response codes](https://wiki.onap.org/).
10341 description: Value from executing hostname on the compute node.
10344 example: __HOSTNAME__
10345 - name: interface-name
10347 description: Name that identifies the physical interface
10350 example: __INTERFACE-NAME__
10351 - name: interface-name
10353 description: Name given to the interface
10356 example: __INTERFACE-NAME__
10357 - name: vlan-interface
10359 description: String that identifies the interface
10362 example: __VLAN-INTERFACE__
10365 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10368 $ref: "#/definitions/vlan"
10371 - CloudInfrastructure
10372 summary: update an existing vlan
10374 Update an existing vlan
10376 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10377 The PUT operation will entirely replace an existing object.
10378 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10380 Other differences between PUT and PATCH are:
10382 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10383 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10384 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10385 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10394 description: Response codes found in [response codes](https://wiki.onap.org/).
10398 description: Value from executing hostname on the compute node.
10401 example: __HOSTNAME__
10402 - name: interface-name
10404 description: Name that identifies the physical interface
10407 example: __INTERFACE-NAME__
10408 - name: interface-name
10410 description: Name given to the interface
10413 example: __INTERFACE-NAME__
10414 - name: vlan-interface
10416 description: String that identifies the interface
10419 example: __VLAN-INTERFACE__
10422 description: vlan object that needs to be updated.
10425 $ref: "#/patchDefinitions/vlan"
10428 - CloudInfrastructure
10429 summary: delete an existing vlan
10430 description: delete an existing vlan
10431 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10440 description: Response codes found in [response codes](https://wiki.onap.org/).
10444 description: Value from executing hostname on the compute node.
10447 example: __HOSTNAME__
10448 - name: interface-name
10450 description: Name that identifies the physical interface
10453 example: __INTERFACE-NAME__
10454 - name: interface-name
10456 description: Name given to the interface
10459 example: __INTERFACE-NAME__
10460 - name: vlan-interface
10462 description: String that identifies the interface
10465 example: __VLAN-INTERFACE__
10466 - name: resource-version
10468 description: resource-version for concurrency
10471 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10474 - CloudInfrastructure
10475 summary: returns vlans
10476 description: returns vlans
10477 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
10483 description: successful operation
10485 $ref: "#/getDefinitions/vlans"
10487 description: Response codes found in [response codes](https://wiki.onap.org/).
10491 description: Value from executing hostname on the compute node.
10494 example: __HOSTNAME__
10495 - name: interface-name
10497 description: Name that identifies the physical interface
10500 example: __INTERFACE-NAME__
10501 - name: interface-name
10503 description: Name given to the interface
10506 example: __INTERFACE-NAME__
10507 - name: vlan-interface
10512 - name: vlan-id-inner
10523 /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:
10526 - CloudInfrastructure
10527 summary: see node definition for valid relationships
10528 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10537 description: Response codes found in [response codes](https://wiki.onap.org/).
10541 description: Value from executing hostname on the compute node.
10544 example: __HOSTNAME__
10545 - name: interface-name
10547 description: Name that identifies the physical interface
10550 example: __INTERFACE-NAME__
10551 - name: interface-name
10553 description: Name given to the interface
10556 example: __INTERFACE-NAME__
10559 description: PCI ID used to identify the sriov-vf
10562 example: __PCI-ID__
10565 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10568 $ref: "#/definitions/relationship"
10571 - CloudInfrastructure
10572 summary: delete an existing relationship
10573 description: delete an existing relationship
10574 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10583 description: Response codes found in [response codes](https://wiki.onap.org/).
10587 description: Value from executing hostname on the compute node.
10590 example: __HOSTNAME__
10591 - name: interface-name
10593 description: Name that identifies the physical interface
10596 example: __INTERFACE-NAME__
10597 - name: interface-name
10599 description: Name given to the interface
10602 example: __INTERFACE-NAME__
10605 description: PCI ID used to identify the sriov-vf
10608 example: __PCI-ID__
10609 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10612 - CloudInfrastructure
10613 summary: returns sriov-vf
10614 description: returns sriov-vf
10615 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10621 description: successful operation
10623 $ref: "#/getDefinitions/sriov-vf"
10625 description: Response codes found in [response codes](https://wiki.onap.org/).
10629 description: Value from executing hostname on the compute node.
10632 example: __HOSTNAME__
10633 - name: interface-name
10635 description: Name that identifies the physical interface
10638 example: __INTERFACE-NAME__
10639 - name: interface-name
10641 description: Name given to the interface
10644 example: __INTERFACE-NAME__
10647 description: PCI ID used to identify the sriov-vf
10650 example: __PCI-ID__
10653 - CloudInfrastructure
10654 summary: create or update an existing sriov-vf
10656 Create or update an existing sriov-vf.
10658 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10659 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10668 description: Response codes found in [response codes](https://wiki.onap.org/).
10672 description: Value from executing hostname on the compute node.
10675 example: __HOSTNAME__
10676 - name: interface-name
10678 description: Name that identifies the physical interface
10681 example: __INTERFACE-NAME__
10682 - name: interface-name
10684 description: Name given to the interface
10687 example: __INTERFACE-NAME__
10690 description: PCI ID used to identify the sriov-vf
10693 example: __PCI-ID__
10696 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10699 $ref: "#/definitions/sriov-vf"
10702 - CloudInfrastructure
10703 summary: update an existing sriov-vf
10705 Update an existing sriov-vf
10707 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10708 The PUT operation will entirely replace an existing object.
10709 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10711 Other differences between PUT and PATCH are:
10713 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10714 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10715 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10716 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10725 description: Response codes found in [response codes](https://wiki.onap.org/).
10729 description: Value from executing hostname on the compute node.
10732 example: __HOSTNAME__
10733 - name: interface-name
10735 description: Name that identifies the physical interface
10738 example: __INTERFACE-NAME__
10739 - name: interface-name
10741 description: Name given to the interface
10744 example: __INTERFACE-NAME__
10747 description: PCI ID used to identify the sriov-vf
10750 example: __PCI-ID__
10753 description: sriov-vf object that needs to be updated.
10756 $ref: "#/patchDefinitions/sriov-vf"
10759 - CloudInfrastructure
10760 summary: delete an existing sriov-vf
10761 description: delete an existing sriov-vf
10762 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10771 description: Response codes found in [response codes](https://wiki.onap.org/).
10775 description: Value from executing hostname on the compute node.
10778 example: __HOSTNAME__
10779 - name: interface-name
10781 description: Name that identifies the physical interface
10784 example: __INTERFACE-NAME__
10785 - name: interface-name
10787 description: Name given to the interface
10790 example: __INTERFACE-NAME__
10793 description: PCI ID used to identify the sriov-vf
10796 example: __PCI-ID__
10797 - name: resource-version
10799 description: resource-version for concurrency
10802 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10805 - CloudInfrastructure
10806 summary: returns sriov-vfs
10807 description: returns sriov-vfs
10808 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
10814 description: successful operation
10816 $ref: "#/getDefinitions/sriov-vfs"
10818 description: Response codes found in [response codes](https://wiki.onap.org/).
10822 description: Value from executing hostname on the compute node.
10825 example: __HOSTNAME__
10826 - name: interface-name
10828 description: Name that identifies the physical interface
10831 example: __INTERFACE-NAME__
10832 - name: interface-name
10834 description: Name given to the interface
10837 example: __INTERFACE-NAME__
10843 - name: vf-vlan-filter
10848 - name: vf-mac-filter
10853 - name: vf-vlan-strip
10858 - name: neutron-network-id
10863 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10866 - CloudInfrastructure
10867 summary: see node definition for valid relationships
10868 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10877 description: Response codes found in [response codes](https://wiki.onap.org/).
10881 description: Value from executing hostname on the compute node.
10884 example: __HOSTNAME__
10885 - name: interface-name
10887 description: Name that identifies the physical interface
10890 example: __INTERFACE-NAME__
10891 - name: interface-name
10893 description: Name given to the interface
10896 example: __INTERFACE-NAME__
10899 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10902 $ref: "#/definitions/relationship"
10905 - CloudInfrastructure
10906 summary: delete an existing relationship
10907 description: delete an existing relationship
10908 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10917 description: Response codes found in [response codes](https://wiki.onap.org/).
10921 description: Value from executing hostname on the compute node.
10924 example: __HOSTNAME__
10925 - name: interface-name
10927 description: Name that identifies the physical interface
10930 example: __INTERFACE-NAME__
10931 - name: interface-name
10933 description: Name given to the interface
10936 example: __INTERFACE-NAME__
10937 /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:
10940 - CloudInfrastructure
10941 summary: see node definition for valid relationships
10942 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10951 description: Response codes found in [response codes](https://wiki.onap.org/).
10955 description: Value from executing hostname on the compute node.
10958 example: __HOSTNAME__
10959 - name: interface-name
10961 description: Name that identifies the physical interface
10964 example: __INTERFACE-NAME__
10965 - name: interface-name
10967 description: Name given to the interface
10970 example: __INTERFACE-NAME__
10971 - name: l3-interface-ipv4-address
10973 description: IP address
10976 example: __L3-INTERFACE-IPV4-ADDRESS__
10979 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10982 $ref: "#/definitions/relationship"
10985 - CloudInfrastructure
10986 summary: delete an existing relationship
10987 description: delete an existing relationship
10988 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10997 description: Response codes found in [response codes](https://wiki.onap.org/).
11001 description: Value from executing hostname on the compute node.
11004 example: __HOSTNAME__
11005 - name: interface-name
11007 description: Name that identifies the physical interface
11010 example: __INTERFACE-NAME__
11011 - name: interface-name
11013 description: Name given to the interface
11016 example: __INTERFACE-NAME__
11017 - name: l3-interface-ipv4-address
11019 description: IP address
11022 example: __L3-INTERFACE-IPV4-ADDRESS__
11023 /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}:
11026 - CloudInfrastructure
11027 summary: returns l3-interface-ipv4-address-list
11028 description: returns l3-interface-ipv4-address-list
11029 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11035 description: successful operation
11037 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11039 description: Response codes found in [response codes](https://wiki.onap.org/).
11043 description: Value from executing hostname on the compute node.
11046 example: __HOSTNAME__
11047 - name: interface-name
11049 description: Name that identifies the physical interface
11052 example: __INTERFACE-NAME__
11053 - name: interface-name
11055 description: Name given to the interface
11058 example: __INTERFACE-NAME__
11059 - name: l3-interface-ipv4-address
11061 description: IP address
11064 example: __L3-INTERFACE-IPV4-ADDRESS__
11067 - CloudInfrastructure
11068 summary: create or update an existing l3-interface-ipv4-address-list
11070 Create or update an existing l3-interface-ipv4-address-list.
11072 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11073 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11082 description: Response codes found in [response codes](https://wiki.onap.org/).
11086 description: Value from executing hostname on the compute node.
11089 example: __HOSTNAME__
11090 - name: interface-name
11092 description: Name that identifies the physical interface
11095 example: __INTERFACE-NAME__
11096 - name: interface-name
11098 description: Name given to the interface
11101 example: __INTERFACE-NAME__
11102 - name: l3-interface-ipv4-address
11104 description: IP address
11107 example: __L3-INTERFACE-IPV4-ADDRESS__
11110 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11113 $ref: "#/definitions/l3-interface-ipv4-address-list"
11116 - CloudInfrastructure
11117 summary: update an existing l3-interface-ipv4-address-list
11119 Update an existing l3-interface-ipv4-address-list
11121 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11122 The PUT operation will entirely replace an existing object.
11123 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11125 Other differences between PUT and PATCH are:
11127 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11128 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11129 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11130 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11139 description: Response codes found in [response codes](https://wiki.onap.org/).
11143 description: Value from executing hostname on the compute node.
11146 example: __HOSTNAME__
11147 - name: interface-name
11149 description: Name that identifies the physical interface
11152 example: __INTERFACE-NAME__
11153 - name: interface-name
11155 description: Name given to the interface
11158 example: __INTERFACE-NAME__
11159 - name: l3-interface-ipv4-address
11161 description: IP address
11164 example: __L3-INTERFACE-IPV4-ADDRESS__
11167 description: l3-interface-ipv4-address-list object that needs to be updated.
11170 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11173 - CloudInfrastructure
11174 summary: delete an existing l3-interface-ipv4-address-list
11175 description: delete an existing l3-interface-ipv4-address-list
11176 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11185 description: Response codes found in [response codes](https://wiki.onap.org/).
11189 description: Value from executing hostname on the compute node.
11192 example: __HOSTNAME__
11193 - name: interface-name
11195 description: Name that identifies the physical interface
11198 example: __INTERFACE-NAME__
11199 - name: interface-name
11201 description: Name given to the interface
11204 example: __INTERFACE-NAME__
11205 - name: l3-interface-ipv4-address
11207 description: IP address
11210 example: __L3-INTERFACE-IPV4-ADDRESS__
11211 - name: resource-version
11213 description: resource-version for concurrency
11216 /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:
11219 - CloudInfrastructure
11220 summary: see node definition for valid relationships
11221 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11230 description: Response codes found in [response codes](https://wiki.onap.org/).
11234 description: Value from executing hostname on the compute node.
11237 example: __HOSTNAME__
11238 - name: interface-name
11240 description: Name that identifies the physical interface
11243 example: __INTERFACE-NAME__
11244 - name: interface-name
11246 description: Name given to the interface
11249 example: __INTERFACE-NAME__
11250 - name: l3-interface-ipv6-address
11252 description: IP address
11255 example: __L3-INTERFACE-IPV6-ADDRESS__
11258 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11261 $ref: "#/definitions/relationship"
11264 - CloudInfrastructure
11265 summary: delete an existing relationship
11266 description: delete an existing relationship
11267 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11276 description: Response codes found in [response codes](https://wiki.onap.org/).
11280 description: Value from executing hostname on the compute node.
11283 example: __HOSTNAME__
11284 - name: interface-name
11286 description: Name that identifies the physical interface
11289 example: __INTERFACE-NAME__
11290 - name: interface-name
11292 description: Name given to the interface
11295 example: __INTERFACE-NAME__
11296 - name: l3-interface-ipv6-address
11298 description: IP address
11301 example: __L3-INTERFACE-IPV6-ADDRESS__
11302 /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}:
11305 - CloudInfrastructure
11306 summary: returns l3-interface-ipv6-address-list
11307 description: returns l3-interface-ipv6-address-list
11308 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11314 description: successful operation
11316 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11318 description: Response codes found in [response codes](https://wiki.onap.org/).
11322 description: Value from executing hostname on the compute node.
11325 example: __HOSTNAME__
11326 - name: interface-name
11328 description: Name that identifies the physical interface
11331 example: __INTERFACE-NAME__
11332 - name: interface-name
11334 description: Name given to the interface
11337 example: __INTERFACE-NAME__
11338 - name: l3-interface-ipv6-address
11340 description: IP address
11343 example: __L3-INTERFACE-IPV6-ADDRESS__
11346 - CloudInfrastructure
11347 summary: create or update an existing l3-interface-ipv6-address-list
11349 Create or update an existing l3-interface-ipv6-address-list.
11351 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11352 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11361 description: Response codes found in [response codes](https://wiki.onap.org/).
11365 description: Value from executing hostname on the compute node.
11368 example: __HOSTNAME__
11369 - name: interface-name
11371 description: Name that identifies the physical interface
11374 example: __INTERFACE-NAME__
11375 - name: interface-name
11377 description: Name given to the interface
11380 example: __INTERFACE-NAME__
11381 - name: l3-interface-ipv6-address
11383 description: IP address
11386 example: __L3-INTERFACE-IPV6-ADDRESS__
11389 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11392 $ref: "#/definitions/l3-interface-ipv6-address-list"
11395 - CloudInfrastructure
11396 summary: update an existing l3-interface-ipv6-address-list
11398 Update an existing l3-interface-ipv6-address-list
11400 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11401 The PUT operation will entirely replace an existing object.
11402 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11404 Other differences between PUT and PATCH are:
11406 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11407 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11408 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11409 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11418 description: Response codes found in [response codes](https://wiki.onap.org/).
11422 description: Value from executing hostname on the compute node.
11425 example: __HOSTNAME__
11426 - name: interface-name
11428 description: Name that identifies the physical interface
11431 example: __INTERFACE-NAME__
11432 - name: interface-name
11434 description: Name given to the interface
11437 example: __INTERFACE-NAME__
11438 - name: l3-interface-ipv6-address
11440 description: IP address
11443 example: __L3-INTERFACE-IPV6-ADDRESS__
11446 description: l3-interface-ipv6-address-list object that needs to be updated.
11449 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11452 - CloudInfrastructure
11453 summary: delete an existing l3-interface-ipv6-address-list
11454 description: delete an existing l3-interface-ipv6-address-list
11455 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11464 description: Response codes found in [response codes](https://wiki.onap.org/).
11468 description: Value from executing hostname on the compute node.
11471 example: __HOSTNAME__
11472 - name: interface-name
11474 description: Name that identifies the physical interface
11477 example: __INTERFACE-NAME__
11478 - name: interface-name
11480 description: Name given to the interface
11483 example: __INTERFACE-NAME__
11484 - name: l3-interface-ipv6-address
11486 description: IP address
11489 example: __L3-INTERFACE-IPV6-ADDRESS__
11490 - name: resource-version
11492 description: resource-version for concurrency
11495 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11498 - CloudInfrastructure
11499 summary: returns l-interface
11500 description: returns l-interface
11501 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11507 description: successful operation
11509 $ref: "#/getDefinitions/l-interface"
11511 description: Response codes found in [response codes](https://wiki.onap.org/).
11515 description: Value from executing hostname on the compute node.
11518 example: __HOSTNAME__
11519 - name: interface-name
11521 description: Name that identifies the physical interface
11524 example: __INTERFACE-NAME__
11525 - name: interface-name
11527 description: Name given to the interface
11530 example: __INTERFACE-NAME__
11533 - CloudInfrastructure
11534 summary: create or update an existing l-interface
11536 Create or update an existing l-interface.
11538 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11539 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11548 description: Response codes found in [response codes](https://wiki.onap.org/).
11552 description: Value from executing hostname on the compute node.
11555 example: __HOSTNAME__
11556 - name: interface-name
11558 description: Name that identifies the physical interface
11561 example: __INTERFACE-NAME__
11562 - name: interface-name
11564 description: Name given to the interface
11567 example: __INTERFACE-NAME__
11570 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11573 $ref: "#/definitions/l-interface"
11576 - CloudInfrastructure
11577 summary: update an existing l-interface
11579 Update an existing l-interface
11581 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11582 The PUT operation will entirely replace an existing object.
11583 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11585 Other differences between PUT and PATCH are:
11587 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11588 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11589 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11590 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11599 description: Response codes found in [response codes](https://wiki.onap.org/).
11603 description: Value from executing hostname on the compute node.
11606 example: __HOSTNAME__
11607 - name: interface-name
11609 description: Name that identifies the physical interface
11612 example: __INTERFACE-NAME__
11613 - name: interface-name
11615 description: Name given to the interface
11618 example: __INTERFACE-NAME__
11621 description: l-interface object that needs to be updated.
11624 $ref: "#/patchDefinitions/l-interface"
11627 - CloudInfrastructure
11628 summary: delete an existing l-interface
11629 description: delete an existing l-interface
11630 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11639 description: Response codes found in [response codes](https://wiki.onap.org/).
11643 description: Value from executing hostname on the compute node.
11646 example: __HOSTNAME__
11647 - name: interface-name
11649 description: Name that identifies the physical interface
11652 example: __INTERFACE-NAME__
11653 - name: interface-name
11655 description: Name given to the interface
11658 example: __INTERFACE-NAME__
11659 - name: resource-version
11661 description: resource-version for concurrency
11664 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
11667 - CloudInfrastructure
11668 summary: returns l-interfaces
11669 description: returns l-interfaces
11670 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
11676 description: successful operation
11678 $ref: "#/getDefinitions/l-interfaces"
11680 description: Response codes found in [response codes](https://wiki.onap.org/).
11684 description: Value from executing hostname on the compute node.
11687 example: __HOSTNAME__
11688 - name: interface-name
11690 description: Name that identifies the physical interface
11693 example: __INTERFACE-NAME__
11694 - name: interface-name
11699 - name: interface-id
11709 - name: network-name
11714 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
11717 - CloudInfrastructure
11718 summary: returns p-interface
11719 description: returns p-interface
11720 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
11726 description: successful operation
11728 $ref: "#/getDefinitions/p-interface"
11730 description: Response codes found in [response codes](https://wiki.onap.org/).
11734 description: Value from executing hostname on the compute node.
11737 example: __HOSTNAME__
11738 - name: interface-name
11740 description: Name that identifies the physical interface
11743 example: __INTERFACE-NAME__
11746 - CloudInfrastructure
11747 summary: create or update an existing p-interface
11749 Create or update an existing p-interface.
11751 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11752 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11761 description: Response codes found in [response codes](https://wiki.onap.org/).
11765 description: Value from executing hostname on the compute node.
11768 example: __HOSTNAME__
11769 - name: interface-name
11771 description: Name that identifies the physical interface
11774 example: __INTERFACE-NAME__
11777 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
11780 $ref: "#/definitions/p-interface"
11783 - CloudInfrastructure
11784 summary: update an existing p-interface
11786 Update an existing p-interface
11788 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11789 The PUT operation will entirely replace an existing object.
11790 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11792 Other differences between PUT and PATCH are:
11794 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11795 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11796 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11797 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
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 physical interface
11819 example: __INTERFACE-NAME__
11822 description: p-interface object that needs to be updated.
11825 $ref: "#/patchDefinitions/p-interface"
11828 - CloudInfrastructure
11829 summary: delete an existing p-interface
11830 description: delete an existing p-interface
11831 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
11840 description: Response codes found in [response codes](https://wiki.onap.org/).
11844 description: Value from executing hostname on the compute node.
11847 example: __HOSTNAME__
11848 - name: interface-name
11850 description: Name that identifies the physical interface
11853 example: __INTERFACE-NAME__
11854 - name: resource-version
11856 description: resource-version for concurrency
11859 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
11862 - CloudInfrastructure
11863 summary: returns p-interfaces
11864 description: returns p-interfaces
11865 operationId: getCloudInfrastructurePserversPserverPInterfaces
11871 description: successful operation
11873 $ref: "#/getDefinitions/p-interfaces"
11875 description: Response codes found in [response codes](https://wiki.onap.org/).
11879 description: Value from executing hostname on the compute node.
11882 example: __HOSTNAME__
11883 - name: interface-name
11888 - name: prov-status
11893 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
11896 - CloudInfrastructure
11897 summary: see node definition for valid relationships
11898 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11907 description: Response codes found in [response codes](https://wiki.onap.org/).
11911 description: Value from executing hostname on the compute node.
11914 example: __HOSTNAME__
11915 - name: interface-name
11917 description: Name that identifies the link aggregate interface
11920 example: __INTERFACE-NAME__
11923 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11926 $ref: "#/definitions/relationship"
11929 - CloudInfrastructure
11930 summary: delete an existing relationship
11931 description: delete an existing relationship
11932 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11941 description: Response codes found in [response codes](https://wiki.onap.org/).
11945 description: Value from executing hostname on the compute node.
11948 example: __HOSTNAME__
11949 - name: interface-name
11951 description: Name that identifies the link aggregate interface
11954 example: __INTERFACE-NAME__
11955 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11958 - CloudInfrastructure
11959 summary: see node definition for valid relationships
11960 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11969 description: Response codes found in [response codes](https://wiki.onap.org/).
11973 description: Value from executing hostname on the compute node.
11976 example: __HOSTNAME__
11977 - name: interface-name
11979 description: Name that identifies the link aggregate interface
11982 example: __INTERFACE-NAME__
11983 - name: interface-name
11985 description: Name given to the interface
11988 example: __INTERFACE-NAME__
11989 - name: vlan-interface
11991 description: String that identifies the interface
11994 example: __VLAN-INTERFACE__
11997 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12000 $ref: "#/definitions/relationship"
12003 - CloudInfrastructure
12004 summary: delete an existing relationship
12005 description: delete an existing relationship
12006 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
12015 description: Response codes found in [response codes](https://wiki.onap.org/).
12019 description: Value from executing hostname on the compute node.
12022 example: __HOSTNAME__
12023 - name: interface-name
12025 description: Name that identifies the link aggregate interface
12028 example: __INTERFACE-NAME__
12029 - name: interface-name
12031 description: Name given to the interface
12034 example: __INTERFACE-NAME__
12035 - name: vlan-interface
12037 description: String that identifies the interface
12040 example: __VLAN-INTERFACE__
12041 /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:
12044 - CloudInfrastructure
12045 summary: see node definition for valid relationships
12046 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12055 description: Response codes found in [response codes](https://wiki.onap.org/).
12059 description: Value from executing hostname on the compute node.
12062 example: __HOSTNAME__
12063 - name: interface-name
12065 description: Name that identifies the link aggregate interface
12068 example: __INTERFACE-NAME__
12069 - name: interface-name
12071 description: Name given to the interface
12074 example: __INTERFACE-NAME__
12075 - name: vlan-interface
12077 description: String that identifies the interface
12080 example: __VLAN-INTERFACE__
12081 - name: l3-interface-ipv4-address
12083 description: IP address
12086 example: __L3-INTERFACE-IPV4-ADDRESS__
12089 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12092 $ref: "#/definitions/relationship"
12095 - CloudInfrastructure
12096 summary: delete an existing relationship
12097 description: delete an existing relationship
12098 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12107 description: Response codes found in [response codes](https://wiki.onap.org/).
12111 description: Value from executing hostname on the compute node.
12114 example: __HOSTNAME__
12115 - name: interface-name
12117 description: Name that identifies the link aggregate interface
12120 example: __INTERFACE-NAME__
12121 - name: interface-name
12123 description: Name given to the interface
12126 example: __INTERFACE-NAME__
12127 - name: vlan-interface
12129 description: String that identifies the interface
12132 example: __VLAN-INTERFACE__
12133 - name: l3-interface-ipv4-address
12135 description: IP address
12138 example: __L3-INTERFACE-IPV4-ADDRESS__
12139 /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}:
12142 - CloudInfrastructure
12143 summary: returns l3-interface-ipv4-address-list
12144 description: returns l3-interface-ipv4-address-list
12145 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12151 description: successful operation
12153 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12155 description: Response codes found in [response codes](https://wiki.onap.org/).
12159 description: Value from executing hostname on the compute node.
12162 example: __HOSTNAME__
12163 - name: interface-name
12165 description: Name that identifies the link aggregate interface
12168 example: __INTERFACE-NAME__
12169 - name: interface-name
12171 description: Name given to the interface
12174 example: __INTERFACE-NAME__
12175 - name: vlan-interface
12177 description: String that identifies the interface
12180 example: __VLAN-INTERFACE__
12181 - name: l3-interface-ipv4-address
12183 description: IP address
12186 example: __L3-INTERFACE-IPV4-ADDRESS__
12189 - CloudInfrastructure
12190 summary: create or update an existing l3-interface-ipv4-address-list
12192 Create or update an existing l3-interface-ipv4-address-list.
12194 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12195 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12204 description: Response codes found in [response codes](https://wiki.onap.org/).
12208 description: Value from executing hostname on the compute node.
12211 example: __HOSTNAME__
12212 - name: interface-name
12214 description: Name that identifies the link aggregate interface
12217 example: __INTERFACE-NAME__
12218 - name: interface-name
12220 description: Name given to the interface
12223 example: __INTERFACE-NAME__
12224 - name: vlan-interface
12226 description: String that identifies the interface
12229 example: __VLAN-INTERFACE__
12230 - name: l3-interface-ipv4-address
12232 description: IP address
12235 example: __L3-INTERFACE-IPV4-ADDRESS__
12238 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12241 $ref: "#/definitions/l3-interface-ipv4-address-list"
12244 - CloudInfrastructure
12245 summary: update an existing l3-interface-ipv4-address-list
12247 Update an existing l3-interface-ipv4-address-list
12249 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12250 The PUT operation will entirely replace an existing object.
12251 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12253 Other differences between PUT and PATCH are:
12255 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12256 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12257 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12258 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12267 description: Response codes found in [response codes](https://wiki.onap.org/).
12271 description: Value from executing hostname on the compute node.
12274 example: __HOSTNAME__
12275 - name: interface-name
12277 description: Name that identifies the link aggregate interface
12280 example: __INTERFACE-NAME__
12281 - name: interface-name
12283 description: Name given to the interface
12286 example: __INTERFACE-NAME__
12287 - name: vlan-interface
12289 description: String that identifies the interface
12292 example: __VLAN-INTERFACE__
12293 - name: l3-interface-ipv4-address
12295 description: IP address
12298 example: __L3-INTERFACE-IPV4-ADDRESS__
12301 description: l3-interface-ipv4-address-list object that needs to be updated.
12304 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12307 - CloudInfrastructure
12308 summary: delete an existing l3-interface-ipv4-address-list
12309 description: delete an existing l3-interface-ipv4-address-list
12310 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12319 description: Response codes found in [response codes](https://wiki.onap.org/).
12323 description: Value from executing hostname on the compute node.
12326 example: __HOSTNAME__
12327 - name: interface-name
12329 description: Name that identifies the link aggregate interface
12332 example: __INTERFACE-NAME__
12333 - name: interface-name
12335 description: Name given to the interface
12338 example: __INTERFACE-NAME__
12339 - name: vlan-interface
12341 description: String that identifies the interface
12344 example: __VLAN-INTERFACE__
12345 - name: l3-interface-ipv4-address
12347 description: IP address
12350 example: __L3-INTERFACE-IPV4-ADDRESS__
12351 - name: resource-version
12353 description: resource-version for concurrency
12356 /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:
12359 - CloudInfrastructure
12360 summary: see node definition for valid relationships
12361 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12370 description: Response codes found in [response codes](https://wiki.onap.org/).
12374 description: Value from executing hostname on the compute node.
12377 example: __HOSTNAME__
12378 - name: interface-name
12380 description: Name that identifies the link aggregate interface
12383 example: __INTERFACE-NAME__
12384 - name: interface-name
12386 description: Name given to the interface
12389 example: __INTERFACE-NAME__
12390 - name: vlan-interface
12392 description: String that identifies the interface
12395 example: __VLAN-INTERFACE__
12396 - name: l3-interface-ipv6-address
12398 description: IP address
12401 example: __L3-INTERFACE-IPV6-ADDRESS__
12404 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12407 $ref: "#/definitions/relationship"
12410 - CloudInfrastructure
12411 summary: delete an existing relationship
12412 description: delete an existing relationship
12413 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12422 description: Response codes found in [response codes](https://wiki.onap.org/).
12426 description: Value from executing hostname on the compute node.
12429 example: __HOSTNAME__
12430 - name: interface-name
12432 description: Name that identifies the link aggregate interface
12435 example: __INTERFACE-NAME__
12436 - name: interface-name
12438 description: Name given to the interface
12441 example: __INTERFACE-NAME__
12442 - name: vlan-interface
12444 description: String that identifies the interface
12447 example: __VLAN-INTERFACE__
12448 - name: l3-interface-ipv6-address
12450 description: IP address
12453 example: __L3-INTERFACE-IPV6-ADDRESS__
12454 /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}:
12457 - CloudInfrastructure
12458 summary: returns l3-interface-ipv6-address-list
12459 description: returns l3-interface-ipv6-address-list
12460 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12466 description: successful operation
12468 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12470 description: Response codes found in [response codes](https://wiki.onap.org/).
12474 description: Value from executing hostname on the compute node.
12477 example: __HOSTNAME__
12478 - name: interface-name
12480 description: Name that identifies the link aggregate interface
12483 example: __INTERFACE-NAME__
12484 - name: interface-name
12486 description: Name given to the interface
12489 example: __INTERFACE-NAME__
12490 - name: vlan-interface
12492 description: String that identifies the interface
12495 example: __VLAN-INTERFACE__
12496 - name: l3-interface-ipv6-address
12498 description: IP address
12501 example: __L3-INTERFACE-IPV6-ADDRESS__
12504 - CloudInfrastructure
12505 summary: create or update an existing l3-interface-ipv6-address-list
12507 Create or update an existing l3-interface-ipv6-address-list.
12509 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12510 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12519 description: Response codes found in [response codes](https://wiki.onap.org/).
12523 description: Value from executing hostname on the compute node.
12526 example: __HOSTNAME__
12527 - name: interface-name
12529 description: Name that identifies the link aggregate interface
12532 example: __INTERFACE-NAME__
12533 - name: interface-name
12535 description: Name given to the interface
12538 example: __INTERFACE-NAME__
12539 - name: vlan-interface
12541 description: String that identifies the interface
12544 example: __VLAN-INTERFACE__
12545 - name: l3-interface-ipv6-address
12547 description: IP address
12550 example: __L3-INTERFACE-IPV6-ADDRESS__
12553 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12556 $ref: "#/definitions/l3-interface-ipv6-address-list"
12559 - CloudInfrastructure
12560 summary: update an existing l3-interface-ipv6-address-list
12562 Update an existing l3-interface-ipv6-address-list
12564 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12565 The PUT operation will entirely replace an existing object.
12566 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12568 Other differences between PUT and PATCH are:
12570 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12571 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12572 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12573 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12582 description: Response codes found in [response codes](https://wiki.onap.org/).
12586 description: Value from executing hostname on the compute node.
12589 example: __HOSTNAME__
12590 - name: interface-name
12592 description: Name that identifies the link aggregate interface
12595 example: __INTERFACE-NAME__
12596 - name: interface-name
12598 description: Name given to the interface
12601 example: __INTERFACE-NAME__
12602 - name: vlan-interface
12604 description: String that identifies the interface
12607 example: __VLAN-INTERFACE__
12608 - name: l3-interface-ipv6-address
12610 description: IP address
12613 example: __L3-INTERFACE-IPV6-ADDRESS__
12616 description: l3-interface-ipv6-address-list object that needs to be updated.
12619 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12622 - CloudInfrastructure
12623 summary: delete an existing l3-interface-ipv6-address-list
12624 description: delete an existing l3-interface-ipv6-address-list
12625 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12634 description: Response codes found in [response codes](https://wiki.onap.org/).
12638 description: Value from executing hostname on the compute node.
12641 example: __HOSTNAME__
12642 - name: interface-name
12644 description: Name that identifies the link aggregate interface
12647 example: __INTERFACE-NAME__
12648 - name: interface-name
12650 description: Name given to the interface
12653 example: __INTERFACE-NAME__
12654 - name: vlan-interface
12656 description: String that identifies the interface
12659 example: __VLAN-INTERFACE__
12660 - name: l3-interface-ipv6-address
12662 description: IP address
12665 example: __L3-INTERFACE-IPV6-ADDRESS__
12666 - name: resource-version
12668 description: resource-version for concurrency
12671 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
12674 - CloudInfrastructure
12675 summary: returns vlan
12676 description: returns vlan
12677 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12683 description: successful operation
12685 $ref: "#/getDefinitions/vlan"
12687 description: Response codes found in [response codes](https://wiki.onap.org/).
12691 description: Value from executing hostname on the compute node.
12694 example: __HOSTNAME__
12695 - name: interface-name
12697 description: Name that identifies the link aggregate interface
12700 example: __INTERFACE-NAME__
12701 - name: interface-name
12703 description: Name given to the interface
12706 example: __INTERFACE-NAME__
12707 - name: vlan-interface
12709 description: String that identifies the interface
12712 example: __VLAN-INTERFACE__
12715 - CloudInfrastructure
12716 summary: create or update an existing vlan
12718 Create or update an existing vlan.
12720 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12721 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12730 description: Response codes found in [response codes](https://wiki.onap.org/).
12734 description: Value from executing hostname on the compute node.
12737 example: __HOSTNAME__
12738 - name: interface-name
12740 description: Name that identifies the link aggregate interface
12743 example: __INTERFACE-NAME__
12744 - name: interface-name
12746 description: Name given to the interface
12749 example: __INTERFACE-NAME__
12750 - name: vlan-interface
12752 description: String that identifies the interface
12755 example: __VLAN-INTERFACE__
12758 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12761 $ref: "#/definitions/vlan"
12764 - CloudInfrastructure
12765 summary: update an existing vlan
12767 Update an existing vlan
12769 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12770 The PUT operation will entirely replace an existing object.
12771 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12773 Other differences between PUT and PATCH are:
12775 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12776 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12777 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12778 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12787 description: Response codes found in [response codes](https://wiki.onap.org/).
12791 description: Value from executing hostname on the compute node.
12794 example: __HOSTNAME__
12795 - name: interface-name
12797 description: Name that identifies the link aggregate interface
12800 example: __INTERFACE-NAME__
12801 - name: interface-name
12803 description: Name given to the interface
12806 example: __INTERFACE-NAME__
12807 - name: vlan-interface
12809 description: String that identifies the interface
12812 example: __VLAN-INTERFACE__
12815 description: vlan object that needs to be updated.
12818 $ref: "#/patchDefinitions/vlan"
12821 - CloudInfrastructure
12822 summary: delete an existing vlan
12823 description: delete an existing vlan
12824 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12833 description: Response codes found in [response codes](https://wiki.onap.org/).
12837 description: Value from executing hostname on the compute node.
12840 example: __HOSTNAME__
12841 - name: interface-name
12843 description: Name that identifies the link aggregate interface
12846 example: __INTERFACE-NAME__
12847 - name: interface-name
12849 description: Name given to the interface
12852 example: __INTERFACE-NAME__
12853 - name: vlan-interface
12855 description: String that identifies the interface
12858 example: __VLAN-INTERFACE__
12859 - name: resource-version
12861 description: resource-version for concurrency
12864 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
12867 - CloudInfrastructure
12868 summary: returns vlans
12869 description: returns vlans
12870 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
12876 description: successful operation
12878 $ref: "#/getDefinitions/vlans"
12880 description: Response codes found in [response codes](https://wiki.onap.org/).
12884 description: Value from executing hostname on the compute node.
12887 example: __HOSTNAME__
12888 - name: interface-name
12890 description: Name that identifies the link aggregate interface
12893 example: __INTERFACE-NAME__
12894 - name: interface-name
12896 description: Name given to the interface
12899 example: __INTERFACE-NAME__
12900 - name: vlan-interface
12905 - name: vlan-id-inner
12916 /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:
12919 - CloudInfrastructure
12920 summary: see node definition for valid relationships
12921 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12930 description: Response codes found in [response codes](https://wiki.onap.org/).
12934 description: Value from executing hostname on the compute node.
12937 example: __HOSTNAME__
12938 - name: interface-name
12940 description: Name that identifies the link aggregate interface
12943 example: __INTERFACE-NAME__
12944 - name: interface-name
12946 description: Name given to the interface
12949 example: __INTERFACE-NAME__
12952 description: PCI ID used to identify the sriov-vf
12955 example: __PCI-ID__
12958 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12961 $ref: "#/definitions/relationship"
12964 - CloudInfrastructure
12965 summary: delete an existing relationship
12966 description: delete an existing relationship
12967 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12976 description: Response codes found in [response codes](https://wiki.onap.org/).
12980 description: Value from executing hostname on the compute node.
12983 example: __HOSTNAME__
12984 - name: interface-name
12986 description: Name that identifies the link aggregate interface
12989 example: __INTERFACE-NAME__
12990 - name: interface-name
12992 description: Name given to the interface
12995 example: __INTERFACE-NAME__
12998 description: PCI ID used to identify the sriov-vf
13001 example: __PCI-ID__
13002 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
13005 - CloudInfrastructure
13006 summary: returns sriov-vf
13007 description: returns sriov-vf
13008 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13014 description: successful operation
13016 $ref: "#/getDefinitions/sriov-vf"
13018 description: Response codes found in [response codes](https://wiki.onap.org/).
13022 description: Value from executing hostname on the compute node.
13025 example: __HOSTNAME__
13026 - name: interface-name
13028 description: Name that identifies the link aggregate interface
13031 example: __INTERFACE-NAME__
13032 - name: interface-name
13034 description: Name given to the interface
13037 example: __INTERFACE-NAME__
13040 description: PCI ID used to identify the sriov-vf
13043 example: __PCI-ID__
13046 - CloudInfrastructure
13047 summary: create or update an existing sriov-vf
13049 Create or update an existing sriov-vf.
13051 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13052 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13061 description: Response codes found in [response codes](https://wiki.onap.org/).
13065 description: Value from executing hostname on the compute node.
13068 example: __HOSTNAME__
13069 - name: interface-name
13071 description: Name that identifies the link aggregate interface
13074 example: __INTERFACE-NAME__
13075 - name: interface-name
13077 description: Name given to the interface
13080 example: __INTERFACE-NAME__
13083 description: PCI ID used to identify the sriov-vf
13086 example: __PCI-ID__
13089 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
13092 $ref: "#/definitions/sriov-vf"
13095 - CloudInfrastructure
13096 summary: update an existing sriov-vf
13098 Update an existing sriov-vf
13100 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13101 The PUT operation will entirely replace an existing object.
13102 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13104 Other differences between PUT and PATCH are:
13106 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13107 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13108 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13109 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13118 description: Response codes found in [response codes](https://wiki.onap.org/).
13122 description: Value from executing hostname on the compute node.
13125 example: __HOSTNAME__
13126 - name: interface-name
13128 description: Name that identifies the link aggregate interface
13131 example: __INTERFACE-NAME__
13132 - name: interface-name
13134 description: Name given to the interface
13137 example: __INTERFACE-NAME__
13140 description: PCI ID used to identify the sriov-vf
13143 example: __PCI-ID__
13146 description: sriov-vf object that needs to be updated.
13149 $ref: "#/patchDefinitions/sriov-vf"
13152 - CloudInfrastructure
13153 summary: delete an existing sriov-vf
13154 description: delete an existing sriov-vf
13155 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13164 description: Response codes found in [response codes](https://wiki.onap.org/).
13168 description: Value from executing hostname on the compute node.
13171 example: __HOSTNAME__
13172 - name: interface-name
13174 description: Name that identifies the link aggregate interface
13177 example: __INTERFACE-NAME__
13178 - name: interface-name
13180 description: Name given to the interface
13183 example: __INTERFACE-NAME__
13186 description: PCI ID used to identify the sriov-vf
13189 example: __PCI-ID__
13190 - name: resource-version
13192 description: resource-version for concurrency
13195 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
13198 - CloudInfrastructure
13199 summary: returns sriov-vfs
13200 description: returns sriov-vfs
13201 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
13207 description: successful operation
13209 $ref: "#/getDefinitions/sriov-vfs"
13211 description: Response codes found in [response codes](https://wiki.onap.org/).
13215 description: Value from executing hostname on the compute node.
13218 example: __HOSTNAME__
13219 - name: interface-name
13221 description: Name that identifies the link aggregate interface
13224 example: __INTERFACE-NAME__
13225 - name: interface-name
13227 description: Name given to the interface
13230 example: __INTERFACE-NAME__
13236 - name: vf-vlan-filter
13241 - name: vf-mac-filter
13246 - name: vf-vlan-strip
13251 - name: neutron-network-id
13256 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
13259 - CloudInfrastructure
13260 summary: see node definition for valid relationships
13261 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13270 description: Response codes found in [response codes](https://wiki.onap.org/).
13274 description: Value from executing hostname on the compute node.
13277 example: __HOSTNAME__
13278 - name: interface-name
13280 description: Name that identifies the link aggregate interface
13283 example: __INTERFACE-NAME__
13284 - name: interface-name
13286 description: Name given to the interface
13289 example: __INTERFACE-NAME__
13292 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13295 $ref: "#/definitions/relationship"
13298 - CloudInfrastructure
13299 summary: delete an existing relationship
13300 description: delete an existing relationship
13301 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13310 description: Response codes found in [response codes](https://wiki.onap.org/).
13314 description: Value from executing hostname on the compute node.
13317 example: __HOSTNAME__
13318 - name: interface-name
13320 description: Name that identifies the link aggregate interface
13323 example: __INTERFACE-NAME__
13324 - name: interface-name
13326 description: Name given to the interface
13329 example: __INTERFACE-NAME__
13330 /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:
13333 - CloudInfrastructure
13334 summary: see node definition for valid relationships
13335 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13344 description: Response codes found in [response codes](https://wiki.onap.org/).
13348 description: Value from executing hostname on the compute node.
13351 example: __HOSTNAME__
13352 - name: interface-name
13354 description: Name that identifies the link aggregate interface
13357 example: __INTERFACE-NAME__
13358 - name: interface-name
13360 description: Name given to the interface
13363 example: __INTERFACE-NAME__
13364 - name: l3-interface-ipv4-address
13366 description: IP address
13369 example: __L3-INTERFACE-IPV4-ADDRESS__
13372 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13375 $ref: "#/definitions/relationship"
13378 - CloudInfrastructure
13379 summary: delete an existing relationship
13380 description: delete an existing relationship
13381 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13390 description: Response codes found in [response codes](https://wiki.onap.org/).
13394 description: Value from executing hostname on the compute node.
13397 example: __HOSTNAME__
13398 - name: interface-name
13400 description: Name that identifies the link aggregate interface
13403 example: __INTERFACE-NAME__
13404 - name: interface-name
13406 description: Name given to the interface
13409 example: __INTERFACE-NAME__
13410 - name: l3-interface-ipv4-address
13412 description: IP address
13415 example: __L3-INTERFACE-IPV4-ADDRESS__
13416 /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}:
13419 - CloudInfrastructure
13420 summary: returns l3-interface-ipv4-address-list
13421 description: returns l3-interface-ipv4-address-list
13422 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13428 description: successful operation
13430 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
13432 description: Response codes found in [response codes](https://wiki.onap.org/).
13436 description: Value from executing hostname on the compute node.
13439 example: __HOSTNAME__
13440 - name: interface-name
13442 description: Name that identifies the link aggregate interface
13445 example: __INTERFACE-NAME__
13446 - name: interface-name
13448 description: Name given to the interface
13451 example: __INTERFACE-NAME__
13452 - name: l3-interface-ipv4-address
13454 description: IP address
13457 example: __L3-INTERFACE-IPV4-ADDRESS__
13460 - CloudInfrastructure
13461 summary: create or update an existing l3-interface-ipv4-address-list
13463 Create or update an existing l3-interface-ipv4-address-list.
13465 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13466 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13475 description: Response codes found in [response codes](https://wiki.onap.org/).
13479 description: Value from executing hostname on the compute node.
13482 example: __HOSTNAME__
13483 - name: interface-name
13485 description: Name that identifies the link aggregate interface
13488 example: __INTERFACE-NAME__
13489 - name: interface-name
13491 description: Name given to the interface
13494 example: __INTERFACE-NAME__
13495 - name: l3-interface-ipv4-address
13497 description: IP address
13500 example: __L3-INTERFACE-IPV4-ADDRESS__
13503 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13506 $ref: "#/definitions/l3-interface-ipv4-address-list"
13509 - CloudInfrastructure
13510 summary: update an existing l3-interface-ipv4-address-list
13512 Update an existing l3-interface-ipv4-address-list
13514 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13515 The PUT operation will entirely replace an existing object.
13516 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13518 Other differences between PUT and PATCH are:
13520 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13521 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13522 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13523 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13532 description: Response codes found in [response codes](https://wiki.onap.org/).
13536 description: Value from executing hostname on the compute node.
13539 example: __HOSTNAME__
13540 - name: interface-name
13542 description: Name that identifies the link aggregate interface
13545 example: __INTERFACE-NAME__
13546 - name: interface-name
13548 description: Name given to the interface
13551 example: __INTERFACE-NAME__
13552 - name: l3-interface-ipv4-address
13554 description: IP address
13557 example: __L3-INTERFACE-IPV4-ADDRESS__
13560 description: l3-interface-ipv4-address-list object that needs to be updated.
13563 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
13566 - CloudInfrastructure
13567 summary: delete an existing l3-interface-ipv4-address-list
13568 description: delete an existing l3-interface-ipv4-address-list
13569 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13578 description: Response codes found in [response codes](https://wiki.onap.org/).
13582 description: Value from executing hostname on the compute node.
13585 example: __HOSTNAME__
13586 - name: interface-name
13588 description: Name that identifies the link aggregate interface
13591 example: __INTERFACE-NAME__
13592 - name: interface-name
13594 description: Name given to the interface
13597 example: __INTERFACE-NAME__
13598 - name: l3-interface-ipv4-address
13600 description: IP address
13603 example: __L3-INTERFACE-IPV4-ADDRESS__
13604 - name: resource-version
13606 description: resource-version for concurrency
13609 /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:
13612 - CloudInfrastructure
13613 summary: see node definition for valid relationships
13614 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13623 description: Response codes found in [response codes](https://wiki.onap.org/).
13627 description: Value from executing hostname on the compute node.
13630 example: __HOSTNAME__
13631 - name: interface-name
13633 description: Name that identifies the link aggregate interface
13636 example: __INTERFACE-NAME__
13637 - name: interface-name
13639 description: Name given to the interface
13642 example: __INTERFACE-NAME__
13643 - name: l3-interface-ipv6-address
13645 description: IP address
13648 example: __L3-INTERFACE-IPV6-ADDRESS__
13651 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13654 $ref: "#/definitions/relationship"
13657 - CloudInfrastructure
13658 summary: delete an existing relationship
13659 description: delete an existing relationship
13660 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13669 description: Response codes found in [response codes](https://wiki.onap.org/).
13673 description: Value from executing hostname on the compute node.
13676 example: __HOSTNAME__
13677 - name: interface-name
13679 description: Name that identifies the link aggregate interface
13682 example: __INTERFACE-NAME__
13683 - name: interface-name
13685 description: Name given to the interface
13688 example: __INTERFACE-NAME__
13689 - name: l3-interface-ipv6-address
13691 description: IP address
13694 example: __L3-INTERFACE-IPV6-ADDRESS__
13695 /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}:
13698 - CloudInfrastructure
13699 summary: returns l3-interface-ipv6-address-list
13700 description: returns l3-interface-ipv6-address-list
13701 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13707 description: successful operation
13709 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13711 description: Response codes found in [response codes](https://wiki.onap.org/).
13715 description: Value from executing hostname on the compute node.
13718 example: __HOSTNAME__
13719 - name: interface-name
13721 description: Name that identifies the link aggregate interface
13724 example: __INTERFACE-NAME__
13725 - name: interface-name
13727 description: Name given to the interface
13730 example: __INTERFACE-NAME__
13731 - name: l3-interface-ipv6-address
13733 description: IP address
13736 example: __L3-INTERFACE-IPV6-ADDRESS__
13739 - CloudInfrastructure
13740 summary: create or update an existing l3-interface-ipv6-address-list
13742 Create or update an existing l3-interface-ipv6-address-list.
13744 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13745 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13754 description: Response codes found in [response codes](https://wiki.onap.org/).
13758 description: Value from executing hostname on the compute node.
13761 example: __HOSTNAME__
13762 - name: interface-name
13764 description: Name that identifies the link aggregate interface
13767 example: __INTERFACE-NAME__
13768 - name: interface-name
13770 description: Name given to the interface
13773 example: __INTERFACE-NAME__
13774 - name: l3-interface-ipv6-address
13776 description: IP address
13779 example: __L3-INTERFACE-IPV6-ADDRESS__
13782 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13785 $ref: "#/definitions/l3-interface-ipv6-address-list"
13788 - CloudInfrastructure
13789 summary: update an existing l3-interface-ipv6-address-list
13791 Update an existing l3-interface-ipv6-address-list
13793 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13794 The PUT operation will entirely replace an existing object.
13795 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13797 Other differences between PUT and PATCH are:
13799 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13800 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13801 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13802 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13811 description: Response codes found in [response codes](https://wiki.onap.org/).
13815 description: Value from executing hostname on the compute node.
13818 example: __HOSTNAME__
13819 - name: interface-name
13821 description: Name that identifies the link aggregate interface
13824 example: __INTERFACE-NAME__
13825 - name: interface-name
13827 description: Name given to the interface
13830 example: __INTERFACE-NAME__
13831 - name: l3-interface-ipv6-address
13833 description: IP address
13836 example: __L3-INTERFACE-IPV6-ADDRESS__
13839 description: l3-interface-ipv6-address-list object that needs to be updated.
13842 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13845 - CloudInfrastructure
13846 summary: delete an existing l3-interface-ipv6-address-list
13847 description: delete an existing l3-interface-ipv6-address-list
13848 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13857 description: Response codes found in [response codes](https://wiki.onap.org/).
13861 description: Value from executing hostname on the compute node.
13864 example: __HOSTNAME__
13865 - name: interface-name
13867 description: Name that identifies the link aggregate interface
13870 example: __INTERFACE-NAME__
13871 - name: interface-name
13873 description: Name given to the interface
13876 example: __INTERFACE-NAME__
13877 - name: l3-interface-ipv6-address
13879 description: IP address
13882 example: __L3-INTERFACE-IPV6-ADDRESS__
13883 - name: resource-version
13885 description: resource-version for concurrency
13888 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13891 - CloudInfrastructure
13892 summary: returns l-interface
13893 description: returns l-interface
13894 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13900 description: successful operation
13902 $ref: "#/getDefinitions/l-interface"
13904 description: Response codes found in [response codes](https://wiki.onap.org/).
13908 description: Value from executing hostname on the compute node.
13911 example: __HOSTNAME__
13912 - name: interface-name
13914 description: Name that identifies the link aggregate interface
13917 example: __INTERFACE-NAME__
13918 - name: interface-name
13920 description: Name given to the interface
13923 example: __INTERFACE-NAME__
13926 - CloudInfrastructure
13927 summary: create or update an existing l-interface
13929 Create or update an existing l-interface.
13931 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13932 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13941 description: Response codes found in [response codes](https://wiki.onap.org/).
13945 description: Value from executing hostname on the compute node.
13948 example: __HOSTNAME__
13949 - name: interface-name
13951 description: Name that identifies the link aggregate interface
13954 example: __INTERFACE-NAME__
13955 - name: interface-name
13957 description: Name given to the interface
13960 example: __INTERFACE-NAME__
13963 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13966 $ref: "#/definitions/l-interface"
13969 - CloudInfrastructure
13970 summary: update an existing l-interface
13972 Update an existing l-interface
13974 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13975 The PUT operation will entirely replace an existing object.
13976 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13978 Other differences between PUT and PATCH are:
13980 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13981 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13982 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13983 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13992 description: Response codes found in [response codes](https://wiki.onap.org/).
13996 description: Value from executing hostname on the compute node.
13999 example: __HOSTNAME__
14000 - name: interface-name
14002 description: Name that identifies the link aggregate interface
14005 example: __INTERFACE-NAME__
14006 - name: interface-name
14008 description: Name given to the interface
14011 example: __INTERFACE-NAME__
14014 description: l-interface object that needs to be updated.
14017 $ref: "#/patchDefinitions/l-interface"
14020 - CloudInfrastructure
14021 summary: delete an existing l-interface
14022 description: delete an existing l-interface
14023 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14032 description: Response codes found in [response codes](https://wiki.onap.org/).
14036 description: Value from executing hostname on the compute node.
14039 example: __HOSTNAME__
14040 - name: interface-name
14042 description: Name that identifies the link aggregate interface
14045 example: __INTERFACE-NAME__
14046 - name: interface-name
14048 description: Name given to the interface
14051 example: __INTERFACE-NAME__
14052 - name: resource-version
14054 description: resource-version for concurrency
14057 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
14060 - CloudInfrastructure
14061 summary: returns l-interfaces
14062 description: returns l-interfaces
14063 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
14069 description: successful operation
14071 $ref: "#/getDefinitions/l-interfaces"
14073 description: Response codes found in [response codes](https://wiki.onap.org/).
14077 description: Value from executing hostname on the compute node.
14080 example: __HOSTNAME__
14081 - name: interface-name
14083 description: Name that identifies the link aggregate interface
14086 example: __INTERFACE-NAME__
14087 - name: interface-name
14092 - name: interface-id
14102 - name: network-name
14107 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
14110 - CloudInfrastructure
14111 summary: returns lag-interface
14112 description: returns lag-interface
14113 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
14119 description: successful operation
14121 $ref: "#/getDefinitions/lag-interface"
14123 description: Response codes found in [response codes](https://wiki.onap.org/).
14127 description: Value from executing hostname on the compute node.
14130 example: __HOSTNAME__
14131 - name: interface-name
14133 description: Name that identifies the link aggregate interface
14136 example: __INTERFACE-NAME__
14139 - CloudInfrastructure
14140 summary: create or update an existing lag-interface
14142 Create or update an existing lag-interface.
14144 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14145 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14154 description: Response codes found in [response codes](https://wiki.onap.org/).
14158 description: Value from executing hostname on the compute node.
14161 example: __HOSTNAME__
14162 - name: interface-name
14164 description: Name that identifies the link aggregate interface
14167 example: __INTERFACE-NAME__
14170 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
14173 $ref: "#/definitions/lag-interface"
14176 - CloudInfrastructure
14177 summary: update an existing lag-interface
14179 Update an existing lag-interface
14181 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14182 The PUT operation will entirely replace an existing object.
14183 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14185 Other differences between PUT and PATCH are:
14187 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14188 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14189 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14190 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14199 description: Response codes found in [response codes](https://wiki.onap.org/).
14203 description: Value from executing hostname on the compute node.
14206 example: __HOSTNAME__
14207 - name: interface-name
14209 description: Name that identifies the link aggregate interface
14212 example: __INTERFACE-NAME__
14215 description: lag-interface object that needs to be updated.
14218 $ref: "#/patchDefinitions/lag-interface"
14221 - CloudInfrastructure
14222 summary: delete an existing lag-interface
14223 description: delete an existing lag-interface
14224 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
14233 description: Response codes found in [response codes](https://wiki.onap.org/).
14237 description: Value from executing hostname on the compute node.
14240 example: __HOSTNAME__
14241 - name: interface-name
14243 description: Name that identifies the link aggregate interface
14246 example: __INTERFACE-NAME__
14247 - name: resource-version
14249 description: resource-version for concurrency
14252 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
14255 - CloudInfrastructure
14256 summary: returns lag-interfaces
14257 description: returns lag-interfaces
14258 operationId: getCloudInfrastructurePserversPserverLagInterfaces
14264 description: successful operation
14266 $ref: "#/getDefinitions/lag-interfaces"
14268 description: Response codes found in [response codes](https://wiki.onap.org/).
14272 description: Value from executing hostname on the compute node.
14275 example: __HOSTNAME__
14276 - name: interface-name
14281 - name: interface-id
14286 - name: interface-role
14291 /cloud-infrastructure/pservers/pserver/{hostname}:
14294 - CloudInfrastructure
14295 summary: returns pserver
14296 description: returns pserver
14297 operationId: getCloudInfrastructurePserversPserver
14303 description: successful operation
14305 $ref: "#/getDefinitions/pserver"
14307 description: Response codes found in [response codes](https://wiki.onap.org/).
14311 description: Value from executing hostname on the compute node.
14314 example: __HOSTNAME__
14317 - CloudInfrastructure
14318 summary: create or update an existing pserver
14320 Create or update an existing pserver.
14322 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14323 operationId: createOrUpdateCloudInfrastructurePserversPserver
14332 description: Response codes found in [response codes](https://wiki.onap.org/).
14336 description: Value from executing hostname on the compute node.
14339 example: __HOSTNAME__
14342 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserver.json)
14345 $ref: "#/definitions/pserver"
14348 - CloudInfrastructure
14349 summary: update an existing pserver
14351 Update an existing pserver
14353 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14354 The PUT operation will entirely replace an existing object.
14355 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14357 Other differences between PUT and PATCH are:
14359 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14360 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14361 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14362 operationId: UpdateCloudInfrastructurePserversPserver
14371 description: Response codes found in [response codes](https://wiki.onap.org/).
14375 description: Value from executing hostname on the compute node.
14378 example: __HOSTNAME__
14381 description: pserver object that needs to be updated.
14384 $ref: "#/patchDefinitions/pserver"
14387 - CloudInfrastructure
14388 summary: delete an existing pserver
14389 description: delete an existing pserver
14390 operationId: deleteCloudInfrastructurePserversPserver
14399 description: Response codes found in [response codes](https://wiki.onap.org/).
14403 description: Value from executing hostname on the compute node.
14406 example: __HOSTNAME__
14407 - name: resource-version
14409 description: resource-version for concurrency
14412 /cloud-infrastructure/pservers:
14415 - CloudInfrastructure
14416 summary: returns pservers
14417 description: returns pservers
14418 operationId: getCloudInfrastructurePservers
14424 description: successful operation
14426 $ref: "#/getDefinitions/pservers"
14428 description: Response codes found in [response codes](https://wiki.onap.org/).
14450 - name: pserver-name2
14455 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14458 - CloudInfrastructure
14459 summary: see node definition for valid relationships
14460 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14469 description: Response codes found in [response codes](https://wiki.onap.org/).
14473 description: Unique ID of the vdc
14476 example: __VDC-ID__
14479 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14482 $ref: "#/definitions/relationship"
14485 - CloudInfrastructure
14486 summary: delete an existing relationship
14487 description: delete an existing relationship
14488 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14497 description: Response codes found in [response codes](https://wiki.onap.org/).
14501 description: Unique ID of the vdc
14504 example: __VDC-ID__
14505 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14508 - CloudInfrastructure
14509 summary: returns virtual-data-center
14510 description: returns virtual-data-center
14511 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
14517 description: successful operation
14519 $ref: "#/getDefinitions/virtual-data-center"
14521 description: Response codes found in [response codes](https://wiki.onap.org/).
14525 description: Unique ID of the vdc
14528 example: __VDC-ID__
14531 - CloudInfrastructure
14532 summary: create or update an existing virtual-data-center
14534 Create or update an existing virtual-data-center.
14536 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14537 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14546 description: Response codes found in [response codes](https://wiki.onap.org/).
14550 description: Unique ID of the vdc
14553 example: __VDC-ID__
14556 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14559 $ref: "#/definitions/virtual-data-center"
14562 - CloudInfrastructure
14563 summary: update an existing virtual-data-center
14565 Update an existing virtual-data-center
14567 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14568 The PUT operation will entirely replace an existing object.
14569 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14571 Other differences between PUT and PATCH are:
14573 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14574 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14575 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14576 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14585 description: Response codes found in [response codes](https://wiki.onap.org/).
14589 description: Unique ID of the vdc
14592 example: __VDC-ID__
14595 description: virtual-data-center object that needs to be updated.
14598 $ref: "#/patchDefinitions/virtual-data-center"
14601 - CloudInfrastructure
14602 summary: delete an existing virtual-data-center
14603 description: delete an existing virtual-data-center
14604 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
14613 description: Response codes found in [response codes](https://wiki.onap.org/).
14617 description: Unique ID of the vdc
14620 example: __VDC-ID__
14621 - name: resource-version
14623 description: resource-version for concurrency
14626 /cloud-infrastructure/virtual-data-centers:
14629 - CloudInfrastructure
14630 summary: returns virtual-data-centers
14631 description: returns virtual-data-centers
14632 operationId: getCloudInfrastructureVirtualDataCenters
14638 description: successful operation
14640 $ref: "#/getDefinitions/virtual-data-centers"
14642 description: Response codes found in [response codes](https://wiki.onap.org/).
14654 /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
14657 - CloudInfrastructure
14658 summary: see node definition for valid relationships
14659 operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
14668 description: Response codes found in [response codes](https://wiki.onap.org/).
14670 - name: operational-environment-id
14672 description: UUID of an operational environment
14675 example: __OPERATIONAL-ENVIRONMENT-ID__
14678 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
14681 $ref: "#/definitions/relationship"
14684 - CloudInfrastructure
14685 summary: delete an existing relationship
14686 description: delete an existing relationship
14687 operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
14696 description: Response codes found in [response codes](https://wiki.onap.org/).
14698 - name: operational-environment-id
14700 description: UUID of an operational environment
14703 example: __OPERATIONAL-ENVIRONMENT-ID__
14704 /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}:
14707 - CloudInfrastructure
14708 summary: returns operational-environment
14709 description: returns operational-environment
14710 operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14716 description: successful operation
14718 $ref: "#/getDefinitions/operational-environment"
14720 description: Response codes found in [response codes](https://wiki.onap.org/).
14722 - name: operational-environment-id
14724 description: UUID of an operational environment
14727 example: __OPERATIONAL-ENVIRONMENT-ID__
14730 - CloudInfrastructure
14731 summary: create or update an existing operational-environment
14733 Create or update an existing operational-environment.
14735 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14736 operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14745 description: Response codes found in [response codes](https://wiki.onap.org/).
14747 - name: operational-environment-id
14749 description: UUID of an operational environment
14752 example: __OPERATIONAL-ENVIRONMENT-ID__
14755 description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
14758 $ref: "#/definitions/operational-environment"
14761 - CloudInfrastructure
14762 summary: update an existing operational-environment
14764 Update an existing operational-environment
14766 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14767 The PUT operation will entirely replace an existing object.
14768 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14770 Other differences between PUT and PATCH are:
14772 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14773 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14774 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14775 operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14784 description: Response codes found in [response codes](https://wiki.onap.org/).
14786 - name: operational-environment-id
14788 description: UUID of an operational environment
14791 example: __OPERATIONAL-ENVIRONMENT-ID__
14794 description: operational-environment object that needs to be updated.
14797 $ref: "#/patchDefinitions/operational-environment"
14800 - CloudInfrastructure
14801 summary: delete an existing operational-environment
14802 description: delete an existing operational-environment
14803 operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14812 description: Response codes found in [response codes](https://wiki.onap.org/).
14814 - name: operational-environment-id
14816 description: UUID of an operational environment
14819 example: __OPERATIONAL-ENVIRONMENT-ID__
14820 - name: resource-version
14822 description: resource-version for concurrency
14825 /cloud-infrastructure/operational-environments:
14828 - CloudInfrastructure
14829 summary: returns operational-environments
14830 description: returns operational-environments
14831 operationId: getCloudInfrastructureOperationalEnvironments
14837 description: successful operation
14839 $ref: "#/getDefinitions/operational-environments"
14841 description: Response codes found in [response codes](https://wiki.onap.org/).
14843 - name: operational-environment-id
14848 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
14852 summary: see node definition for valid relationships
14853 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
14862 description: Response codes found in [response codes](https://wiki.onap.org/).
14864 - name: resource-instance-id
14866 description: Unique id of resource instance.
14869 example: __RESOURCE-INSTANCE-ID__
14872 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnector.json)
14875 $ref: "#/definitions/relationship"
14879 summary: delete an existing relationship
14880 description: delete an existing relationship
14881 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
14890 description: Response codes found in [response codes](https://wiki.onap.org/).
14892 - name: resource-instance-id
14894 description: Unique id of resource instance.
14897 example: __RESOURCE-INSTANCE-ID__
14898 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
14902 summary: returns metadatum
14903 description: returns metadatum
14904 operationId: getBusinessConnectorsConnectorMetadataMetadatum
14910 description: successful operation
14912 $ref: "#/getDefinitions/metadatum"
14914 description: Response codes found in [response codes](https://wiki.onap.org/).
14916 - name: resource-instance-id
14918 description: Unique id of resource instance.
14921 example: __RESOURCE-INSTANCE-ID__
14926 example: __METANAME__
14930 summary: create or update an existing metadatum
14932 Create or update an existing metadatum.
14934 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14935 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14944 description: Response codes found in [response codes](https://wiki.onap.org/).
14946 - name: resource-instance-id
14948 description: Unique id of resource instance.
14951 example: __RESOURCE-INSTANCE-ID__
14956 example: __METANAME__
14959 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnectorMetadataMetadatum.json)
14962 $ref: "#/definitions/metadatum"
14966 summary: update an existing metadatum
14968 Update an existing metadatum
14970 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14971 The PUT operation will entirely replace an existing object.
14972 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14974 Other differences between PUT and PATCH are:
14976 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14977 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14978 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14979 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14988 description: Response codes found in [response codes](https://wiki.onap.org/).
14990 - name: resource-instance-id
14992 description: Unique id of resource instance.
14995 example: __RESOURCE-INSTANCE-ID__
15000 example: __METANAME__
15003 description: metadatum object that needs to be updated.
15006 $ref: "#/patchDefinitions/metadatum"
15010 summary: delete an existing metadatum
15011 description: delete an existing metadatum
15012 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
15021 description: Response codes found in [response codes](https://wiki.onap.org/).
15023 - name: resource-instance-id
15025 description: Unique id of resource instance.
15028 example: __RESOURCE-INSTANCE-ID__
15033 example: __METANAME__
15034 - name: resource-version
15036 description: resource-version for concurrency
15039 /business/connectors/connector/{resource-instance-id}/metadata:
15043 summary: returns metadata
15044 description: returns metadata
15045 operationId: getBusinessConnectorsConnectorMetadata
15051 description: successful operation
15053 $ref: "#/getDefinitions/metadata"
15055 description: Response codes found in [response codes](https://wiki.onap.org/).
15057 - name: resource-instance-id
15059 description: Unique id of resource instance.
15062 example: __RESOURCE-INSTANCE-ID__
15068 /business/connectors/connector/{resource-instance-id}:
15072 summary: returns connector
15073 description: returns connector
15074 operationId: getBusinessConnectorsConnector
15080 description: successful operation
15082 $ref: "#/getDefinitions/connector"
15084 description: Response codes found in [response codes](https://wiki.onap.org/).
15086 - name: resource-instance-id
15088 description: Unique id of resource instance.
15091 example: __RESOURCE-INSTANCE-ID__
15095 summary: create or update an existing connector
15097 Create or update an existing connector.
15099 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15100 operationId: createOrUpdateBusinessConnectorsConnector
15109 description: Response codes found in [response codes](https://wiki.onap.org/).
15111 - name: resource-instance-id
15113 description: Unique id of resource instance.
15116 example: __RESOURCE-INSTANCE-ID__
15119 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnector.json)
15122 $ref: "#/definitions/connector"
15126 summary: update an existing connector
15128 Update an existing connector
15130 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15131 The PUT operation will entirely replace an existing object.
15132 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15134 Other differences between PUT and PATCH are:
15136 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15137 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15138 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15139 operationId: UpdateBusinessConnectorsConnector
15148 description: Response codes found in [response codes](https://wiki.onap.org/).
15150 - name: resource-instance-id
15152 description: Unique id of resource instance.
15155 example: __RESOURCE-INSTANCE-ID__
15158 description: connector object that needs to be updated.
15161 $ref: "#/patchDefinitions/connector"
15165 summary: delete an existing connector
15166 description: delete an existing connector
15167 operationId: deleteBusinessConnectorsConnector
15176 description: Response codes found in [response codes](https://wiki.onap.org/).
15178 - name: resource-instance-id
15180 description: Unique id of resource instance.
15183 example: __RESOURCE-INSTANCE-ID__
15184 - name: resource-version
15186 description: resource-version for concurrency
15189 /business/connectors:
15193 summary: returns connectors
15194 description: returns connectors
15195 operationId: getBusinessConnectors
15201 description: successful operation
15203 $ref: "#/getDefinitions/connectors"
15205 description: Response codes found in [response codes](https://wiki.onap.org/).
15207 - name: resource-instance-id
15212 - name: model-invariant-id
15217 - name: model-version-id
15222 - name: widget-model-id
15227 - name: widget-model-version
15232 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
15236 summary: see node definition for valid relationships
15237 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15246 description: Response codes found in [response codes](https://wiki.onap.org/).
15248 - name: global-customer-id
15250 description: Global customer id used across ECOMP to uniquely identify customer.
15253 example: __GLOBAL-CUSTOMER-ID__
15254 - name: service-type
15256 description: Value defined by orchestration to identify this service across ECOMP.
15259 example: __SERVICE-TYPE__
15260 - name: service-instance-id
15262 description: Uniquely identifies this instance of a service
15265 example: __SERVICE-INSTANCE-ID__
15268 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
15271 $ref: "#/definitions/relationship"
15275 summary: delete an existing relationship
15276 description: delete an existing relationship
15277 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15286 description: Response codes found in [response codes](https://wiki.onap.org/).
15288 - name: global-customer-id
15290 description: Global customer id used across ECOMP to uniquely identify customer.
15293 example: __GLOBAL-CUSTOMER-ID__
15294 - name: service-type
15296 description: Value defined by orchestration to identify this service across ECOMP.
15299 example: __SERVICE-TYPE__
15300 - name: service-instance-id
15302 description: Uniquely identifies this instance of a service
15305 example: __SERVICE-INSTANCE-ID__
15306 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
15310 summary: returns metadatum
15311 description: returns metadatum
15312 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15318 description: successful operation
15320 $ref: "#/getDefinitions/metadatum"
15322 description: Response codes found in [response codes](https://wiki.onap.org/).
15324 - name: global-customer-id
15326 description: Global customer id used across ECOMP to uniquely identify customer.
15329 example: __GLOBAL-CUSTOMER-ID__
15330 - name: service-type
15332 description: Value defined by orchestration to identify this service across ECOMP.
15335 example: __SERVICE-TYPE__
15336 - name: service-instance-id
15338 description: Uniquely identifies this instance of a service
15341 example: __SERVICE-INSTANCE-ID__
15346 example: __METANAME__
15350 summary: create or update an existing metadatum
15352 Create or update an existing metadatum.
15354 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15355 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15364 description: Response codes found in [response codes](https://wiki.onap.org/).
15366 - name: global-customer-id
15368 description: Global customer id used across ECOMP to uniquely identify customer.
15371 example: __GLOBAL-CUSTOMER-ID__
15372 - name: service-type
15374 description: Value defined by orchestration to identify this service across ECOMP.
15377 example: __SERVICE-TYPE__
15378 - name: service-instance-id
15380 description: Uniquely identifies this instance of a service
15383 example: __SERVICE-INSTANCE-ID__
15388 example: __METANAME__
15391 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
15394 $ref: "#/definitions/metadatum"
15398 summary: update an existing metadatum
15400 Update an existing metadatum
15402 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15403 The PUT operation will entirely replace an existing object.
15404 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15406 Other differences between PUT and PATCH are:
15408 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15409 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15410 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15411 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15420 description: Response codes found in [response codes](https://wiki.onap.org/).
15422 - name: global-customer-id
15424 description: Global customer id used across ECOMP to uniquely identify customer.
15427 example: __GLOBAL-CUSTOMER-ID__
15428 - name: service-type
15430 description: Value defined by orchestration to identify this service across ECOMP.
15433 example: __SERVICE-TYPE__
15434 - name: service-instance-id
15436 description: Uniquely identifies this instance of a service
15439 example: __SERVICE-INSTANCE-ID__
15444 example: __METANAME__
15447 description: metadatum object that needs to be updated.
15450 $ref: "#/patchDefinitions/metadatum"
15454 summary: delete an existing metadatum
15455 description: delete an existing metadatum
15456 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15465 description: Response codes found in [response codes](https://wiki.onap.org/).
15467 - name: global-customer-id
15469 description: Global customer id used across ECOMP to uniquely identify customer.
15472 example: __GLOBAL-CUSTOMER-ID__
15473 - name: service-type
15475 description: Value defined by orchestration to identify this service across ECOMP.
15478 example: __SERVICE-TYPE__
15479 - name: service-instance-id
15481 description: Uniquely identifies this instance of a service
15484 example: __SERVICE-INSTANCE-ID__
15489 example: __METANAME__
15490 - name: resource-version
15492 description: resource-version for concurrency
15495 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
15499 summary: returns metadata
15500 description: returns metadata
15501 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
15507 description: successful operation
15509 $ref: "#/getDefinitions/metadata"
15511 description: Response codes found in [response codes](https://wiki.onap.org/).
15513 - name: global-customer-id
15515 description: Global customer id used across ECOMP to uniquely identify customer.
15518 example: __GLOBAL-CUSTOMER-ID__
15519 - name: service-type
15521 description: Value defined by orchestration to identify this service across ECOMP.
15524 example: __SERVICE-TYPE__
15525 - name: service-instance-id
15527 description: Uniquely identifies this instance of a service
15530 example: __SERVICE-INSTANCE-ID__
15536 /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:
15540 summary: see node definition for valid relationships
15541 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15550 description: Response codes found in [response codes](https://wiki.onap.org/).
15552 - name: global-customer-id
15554 description: Global customer id used across ECOMP to uniquely identify customer.
15557 example: __GLOBAL-CUSTOMER-ID__
15558 - name: service-type
15560 description: Value defined by orchestration to identify this service across ECOMP.
15563 example: __SERVICE-TYPE__
15564 - name: service-instance-id
15566 description: Uniquely identifies this instance of a service
15569 example: __SERVICE-INSTANCE-ID__
15572 description: Allotted Resource id UUID assigned to this instance.
15578 description: Allotted Resource id UUID assigned to this instance.
15584 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15587 $ref: "#/definitions/relationship"
15591 summary: delete an existing relationship
15592 description: delete an existing relationship
15593 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15602 description: Response codes found in [response codes](https://wiki.onap.org/).
15604 - name: global-customer-id
15606 description: Global customer id used across ECOMP to uniquely identify customer.
15609 example: __GLOBAL-CUSTOMER-ID__
15610 - name: service-type
15612 description: Value defined by orchestration to identify this service across ECOMP.
15615 example: __SERVICE-TYPE__
15616 - name: service-instance-id
15618 description: Uniquely identifies this instance of a service
15621 example: __SERVICE-INSTANCE-ID__
15624 description: Allotted Resource id UUID assigned to this instance.
15630 description: Allotted Resource id UUID assigned to this instance.
15634 /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}:
15638 summary: returns tunnel-xconnect
15639 description: returns tunnel-xconnect
15640 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15646 description: successful operation
15648 $ref: "#/getDefinitions/tunnel-xconnect"
15650 description: Response codes found in [response codes](https://wiki.onap.org/).
15652 - name: global-customer-id
15654 description: Global customer id used across ECOMP to uniquely identify customer.
15657 example: __GLOBAL-CUSTOMER-ID__
15658 - name: service-type
15660 description: Value defined by orchestration to identify this service across ECOMP.
15663 example: __SERVICE-TYPE__
15664 - name: service-instance-id
15666 description: Uniquely identifies this instance of a service
15669 example: __SERVICE-INSTANCE-ID__
15672 description: Allotted Resource id UUID assigned to this instance.
15678 description: Allotted Resource id UUID assigned to this instance.
15685 summary: create or update an existing tunnel-xconnect
15687 Create or update an existing tunnel-xconnect.
15689 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15690 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15699 description: Response codes found in [response codes](https://wiki.onap.org/).
15701 - name: global-customer-id
15703 description: Global customer id used across ECOMP to uniquely identify customer.
15706 example: __GLOBAL-CUSTOMER-ID__
15707 - name: service-type
15709 description: Value defined by orchestration to identify this service across ECOMP.
15712 example: __SERVICE-TYPE__
15713 - name: service-instance-id
15715 description: Uniquely identifies this instance of a service
15718 example: __SERVICE-INSTANCE-ID__
15721 description: Allotted Resource id UUID assigned to this instance.
15727 description: Allotted Resource id UUID assigned to this instance.
15733 description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15736 $ref: "#/definitions/tunnel-xconnect"
15740 summary: update an existing tunnel-xconnect
15742 Update an existing tunnel-xconnect
15744 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15745 The PUT operation will entirely replace an existing object.
15746 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15748 Other differences between PUT and PATCH are:
15750 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15751 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15752 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15753 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15762 description: Response codes found in [response codes](https://wiki.onap.org/).
15764 - name: global-customer-id
15766 description: Global customer id used across ECOMP to uniquely identify customer.
15769 example: __GLOBAL-CUSTOMER-ID__
15770 - name: service-type
15772 description: Value defined by orchestration to identify this service across ECOMP.
15775 example: __SERVICE-TYPE__
15776 - name: service-instance-id
15778 description: Uniquely identifies this instance of a service
15781 example: __SERVICE-INSTANCE-ID__
15784 description: Allotted Resource id UUID assigned to this instance.
15790 description: Allotted Resource id UUID assigned to this instance.
15796 description: tunnel-xconnect object that needs to be updated.
15799 $ref: "#/patchDefinitions/tunnel-xconnect"
15803 summary: delete an existing tunnel-xconnect
15804 description: delete an existing tunnel-xconnect
15805 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15814 description: Response codes found in [response codes](https://wiki.onap.org/).
15816 - name: global-customer-id
15818 description: Global customer id used across ECOMP to uniquely identify customer.
15821 example: __GLOBAL-CUSTOMER-ID__
15822 - name: service-type
15824 description: Value defined by orchestration to identify this service across ECOMP.
15827 example: __SERVICE-TYPE__
15828 - name: service-instance-id
15830 description: Uniquely identifies this instance of a service
15833 example: __SERVICE-INSTANCE-ID__
15836 description: Allotted Resource id UUID assigned to this instance.
15842 description: Allotted Resource id UUID assigned to this instance.
15846 - name: resource-version
15848 description: resource-version for concurrency
15851 /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:
15855 summary: returns tunnel-xconnects
15856 description: returns tunnel-xconnects
15857 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
15863 description: successful operation
15865 $ref: "#/getDefinitions/tunnel-xconnects"
15867 description: Response codes found in [response codes](https://wiki.onap.org/).
15869 - name: global-customer-id
15871 description: Global customer id used across ECOMP to uniquely identify customer.
15874 example: __GLOBAL-CUSTOMER-ID__
15875 - name: service-type
15877 description: Value defined by orchestration to identify this service across ECOMP.
15880 example: __SERVICE-TYPE__
15881 - name: service-instance-id
15883 description: Uniquely identifies this instance of a service
15886 example: __SERVICE-INSTANCE-ID__
15889 description: Allotted Resource id UUID assigned to this instance.
15898 /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:
15902 summary: see node definition for valid relationships
15903 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15912 description: Response codes found in [response codes](https://wiki.onap.org/).
15914 - name: global-customer-id
15916 description: Global customer id used across ECOMP to uniquely identify customer.
15919 example: __GLOBAL-CUSTOMER-ID__
15920 - name: service-type
15922 description: Value defined by orchestration to identify this service across ECOMP.
15925 example: __SERVICE-TYPE__
15926 - name: service-instance-id
15928 description: Uniquely identifies this instance of a service
15931 example: __SERVICE-INSTANCE-ID__
15934 description: Allotted Resource id UUID assigned to this instance.
15940 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15943 $ref: "#/definitions/relationship"
15947 summary: delete an existing relationship
15948 description: delete an existing relationship
15949 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15958 description: Response codes found in [response codes](https://wiki.onap.org/).
15960 - name: global-customer-id
15962 description: Global customer id used across ECOMP to uniquely identify customer.
15965 example: __GLOBAL-CUSTOMER-ID__
15966 - name: service-type
15968 description: Value defined by orchestration to identify this service across ECOMP.
15971 example: __SERVICE-TYPE__
15972 - name: service-instance-id
15974 description: Uniquely identifies this instance of a service
15977 example: __SERVICE-INSTANCE-ID__
15980 description: Allotted Resource id UUID assigned to this instance.
15984 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
15988 summary: returns allotted-resource
15989 description: returns allotted-resource
15990 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15996 description: successful operation
15998 $ref: "#/getDefinitions/allotted-resource"
16000 description: Response codes found in [response codes](https://wiki.onap.org/).
16002 - name: global-customer-id
16004 description: Global customer id used across ECOMP to uniquely identify customer.
16007 example: __GLOBAL-CUSTOMER-ID__
16008 - name: service-type
16010 description: Value defined by orchestration to identify this service across ECOMP.
16013 example: __SERVICE-TYPE__
16014 - name: service-instance-id
16016 description: Uniquely identifies this instance of a service
16019 example: __SERVICE-INSTANCE-ID__
16022 description: Allotted Resource id UUID assigned to this instance.
16029 summary: create or update an existing allotted-resource
16031 Create or update an existing allotted-resource.
16033 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16034 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16043 description: Response codes found in [response codes](https://wiki.onap.org/).
16045 - name: global-customer-id
16047 description: Global customer id used across ECOMP to uniquely identify customer.
16050 example: __GLOBAL-CUSTOMER-ID__
16051 - name: service-type
16053 description: Value defined by orchestration to identify this service across ECOMP.
16056 example: __SERVICE-TYPE__
16057 - name: service-instance-id
16059 description: Uniquely identifies this instance of a service
16062 example: __SERVICE-INSTANCE-ID__
16065 description: Allotted Resource id UUID assigned to this instance.
16071 description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
16074 $ref: "#/definitions/allotted-resource"
16078 summary: update an existing allotted-resource
16080 Update an existing allotted-resource
16082 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16083 The PUT operation will entirely replace an existing object.
16084 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16086 Other differences between PUT and PATCH are:
16088 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16089 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16090 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16091 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16100 description: Response codes found in [response codes](https://wiki.onap.org/).
16102 - name: global-customer-id
16104 description: Global customer id used across ECOMP to uniquely identify customer.
16107 example: __GLOBAL-CUSTOMER-ID__
16108 - name: service-type
16110 description: Value defined by orchestration to identify this service across ECOMP.
16113 example: __SERVICE-TYPE__
16114 - name: service-instance-id
16116 description: Uniquely identifies this instance of a service
16119 example: __SERVICE-INSTANCE-ID__
16122 description: Allotted Resource id UUID assigned to this instance.
16128 description: allotted-resource object that needs to be updated.
16131 $ref: "#/patchDefinitions/allotted-resource"
16135 summary: delete an existing allotted-resource
16136 description: delete an existing allotted-resource
16137 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16146 description: Response codes found in [response codes](https://wiki.onap.org/).
16148 - name: global-customer-id
16150 description: Global customer id used across ECOMP to uniquely identify customer.
16153 example: __GLOBAL-CUSTOMER-ID__
16154 - name: service-type
16156 description: Value defined by orchestration to identify this service across ECOMP.
16159 example: __SERVICE-TYPE__
16160 - name: service-instance-id
16162 description: Uniquely identifies this instance of a service
16165 example: __SERVICE-INSTANCE-ID__
16168 description: Allotted Resource id UUID assigned to this instance.
16172 - name: resource-version
16174 description: resource-version for concurrency
16177 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
16181 summary: returns allotted-resources
16182 description: returns allotted-resources
16183 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
16189 description: successful operation
16191 $ref: "#/getDefinitions/allotted-resources"
16193 description: Response codes found in [response codes](https://wiki.onap.org/).
16195 - name: global-customer-id
16197 description: Global customer id used across ECOMP to uniquely identify customer.
16200 example: __GLOBAL-CUSTOMER-ID__
16201 - name: service-type
16203 description: Value defined by orchestration to identify this service across ECOMP.
16206 example: __SERVICE-TYPE__
16207 - name: service-instance-id
16209 description: Uniquely identifies this instance of a service
16212 example: __SERVICE-INSTANCE-ID__
16218 - name: model-invariant-id
16223 - name: model-version-id
16238 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
16242 summary: returns service-instance
16243 description: returns service-instance
16244 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16250 description: successful operation
16252 $ref: "#/getDefinitions/service-instance"
16254 description: Response codes found in [response codes](https://wiki.onap.org/).
16256 - name: global-customer-id
16258 description: Global customer id used across ECOMP to uniquely identify customer.
16261 example: __GLOBAL-CUSTOMER-ID__
16262 - name: service-type
16264 description: Value defined by orchestration to identify this service across ECOMP.
16267 example: __SERVICE-TYPE__
16268 - name: service-instance-id
16270 description: Uniquely identifies this instance of a service
16273 example: __SERVICE-INSTANCE-ID__
16277 summary: create or update an existing service-instance
16279 Create or update an existing service-instance.
16281 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16282 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16291 description: Response codes found in [response codes](https://wiki.onap.org/).
16293 - name: global-customer-id
16295 description: Global customer id used across ECOMP to uniquely identify customer.
16298 example: __GLOBAL-CUSTOMER-ID__
16299 - name: service-type
16301 description: Value defined by orchestration to identify this service across ECOMP.
16304 example: __SERVICE-TYPE__
16305 - name: service-instance-id
16307 description: Uniquely identifies this instance of a service
16310 example: __SERVICE-INSTANCE-ID__
16313 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16316 $ref: "#/definitions/service-instance"
16320 summary: update an existing service-instance
16322 Update an existing service-instance
16324 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16325 The PUT operation will entirely replace an existing object.
16326 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16328 Other differences between PUT and PATCH are:
16330 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16331 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16332 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16333 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16342 description: Response codes found in [response codes](https://wiki.onap.org/).
16344 - name: global-customer-id
16346 description: Global customer id used across ECOMP to uniquely identify customer.
16349 example: __GLOBAL-CUSTOMER-ID__
16350 - name: service-type
16352 description: Value defined by orchestration to identify this service across ECOMP.
16355 example: __SERVICE-TYPE__
16356 - name: service-instance-id
16358 description: Uniquely identifies this instance of a service
16361 example: __SERVICE-INSTANCE-ID__
16364 description: service-instance object that needs to be updated.
16367 $ref: "#/patchDefinitions/service-instance"
16371 summary: delete an existing service-instance
16372 description: delete an existing service-instance
16373 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16382 description: Response codes found in [response codes](https://wiki.onap.org/).
16384 - name: global-customer-id
16386 description: Global customer id used across ECOMP to uniquely identify customer.
16389 example: __GLOBAL-CUSTOMER-ID__
16390 - name: service-type
16392 description: Value defined by orchestration to identify this service across ECOMP.
16395 example: __SERVICE-TYPE__
16396 - name: service-instance-id
16398 description: Uniquely identifies this instance of a service
16401 example: __SERVICE-INSTANCE-ID__
16402 - name: resource-version
16404 description: resource-version for concurrency
16407 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
16411 summary: returns service-instances
16412 description: returns service-instances
16413 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
16419 description: successful operation
16421 $ref: "#/getDefinitions/service-instances"
16423 description: Response codes found in [response codes](https://wiki.onap.org/).
16425 - name: global-customer-id
16427 description: Global customer id used across ECOMP to uniquely identify customer.
16430 example: __GLOBAL-CUSTOMER-ID__
16431 - name: service-type
16433 description: Value defined by orchestration to identify this service across ECOMP.
16436 example: __SERVICE-TYPE__
16437 - name: service-instance-id
16442 - name: service-instance-name
16447 - name: environment-context
16452 - name: workload-context
16457 - name: model-invariant-id
16462 - name: model-version-id
16467 - name: widget-model-id
16472 - name: widget-model-version
16477 - name: service-instance-location-id
16482 - name: orchestration-status
16487 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
16491 summary: see node definition for valid relationships
16492 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16501 description: Response codes found in [response codes](https://wiki.onap.org/).
16503 - name: global-customer-id
16505 description: Global customer id used across ECOMP to uniquely identify customer.
16508 example: __GLOBAL-CUSTOMER-ID__
16509 - name: service-type
16511 description: Value defined by orchestration to identify this service across ECOMP.
16514 example: __SERVICE-TYPE__
16517 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16520 $ref: "#/definitions/relationship"
16524 summary: delete an existing relationship
16525 description: delete an existing relationship
16526 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16535 description: Response codes found in [response codes](https://wiki.onap.org/).
16537 - name: global-customer-id
16539 description: Global customer id used across ECOMP to uniquely identify customer.
16542 example: __GLOBAL-CUSTOMER-ID__
16543 - name: service-type
16545 description: Value defined by orchestration to identify this service across ECOMP.
16548 example: __SERVICE-TYPE__
16549 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
16553 summary: returns service-subscription
16554 description: returns service-subscription
16555 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16561 description: successful operation
16563 $ref: "#/getDefinitions/service-subscription"
16565 description: Response codes found in [response codes](https://wiki.onap.org/).
16567 - name: global-customer-id
16569 description: Global customer id used across ECOMP to uniquely identify customer.
16572 example: __GLOBAL-CUSTOMER-ID__
16573 - name: service-type
16575 description: Value defined by orchestration to identify this service across ECOMP.
16578 example: __SERVICE-TYPE__
16582 summary: create or update an existing service-subscription
16584 Create or update an existing service-subscription.
16586 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16587 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16596 description: Response codes found in [response codes](https://wiki.onap.org/).
16598 - name: global-customer-id
16600 description: Global customer id used across ECOMP to uniquely identify customer.
16603 example: __GLOBAL-CUSTOMER-ID__
16604 - name: service-type
16606 description: Value defined by orchestration to identify this service across ECOMP.
16609 example: __SERVICE-TYPE__
16612 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16615 $ref: "#/definitions/service-subscription"
16619 summary: update an existing service-subscription
16621 Update an existing service-subscription
16623 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16624 The PUT operation will entirely replace an existing object.
16625 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16627 Other differences between PUT and PATCH are:
16629 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16630 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16631 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16632 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16641 description: Response codes found in [response codes](https://wiki.onap.org/).
16643 - name: global-customer-id
16645 description: Global customer id used across ECOMP to uniquely identify customer.
16648 example: __GLOBAL-CUSTOMER-ID__
16649 - name: service-type
16651 description: Value defined by orchestration to identify this service across ECOMP.
16654 example: __SERVICE-TYPE__
16657 description: service-subscription object that needs to be updated.
16660 $ref: "#/patchDefinitions/service-subscription"
16664 summary: delete an existing service-subscription
16665 description: delete an existing service-subscription
16666 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16675 description: Response codes found in [response codes](https://wiki.onap.org/).
16677 - name: global-customer-id
16679 description: Global customer id used across ECOMP to uniquely identify customer.
16682 example: __GLOBAL-CUSTOMER-ID__
16683 - name: service-type
16685 description: Value defined by orchestration to identify this service across ECOMP.
16688 example: __SERVICE-TYPE__
16689 - name: resource-version
16691 description: resource-version for concurrency
16694 /business/customers/customer/{global-customer-id}/service-subscriptions:
16698 summary: returns service-subscriptions
16699 description: returns service-subscriptions
16700 operationId: getBusinessCustomersCustomerServiceSubscriptions
16706 description: successful operation
16708 $ref: "#/getDefinitions/service-subscriptions"
16710 description: Response codes found in [response codes](https://wiki.onap.org/).
16712 - name: global-customer-id
16714 description: Global customer id used across ECOMP to uniquely identify customer.
16717 example: __GLOBAL-CUSTOMER-ID__
16718 - name: service-type
16723 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
16727 summary: see node definition for valid relationships
16728 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
16737 description: Response codes found in [response codes](https://wiki.onap.org/).
16739 - name: global-customer-id
16741 description: Global customer id used across ECOMP to uniquely identify customer.
16744 example: __GLOBAL-CUSTOMER-ID__
16747 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomer.json)
16750 $ref: "#/definitions/relationship"
16754 summary: delete an existing relationship
16755 description: delete an existing relationship
16756 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
16765 description: Response codes found in [response codes](https://wiki.onap.org/).
16767 - name: global-customer-id
16769 description: Global customer id used across ECOMP to uniquely identify customer.
16772 example: __GLOBAL-CUSTOMER-ID__
16773 /business/customers/customer/{global-customer-id}:
16777 summary: returns customer
16778 description: returns customer
16779 operationId: getBusinessCustomersCustomer
16785 description: successful operation
16787 $ref: "#/getDefinitions/customer"
16789 description: Response codes found in [response codes](https://wiki.onap.org/).
16791 - name: global-customer-id
16793 description: Global customer id used across ECOMP to uniquely identify customer.
16796 example: __GLOBAL-CUSTOMER-ID__
16800 summary: create or update an existing customer
16802 Create or update an existing customer.
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: createOrUpdateBusinessCustomersCustomer
16814 description: Response codes found in [response codes](https://wiki.onap.org/).
16816 - name: global-customer-id
16818 description: Global customer id used across ECOMP to uniquely identify customer.
16821 example: __GLOBAL-CUSTOMER-ID__
16824 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomer.json)
16827 $ref: "#/definitions/customer"
16831 summary: update an existing customer
16833 Update an existing customer
16835 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16836 The PUT operation will entirely replace an existing object.
16837 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16839 Other differences between PUT and PATCH are:
16841 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16842 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16843 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16844 operationId: UpdateBusinessCustomersCustomer
16853 description: Response codes found in [response codes](https://wiki.onap.org/).
16855 - name: global-customer-id
16857 description: Global customer id used across ECOMP to uniquely identify customer.
16860 example: __GLOBAL-CUSTOMER-ID__
16863 description: customer object that needs to be updated.
16866 $ref: "#/patchDefinitions/customer"
16870 summary: delete an existing customer
16871 description: delete an existing customer
16872 operationId: deleteBusinessCustomersCustomer
16881 description: Response codes found in [response codes](https://wiki.onap.org/).
16883 - name: global-customer-id
16885 description: Global customer id used across ECOMP to uniquely identify customer.
16888 example: __GLOBAL-CUSTOMER-ID__
16889 - name: resource-version
16891 description: resource-version for concurrency
16894 /business/customers:
16898 summary: returns customers
16899 description: returns customers
16900 operationId: getBusinessCustomers
16906 description: successful operation
16908 $ref: "#/getDefinitions/customers"
16910 description: Response codes found in [response codes](https://wiki.onap.org/).
16912 - name: global-customer-id
16917 - name: subscriber-name
16922 - name: subscriber-type
16927 /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
16931 summary: see node definition for valid relationships
16932 operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
16941 description: Response codes found in [response codes](https://wiki.onap.org/).
16943 - name: line-of-business-name
16945 description: Name of the line-of-business (product)
16948 example: __LINE-OF-BUSINESS-NAME__
16951 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json)
16954 $ref: "#/definitions/relationship"
16958 summary: delete an existing relationship
16959 description: delete an existing relationship
16960 operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
16969 description: Response codes found in [response codes](https://wiki.onap.org/).
16971 - name: line-of-business-name
16973 description: Name of the line-of-business (product)
16976 example: __LINE-OF-BUSINESS-NAME__
16977 /business/lines-of-business/line-of-business/{line-of-business-name}:
16981 summary: returns line-of-business
16982 description: returns line-of-business
16983 operationId: getBusinessLinesOfBusinessLineOfBusiness
16989 description: successful operation
16991 $ref: "#/getDefinitions/line-of-business"
16993 description: Response codes found in [response codes](https://wiki.onap.org/).
16995 - name: line-of-business-name
16997 description: Name of the line-of-business (product)
17000 example: __LINE-OF-BUSINESS-NAME__
17004 summary: create or update an existing line-of-business
17006 Create or update an existing line-of-business.
17008 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17009 operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
17018 description: Response codes found in [response codes](https://wiki.onap.org/).
17020 - name: line-of-business-name
17022 description: Name of the line-of-business (product)
17025 example: __LINE-OF-BUSINESS-NAME__
17028 description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json)
17031 $ref: "#/definitions/line-of-business"
17035 summary: update an existing line-of-business
17037 Update an existing line-of-business
17039 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17040 The PUT operation will entirely replace an existing object.
17041 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17043 Other differences between PUT and PATCH are:
17045 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17046 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17047 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17048 operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
17057 description: Response codes found in [response codes](https://wiki.onap.org/).
17059 - name: line-of-business-name
17061 description: Name of the line-of-business (product)
17064 example: __LINE-OF-BUSINESS-NAME__
17067 description: line-of-business object that needs to be updated.
17070 $ref: "#/patchDefinitions/line-of-business"
17074 summary: delete an existing line-of-business
17075 description: delete an existing line-of-business
17076 operationId: deleteBusinessLinesOfBusinessLineOfBusiness
17085 description: Response codes found in [response codes](https://wiki.onap.org/).
17087 - name: line-of-business-name
17089 description: Name of the line-of-business (product)
17092 example: __LINE-OF-BUSINESS-NAME__
17093 - name: resource-version
17095 description: resource-version for concurrency
17098 /business/lines-of-business:
17102 summary: returns lines-of-business
17103 description: returns lines-of-business
17104 operationId: getBusinessLinesOfBusiness
17110 description: successful operation
17112 $ref: "#/getDefinitions/lines-of-business"
17114 description: Response codes found in [response codes](https://wiki.onap.org/).
17116 - name: line-of-business-name
17121 /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
17125 summary: see node definition for valid relationships
17126 operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
17135 description: Response codes found in [response codes](https://wiki.onap.org/).
17137 - name: owning-entity-id
17139 description: UUID of an owning entity
17142 example: __OWNING-ENTITY-ID__
17145 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json)
17148 $ref: "#/definitions/relationship"
17152 summary: delete an existing relationship
17153 description: delete an existing relationship
17154 operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
17163 description: Response codes found in [response codes](https://wiki.onap.org/).
17165 - name: owning-entity-id
17167 description: UUID of an owning entity
17170 example: __OWNING-ENTITY-ID__
17171 /business/owning-entities/owning-entity/{owning-entity-id}:
17175 summary: returns owning-entity
17176 description: returns owning-entity
17177 operationId: getBusinessOwningEntitiesOwningEntity
17183 description: successful operation
17185 $ref: "#/getDefinitions/owning-entity"
17187 description: Response codes found in [response codes](https://wiki.onap.org/).
17189 - name: owning-entity-id
17191 description: UUID of an owning entity
17194 example: __OWNING-ENTITY-ID__
17198 summary: create or update an existing owning-entity
17200 Create or update an existing owning-entity.
17202 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17203 operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
17212 description: Response codes found in [response codes](https://wiki.onap.org/).
17214 - name: owning-entity-id
17216 description: UUID of an owning entity
17219 example: __OWNING-ENTITY-ID__
17222 description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json)
17225 $ref: "#/definitions/owning-entity"
17229 summary: update an existing owning-entity
17231 Update an existing owning-entity
17233 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17234 The PUT operation will entirely replace an existing object.
17235 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17237 Other differences between PUT and PATCH are:
17239 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17240 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17241 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17242 operationId: UpdateBusinessOwningEntitiesOwningEntity
17251 description: Response codes found in [response codes](https://wiki.onap.org/).
17253 - name: owning-entity-id
17255 description: UUID of an owning entity
17258 example: __OWNING-ENTITY-ID__
17261 description: owning-entity object that needs to be updated.
17264 $ref: "#/patchDefinitions/owning-entity"
17268 summary: delete an existing owning-entity
17269 description: delete an existing owning-entity
17270 operationId: deleteBusinessOwningEntitiesOwningEntity
17279 description: Response codes found in [response codes](https://wiki.onap.org/).
17281 - name: owning-entity-id
17283 description: UUID of an owning entity
17286 example: __OWNING-ENTITY-ID__
17287 - name: resource-version
17289 description: resource-version for concurrency
17292 /business/owning-entities:
17296 summary: returns owning-entities
17297 description: returns owning-entities
17298 operationId: getBusinessOwningEntities
17304 description: successful operation
17306 $ref: "#/getDefinitions/owning-entities"
17308 description: Response codes found in [response codes](https://wiki.onap.org/).
17310 - name: owning-entity-id
17315 /business/platforms/platform/{platform-name}/relationship-list/relationship:
17319 summary: see node definition for valid relationships
17320 operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
17329 description: Response codes found in [response codes](https://wiki.onap.org/).
17331 - name: platform-name
17333 description: Name of the platform
17336 example: __PLATFORM-NAME__
17339 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessPlatformsPlatform.json)
17342 $ref: "#/definitions/relationship"
17346 summary: delete an existing relationship
17347 description: delete an existing relationship
17348 operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
17357 description: Response codes found in [response codes](https://wiki.onap.org/).
17359 - name: platform-name
17361 description: Name of the platform
17364 example: __PLATFORM-NAME__
17365 /business/platforms/platform/{platform-name}:
17369 summary: returns platform
17370 description: returns platform
17371 operationId: getBusinessPlatformsPlatform
17377 description: successful operation
17379 $ref: "#/getDefinitions/platform"
17381 description: Response codes found in [response codes](https://wiki.onap.org/).
17383 - name: platform-name
17385 description: Name of the platform
17388 example: __PLATFORM-NAME__
17392 summary: create or update an existing platform
17394 Create or update an existing platform.
17396 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17397 operationId: createOrUpdateBusinessPlatformsPlatform
17406 description: Response codes found in [response codes](https://wiki.onap.org/).
17408 - name: platform-name
17410 description: Name of the platform
17413 example: __PLATFORM-NAME__
17416 description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessPlatformsPlatform.json)
17419 $ref: "#/definitions/platform"
17423 summary: update an existing platform
17425 Update an existing platform
17427 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17428 The PUT operation will entirely replace an existing object.
17429 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17431 Other differences between PUT and PATCH are:
17433 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17434 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17435 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17436 operationId: UpdateBusinessPlatformsPlatform
17445 description: Response codes found in [response codes](https://wiki.onap.org/).
17447 - name: platform-name
17449 description: Name of the platform
17452 example: __PLATFORM-NAME__
17455 description: platform object that needs to be updated.
17458 $ref: "#/patchDefinitions/platform"
17462 summary: delete an existing platform
17463 description: delete an existing platform
17464 operationId: deleteBusinessPlatformsPlatform
17473 description: Response codes found in [response codes](https://wiki.onap.org/).
17475 - name: platform-name
17477 description: Name of the platform
17480 example: __PLATFORM-NAME__
17481 - name: resource-version
17483 description: resource-version for concurrency
17486 /business/platforms:
17490 summary: returns platforms
17491 description: returns platforms
17492 operationId: getBusinessPlatforms
17498 description: successful operation
17500 $ref: "#/getDefinitions/platforms"
17502 description: Response codes found in [response codes](https://wiki.onap.org/).
17504 - name: platform-name
17509 /business/projects/project/{project-name}/relationship-list/relationship:
17513 summary: see node definition for valid relationships
17514 operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
17523 description: Response codes found in [response codes](https://wiki.onap.org/).
17525 - name: project-name
17527 description: Name of the project deploying a service
17530 example: __PROJECT-NAME__
17533 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessProjectsProject.json)
17536 $ref: "#/definitions/relationship"
17540 summary: delete an existing relationship
17541 description: delete an existing relationship
17542 operationId: deleteBusinessProjectsProjectRelationshipListRelationship
17551 description: Response codes found in [response codes](https://wiki.onap.org/).
17553 - name: project-name
17555 description: Name of the project deploying a service
17558 example: __PROJECT-NAME__
17559 /business/projects/project/{project-name}:
17563 summary: returns project
17564 description: returns project
17565 operationId: getBusinessProjectsProject
17571 description: successful operation
17573 $ref: "#/getDefinitions/project"
17575 description: Response codes found in [response codes](https://wiki.onap.org/).
17577 - name: project-name
17579 description: Name of the project deploying a service
17582 example: __PROJECT-NAME__
17586 summary: create or update an existing project
17588 Create or update an existing project.
17590 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17591 operationId: createOrUpdateBusinessProjectsProject
17600 description: Response codes found in [response codes](https://wiki.onap.org/).
17602 - name: project-name
17604 description: Name of the project deploying a service
17607 example: __PROJECT-NAME__
17610 description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessProjectsProject.json)
17613 $ref: "#/definitions/project"
17617 summary: update an existing project
17619 Update an existing project
17621 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17622 The PUT operation will entirely replace an existing object.
17623 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17625 Other differences between PUT and PATCH are:
17627 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17628 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17629 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17630 operationId: UpdateBusinessProjectsProject
17639 description: Response codes found in [response codes](https://wiki.onap.org/).
17641 - name: project-name
17643 description: Name of the project deploying a service
17646 example: __PROJECT-NAME__
17649 description: project object that needs to be updated.
17652 $ref: "#/patchDefinitions/project"
17656 summary: delete an existing project
17657 description: delete an existing project
17658 operationId: deleteBusinessProjectsProject
17667 description: Response codes found in [response codes](https://wiki.onap.org/).
17669 - name: project-name
17671 description: Name of the project deploying a service
17674 example: __PROJECT-NAME__
17675 - name: resource-version
17677 description: resource-version for concurrency
17680 /business/projects:
17684 summary: returns projects
17685 description: returns projects
17686 operationId: getBusinessProjects
17692 description: successful operation
17694 $ref: "#/getDefinitions/projects"
17696 description: Response codes found in [response codes](https://wiki.onap.org/).
17698 - name: project-name
17703 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
17706 - ServiceDesignAndCreation
17707 summary: see node definition for valid relationships
17708 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
17717 description: Response codes found in [response codes](https://wiki.onap.org/).
17719 - name: vnf-image-uuid
17721 description: Unique ID of this asset
17724 example: __VNF-IMAGE-UUID__
17727 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)
17730 $ref: "#/definitions/relationship"
17733 - ServiceDesignAndCreation
17734 summary: delete an existing relationship
17735 description: delete an existing relationship
17736 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
17745 description: Response codes found in [response codes](https://wiki.onap.org/).
17747 - name: vnf-image-uuid
17749 description: Unique ID of this asset
17752 example: __VNF-IMAGE-UUID__
17753 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
17756 - ServiceDesignAndCreation
17757 summary: returns vnf-image
17758 description: returns vnf-image
17759 operationId: getServiceDesignAndCreationVnfImagesVnfImage
17765 description: successful operation
17767 $ref: "#/getDefinitions/vnf-image"
17769 description: Response codes found in [response codes](https://wiki.onap.org/).
17771 - name: vnf-image-uuid
17773 description: Unique ID of this asset
17776 example: __VNF-IMAGE-UUID__
17779 - ServiceDesignAndCreation
17780 summary: create or update an existing vnf-image
17782 Create or update an existing vnf-image.
17784 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17785 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
17794 description: Response codes found in [response codes](https://wiki.onap.org/).
17796 - name: vnf-image-uuid
17798 description: Unique ID of this asset
17801 example: __VNF-IMAGE-UUID__
17804 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)
17807 $ref: "#/definitions/vnf-image"
17810 - ServiceDesignAndCreation
17811 summary: update an existing vnf-image
17813 Update an existing vnf-image
17815 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17816 The PUT operation will entirely replace an existing object.
17817 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17819 Other differences between PUT and PATCH are:
17821 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17822 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17823 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17824 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
17833 description: Response codes found in [response codes](https://wiki.onap.org/).
17835 - name: vnf-image-uuid
17837 description: Unique ID of this asset
17840 example: __VNF-IMAGE-UUID__
17843 description: vnf-image object that needs to be updated.
17846 $ref: "#/patchDefinitions/vnf-image"
17849 - ServiceDesignAndCreation
17850 summary: delete an existing vnf-image
17851 description: delete an existing vnf-image
17852 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
17861 description: Response codes found in [response codes](https://wiki.onap.org/).
17863 - name: vnf-image-uuid
17865 description: Unique ID of this asset
17868 example: __VNF-IMAGE-UUID__
17869 - name: resource-version
17871 description: resource-version for concurrency
17874 /service-design-and-creation/vnf-images:
17877 - ServiceDesignAndCreation
17878 summary: returns vnf-images
17879 description: returns vnf-images
17880 operationId: getServiceDesignAndCreationVnfImages
17886 description: successful operation
17888 $ref: "#/getDefinitions/vnf-images"
17890 description: Response codes found in [response codes](https://wiki.onap.org/).
17892 - name: vnf-image-uuid
17897 - name: application
17902 - name: application-vendor
17907 - name: application-version
17912 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
17915 - ServiceDesignAndCreation
17916 summary: see node definition for valid relationships
17917 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
17926 description: Response codes found in [response codes](https://wiki.onap.org/).
17930 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17933 example: __SERVICE-ID__
17936 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServicesService.json)
17939 $ref: "#/definitions/relationship"
17942 - ServiceDesignAndCreation
17943 summary: delete an existing relationship
17944 description: delete an existing relationship
17945 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
17954 description: Response codes found in [response codes](https://wiki.onap.org/).
17958 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17961 example: __SERVICE-ID__
17962 /service-design-and-creation/services/service/{service-id}:
17965 - ServiceDesignAndCreation
17966 summary: returns service
17967 description: returns service
17968 operationId: getServiceDesignAndCreationServicesService
17974 description: successful operation
17976 $ref: "#/getDefinitions/service"
17978 description: Response codes found in [response codes](https://wiki.onap.org/).
17982 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17985 example: __SERVICE-ID__
17988 - ServiceDesignAndCreation
17989 summary: create or update an existing service
17991 Create or update an existing service.
17993 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17994 operationId: createOrUpdateServiceDesignAndCreationServicesService
18003 description: Response codes found in [response codes](https://wiki.onap.org/).
18007 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18010 example: __SERVICE-ID__
18013 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServicesService.json)
18016 $ref: "#/definitions/service"
18019 - ServiceDesignAndCreation
18020 summary: update an existing service
18022 Update an existing service
18024 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18025 The PUT operation will entirely replace an existing object.
18026 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18028 Other differences between PUT and PATCH are:
18030 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18031 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18032 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18033 operationId: UpdateServiceDesignAndCreationServicesService
18042 description: Response codes found in [response codes](https://wiki.onap.org/).
18046 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18049 example: __SERVICE-ID__
18052 description: service object that needs to be updated.
18055 $ref: "#/patchDefinitions/service"
18058 - ServiceDesignAndCreation
18059 summary: delete an existing service
18060 description: delete an existing service
18061 operationId: deleteServiceDesignAndCreationServicesService
18070 description: Response codes found in [response codes](https://wiki.onap.org/).
18074 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18077 example: __SERVICE-ID__
18078 - name: resource-version
18080 description: resource-version for concurrency
18083 /service-design-and-creation/services:
18086 - ServiceDesignAndCreation
18087 summary: returns services
18088 description: returns services
18089 operationId: getServiceDesignAndCreationServices
18095 description: successful operation
18097 $ref: "#/getDefinitions/services"
18099 description: Response codes found in [response codes](https://wiki.onap.org/).
18106 - name: service-description
18111 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
18114 - ServiceDesignAndCreation
18115 summary: see node definition for valid relationships
18116 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
18125 description: Response codes found in [response codes](https://wiki.onap.org/).
18127 - name: service-type
18129 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18132 example: __SERVICE-TYPE__
18135 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.
18138 example: __VNF-TYPE__
18141 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
18144 $ref: "#/definitions/relationship"
18147 - ServiceDesignAndCreation
18148 summary: delete an existing relationship
18149 description: delete an existing relationship
18150 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
18159 description: Response codes found in [response codes](https://wiki.onap.org/).
18161 - name: service-type
18163 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18166 example: __SERVICE-TYPE__
18169 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.
18172 example: __VNF-TYPE__
18173 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
18176 - ServiceDesignAndCreation
18177 summary: returns service-capability
18178 description: returns service-capability
18179 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
18185 description: successful operation
18187 $ref: "#/getDefinitions/service-capability"
18189 description: Response codes found in [response codes](https://wiki.onap.org/).
18191 - name: service-type
18193 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18196 example: __SERVICE-TYPE__
18199 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.
18202 example: __VNF-TYPE__
18205 - ServiceDesignAndCreation
18206 summary: create or update an existing service-capability
18208 Create or update an existing service-capability.
18210 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18211 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
18220 description: Response codes found in [response codes](https://wiki.onap.org/).
18222 - name: service-type
18224 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18227 example: __SERVICE-TYPE__
18230 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.
18233 example: __VNF-TYPE__
18236 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
18239 $ref: "#/definitions/service-capability"
18242 - ServiceDesignAndCreation
18243 summary: update an existing service-capability
18245 Update an existing service-capability
18247 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18248 The PUT operation will entirely replace an existing object.
18249 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18251 Other differences between PUT and PATCH are:
18253 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18254 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18255 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18256 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
18265 description: Response codes found in [response codes](https://wiki.onap.org/).
18267 - name: service-type
18269 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18272 example: __SERVICE-TYPE__
18275 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.
18278 example: __VNF-TYPE__
18281 description: service-capability object that needs to be updated.
18284 $ref: "#/patchDefinitions/service-capability"
18287 - ServiceDesignAndCreation
18288 summary: delete an existing service-capability
18289 description: delete an existing service-capability
18290 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
18299 description: Response codes found in [response codes](https://wiki.onap.org/).
18301 - name: service-type
18303 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18306 example: __SERVICE-TYPE__
18309 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.
18312 example: __VNF-TYPE__
18313 - name: resource-version
18315 description: resource-version for concurrency
18318 /service-design-and-creation/service-capabilities:
18321 - ServiceDesignAndCreation
18322 summary: returns service-capabilities
18323 description: returns service-capabilities
18324 operationId: getServiceDesignAndCreationServiceCapabilities
18330 description: successful operation
18332 $ref: "#/getDefinitions/service-capabilities"
18334 description: Response codes found in [response codes](https://wiki.onap.org/).
18336 - name: service-type
18346 /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:
18349 - ServiceDesignAndCreation
18350 summary: see node definition for valid relationships
18351 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
18360 description: Response codes found in [response codes](https://wiki.onap.org/).
18362 - name: model-invariant-id
18364 description: Unique identifier corresponding to the main definition of a model in ASDC
18367 example: __MODEL-INVARIANT-ID__
18368 - name: model-version-id
18370 description: Unique identifier corresponding to one version of a model in ASDC
18373 example: __MODEL-VERSION-ID__
18374 - name: model-element-uuid
18378 example: __MODEL-ELEMENT-UUID__
18379 - name: model-constraint-uuid
18383 example: __MODEL-CONSTRAINT-UUID__
18384 - name: constrained-element-set-uuid
18388 example: __CONSTRAINED-ELEMENT-SET-UUID__
18389 - name: element-choice-set-uuid
18393 example: __ELEMENT-CHOICE-SET-UUID__
18396 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
18399 $ref: "#/definitions/relationship"
18402 - ServiceDesignAndCreation
18403 summary: delete an existing relationship
18404 description: delete an existing relationship
18405 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
18414 description: Response codes found in [response codes](https://wiki.onap.org/).
18416 - name: model-invariant-id
18418 description: Unique identifier corresponding to the main definition of a model in ASDC
18421 example: __MODEL-INVARIANT-ID__
18422 - name: model-version-id
18424 description: Unique identifier corresponding to one version of a model in ASDC
18427 example: __MODEL-VERSION-ID__
18428 - name: model-element-uuid
18432 example: __MODEL-ELEMENT-UUID__
18433 - name: model-constraint-uuid
18437 example: __MODEL-CONSTRAINT-UUID__
18438 - name: constrained-element-set-uuid
18442 example: __CONSTRAINED-ELEMENT-SET-UUID__
18443 - name: element-choice-set-uuid
18447 example: __ELEMENT-CHOICE-SET-UUID__
18448 /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}:
18451 - ServiceDesignAndCreation
18452 summary: returns element-choice-set
18453 description: returns element-choice-set
18454 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18460 description: successful operation
18462 $ref: "#/getDefinitions/element-choice-set"
18464 description: Response codes found in [response codes](https://wiki.onap.org/).
18466 - name: model-invariant-id
18468 description: Unique identifier corresponding to the main definition of a model in ASDC
18471 example: __MODEL-INVARIANT-ID__
18472 - name: model-version-id
18474 description: Unique identifier corresponding to one version of a model in ASDC
18477 example: __MODEL-VERSION-ID__
18478 - name: model-element-uuid
18482 example: __MODEL-ELEMENT-UUID__
18483 - name: model-constraint-uuid
18487 example: __MODEL-CONSTRAINT-UUID__
18488 - name: constrained-element-set-uuid
18492 example: __CONSTRAINED-ELEMENT-SET-UUID__
18493 - name: element-choice-set-uuid
18497 example: __ELEMENT-CHOICE-SET-UUID__
18500 - ServiceDesignAndCreation
18501 summary: create or update an existing element-choice-set
18503 Create or update an existing element-choice-set.
18505 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18506 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18515 description: Response codes found in [response codes](https://wiki.onap.org/).
18517 - name: model-invariant-id
18519 description: Unique identifier corresponding to the main definition of a model in ASDC
18522 example: __MODEL-INVARIANT-ID__
18523 - name: model-version-id
18525 description: Unique identifier corresponding to one version of a model in ASDC
18528 example: __MODEL-VERSION-ID__
18529 - name: model-element-uuid
18533 example: __MODEL-ELEMENT-UUID__
18534 - name: model-constraint-uuid
18538 example: __MODEL-CONSTRAINT-UUID__
18539 - name: constrained-element-set-uuid
18543 example: __CONSTRAINED-ELEMENT-SET-UUID__
18544 - name: element-choice-set-uuid
18548 example: __ELEMENT-CHOICE-SET-UUID__
18551 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
18554 $ref: "#/definitions/element-choice-set"
18557 - ServiceDesignAndCreation
18558 summary: update an existing element-choice-set
18560 Update an existing element-choice-set
18562 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18563 The PUT operation will entirely replace an existing object.
18564 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18566 Other differences between PUT and PATCH are:
18568 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18569 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18570 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18571 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18580 description: Response codes found in [response codes](https://wiki.onap.org/).
18582 - name: model-invariant-id
18584 description: Unique identifier corresponding to the main definition of a model in ASDC
18587 example: __MODEL-INVARIANT-ID__
18588 - name: model-version-id
18590 description: Unique identifier corresponding to one version of a model in ASDC
18593 example: __MODEL-VERSION-ID__
18594 - name: model-element-uuid
18598 example: __MODEL-ELEMENT-UUID__
18599 - name: model-constraint-uuid
18603 example: __MODEL-CONSTRAINT-UUID__
18604 - name: constrained-element-set-uuid
18608 example: __CONSTRAINED-ELEMENT-SET-UUID__
18609 - name: element-choice-set-uuid
18613 example: __ELEMENT-CHOICE-SET-UUID__
18616 description: element-choice-set object that needs to be updated.
18619 $ref: "#/patchDefinitions/element-choice-set"
18622 - ServiceDesignAndCreation
18623 summary: delete an existing element-choice-set
18624 description: delete an existing element-choice-set
18625 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18634 description: Response codes found in [response codes](https://wiki.onap.org/).
18636 - name: model-invariant-id
18638 description: Unique identifier corresponding to the main definition of a model in ASDC
18641 example: __MODEL-INVARIANT-ID__
18642 - name: model-version-id
18644 description: Unique identifier corresponding to one version of a model in ASDC
18647 example: __MODEL-VERSION-ID__
18648 - name: model-element-uuid
18652 example: __MODEL-ELEMENT-UUID__
18653 - name: model-constraint-uuid
18657 example: __MODEL-CONSTRAINT-UUID__
18658 - name: constrained-element-set-uuid
18662 example: __CONSTRAINED-ELEMENT-SET-UUID__
18663 - name: element-choice-set-uuid
18667 example: __ELEMENT-CHOICE-SET-UUID__
18668 - name: resource-version
18670 description: resource-version for concurrency
18673 /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:
18676 - ServiceDesignAndCreation
18677 summary: returns element-choice-sets
18678 description: returns element-choice-sets
18679 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
18685 description: successful operation
18687 $ref: "#/getDefinitions/element-choice-sets"
18689 description: Response codes found in [response codes](https://wiki.onap.org/).
18691 - name: model-invariant-id
18693 description: Unique identifier corresponding to the main definition of a model in ASDC
18696 example: __MODEL-INVARIANT-ID__
18697 - name: model-version-id
18699 description: Unique identifier corresponding to one version of a model in ASDC
18702 example: __MODEL-VERSION-ID__
18703 - name: model-element-uuid
18707 example: __MODEL-ELEMENT-UUID__
18708 - name: model-constraint-uuid
18712 example: __MODEL-CONSTRAINT-UUID__
18713 - name: constrained-element-set-uuid
18717 example: __CONSTRAINED-ELEMENT-SET-UUID__
18718 - name: element-choice-set-uuid
18723 /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:
18726 - ServiceDesignAndCreation
18727 summary: see node definition for valid relationships
18728 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
18737 description: Response codes found in [response codes](https://wiki.onap.org/).
18739 - name: model-invariant-id
18741 description: Unique identifier corresponding to the main definition of a model in ASDC
18744 example: __MODEL-INVARIANT-ID__
18745 - name: model-version-id
18747 description: Unique identifier corresponding to one version of a model in ASDC
18750 example: __MODEL-VERSION-ID__
18751 - name: model-element-uuid
18755 example: __MODEL-ELEMENT-UUID__
18756 - name: model-constraint-uuid
18760 example: __MODEL-CONSTRAINT-UUID__
18761 - name: constrained-element-set-uuid
18765 example: __CONSTRAINED-ELEMENT-SET-UUID__
18768 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
18771 $ref: "#/definitions/relationship"
18774 - ServiceDesignAndCreation
18775 summary: delete an existing relationship
18776 description: delete an existing relationship
18777 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
18786 description: Response codes found in [response codes](https://wiki.onap.org/).
18788 - name: model-invariant-id
18790 description: Unique identifier corresponding to the main definition of a model in ASDC
18793 example: __MODEL-INVARIANT-ID__
18794 - name: model-version-id
18796 description: Unique identifier corresponding to one version of a model in ASDC
18799 example: __MODEL-VERSION-ID__
18800 - name: model-element-uuid
18804 example: __MODEL-ELEMENT-UUID__
18805 - name: model-constraint-uuid
18809 example: __MODEL-CONSTRAINT-UUID__
18810 - name: constrained-element-set-uuid
18814 example: __CONSTRAINED-ELEMENT-SET-UUID__
18815 /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}:
18818 - ServiceDesignAndCreation
18819 summary: returns constrained-element-set
18820 description: returns constrained-element-set
18821 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18827 description: successful operation
18829 $ref: "#/getDefinitions/constrained-element-set"
18831 description: Response codes found in [response codes](https://wiki.onap.org/).
18833 - name: model-invariant-id
18835 description: Unique identifier corresponding to the main definition of a model in ASDC
18838 example: __MODEL-INVARIANT-ID__
18839 - name: model-version-id
18841 description: Unique identifier corresponding to one version of a model in ASDC
18844 example: __MODEL-VERSION-ID__
18845 - name: model-element-uuid
18849 example: __MODEL-ELEMENT-UUID__
18850 - name: model-constraint-uuid
18854 example: __MODEL-CONSTRAINT-UUID__
18855 - name: constrained-element-set-uuid
18859 example: __CONSTRAINED-ELEMENT-SET-UUID__
18862 - ServiceDesignAndCreation
18863 summary: create or update an existing constrained-element-set
18865 Create or update an existing constrained-element-set.
18867 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18868 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18877 description: Response codes found in [response codes](https://wiki.onap.org/).
18879 - name: model-invariant-id
18881 description: Unique identifier corresponding to the main definition of a model in ASDC
18884 example: __MODEL-INVARIANT-ID__
18885 - name: model-version-id
18887 description: Unique identifier corresponding to one version of a model in ASDC
18890 example: __MODEL-VERSION-ID__
18891 - name: model-element-uuid
18895 example: __MODEL-ELEMENT-UUID__
18896 - name: model-constraint-uuid
18900 example: __MODEL-CONSTRAINT-UUID__
18901 - name: constrained-element-set-uuid
18905 example: __CONSTRAINED-ELEMENT-SET-UUID__
18908 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
18911 $ref: "#/definitions/constrained-element-set"
18914 - ServiceDesignAndCreation
18915 summary: update an existing constrained-element-set
18917 Update an existing constrained-element-set
18919 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18920 The PUT operation will entirely replace an existing object.
18921 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18923 Other differences between PUT and PATCH are:
18925 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18926 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18927 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18928 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18937 description: Response codes found in [response codes](https://wiki.onap.org/).
18939 - name: model-invariant-id
18941 description: Unique identifier corresponding to the main definition of a model in ASDC
18944 example: __MODEL-INVARIANT-ID__
18945 - name: model-version-id
18947 description: Unique identifier corresponding to one version of a model in ASDC
18950 example: __MODEL-VERSION-ID__
18951 - name: model-element-uuid
18955 example: __MODEL-ELEMENT-UUID__
18956 - name: model-constraint-uuid
18960 example: __MODEL-CONSTRAINT-UUID__
18961 - name: constrained-element-set-uuid
18965 example: __CONSTRAINED-ELEMENT-SET-UUID__
18968 description: constrained-element-set object that needs to be updated.
18971 $ref: "#/patchDefinitions/constrained-element-set"
18974 - ServiceDesignAndCreation
18975 summary: delete an existing constrained-element-set
18976 description: delete an existing constrained-element-set
18977 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18986 description: Response codes found in [response codes](https://wiki.onap.org/).
18988 - name: model-invariant-id
18990 description: Unique identifier corresponding to the main definition of a model in ASDC
18993 example: __MODEL-INVARIANT-ID__
18994 - name: model-version-id
18996 description: Unique identifier corresponding to one version of a model in ASDC
18999 example: __MODEL-VERSION-ID__
19000 - name: model-element-uuid
19004 example: __MODEL-ELEMENT-UUID__
19005 - name: model-constraint-uuid
19009 example: __MODEL-CONSTRAINT-UUID__
19010 - name: constrained-element-set-uuid
19014 example: __CONSTRAINED-ELEMENT-SET-UUID__
19015 - name: resource-version
19017 description: resource-version for concurrency
19020 /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:
19023 - ServiceDesignAndCreation
19024 summary: returns constrained-element-sets
19025 description: returns constrained-element-sets
19026 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
19032 description: successful operation
19034 $ref: "#/getDefinitions/constrained-element-sets"
19036 description: Response codes found in [response codes](https://wiki.onap.org/).
19038 - name: model-invariant-id
19040 description: Unique identifier corresponding to the main definition of a model in ASDC
19043 example: __MODEL-INVARIANT-ID__
19044 - name: model-version-id
19046 description: Unique identifier corresponding to one version of a model in ASDC
19049 example: __MODEL-VERSION-ID__
19050 - name: model-element-uuid
19054 example: __MODEL-ELEMENT-UUID__
19055 - name: model-constraint-uuid
19059 example: __MODEL-CONSTRAINT-UUID__
19060 - name: constrained-element-set-uuid
19065 /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}:
19068 - ServiceDesignAndCreation
19069 summary: returns model-constraint
19070 description: returns model-constraint
19071 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19077 description: successful operation
19079 $ref: "#/getDefinitions/model-constraint"
19081 description: Response codes found in [response codes](https://wiki.onap.org/).
19083 - name: model-invariant-id
19085 description: Unique identifier corresponding to the main definition of a model in ASDC
19088 example: __MODEL-INVARIANT-ID__
19089 - name: model-version-id
19091 description: Unique identifier corresponding to one version of a model in ASDC
19094 example: __MODEL-VERSION-ID__
19095 - name: model-element-uuid
19099 example: __MODEL-ELEMENT-UUID__
19100 - name: model-constraint-uuid
19104 example: __MODEL-CONSTRAINT-UUID__
19107 - ServiceDesignAndCreation
19108 summary: create or update an existing model-constraint
19110 Create or update an existing model-constraint.
19112 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19113 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19122 description: Response codes found in [response codes](https://wiki.onap.org/).
19124 - name: model-invariant-id
19126 description: Unique identifier corresponding to the main definition of a model in ASDC
19129 example: __MODEL-INVARIANT-ID__
19130 - name: model-version-id
19132 description: Unique identifier corresponding to one version of a model in ASDC
19135 example: __MODEL-VERSION-ID__
19136 - name: model-element-uuid
19140 example: __MODEL-ELEMENT-UUID__
19141 - name: model-constraint-uuid
19145 example: __MODEL-CONSTRAINT-UUID__
19148 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
19151 $ref: "#/definitions/model-constraint"
19154 - ServiceDesignAndCreation
19155 summary: update an existing model-constraint
19157 Update an existing model-constraint
19159 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19160 The PUT operation will entirely replace an existing object.
19161 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19163 Other differences between PUT and PATCH are:
19165 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19166 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19167 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19168 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19177 description: Response codes found in [response codes](https://wiki.onap.org/).
19179 - name: model-invariant-id
19181 description: Unique identifier corresponding to the main definition of a model in ASDC
19184 example: __MODEL-INVARIANT-ID__
19185 - name: model-version-id
19187 description: Unique identifier corresponding to one version of a model in ASDC
19190 example: __MODEL-VERSION-ID__
19191 - name: model-element-uuid
19195 example: __MODEL-ELEMENT-UUID__
19196 - name: model-constraint-uuid
19200 example: __MODEL-CONSTRAINT-UUID__
19203 description: model-constraint object that needs to be updated.
19206 $ref: "#/patchDefinitions/model-constraint"
19209 - ServiceDesignAndCreation
19210 summary: delete an existing model-constraint
19211 description: delete an existing model-constraint
19212 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19221 description: Response codes found in [response codes](https://wiki.onap.org/).
19223 - name: model-invariant-id
19225 description: Unique identifier corresponding to the main definition of a model in ASDC
19228 example: __MODEL-INVARIANT-ID__
19229 - name: model-version-id
19231 description: Unique identifier corresponding to one version of a model in ASDC
19234 example: __MODEL-VERSION-ID__
19235 - name: model-element-uuid
19239 example: __MODEL-ELEMENT-UUID__
19240 - name: model-constraint-uuid
19244 example: __MODEL-CONSTRAINT-UUID__
19245 - name: resource-version
19247 description: resource-version for concurrency
19250 /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:
19253 - ServiceDesignAndCreation
19254 summary: returns model-constraints
19255 description: returns model-constraints
19256 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
19262 description: successful operation
19264 $ref: "#/getDefinitions/model-constraints"
19266 description: Response codes found in [response codes](https://wiki.onap.org/).
19268 - name: model-invariant-id
19270 description: Unique identifier corresponding to the main definition of a model in ASDC
19273 example: __MODEL-INVARIANT-ID__
19274 - name: model-version-id
19276 description: Unique identifier corresponding to one version of a model in ASDC
19279 example: __MODEL-VERSION-ID__
19280 - name: model-element-uuid
19284 example: __MODEL-ELEMENT-UUID__
19285 - name: model-constraint-uuid
19290 /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:
19293 - ServiceDesignAndCreation
19294 summary: see node definition for valid relationships
19295 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
19304 description: Response codes found in [response codes](https://wiki.onap.org/).
19306 - name: model-invariant-id
19308 description: Unique identifier corresponding to the main definition of a model in ASDC
19311 example: __MODEL-INVARIANT-ID__
19312 - name: model-version-id
19314 description: Unique identifier corresponding to one version of a model in ASDC
19317 example: __MODEL-VERSION-ID__
19318 - name: model-element-uuid
19322 example: __MODEL-ELEMENT-UUID__
19325 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
19328 $ref: "#/definitions/relationship"
19331 - ServiceDesignAndCreation
19332 summary: delete an existing relationship
19333 description: delete an existing relationship
19334 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
19343 description: Response codes found in [response codes](https://wiki.onap.org/).
19345 - name: model-invariant-id
19347 description: Unique identifier corresponding to the main definition of a model in ASDC
19350 example: __MODEL-INVARIANT-ID__
19351 - name: model-version-id
19353 description: Unique identifier corresponding to one version of a model in ASDC
19356 example: __MODEL-VERSION-ID__
19357 - name: model-element-uuid
19361 example: __MODEL-ELEMENT-UUID__
19362 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
19365 - ServiceDesignAndCreation
19366 summary: returns model-element
19367 description: returns model-element
19368 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19374 description: successful operation
19376 $ref: "#/getDefinitions/model-element"
19378 description: Response codes found in [response codes](https://wiki.onap.org/).
19380 - name: model-invariant-id
19382 description: Unique identifier corresponding to the main definition of a model in ASDC
19385 example: __MODEL-INVARIANT-ID__
19386 - name: model-version-id
19388 description: Unique identifier corresponding to one version of a model in ASDC
19391 example: __MODEL-VERSION-ID__
19392 - name: model-element-uuid
19396 example: __MODEL-ELEMENT-UUID__
19399 - ServiceDesignAndCreation
19400 summary: create or update an existing model-element
19402 Create or update an existing model-element.
19404 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19405 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19414 description: Response codes found in [response codes](https://wiki.onap.org/).
19416 - name: model-invariant-id
19418 description: Unique identifier corresponding to the main definition of a model in ASDC
19421 example: __MODEL-INVARIANT-ID__
19422 - name: model-version-id
19424 description: Unique identifier corresponding to one version of a model in ASDC
19427 example: __MODEL-VERSION-ID__
19428 - name: model-element-uuid
19432 example: __MODEL-ELEMENT-UUID__
19435 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
19438 $ref: "#/definitions/model-element"
19441 - ServiceDesignAndCreation
19442 summary: update an existing model-element
19444 Update an existing model-element
19446 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19447 The PUT operation will entirely replace an existing object.
19448 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19450 Other differences between PUT and PATCH are:
19452 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19453 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19454 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19455 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19464 description: Response codes found in [response codes](https://wiki.onap.org/).
19466 - name: model-invariant-id
19468 description: Unique identifier corresponding to the main definition of a model in ASDC
19471 example: __MODEL-INVARIANT-ID__
19472 - name: model-version-id
19474 description: Unique identifier corresponding to one version of a model in ASDC
19477 example: __MODEL-VERSION-ID__
19478 - name: model-element-uuid
19482 example: __MODEL-ELEMENT-UUID__
19485 description: model-element object that needs to be updated.
19488 $ref: "#/patchDefinitions/model-element"
19491 - ServiceDesignAndCreation
19492 summary: delete an existing model-element
19493 description: delete an existing model-element
19494 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19503 description: Response codes found in [response codes](https://wiki.onap.org/).
19505 - name: model-invariant-id
19507 description: Unique identifier corresponding to the main definition of a model in ASDC
19510 example: __MODEL-INVARIANT-ID__
19511 - name: model-version-id
19513 description: Unique identifier corresponding to one version of a model in ASDC
19516 example: __MODEL-VERSION-ID__
19517 - name: model-element-uuid
19521 example: __MODEL-ELEMENT-UUID__
19522 - name: resource-version
19524 description: resource-version for concurrency
19527 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
19530 - ServiceDesignAndCreation
19531 summary: returns model-elements
19532 description: returns model-elements
19533 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
19539 description: successful operation
19541 $ref: "#/getDefinitions/model-elements"
19543 description: Response codes found in [response codes](https://wiki.onap.org/).
19545 - name: model-invariant-id
19547 description: Unique identifier corresponding to the main definition of a model in ASDC
19550 example: __MODEL-INVARIANT-ID__
19551 - name: model-version-id
19553 description: Unique identifier corresponding to one version of a model in ASDC
19556 example: __MODEL-VERSION-ID__
19557 - name: model-element-uuid
19562 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
19565 - ServiceDesignAndCreation
19566 summary: returns metadatum
19567 description: returns metadatum
19568 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19574 description: successful operation
19576 $ref: "#/getDefinitions/metadatum"
19578 description: Response codes found in [response codes](https://wiki.onap.org/).
19580 - name: model-invariant-id
19582 description: Unique identifier corresponding to the main definition of a model in ASDC
19585 example: __MODEL-INVARIANT-ID__
19586 - name: model-version-id
19588 description: Unique identifier corresponding to one version of a model in ASDC
19591 example: __MODEL-VERSION-ID__
19596 example: __METANAME__
19599 - ServiceDesignAndCreation
19600 summary: create or update an existing metadatum
19602 Create or update an existing metadatum.
19604 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19605 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19614 description: Response codes found in [response codes](https://wiki.onap.org/).
19616 - name: model-invariant-id
19618 description: Unique identifier corresponding to the main definition of a model in ASDC
19621 example: __MODEL-INVARIANT-ID__
19622 - name: model-version-id
19624 description: Unique identifier corresponding to one version of a model in ASDC
19627 example: __MODEL-VERSION-ID__
19632 example: __METANAME__
19635 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
19638 $ref: "#/definitions/metadatum"
19641 - ServiceDesignAndCreation
19642 summary: update an existing metadatum
19644 Update an existing metadatum
19646 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19647 The PUT operation will entirely replace an existing object.
19648 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19650 Other differences between PUT and PATCH are:
19652 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19653 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19654 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19655 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19664 description: Response codes found in [response codes](https://wiki.onap.org/).
19666 - name: model-invariant-id
19668 description: Unique identifier corresponding to the main definition of a model in ASDC
19671 example: __MODEL-INVARIANT-ID__
19672 - name: model-version-id
19674 description: Unique identifier corresponding to one version of a model in ASDC
19677 example: __MODEL-VERSION-ID__
19682 example: __METANAME__
19685 description: metadatum object that needs to be updated.
19688 $ref: "#/patchDefinitions/metadatum"
19691 - ServiceDesignAndCreation
19692 summary: delete an existing metadatum
19693 description: delete an existing metadatum
19694 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19703 description: Response codes found in [response codes](https://wiki.onap.org/).
19705 - name: model-invariant-id
19707 description: Unique identifier corresponding to the main definition of a model in ASDC
19710 example: __MODEL-INVARIANT-ID__
19711 - name: model-version-id
19713 description: Unique identifier corresponding to one version of a model in ASDC
19716 example: __MODEL-VERSION-ID__
19721 example: __METANAME__
19722 - name: resource-version
19724 description: resource-version for concurrency
19727 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
19730 - ServiceDesignAndCreation
19731 summary: returns metadata
19732 description: returns metadata
19733 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
19739 description: successful operation
19741 $ref: "#/getDefinitions/metadata"
19743 description: Response codes found in [response codes](https://wiki.onap.org/).
19745 - name: model-invariant-id
19747 description: Unique identifier corresponding to the main definition of a model in ASDC
19750 example: __MODEL-INVARIANT-ID__
19751 - name: model-version-id
19753 description: Unique identifier corresponding to one version of a model in ASDC
19756 example: __MODEL-VERSION-ID__
19762 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
19765 - ServiceDesignAndCreation
19766 summary: see node definition for valid relationships
19767 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
19776 description: Response codes found in [response codes](https://wiki.onap.org/).
19778 - name: model-invariant-id
19780 description: Unique identifier corresponding to the main definition of a model in ASDC
19783 example: __MODEL-INVARIANT-ID__
19784 - name: model-version-id
19786 description: Unique identifier corresponding to one version of a model in ASDC
19789 example: __MODEL-VERSION-ID__
19792 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
19795 $ref: "#/definitions/relationship"
19798 - ServiceDesignAndCreation
19799 summary: delete an existing relationship
19800 description: delete an existing relationship
19801 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
19810 description: Response codes found in [response codes](https://wiki.onap.org/).
19812 - name: model-invariant-id
19814 description: Unique identifier corresponding to the main definition of a model in ASDC
19817 example: __MODEL-INVARIANT-ID__
19818 - name: model-version-id
19820 description: Unique identifier corresponding to one version of a model in ASDC
19823 example: __MODEL-VERSION-ID__
19824 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
19827 - ServiceDesignAndCreation
19828 summary: returns model-ver
19829 description: returns model-ver
19830 operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
19836 description: successful operation
19838 $ref: "#/getDefinitions/model-ver"
19840 description: Response codes found in [response codes](https://wiki.onap.org/).
19842 - name: model-invariant-id
19844 description: Unique identifier corresponding to the main definition of a model in ASDC
19847 example: __MODEL-INVARIANT-ID__
19848 - name: model-version-id
19850 description: Unique identifier corresponding to one version of a model in ASDC
19853 example: __MODEL-VERSION-ID__
19856 - ServiceDesignAndCreation
19857 summary: create or update an existing model-ver
19859 Create or update an existing model-ver.
19861 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19862 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
19871 description: Response codes found in [response codes](https://wiki.onap.org/).
19873 - name: model-invariant-id
19875 description: Unique identifier corresponding to the main definition of a model in ASDC
19878 example: __MODEL-INVARIANT-ID__
19879 - name: model-version-id
19881 description: Unique identifier corresponding to one version of a model in ASDC
19884 example: __MODEL-VERSION-ID__
19887 description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
19890 $ref: "#/definitions/model-ver"
19893 - ServiceDesignAndCreation
19894 summary: update an existing model-ver
19896 Update an existing model-ver
19898 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19899 The PUT operation will entirely replace an existing object.
19900 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19902 Other differences between PUT and PATCH are:
19904 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19905 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19906 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19907 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
19916 description: Response codes found in [response codes](https://wiki.onap.org/).
19918 - name: model-invariant-id
19920 description: Unique identifier corresponding to the main definition of a model in ASDC
19923 example: __MODEL-INVARIANT-ID__
19924 - name: model-version-id
19926 description: Unique identifier corresponding to one version of a model in ASDC
19929 example: __MODEL-VERSION-ID__
19932 description: model-ver object that needs to be updated.
19935 $ref: "#/patchDefinitions/model-ver"
19938 - ServiceDesignAndCreation
19939 summary: delete an existing model-ver
19940 description: delete an existing model-ver
19941 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
19950 description: Response codes found in [response codes](https://wiki.onap.org/).
19952 - name: model-invariant-id
19954 description: Unique identifier corresponding to the main definition of a model in ASDC
19957 example: __MODEL-INVARIANT-ID__
19958 - name: model-version-id
19960 description: Unique identifier corresponding to one version of a model in ASDC
19963 example: __MODEL-VERSION-ID__
19964 - name: resource-version
19966 description: resource-version for concurrency
19969 /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
19972 - ServiceDesignAndCreation
19973 summary: returns model-vers
19974 description: returns model-vers
19975 operationId: getServiceDesignAndCreationModelsModelModelVers
19981 description: successful operation
19983 $ref: "#/getDefinitions/model-vers"
19985 description: Response codes found in [response codes](https://wiki.onap.org/).
19987 - name: model-invariant-id
19989 description: Unique identifier corresponding to the main definition of a model in ASDC
19992 example: __MODEL-INVARIANT-ID__
19993 - name: model-version-id
20003 - name: model-version
20008 - name: distribution-status
20013 /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
20016 - ServiceDesignAndCreation
20017 summary: see node definition for valid relationships
20018 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
20027 description: Response codes found in [response codes](https://wiki.onap.org/).
20029 - name: model-invariant-id
20031 description: Unique identifier corresponding to the main definition of a model in ASDC
20034 example: __MODEL-INVARIANT-ID__
20037 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModel.json)
20040 $ref: "#/definitions/relationship"
20043 - ServiceDesignAndCreation
20044 summary: delete an existing relationship
20045 description: delete an existing relationship
20046 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
20055 description: Response codes found in [response codes](https://wiki.onap.org/).
20057 - name: model-invariant-id
20059 description: Unique identifier corresponding to the main definition of a model in ASDC
20062 example: __MODEL-INVARIANT-ID__
20063 /service-design-and-creation/models/model/{model-invariant-id}:
20066 - ServiceDesignAndCreation
20067 summary: returns model
20068 description: returns model
20069 operationId: getServiceDesignAndCreationModelsModel
20075 description: successful operation
20077 $ref: "#/getDefinitions/model"
20079 description: Response codes found in [response codes](https://wiki.onap.org/).
20081 - name: model-invariant-id
20083 description: Unique identifier corresponding to the main definition of a model in ASDC
20086 example: __MODEL-INVARIANT-ID__
20089 - ServiceDesignAndCreation
20090 summary: create or update an existing model
20092 Create or update an existing model.
20094 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20095 operationId: createOrUpdateServiceDesignAndCreationModelsModel
20104 description: Response codes found in [response codes](https://wiki.onap.org/).
20106 - name: model-invariant-id
20108 description: Unique identifier corresponding to the main definition of a model in ASDC
20111 example: __MODEL-INVARIANT-ID__
20114 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModel.json)
20117 $ref: "#/definitions/model"
20120 - ServiceDesignAndCreation
20121 summary: update an existing model
20123 Update an existing model
20125 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20126 The PUT operation will entirely replace an existing object.
20127 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20129 Other differences between PUT and PATCH are:
20131 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20132 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20133 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20134 operationId: UpdateServiceDesignAndCreationModelsModel
20143 description: Response codes found in [response codes](https://wiki.onap.org/).
20145 - name: model-invariant-id
20147 description: Unique identifier corresponding to the main definition of a model in ASDC
20150 example: __MODEL-INVARIANT-ID__
20153 description: model object that needs to be updated.
20156 $ref: "#/patchDefinitions/model"
20159 - ServiceDesignAndCreation
20160 summary: delete an existing model
20161 description: delete an existing model
20162 operationId: deleteServiceDesignAndCreationModelsModel
20171 description: Response codes found in [response codes](https://wiki.onap.org/).
20173 - name: model-invariant-id
20175 description: Unique identifier corresponding to the main definition of a model in ASDC
20178 example: __MODEL-INVARIANT-ID__
20179 - name: resource-version
20181 description: resource-version for concurrency
20184 /service-design-and-creation/models:
20187 - ServiceDesignAndCreation
20188 summary: returns models
20189 description: returns models
20190 operationId: getServiceDesignAndCreationModels
20196 description: successful operation
20198 $ref: "#/getDefinitions/models"
20200 description: Response codes found in [response codes](https://wiki.onap.org/).
20202 - name: model-invariant-id
20212 /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:
20215 - ServiceDesignAndCreation
20216 summary: see node definition for valid relationships
20217 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
20226 description: Response codes found in [response codes](https://wiki.onap.org/).
20228 - name: named-query-uuid
20232 example: __NAMED-QUERY-UUID__
20233 - name: named-query-element-uuid
20237 example: __NAMED-QUERY-ELEMENT-UUID__
20238 - name: related-lookup-uuid
20242 example: __RELATED-LOOKUP-UUID__
20245 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
20248 $ref: "#/definitions/relationship"
20251 - ServiceDesignAndCreation
20252 summary: delete an existing relationship
20253 description: delete an existing relationship
20254 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
20263 description: Response codes found in [response codes](https://wiki.onap.org/).
20265 - name: named-query-uuid
20269 example: __NAMED-QUERY-UUID__
20270 - name: named-query-element-uuid
20274 example: __NAMED-QUERY-ELEMENT-UUID__
20275 - name: related-lookup-uuid
20279 example: __RELATED-LOOKUP-UUID__
20280 /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}:
20283 - ServiceDesignAndCreation
20284 summary: returns related-lookup
20285 description: returns related-lookup
20286 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20292 description: successful operation
20294 $ref: "#/getDefinitions/related-lookup"
20296 description: Response codes found in [response codes](https://wiki.onap.org/).
20298 - name: named-query-uuid
20302 example: __NAMED-QUERY-UUID__
20303 - name: named-query-element-uuid
20307 example: __NAMED-QUERY-ELEMENT-UUID__
20308 - name: related-lookup-uuid
20312 example: __RELATED-LOOKUP-UUID__
20315 - ServiceDesignAndCreation
20316 summary: create or update an existing related-lookup
20318 Create or update an existing related-lookup.
20320 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20321 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20330 description: Response codes found in [response codes](https://wiki.onap.org/).
20332 - name: named-query-uuid
20336 example: __NAMED-QUERY-UUID__
20337 - name: named-query-element-uuid
20341 example: __NAMED-QUERY-ELEMENT-UUID__
20342 - name: related-lookup-uuid
20346 example: __RELATED-LOOKUP-UUID__
20349 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
20352 $ref: "#/definitions/related-lookup"
20355 - ServiceDesignAndCreation
20356 summary: update an existing related-lookup
20358 Update an existing related-lookup
20360 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20361 The PUT operation will entirely replace an existing object.
20362 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20364 Other differences between PUT and PATCH are:
20366 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20367 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20368 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20369 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20378 description: Response codes found in [response codes](https://wiki.onap.org/).
20380 - name: named-query-uuid
20384 example: __NAMED-QUERY-UUID__
20385 - name: named-query-element-uuid
20389 example: __NAMED-QUERY-ELEMENT-UUID__
20390 - name: related-lookup-uuid
20394 example: __RELATED-LOOKUP-UUID__
20397 description: related-lookup object that needs to be updated.
20400 $ref: "#/patchDefinitions/related-lookup"
20403 - ServiceDesignAndCreation
20404 summary: delete an existing related-lookup
20405 description: delete an existing related-lookup
20406 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20415 description: Response codes found in [response codes](https://wiki.onap.org/).
20417 - name: named-query-uuid
20421 example: __NAMED-QUERY-UUID__
20422 - name: named-query-element-uuid
20426 example: __NAMED-QUERY-ELEMENT-UUID__
20427 - name: related-lookup-uuid
20431 example: __RELATED-LOOKUP-UUID__
20432 - name: resource-version
20434 description: resource-version for concurrency
20437 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
20440 - ServiceDesignAndCreation
20441 summary: returns related-lookups
20442 description: returns related-lookups
20443 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
20449 description: successful operation
20451 $ref: "#/getDefinitions/related-lookups"
20453 description: Response codes found in [response codes](https://wiki.onap.org/).
20455 - name: named-query-uuid
20459 example: __NAMED-QUERY-UUID__
20460 - name: named-query-element-uuid
20464 example: __NAMED-QUERY-ELEMENT-UUID__
20465 - name: related-lookup-uuid
20470 /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}:
20473 - ServiceDesignAndCreation
20474 summary: returns property-constraint
20475 description: returns property-constraint
20476 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20482 description: successful operation
20484 $ref: "#/getDefinitions/property-constraint"
20486 description: Response codes found in [response codes](https://wiki.onap.org/).
20488 - name: named-query-uuid
20492 example: __NAMED-QUERY-UUID__
20493 - name: named-query-element-uuid
20497 example: __NAMED-QUERY-ELEMENT-UUID__
20498 - name: property-constraint-uuid
20502 example: __PROPERTY-CONSTRAINT-UUID__
20505 - ServiceDesignAndCreation
20506 summary: create or update an existing property-constraint
20508 Create or update an existing property-constraint.
20510 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20511 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20520 description: Response codes found in [response codes](https://wiki.onap.org/).
20522 - name: named-query-uuid
20526 example: __NAMED-QUERY-UUID__
20527 - name: named-query-element-uuid
20531 example: __NAMED-QUERY-ELEMENT-UUID__
20532 - name: property-constraint-uuid
20536 example: __PROPERTY-CONSTRAINT-UUID__
20539 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
20542 $ref: "#/definitions/property-constraint"
20545 - ServiceDesignAndCreation
20546 summary: update an existing property-constraint
20548 Update an existing property-constraint
20550 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20551 The PUT operation will entirely replace an existing object.
20552 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20554 Other differences between PUT and PATCH are:
20556 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20557 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20558 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20559 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20568 description: Response codes found in [response codes](https://wiki.onap.org/).
20570 - name: named-query-uuid
20574 example: __NAMED-QUERY-UUID__
20575 - name: named-query-element-uuid
20579 example: __NAMED-QUERY-ELEMENT-UUID__
20580 - name: property-constraint-uuid
20584 example: __PROPERTY-CONSTRAINT-UUID__
20587 description: property-constraint object that needs to be updated.
20590 $ref: "#/patchDefinitions/property-constraint"
20593 - ServiceDesignAndCreation
20594 summary: delete an existing property-constraint
20595 description: delete an existing property-constraint
20596 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20605 description: Response codes found in [response codes](https://wiki.onap.org/).
20607 - name: named-query-uuid
20611 example: __NAMED-QUERY-UUID__
20612 - name: named-query-element-uuid
20616 example: __NAMED-QUERY-ELEMENT-UUID__
20617 - name: property-constraint-uuid
20621 example: __PROPERTY-CONSTRAINT-UUID__
20622 - name: resource-version
20624 description: resource-version for concurrency
20627 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
20630 - ServiceDesignAndCreation
20631 summary: returns property-constraints
20632 description: returns property-constraints
20633 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
20639 description: successful operation
20641 $ref: "#/getDefinitions/property-constraints"
20643 description: Response codes found in [response codes](https://wiki.onap.org/).
20645 - name: named-query-uuid
20649 example: __NAMED-QUERY-UUID__
20650 - name: named-query-element-uuid
20654 example: __NAMED-QUERY-ELEMENT-UUID__
20655 - name: property-constraint-uuid
20660 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
20663 - ServiceDesignAndCreation
20664 summary: see node definition for valid relationships
20665 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
20674 description: Response codes found in [response codes](https://wiki.onap.org/).
20676 - name: named-query-uuid
20680 example: __NAMED-QUERY-UUID__
20681 - name: named-query-element-uuid
20685 example: __NAMED-QUERY-ELEMENT-UUID__
20688 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
20691 $ref: "#/definitions/relationship"
20694 - ServiceDesignAndCreation
20695 summary: delete an existing relationship
20696 description: delete an existing relationship
20697 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
20706 description: Response codes found in [response codes](https://wiki.onap.org/).
20708 - name: named-query-uuid
20712 example: __NAMED-QUERY-UUID__
20713 - name: named-query-element-uuid
20717 example: __NAMED-QUERY-ELEMENT-UUID__
20718 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
20721 - ServiceDesignAndCreation
20722 summary: returns named-query-element
20723 description: returns named-query-element
20724 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20730 description: successful operation
20732 $ref: "#/getDefinitions/named-query-element"
20734 description: Response codes found in [response codes](https://wiki.onap.org/).
20736 - name: named-query-uuid
20740 example: __NAMED-QUERY-UUID__
20741 - name: named-query-element-uuid
20745 example: __NAMED-QUERY-ELEMENT-UUID__
20748 - ServiceDesignAndCreation
20749 summary: create or update an existing named-query-element
20751 Create or update an existing named-query-element.
20753 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20754 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20763 description: Response codes found in [response codes](https://wiki.onap.org/).
20765 - name: named-query-uuid
20769 example: __NAMED-QUERY-UUID__
20770 - name: named-query-element-uuid
20774 example: __NAMED-QUERY-ELEMENT-UUID__
20777 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
20780 $ref: "#/definitions/named-query-element"
20783 - ServiceDesignAndCreation
20784 summary: update an existing named-query-element
20786 Update an existing named-query-element
20788 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20789 The PUT operation will entirely replace an existing object.
20790 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20792 Other differences between PUT and PATCH are:
20794 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20795 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20796 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20797 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20806 description: Response codes found in [response codes](https://wiki.onap.org/).
20808 - name: named-query-uuid
20812 example: __NAMED-QUERY-UUID__
20813 - name: named-query-element-uuid
20817 example: __NAMED-QUERY-ELEMENT-UUID__
20820 description: named-query-element object that needs to be updated.
20823 $ref: "#/patchDefinitions/named-query-element"
20826 - ServiceDesignAndCreation
20827 summary: delete an existing named-query-element
20828 description: delete an existing named-query-element
20829 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20838 description: Response codes found in [response codes](https://wiki.onap.org/).
20840 - name: named-query-uuid
20844 example: __NAMED-QUERY-UUID__
20845 - name: named-query-element-uuid
20849 example: __NAMED-QUERY-ELEMENT-UUID__
20850 - name: resource-version
20852 description: resource-version for concurrency
20855 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
20858 - ServiceDesignAndCreation
20859 summary: returns named-query-elements
20860 description: returns named-query-elements
20861 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
20867 description: successful operation
20869 $ref: "#/getDefinitions/named-query-elements"
20871 description: Response codes found in [response codes](https://wiki.onap.org/).
20873 - name: named-query-uuid
20877 example: __NAMED-QUERY-UUID__
20878 - name: named-query-element-uuid
20883 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
20886 - ServiceDesignAndCreation
20887 summary: see node definition for valid relationships
20888 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
20897 description: Response codes found in [response codes](https://wiki.onap.org/).
20899 - name: named-query-uuid
20903 example: __NAMED-QUERY-UUID__
20906 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20909 $ref: "#/definitions/relationship"
20912 - ServiceDesignAndCreation
20913 summary: delete an existing relationship
20914 description: delete an existing relationship
20915 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
20924 description: Response codes found in [response codes](https://wiki.onap.org/).
20926 - name: named-query-uuid
20930 example: __NAMED-QUERY-UUID__
20931 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
20934 - ServiceDesignAndCreation
20935 summary: returns named-query
20936 description: returns named-query
20937 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
20943 description: successful operation
20945 $ref: "#/getDefinitions/named-query"
20947 description: Response codes found in [response codes](https://wiki.onap.org/).
20949 - name: named-query-uuid
20953 example: __NAMED-QUERY-UUID__
20956 - ServiceDesignAndCreation
20957 summary: create or update an existing named-query
20959 Create or update an existing named-query.
20961 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20962 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
20971 description: Response codes found in [response codes](https://wiki.onap.org/).
20973 - name: named-query-uuid
20977 example: __NAMED-QUERY-UUID__
20980 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20983 $ref: "#/definitions/named-query"
20986 - ServiceDesignAndCreation
20987 summary: update an existing named-query
20989 Update an existing named-query
20991 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20992 The PUT operation will entirely replace an existing object.
20993 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20995 Other differences between PUT and PATCH are:
20997 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20998 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20999 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21000 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
21009 description: Response codes found in [response codes](https://wiki.onap.org/).
21011 - name: named-query-uuid
21015 example: __NAMED-QUERY-UUID__
21018 description: named-query object that needs to be updated.
21021 $ref: "#/patchDefinitions/named-query"
21024 - ServiceDesignAndCreation
21025 summary: delete an existing named-query
21026 description: delete an existing named-query
21027 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
21036 description: Response codes found in [response codes](https://wiki.onap.org/).
21038 - name: named-query-uuid
21042 example: __NAMED-QUERY-UUID__
21043 - name: resource-version
21045 description: resource-version for concurrency
21048 /service-design-and-creation/named-queries:
21051 - ServiceDesignAndCreation
21052 summary: returns named-queries
21053 description: returns named-queries
21054 operationId: getServiceDesignAndCreationNamedQueries
21060 description: successful operation
21062 $ref: "#/getDefinitions/named-queries"
21064 description: Response codes found in [response codes](https://wiki.onap.org/).
21066 - name: named-query-uuid
21071 - name: named-query-name
21076 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
21080 summary: see node definition for valid relationships
21081 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
21090 description: Response codes found in [response codes](https://wiki.onap.org/).
21094 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21097 example: __LINK-NAME__
21100 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json)
21103 $ref: "#/definitions/relationship"
21107 summary: delete an existing relationship
21108 description: delete an existing relationship
21109 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
21118 description: Response codes found in [response codes](https://wiki.onap.org/).
21122 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21125 example: __LINK-NAME__
21126 /network/logical-links/logical-link/{link-name}:
21130 summary: returns logical-link
21131 description: returns logical-link
21132 operationId: getNetworkLogicalLinksLogicalLink
21138 description: successful operation
21140 $ref: "#/getDefinitions/logical-link"
21142 description: Response codes found in [response codes](https://wiki.onap.org/).
21146 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21149 example: __LINK-NAME__
21153 summary: create or update an existing logical-link
21155 Create or update an existing logical-link.
21157 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21158 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
21167 description: Response codes found in [response codes](https://wiki.onap.org/).
21171 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21174 example: __LINK-NAME__
21177 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json)
21180 $ref: "#/definitions/logical-link"
21184 summary: update an existing logical-link
21186 Update an existing logical-link
21188 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21189 The PUT operation will entirely replace an existing object.
21190 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21192 Other differences between PUT and PATCH are:
21194 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21195 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21196 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21197 operationId: UpdateNetworkLogicalLinksLogicalLink
21206 description: Response codes found in [response codes](https://wiki.onap.org/).
21210 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21213 example: __LINK-NAME__
21216 description: logical-link object that needs to be updated.
21219 $ref: "#/patchDefinitions/logical-link"
21223 summary: delete an existing logical-link
21224 description: delete an existing logical-link
21225 operationId: deleteNetworkLogicalLinksLogicalLink
21234 description: Response codes found in [response codes](https://wiki.onap.org/).
21238 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21241 example: __LINK-NAME__
21242 - name: resource-version
21244 description: resource-version for concurrency
21247 /network/logical-links:
21251 summary: returns logical-links
21252 description: returns logical-links
21253 operationId: getNetworkLogicalLinks
21259 description: successful operation
21261 $ref: "#/getDefinitions/logical-links"
21263 description: Response codes found in [response codes](https://wiki.onap.org/).
21270 - name: model-invariant-id
21275 - name: model-version-id
21280 - name: widget-model-id
21285 - name: widget-model-version
21290 - name: prov-status
21310 /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:
21314 summary: see node definition for valid relationships
21315 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
21324 description: Response codes found in [response codes](https://wiki.onap.org/).
21326 - name: site-pair-set-id
21328 description: Unique id of site pair set.
21331 example: __SITE-PAIR-SET-ID__
21332 - name: routing-instance-id
21334 description: Unique id of routing instance
21337 example: __ROUTING-INSTANCE-ID__
21338 - name: site-pair-id
21340 description: unique identifier of probe
21343 example: __SITE-PAIR-ID__
21346 description: unique identifier of probe
21352 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
21355 $ref: "#/definitions/relationship"
21359 summary: delete an existing relationship
21360 description: delete an existing relationship
21361 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
21370 description: Response codes found in [response codes](https://wiki.onap.org/).
21372 - name: site-pair-set-id
21374 description: Unique id of site pair set.
21377 example: __SITE-PAIR-SET-ID__
21378 - name: routing-instance-id
21380 description: Unique id of routing instance
21383 example: __ROUTING-INSTANCE-ID__
21384 - name: site-pair-id
21386 description: unique identifier of probe
21389 example: __SITE-PAIR-ID__
21392 description: unique identifier of probe
21396 /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}:
21400 summary: returns class-of-service
21401 description: returns class-of-service
21402 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21408 description: successful operation
21410 $ref: "#/getDefinitions/class-of-service"
21412 description: Response codes found in [response codes](https://wiki.onap.org/).
21414 - name: site-pair-set-id
21416 description: Unique id of site pair set.
21419 example: __SITE-PAIR-SET-ID__
21420 - name: routing-instance-id
21422 description: Unique id of routing instance
21425 example: __ROUTING-INSTANCE-ID__
21426 - name: site-pair-id
21428 description: unique identifier of probe
21431 example: __SITE-PAIR-ID__
21434 description: unique identifier of probe
21441 summary: create or update an existing class-of-service
21443 Create or update an existing class-of-service.
21445 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21446 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21455 description: Response codes found in [response codes](https://wiki.onap.org/).
21457 - name: site-pair-set-id
21459 description: Unique id of site pair set.
21462 example: __SITE-PAIR-SET-ID__
21463 - name: routing-instance-id
21465 description: Unique id of routing instance
21468 example: __ROUTING-INSTANCE-ID__
21469 - name: site-pair-id
21471 description: unique identifier of probe
21474 example: __SITE-PAIR-ID__
21477 description: unique identifier of probe
21483 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
21486 $ref: "#/definitions/class-of-service"
21490 summary: update an existing class-of-service
21492 Update an existing class-of-service
21494 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21495 The PUT operation will entirely replace an existing object.
21496 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21498 Other differences between PUT and PATCH are:
21500 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21501 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21502 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21503 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21512 description: Response codes found in [response codes](https://wiki.onap.org/).
21514 - name: site-pair-set-id
21516 description: Unique id of site pair set.
21519 example: __SITE-PAIR-SET-ID__
21520 - name: routing-instance-id
21522 description: Unique id of routing instance
21525 example: __ROUTING-INSTANCE-ID__
21526 - name: site-pair-id
21528 description: unique identifier of probe
21531 example: __SITE-PAIR-ID__
21534 description: unique identifier of probe
21540 description: class-of-service object that needs to be updated.
21543 $ref: "#/patchDefinitions/class-of-service"
21547 summary: delete an existing class-of-service
21548 description: delete an existing class-of-service
21549 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21558 description: Response codes found in [response codes](https://wiki.onap.org/).
21560 - name: site-pair-set-id
21562 description: Unique id of site pair set.
21565 example: __SITE-PAIR-SET-ID__
21566 - name: routing-instance-id
21568 description: Unique id of routing instance
21571 example: __ROUTING-INSTANCE-ID__
21572 - name: site-pair-id
21574 description: unique identifier of probe
21577 example: __SITE-PAIR-ID__
21580 description: unique identifier of probe
21584 - name: resource-version
21586 description: resource-version for concurrency
21589 /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:
21593 summary: returns classes-of-service
21594 description: returns classes-of-service
21595 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
21601 description: successful operation
21603 $ref: "#/getDefinitions/classes-of-service"
21605 description: Response codes found in [response codes](https://wiki.onap.org/).
21607 - name: site-pair-set-id
21609 description: Unique id of site pair set.
21612 example: __SITE-PAIR-SET-ID__
21613 - name: routing-instance-id
21615 description: Unique id of routing instance
21618 example: __ROUTING-INSTANCE-ID__
21619 - name: site-pair-id
21621 description: unique identifier of probe
21624 example: __SITE-PAIR-ID__
21630 /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:
21634 summary: see node definition for valid relationships
21635 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
21644 description: Response codes found in [response codes](https://wiki.onap.org/).
21646 - name: site-pair-set-id
21648 description: Unique id of site pair set.
21651 example: __SITE-PAIR-SET-ID__
21652 - name: routing-instance-id
21654 description: Unique id of routing instance
21657 example: __ROUTING-INSTANCE-ID__
21658 - name: site-pair-id
21660 description: unique identifier of probe
21663 example: __SITE-PAIR-ID__
21666 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
21669 $ref: "#/definitions/relationship"
21673 summary: delete an existing relationship
21674 description: delete an existing relationship
21675 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
21684 description: Response codes found in [response codes](https://wiki.onap.org/).
21686 - name: site-pair-set-id
21688 description: Unique id of site pair set.
21691 example: __SITE-PAIR-SET-ID__
21692 - name: routing-instance-id
21694 description: Unique id of routing instance
21697 example: __ROUTING-INSTANCE-ID__
21698 - name: site-pair-id
21700 description: unique identifier of probe
21703 example: __SITE-PAIR-ID__
21704 /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}:
21708 summary: returns site-pair
21709 description: returns site-pair
21710 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21716 description: successful operation
21718 $ref: "#/getDefinitions/site-pair"
21720 description: Response codes found in [response codes](https://wiki.onap.org/).
21722 - name: site-pair-set-id
21724 description: Unique id of site pair set.
21727 example: __SITE-PAIR-SET-ID__
21728 - name: routing-instance-id
21730 description: Unique id of routing instance
21733 example: __ROUTING-INSTANCE-ID__
21734 - name: site-pair-id
21736 description: unique identifier of probe
21739 example: __SITE-PAIR-ID__
21743 summary: create or update an existing site-pair
21745 Create or update an existing site-pair.
21747 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21748 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21757 description: Response codes found in [response codes](https://wiki.onap.org/).
21759 - name: site-pair-set-id
21761 description: Unique id of site pair set.
21764 example: __SITE-PAIR-SET-ID__
21765 - name: routing-instance-id
21767 description: Unique id of routing instance
21770 example: __ROUTING-INSTANCE-ID__
21771 - name: site-pair-id
21773 description: unique identifier of probe
21776 example: __SITE-PAIR-ID__
21779 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
21782 $ref: "#/definitions/site-pair"
21786 summary: update an existing site-pair
21788 Update an existing site-pair
21790 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21791 The PUT operation will entirely replace an existing object.
21792 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21794 Other differences between PUT and PATCH are:
21796 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21797 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21798 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21799 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21808 description: Response codes found in [response codes](https://wiki.onap.org/).
21810 - name: site-pair-set-id
21812 description: Unique id of site pair set.
21815 example: __SITE-PAIR-SET-ID__
21816 - name: routing-instance-id
21818 description: Unique id of routing instance
21821 example: __ROUTING-INSTANCE-ID__
21822 - name: site-pair-id
21824 description: unique identifier of probe
21827 example: __SITE-PAIR-ID__
21830 description: site-pair object that needs to be updated.
21833 $ref: "#/patchDefinitions/site-pair"
21837 summary: delete an existing site-pair
21838 description: delete an existing site-pair
21839 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21848 description: Response codes found in [response codes](https://wiki.onap.org/).
21850 - name: site-pair-set-id
21852 description: Unique id of site pair set.
21855 example: __SITE-PAIR-SET-ID__
21856 - name: routing-instance-id
21858 description: Unique id of routing instance
21861 example: __ROUTING-INSTANCE-ID__
21862 - name: site-pair-id
21864 description: unique identifier of probe
21867 example: __SITE-PAIR-ID__
21868 - name: resource-version
21870 description: resource-version for concurrency
21873 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
21877 summary: returns site-pairs
21878 description: returns site-pairs
21879 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
21885 description: successful operation
21887 $ref: "#/getDefinitions/site-pairs"
21889 description: Response codes found in [response codes](https://wiki.onap.org/).
21891 - name: site-pair-set-id
21893 description: Unique id of site pair set.
21896 example: __SITE-PAIR-SET-ID__
21897 - name: routing-instance-id
21899 description: Unique id of routing instance
21902 example: __ROUTING-INSTANCE-ID__
21903 - name: site-pair-id
21908 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
21912 summary: see node definition for valid relationships
21913 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
21922 description: Response codes found in [response codes](https://wiki.onap.org/).
21924 - name: site-pair-set-id
21926 description: Unique id of site pair set.
21929 example: __SITE-PAIR-SET-ID__
21930 - name: routing-instance-id
21932 description: Unique id of routing instance
21935 example: __ROUTING-INSTANCE-ID__
21938 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21941 $ref: "#/definitions/relationship"
21945 summary: delete an existing relationship
21946 description: delete an existing relationship
21947 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
21956 description: Response codes found in [response codes](https://wiki.onap.org/).
21958 - name: site-pair-set-id
21960 description: Unique id of site pair set.
21963 example: __SITE-PAIR-SET-ID__
21964 - name: routing-instance-id
21966 description: Unique id of routing instance
21969 example: __ROUTING-INSTANCE-ID__
21970 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
21974 summary: returns routing-instance
21975 description: returns routing-instance
21976 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21982 description: successful operation
21984 $ref: "#/getDefinitions/routing-instance"
21986 description: Response codes found in [response codes](https://wiki.onap.org/).
21988 - name: site-pair-set-id
21990 description: Unique id of site pair set.
21993 example: __SITE-PAIR-SET-ID__
21994 - name: routing-instance-id
21996 description: Unique id of routing instance
21999 example: __ROUTING-INSTANCE-ID__
22003 summary: create or update an existing routing-instance
22005 Create or update an existing routing-instance.
22007 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22008 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
22017 description: Response codes found in [response codes](https://wiki.onap.org/).
22019 - name: site-pair-set-id
22021 description: Unique id of site pair set.
22024 example: __SITE-PAIR-SET-ID__
22025 - name: routing-instance-id
22027 description: Unique id of routing instance
22030 example: __ROUTING-INSTANCE-ID__
22033 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
22036 $ref: "#/definitions/routing-instance"
22040 summary: update an existing routing-instance
22042 Update an existing routing-instance
22044 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22045 The PUT operation will entirely replace an existing object.
22046 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22048 Other differences between PUT and PATCH are:
22050 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22051 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22052 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22053 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
22062 description: Response codes found in [response codes](https://wiki.onap.org/).
22064 - name: site-pair-set-id
22066 description: Unique id of site pair set.
22069 example: __SITE-PAIR-SET-ID__
22070 - name: routing-instance-id
22072 description: Unique id of routing instance
22075 example: __ROUTING-INSTANCE-ID__
22078 description: routing-instance object that needs to be updated.
22081 $ref: "#/patchDefinitions/routing-instance"
22085 summary: delete an existing routing-instance
22086 description: delete an existing routing-instance
22087 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
22096 description: Response codes found in [response codes](https://wiki.onap.org/).
22098 - name: site-pair-set-id
22100 description: Unique id of site pair set.
22103 example: __SITE-PAIR-SET-ID__
22104 - name: routing-instance-id
22106 description: Unique id of routing instance
22109 example: __ROUTING-INSTANCE-ID__
22110 - name: resource-version
22112 description: resource-version for concurrency
22115 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
22119 summary: returns routing-instances
22120 description: returns routing-instances
22121 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
22127 description: successful operation
22129 $ref: "#/getDefinitions/routing-instances"
22131 description: Response codes found in [response codes](https://wiki.onap.org/).
22133 - name: site-pair-set-id
22135 description: Unique id of site pair set.
22138 example: __SITE-PAIR-SET-ID__
22139 - name: routing-instance-id
22144 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
22148 summary: see node definition for valid relationships
22149 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
22158 description: Response codes found in [response codes](https://wiki.onap.org/).
22160 - name: site-pair-set-id
22162 description: Unique id of site pair set.
22165 example: __SITE-PAIR-SET-ID__
22168 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json)
22171 $ref: "#/definitions/relationship"
22175 summary: delete an existing relationship
22176 description: delete an existing relationship
22177 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
22186 description: Response codes found in [response codes](https://wiki.onap.org/).
22188 - name: site-pair-set-id
22190 description: Unique id of site pair set.
22193 example: __SITE-PAIR-SET-ID__
22194 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
22198 summary: returns site-pair-set
22199 description: returns site-pair-set
22200 operationId: getNetworkSitePairSetsSitePairSet
22206 description: successful operation
22208 $ref: "#/getDefinitions/site-pair-set"
22210 description: Response codes found in [response codes](https://wiki.onap.org/).
22212 - name: site-pair-set-id
22214 description: Unique id of site pair set.
22217 example: __SITE-PAIR-SET-ID__
22221 summary: create or update an existing site-pair-set
22223 Create or update an existing site-pair-set.
22225 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22226 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
22235 description: Response codes found in [response codes](https://wiki.onap.org/).
22237 - name: site-pair-set-id
22239 description: Unique id of site pair set.
22242 example: __SITE-PAIR-SET-ID__
22245 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json)
22248 $ref: "#/definitions/site-pair-set"
22252 summary: update an existing site-pair-set
22254 Update an existing site-pair-set
22256 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22257 The PUT operation will entirely replace an existing object.
22258 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22260 Other differences between PUT and PATCH are:
22262 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22263 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22264 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22265 operationId: UpdateNetworkSitePairSetsSitePairSet
22274 description: Response codes found in [response codes](https://wiki.onap.org/).
22276 - name: site-pair-set-id
22278 description: Unique id of site pair set.
22281 example: __SITE-PAIR-SET-ID__
22284 description: site-pair-set object that needs to be updated.
22287 $ref: "#/patchDefinitions/site-pair-set"
22291 summary: delete an existing site-pair-set
22292 description: delete an existing site-pair-set
22293 operationId: deleteNetworkSitePairSetsSitePairSet
22302 description: Response codes found in [response codes](https://wiki.onap.org/).
22304 - name: site-pair-set-id
22306 description: Unique id of site pair set.
22309 example: __SITE-PAIR-SET-ID__
22310 - name: resource-version
22312 description: resource-version for concurrency
22315 /network/site-pair-sets:
22319 summary: returns site-pair-sets
22320 description: returns site-pair-sets
22321 operationId: getNetworkSitePairSets
22327 description: successful operation
22329 $ref: "#/getDefinitions/site-pair-sets"
22331 description: Response codes found in [response codes](https://wiki.onap.org/).
22333 - name: site-pair-set-id
22338 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
22342 summary: see node definition for valid relationships
22343 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
22352 description: Response codes found in [response codes](https://wiki.onap.org/).
22356 description: VPN ID, globally unique within A&AI
22359 example: __VPN-ID__
22360 - name: global-route-target
22362 description: Number used to identify an RT, globally unique in the network
22365 example: __GLOBAL-ROUTE-TARGET__
22366 - name: route-target-role
22368 description: Role assigned to this route target
22371 example: __ROUTE-TARGET-ROLE__
22374 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
22377 $ref: "#/definitions/relationship"
22381 summary: delete an existing relationship
22382 description: delete an existing relationship
22383 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
22392 description: Response codes found in [response codes](https://wiki.onap.org/).
22396 description: VPN ID, globally unique within A&AI
22399 example: __VPN-ID__
22400 - name: global-route-target
22402 description: Number used to identify an RT, globally unique in the network
22405 example: __GLOBAL-ROUTE-TARGET__
22406 - name: route-target-role
22408 description: Role assigned to this route target
22411 example: __ROUTE-TARGET-ROLE__
22412 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
22416 summary: returns route-target
22417 description: returns route-target
22418 operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22424 description: successful operation
22426 $ref: "#/getDefinitions/route-target"
22428 description: Response codes found in [response codes](https://wiki.onap.org/).
22432 description: VPN ID, globally unique within A&AI
22435 example: __VPN-ID__
22436 - name: global-route-target
22438 description: Number used to identify an RT, globally unique in the network
22441 example: __GLOBAL-ROUTE-TARGET__
22442 - name: route-target-role
22444 description: Role assigned to this route target
22447 example: __ROUTE-TARGET-ROLE__
22451 summary: create or update an existing route-target
22453 Create or update an existing route-target.
22455 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22456 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22465 description: Response codes found in [response codes](https://wiki.onap.org/).
22469 description: VPN ID, globally unique within A&AI
22472 example: __VPN-ID__
22473 - name: global-route-target
22475 description: Number used to identify an RT, globally unique in the network
22478 example: __GLOBAL-ROUTE-TARGET__
22479 - name: route-target-role
22481 description: Role assigned to this route target
22484 example: __ROUTE-TARGET-ROLE__
22487 description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
22490 $ref: "#/definitions/route-target"
22494 summary: update an existing route-target
22496 Update an existing route-target
22498 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22499 The PUT operation will entirely replace an existing object.
22500 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22502 Other differences between PUT and PATCH are:
22504 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22505 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22506 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22507 operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22516 description: Response codes found in [response codes](https://wiki.onap.org/).
22520 description: VPN ID, globally unique within A&AI
22523 example: __VPN-ID__
22524 - name: global-route-target
22526 description: Number used to identify an RT, globally unique in the network
22529 example: __GLOBAL-ROUTE-TARGET__
22530 - name: route-target-role
22532 description: Role assigned to this route target
22535 example: __ROUTE-TARGET-ROLE__
22538 description: route-target object that needs to be updated.
22541 $ref: "#/patchDefinitions/route-target"
22545 summary: delete an existing route-target
22546 description: delete an existing route-target
22547 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22556 description: Response codes found in [response codes](https://wiki.onap.org/).
22560 description: VPN ID, globally unique within A&AI
22563 example: __VPN-ID__
22564 - name: global-route-target
22566 description: Number used to identify an RT, globally unique in the network
22569 example: __GLOBAL-ROUTE-TARGET__
22570 - name: route-target-role
22572 description: Role assigned to this route target
22575 example: __ROUTE-TARGET-ROLE__
22576 - name: resource-version
22578 description: resource-version for concurrency
22581 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
22585 summary: returns route-targets
22586 description: returns route-targets
22587 operationId: getNetworkVpnBindingsVpnBindingRouteTargets
22593 description: successful operation
22595 $ref: "#/getDefinitions/route-targets"
22597 description: Response codes found in [response codes](https://wiki.onap.org/).
22601 description: VPN ID, globally unique within A&AI
22604 example: __VPN-ID__
22605 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
22609 summary: see node definition for valid relationships
22610 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
22619 description: Response codes found in [response codes](https://wiki.onap.org/).
22623 description: VPN ID, globally unique within A&AI
22626 example: __VPN-ID__
22629 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json)
22632 $ref: "#/definitions/relationship"
22636 summary: delete an existing relationship
22637 description: delete an existing relationship
22638 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
22647 description: Response codes found in [response codes](https://wiki.onap.org/).
22651 description: VPN ID, globally unique within A&AI
22654 example: __VPN-ID__
22655 /network/vpn-bindings/vpn-binding/{vpn-id}:
22659 summary: returns vpn-binding
22660 description: returns vpn-binding
22661 operationId: getNetworkVpnBindingsVpnBinding
22667 description: successful operation
22669 $ref: "#/getDefinitions/vpn-binding"
22671 description: Response codes found in [response codes](https://wiki.onap.org/).
22675 description: VPN ID, globally unique within A&AI
22678 example: __VPN-ID__
22682 summary: create or update an existing vpn-binding
22684 Create or update an existing vpn-binding.
22686 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22687 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
22696 description: Response codes found in [response codes](https://wiki.onap.org/).
22700 description: VPN ID, globally unique within A&AI
22703 example: __VPN-ID__
22706 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json)
22709 $ref: "#/definitions/vpn-binding"
22713 summary: update an existing vpn-binding
22715 Update an existing vpn-binding
22717 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22718 The PUT operation will entirely replace an existing object.
22719 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22721 Other differences between PUT and PATCH are:
22723 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22724 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22725 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22726 operationId: UpdateNetworkVpnBindingsVpnBinding
22735 description: Response codes found in [response codes](https://wiki.onap.org/).
22739 description: VPN ID, globally unique within A&AI
22742 example: __VPN-ID__
22745 description: vpn-binding object that needs to be updated.
22748 $ref: "#/patchDefinitions/vpn-binding"
22752 summary: delete an existing vpn-binding
22753 description: delete an existing vpn-binding
22754 operationId: deleteNetworkVpnBindingsVpnBinding
22763 description: Response codes found in [response codes](https://wiki.onap.org/).
22767 description: VPN ID, globally unique within A&AI
22770 example: __VPN-ID__
22771 - name: resource-version
22773 description: resource-version for concurrency
22776 /network/vpn-bindings:
22780 summary: returns vpn-bindings
22781 description: returns vpn-bindings
22782 operationId: getNetworkVpnBindings
22788 description: successful operation
22790 $ref: "#/getDefinitions/vpn-bindings"
22792 description: Response codes found in [response codes](https://wiki.onap.org/).
22809 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
22813 summary: see node definition for valid relationships
22814 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
22823 description: Response codes found in [response codes](https://wiki.onap.org/).
22825 - name: equipment-name
22829 example: __EQUIPMENT-NAME__
22832 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json)
22835 $ref: "#/definitions/relationship"
22839 summary: delete an existing relationship
22840 description: delete an existing relationship
22841 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
22850 description: Response codes found in [response codes](https://wiki.onap.org/).
22852 - name: equipment-name
22856 example: __EQUIPMENT-NAME__
22857 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
22861 summary: see node definition for valid relationships
22862 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
22871 description: Response codes found in [response codes](https://wiki.onap.org/).
22873 - name: equipment-name
22877 example: __EQUIPMENT-NAME__
22878 - name: interface-name
22880 description: Name that identifies the physical interface
22883 example: __INTERFACE-NAME__
22886 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)
22889 $ref: "#/definitions/relationship"
22893 summary: delete an existing relationship
22894 description: delete an existing relationship
22895 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
22904 description: Response codes found in [response codes](https://wiki.onap.org/).
22906 - name: equipment-name
22910 example: __EQUIPMENT-NAME__
22911 - name: interface-name
22913 description: Name that identifies the physical interface
22916 example: __INTERFACE-NAME__
22917 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
22921 summary: see node definition for valid relationships
22922 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
22931 description: Response codes found in [response codes](https://wiki.onap.org/).
22933 - name: equipment-name
22937 example: __EQUIPMENT-NAME__
22938 - name: interface-name
22940 description: Name that identifies the physical interface
22943 example: __INTERFACE-NAME__
22946 description: Identifier for the sriov-pf
22949 example: __PF-PCI-ID__
22952 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
22955 $ref: "#/definitions/relationship"
22959 summary: delete an existing relationship
22960 description: delete an existing relationship
22961 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
22970 description: Response codes found in [response codes](https://wiki.onap.org/).
22972 - name: equipment-name
22976 example: __EQUIPMENT-NAME__
22977 - name: interface-name
22979 description: Name that identifies the physical interface
22982 example: __INTERFACE-NAME__
22985 description: Identifier for the sriov-pf
22988 example: __PF-PCI-ID__
22989 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
22993 summary: returns sriov-pf
22994 description: returns sriov-pf
22995 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
23001 description: successful operation
23003 $ref: "#/getDefinitions/sriov-pf"
23005 description: Response codes found in [response codes](https://wiki.onap.org/).
23007 - name: equipment-name
23011 example: __EQUIPMENT-NAME__
23012 - name: interface-name
23014 description: Name that identifies the physical interface
23017 example: __INTERFACE-NAME__
23020 description: Identifier for the sriov-pf
23023 example: __PF-PCI-ID__
23027 summary: create or update an existing sriov-pf
23029 Create or update an existing sriov-pf.
23031 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23032 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
23041 description: Response codes found in [response codes](https://wiki.onap.org/).
23043 - name: equipment-name
23047 example: __EQUIPMENT-NAME__
23048 - name: interface-name
23050 description: Name that identifies the physical interface
23053 example: __INTERFACE-NAME__
23056 description: Identifier for the sriov-pf
23059 example: __PF-PCI-ID__
23062 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
23065 $ref: "#/definitions/sriov-pf"
23069 summary: update an existing sriov-pf
23071 Update an existing sriov-pf
23073 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23074 The PUT operation will entirely replace an existing object.
23075 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23077 Other differences between PUT and PATCH are:
23079 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23080 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23081 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23082 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
23091 description: Response codes found in [response codes](https://wiki.onap.org/).
23093 - name: equipment-name
23097 example: __EQUIPMENT-NAME__
23098 - name: interface-name
23100 description: Name that identifies the physical interface
23103 example: __INTERFACE-NAME__
23106 description: Identifier for the sriov-pf
23109 example: __PF-PCI-ID__
23112 description: sriov-pf object that needs to be updated.
23115 $ref: "#/patchDefinitions/sriov-pf"
23119 summary: delete an existing sriov-pf
23120 description: delete an existing sriov-pf
23121 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
23130 description: Response codes found in [response codes](https://wiki.onap.org/).
23132 - name: equipment-name
23136 example: __EQUIPMENT-NAME__
23137 - name: interface-name
23139 description: Name that identifies the physical interface
23142 example: __INTERFACE-NAME__
23145 description: Identifier for the sriov-pf
23148 example: __PF-PCI-ID__
23149 - name: resource-version
23151 description: resource-version for concurrency
23154 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
23158 summary: returns sriov-pfs
23159 description: returns sriov-pfs
23160 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
23166 description: successful operation
23168 $ref: "#/getDefinitions/sriov-pfs"
23170 description: Response codes found in [response codes](https://wiki.onap.org/).
23172 - name: equipment-name
23176 example: __EQUIPMENT-NAME__
23177 - name: interface-name
23179 description: Name that identifies the physical interface
23182 example: __INTERFACE-NAME__
23188 /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:
23192 summary: see node definition for valid relationships
23193 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
23202 description: Response codes found in [response codes](https://wiki.onap.org/).
23204 - name: equipment-name
23208 example: __EQUIPMENT-NAME__
23209 - name: interface-name
23211 description: Name that identifies the physical interface
23214 example: __INTERFACE-NAME__
23215 - name: interface-name
23217 description: Name given to the interface
23220 example: __INTERFACE-NAME__
23221 - name: vlan-interface
23223 description: String that identifies the interface
23226 example: __VLAN-INTERFACE__
23229 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
23232 $ref: "#/definitions/relationship"
23236 summary: delete an existing relationship
23237 description: delete an existing relationship
23238 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
23247 description: Response codes found in [response codes](https://wiki.onap.org/).
23249 - name: equipment-name
23253 example: __EQUIPMENT-NAME__
23254 - name: interface-name
23256 description: Name that identifies the physical interface
23259 example: __INTERFACE-NAME__
23260 - name: interface-name
23262 description: Name given to the interface
23265 example: __INTERFACE-NAME__
23266 - name: vlan-interface
23268 description: String that identifies the interface
23271 example: __VLAN-INTERFACE__
23272 /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:
23276 summary: see node definition for valid relationships
23277 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
23286 description: Response codes found in [response codes](https://wiki.onap.org/).
23288 - name: equipment-name
23292 example: __EQUIPMENT-NAME__
23293 - name: interface-name
23295 description: Name that identifies the physical interface
23298 example: __INTERFACE-NAME__
23299 - name: interface-name
23301 description: Name given to the interface
23304 example: __INTERFACE-NAME__
23305 - name: vlan-interface
23307 description: String that identifies the interface
23310 example: __VLAN-INTERFACE__
23311 - name: l3-interface-ipv4-address
23313 description: IP address
23316 example: __L3-INTERFACE-IPV4-ADDRESS__
23319 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
23322 $ref: "#/definitions/relationship"
23326 summary: delete an existing relationship
23327 description: delete an existing relationship
23328 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
23337 description: Response codes found in [response codes](https://wiki.onap.org/).
23339 - name: equipment-name
23343 example: __EQUIPMENT-NAME__
23344 - name: interface-name
23346 description: Name that identifies the physical interface
23349 example: __INTERFACE-NAME__
23350 - name: interface-name
23352 description: Name given to the interface
23355 example: __INTERFACE-NAME__
23356 - name: vlan-interface
23358 description: String that identifies the interface
23361 example: __VLAN-INTERFACE__
23362 - name: l3-interface-ipv4-address
23364 description: IP address
23367 example: __L3-INTERFACE-IPV4-ADDRESS__
23368 /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}:
23372 summary: returns l3-interface-ipv4-address-list
23373 description: returns l3-interface-ipv4-address-list
23374 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23380 description: successful operation
23382 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23384 description: Response codes found in [response codes](https://wiki.onap.org/).
23386 - name: equipment-name
23390 example: __EQUIPMENT-NAME__
23391 - name: interface-name
23393 description: Name that identifies the physical interface
23396 example: __INTERFACE-NAME__
23397 - name: interface-name
23399 description: Name given to the interface
23402 example: __INTERFACE-NAME__
23403 - name: vlan-interface
23405 description: String that identifies the interface
23408 example: __VLAN-INTERFACE__
23409 - name: l3-interface-ipv4-address
23411 description: IP address
23414 example: __L3-INTERFACE-IPV4-ADDRESS__
23418 summary: create or update an existing l3-interface-ipv4-address-list
23420 Create or update an existing l3-interface-ipv4-address-list.
23422 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23423 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23432 description: Response codes found in [response codes](https://wiki.onap.org/).
23434 - name: equipment-name
23438 example: __EQUIPMENT-NAME__
23439 - name: interface-name
23441 description: Name that identifies the physical interface
23444 example: __INTERFACE-NAME__
23445 - name: interface-name
23447 description: Name given to the interface
23450 example: __INTERFACE-NAME__
23451 - name: vlan-interface
23453 description: String that identifies the interface
23456 example: __VLAN-INTERFACE__
23457 - name: l3-interface-ipv4-address
23459 description: IP address
23462 example: __L3-INTERFACE-IPV4-ADDRESS__
23465 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
23468 $ref: "#/definitions/l3-interface-ipv4-address-list"
23472 summary: update an existing l3-interface-ipv4-address-list
23474 Update an existing l3-interface-ipv4-address-list
23476 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23477 The PUT operation will entirely replace an existing object.
23478 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23480 Other differences between PUT and PATCH are:
23482 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23483 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23484 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23485 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23494 description: Response codes found in [response codes](https://wiki.onap.org/).
23496 - name: equipment-name
23500 example: __EQUIPMENT-NAME__
23501 - name: interface-name
23503 description: Name that identifies the physical interface
23506 example: __INTERFACE-NAME__
23507 - name: interface-name
23509 description: Name given to the interface
23512 example: __INTERFACE-NAME__
23513 - name: vlan-interface
23515 description: String that identifies the interface
23518 example: __VLAN-INTERFACE__
23519 - name: l3-interface-ipv4-address
23521 description: IP address
23524 example: __L3-INTERFACE-IPV4-ADDRESS__
23527 description: l3-interface-ipv4-address-list object that needs to be updated.
23530 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23534 summary: delete an existing l3-interface-ipv4-address-list
23535 description: delete an existing l3-interface-ipv4-address-list
23536 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23545 description: Response codes found in [response codes](https://wiki.onap.org/).
23547 - name: equipment-name
23551 example: __EQUIPMENT-NAME__
23552 - name: interface-name
23554 description: Name that identifies the physical interface
23557 example: __INTERFACE-NAME__
23558 - name: interface-name
23560 description: Name given to the interface
23563 example: __INTERFACE-NAME__
23564 - name: vlan-interface
23566 description: String that identifies the interface
23569 example: __VLAN-INTERFACE__
23570 - name: l3-interface-ipv4-address
23572 description: IP address
23575 example: __L3-INTERFACE-IPV4-ADDRESS__
23576 - name: resource-version
23578 description: resource-version for concurrency
23581 /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:
23585 summary: see node definition for valid relationships
23586 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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: vlan-interface
23616 description: String that identifies the interface
23619 example: __VLAN-INTERFACE__
23620 - name: l3-interface-ipv6-address
23622 description: IP address
23625 example: __L3-INTERFACE-IPV6-ADDRESS__
23628 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23631 $ref: "#/definitions/relationship"
23635 summary: delete an existing relationship
23636 description: delete an existing relationship
23637 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23646 description: Response codes found in [response codes](https://wiki.onap.org/).
23648 - name: equipment-name
23652 example: __EQUIPMENT-NAME__
23653 - name: interface-name
23655 description: Name that identifies the physical interface
23658 example: __INTERFACE-NAME__
23659 - name: interface-name
23661 description: Name given to the interface
23664 example: __INTERFACE-NAME__
23665 - name: vlan-interface
23667 description: String that identifies the interface
23670 example: __VLAN-INTERFACE__
23671 - name: l3-interface-ipv6-address
23673 description: IP address
23676 example: __L3-INTERFACE-IPV6-ADDRESS__
23677 /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}:
23681 summary: returns l3-interface-ipv6-address-list
23682 description: returns l3-interface-ipv6-address-list
23683 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23689 description: successful operation
23691 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23693 description: Response codes found in [response codes](https://wiki.onap.org/).
23695 - name: equipment-name
23699 example: __EQUIPMENT-NAME__
23700 - name: interface-name
23702 description: Name that identifies the physical interface
23705 example: __INTERFACE-NAME__
23706 - name: interface-name
23708 description: Name given to the interface
23711 example: __INTERFACE-NAME__
23712 - name: vlan-interface
23714 description: String that identifies the interface
23717 example: __VLAN-INTERFACE__
23718 - name: l3-interface-ipv6-address
23720 description: IP address
23723 example: __L3-INTERFACE-IPV6-ADDRESS__
23727 summary: create or update an existing l3-interface-ipv6-address-list
23729 Create or update an existing l3-interface-ipv6-address-list.
23731 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23732 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23741 description: Response codes found in [response codes](https://wiki.onap.org/).
23743 - name: equipment-name
23747 example: __EQUIPMENT-NAME__
23748 - name: interface-name
23750 description: Name that identifies the physical interface
23753 example: __INTERFACE-NAME__
23754 - name: interface-name
23756 description: Name given to the interface
23759 example: __INTERFACE-NAME__
23760 - name: vlan-interface
23762 description: String that identifies the interface
23765 example: __VLAN-INTERFACE__
23766 - name: l3-interface-ipv6-address
23768 description: IP address
23771 example: __L3-INTERFACE-IPV6-ADDRESS__
23774 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23777 $ref: "#/definitions/l3-interface-ipv6-address-list"
23781 summary: update an existing l3-interface-ipv6-address-list
23783 Update an existing l3-interface-ipv6-address-list
23785 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23786 The PUT operation will entirely replace an existing object.
23787 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23789 Other differences between PUT and PATCH are:
23791 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23792 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23793 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23794 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23803 description: Response codes found in [response codes](https://wiki.onap.org/).
23805 - name: equipment-name
23809 example: __EQUIPMENT-NAME__
23810 - name: interface-name
23812 description: Name that identifies the physical interface
23815 example: __INTERFACE-NAME__
23816 - name: interface-name
23818 description: Name given to the interface
23821 example: __INTERFACE-NAME__
23822 - name: vlan-interface
23824 description: String that identifies the interface
23827 example: __VLAN-INTERFACE__
23828 - name: l3-interface-ipv6-address
23830 description: IP address
23833 example: __L3-INTERFACE-IPV6-ADDRESS__
23836 description: l3-interface-ipv6-address-list object that needs to be updated.
23839 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23843 summary: delete an existing l3-interface-ipv6-address-list
23844 description: delete an existing l3-interface-ipv6-address-list
23845 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23854 description: Response codes found in [response codes](https://wiki.onap.org/).
23856 - name: equipment-name
23860 example: __EQUIPMENT-NAME__
23861 - name: interface-name
23863 description: Name that identifies the physical interface
23866 example: __INTERFACE-NAME__
23867 - name: interface-name
23869 description: Name given to the interface
23872 example: __INTERFACE-NAME__
23873 - name: vlan-interface
23875 description: String that identifies the interface
23878 example: __VLAN-INTERFACE__
23879 - name: l3-interface-ipv6-address
23881 description: IP address
23884 example: __L3-INTERFACE-IPV6-ADDRESS__
23885 - name: resource-version
23887 description: resource-version for concurrency
23890 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
23894 summary: returns vlan
23895 description: returns vlan
23896 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23902 description: successful operation
23904 $ref: "#/getDefinitions/vlan"
23906 description: Response codes found in [response codes](https://wiki.onap.org/).
23908 - name: equipment-name
23912 example: __EQUIPMENT-NAME__
23913 - name: interface-name
23915 description: Name that identifies the physical interface
23918 example: __INTERFACE-NAME__
23919 - name: interface-name
23921 description: Name given to the interface
23924 example: __INTERFACE-NAME__
23925 - name: vlan-interface
23927 description: String that identifies the interface
23930 example: __VLAN-INTERFACE__
23934 summary: create or update an existing vlan
23936 Create or update an existing vlan.
23938 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23939 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23948 description: Response codes found in [response codes](https://wiki.onap.org/).
23950 - name: equipment-name
23954 example: __EQUIPMENT-NAME__
23955 - name: interface-name
23957 description: Name that identifies the physical interface
23960 example: __INTERFACE-NAME__
23961 - name: interface-name
23963 description: Name given to the interface
23966 example: __INTERFACE-NAME__
23967 - name: vlan-interface
23969 description: String that identifies the interface
23972 example: __VLAN-INTERFACE__
23975 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
23978 $ref: "#/definitions/vlan"
23982 summary: update an existing vlan
23984 Update an existing vlan
23986 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23987 The PUT operation will entirely replace an existing object.
23988 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23990 Other differences between PUT and PATCH are:
23992 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23993 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23994 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23995 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
24004 description: Response codes found in [response codes](https://wiki.onap.org/).
24006 - name: equipment-name
24010 example: __EQUIPMENT-NAME__
24011 - name: interface-name
24013 description: Name that identifies the physical interface
24016 example: __INTERFACE-NAME__
24017 - name: interface-name
24019 description: Name given to the interface
24022 example: __INTERFACE-NAME__
24023 - name: vlan-interface
24025 description: String that identifies the interface
24028 example: __VLAN-INTERFACE__
24031 description: vlan object that needs to be updated.
24034 $ref: "#/patchDefinitions/vlan"
24038 summary: delete an existing vlan
24039 description: delete an existing vlan
24040 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
24049 description: Response codes found in [response codes](https://wiki.onap.org/).
24051 - name: equipment-name
24055 example: __EQUIPMENT-NAME__
24056 - name: interface-name
24058 description: Name that identifies the physical interface
24061 example: __INTERFACE-NAME__
24062 - name: interface-name
24064 description: Name given to the interface
24067 example: __INTERFACE-NAME__
24068 - name: vlan-interface
24070 description: String that identifies the interface
24073 example: __VLAN-INTERFACE__
24074 - name: resource-version
24076 description: resource-version for concurrency
24079 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
24083 summary: returns vlans
24084 description: returns vlans
24085 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
24091 description: successful operation
24093 $ref: "#/getDefinitions/vlans"
24095 description: Response codes found in [response codes](https://wiki.onap.org/).
24097 - name: equipment-name
24101 example: __EQUIPMENT-NAME__
24102 - name: interface-name
24104 description: Name that identifies the physical interface
24107 example: __INTERFACE-NAME__
24108 - name: interface-name
24110 description: Name given to the interface
24113 example: __INTERFACE-NAME__
24114 - name: vlan-interface
24119 - name: vlan-id-inner
24130 /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:
24134 summary: see node definition for valid relationships
24135 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
24144 description: Response codes found in [response codes](https://wiki.onap.org/).
24146 - name: equipment-name
24150 example: __EQUIPMENT-NAME__
24151 - name: interface-name
24153 description: Name that identifies the physical interface
24156 example: __INTERFACE-NAME__
24157 - name: interface-name
24159 description: Name given to the interface
24162 example: __INTERFACE-NAME__
24165 description: PCI ID used to identify the sriov-vf
24168 example: __PCI-ID__
24171 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
24174 $ref: "#/definitions/relationship"
24178 summary: delete an existing relationship
24179 description: delete an existing relationship
24180 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
24189 description: Response codes found in [response codes](https://wiki.onap.org/).
24191 - name: equipment-name
24195 example: __EQUIPMENT-NAME__
24196 - name: interface-name
24198 description: Name that identifies the physical interface
24201 example: __INTERFACE-NAME__
24202 - name: interface-name
24204 description: Name given to the interface
24207 example: __INTERFACE-NAME__
24210 description: PCI ID used to identify the sriov-vf
24213 example: __PCI-ID__
24214 /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}:
24218 summary: returns sriov-vf
24219 description: returns sriov-vf
24220 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24226 description: successful operation
24228 $ref: "#/getDefinitions/sriov-vf"
24230 description: Response codes found in [response codes](https://wiki.onap.org/).
24232 - name: equipment-name
24236 example: __EQUIPMENT-NAME__
24237 - name: interface-name
24239 description: Name that identifies the physical interface
24242 example: __INTERFACE-NAME__
24243 - name: interface-name
24245 description: Name given to the interface
24248 example: __INTERFACE-NAME__
24251 description: PCI ID used to identify the sriov-vf
24254 example: __PCI-ID__
24258 summary: create or update an existing sriov-vf
24260 Create or update an existing sriov-vf.
24262 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24263 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24272 description: Response codes found in [response codes](https://wiki.onap.org/).
24274 - name: equipment-name
24278 example: __EQUIPMENT-NAME__
24279 - name: interface-name
24281 description: Name that identifies the physical interface
24284 example: __INTERFACE-NAME__
24285 - name: interface-name
24287 description: Name given to the interface
24290 example: __INTERFACE-NAME__
24293 description: PCI ID used to identify the sriov-vf
24296 example: __PCI-ID__
24299 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
24302 $ref: "#/definitions/sriov-vf"
24306 summary: update an existing sriov-vf
24308 Update an existing sriov-vf
24310 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24311 The PUT operation will entirely replace an existing object.
24312 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24314 Other differences between PUT and PATCH are:
24316 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24317 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24318 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24319 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24328 description: Response codes found in [response codes](https://wiki.onap.org/).
24330 - name: equipment-name
24334 example: __EQUIPMENT-NAME__
24335 - name: interface-name
24337 description: Name that identifies the physical interface
24340 example: __INTERFACE-NAME__
24341 - name: interface-name
24343 description: Name given to the interface
24346 example: __INTERFACE-NAME__
24349 description: PCI ID used to identify the sriov-vf
24352 example: __PCI-ID__
24355 description: sriov-vf object that needs to be updated.
24358 $ref: "#/patchDefinitions/sriov-vf"
24362 summary: delete an existing sriov-vf
24363 description: delete an existing sriov-vf
24364 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24373 description: Response codes found in [response codes](https://wiki.onap.org/).
24375 - name: equipment-name
24379 example: __EQUIPMENT-NAME__
24380 - name: interface-name
24382 description: Name that identifies the physical interface
24385 example: __INTERFACE-NAME__
24386 - name: interface-name
24388 description: Name given to the interface
24391 example: __INTERFACE-NAME__
24394 description: PCI ID used to identify the sriov-vf
24397 example: __PCI-ID__
24398 - name: resource-version
24400 description: resource-version for concurrency
24403 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
24407 summary: returns sriov-vfs
24408 description: returns sriov-vfs
24409 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
24415 description: successful operation
24417 $ref: "#/getDefinitions/sriov-vfs"
24419 description: Response codes found in [response codes](https://wiki.onap.org/).
24421 - name: equipment-name
24425 example: __EQUIPMENT-NAME__
24426 - name: interface-name
24428 description: Name that identifies the physical interface
24431 example: __INTERFACE-NAME__
24432 - name: interface-name
24434 description: Name given to the interface
24437 example: __INTERFACE-NAME__
24443 - name: vf-vlan-filter
24448 - name: vf-mac-filter
24453 - name: vf-vlan-strip
24458 - name: neutron-network-id
24463 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
24467 summary: see node definition for valid relationships
24468 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
24477 description: Response codes found in [response codes](https://wiki.onap.org/).
24479 - name: equipment-name
24483 example: __EQUIPMENT-NAME__
24484 - name: interface-name
24486 description: Name that identifies the physical interface
24489 example: __INTERFACE-NAME__
24490 - name: interface-name
24492 description: Name given to the interface
24495 example: __INTERFACE-NAME__
24498 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
24501 $ref: "#/definitions/relationship"
24505 summary: delete an existing relationship
24506 description: delete an existing relationship
24507 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
24516 description: Response codes found in [response codes](https://wiki.onap.org/).
24518 - name: equipment-name
24522 example: __EQUIPMENT-NAME__
24523 - name: interface-name
24525 description: Name that identifies the physical interface
24528 example: __INTERFACE-NAME__
24529 - name: interface-name
24531 description: Name given to the interface
24534 example: __INTERFACE-NAME__
24535 /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:
24539 summary: see node definition for valid relationships
24540 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24549 description: Response codes found in [response codes](https://wiki.onap.org/).
24551 - name: equipment-name
24555 example: __EQUIPMENT-NAME__
24556 - name: interface-name
24558 description: Name that identifies the physical interface
24561 example: __INTERFACE-NAME__
24562 - name: interface-name
24564 description: Name given to the interface
24567 example: __INTERFACE-NAME__
24568 - name: l3-interface-ipv4-address
24570 description: IP address
24573 example: __L3-INTERFACE-IPV4-ADDRESS__
24576 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24579 $ref: "#/definitions/relationship"
24583 summary: delete an existing relationship
24584 description: delete an existing relationship
24585 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24594 description: Response codes found in [response codes](https://wiki.onap.org/).
24596 - name: equipment-name
24600 example: __EQUIPMENT-NAME__
24601 - name: interface-name
24603 description: Name that identifies the physical interface
24606 example: __INTERFACE-NAME__
24607 - name: interface-name
24609 description: Name given to the interface
24612 example: __INTERFACE-NAME__
24613 - name: l3-interface-ipv4-address
24615 description: IP address
24618 example: __L3-INTERFACE-IPV4-ADDRESS__
24619 /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}:
24623 summary: returns l3-interface-ipv4-address-list
24624 description: returns l3-interface-ipv4-address-list
24625 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24631 description: successful operation
24633 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24635 description: Response codes found in [response codes](https://wiki.onap.org/).
24637 - name: equipment-name
24641 example: __EQUIPMENT-NAME__
24642 - name: interface-name
24644 description: Name that identifies the physical interface
24647 example: __INTERFACE-NAME__
24648 - name: interface-name
24650 description: Name given to the interface
24653 example: __INTERFACE-NAME__
24654 - name: l3-interface-ipv4-address
24656 description: IP address
24659 example: __L3-INTERFACE-IPV4-ADDRESS__
24663 summary: create or update an existing l3-interface-ipv4-address-list
24665 Create or update an existing l3-interface-ipv4-address-list.
24667 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24668 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24677 description: Response codes found in [response codes](https://wiki.onap.org/).
24679 - name: equipment-name
24683 example: __EQUIPMENT-NAME__
24684 - name: interface-name
24686 description: Name that identifies the physical interface
24689 example: __INTERFACE-NAME__
24690 - name: interface-name
24692 description: Name given to the interface
24695 example: __INTERFACE-NAME__
24696 - name: l3-interface-ipv4-address
24698 description: IP address
24701 example: __L3-INTERFACE-IPV4-ADDRESS__
24704 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24707 $ref: "#/definitions/l3-interface-ipv4-address-list"
24711 summary: update an existing l3-interface-ipv4-address-list
24713 Update an existing l3-interface-ipv4-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: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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 physical interface
24745 example: __INTERFACE-NAME__
24746 - name: interface-name
24748 description: Name given to the interface
24751 example: __INTERFACE-NAME__
24752 - name: l3-interface-ipv4-address
24754 description: IP address
24757 example: __L3-INTERFACE-IPV4-ADDRESS__
24760 description: l3-interface-ipv4-address-list object that needs to be updated.
24763 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24767 summary: delete an existing l3-interface-ipv4-address-list
24768 description: delete an existing l3-interface-ipv4-address-list
24769 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24778 description: Response codes found in [response codes](https://wiki.onap.org/).
24780 - name: equipment-name
24784 example: __EQUIPMENT-NAME__
24785 - name: interface-name
24787 description: Name that identifies the physical interface
24790 example: __INTERFACE-NAME__
24791 - name: interface-name
24793 description: Name given to the interface
24796 example: __INTERFACE-NAME__
24797 - name: l3-interface-ipv4-address
24799 description: IP address
24802 example: __L3-INTERFACE-IPV4-ADDRESS__
24803 - name: resource-version
24805 description: resource-version for concurrency
24808 /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:
24812 summary: see node definition for valid relationships
24813 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24822 description: Response codes found in [response codes](https://wiki.onap.org/).
24824 - name: equipment-name
24828 example: __EQUIPMENT-NAME__
24829 - name: interface-name
24831 description: Name that identifies the physical interface
24834 example: __INTERFACE-NAME__
24835 - name: interface-name
24837 description: Name given to the interface
24840 example: __INTERFACE-NAME__
24841 - name: l3-interface-ipv6-address
24843 description: IP address
24846 example: __L3-INTERFACE-IPV6-ADDRESS__
24849 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24852 $ref: "#/definitions/relationship"
24856 summary: delete an existing relationship
24857 description: delete an existing relationship
24858 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24867 description: Response codes found in [response codes](https://wiki.onap.org/).
24869 - name: equipment-name
24873 example: __EQUIPMENT-NAME__
24874 - name: interface-name
24876 description: Name that identifies the physical interface
24879 example: __INTERFACE-NAME__
24880 - name: interface-name
24882 description: Name given to the interface
24885 example: __INTERFACE-NAME__
24886 - name: l3-interface-ipv6-address
24888 description: IP address
24891 example: __L3-INTERFACE-IPV6-ADDRESS__
24892 /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}:
24896 summary: returns l3-interface-ipv6-address-list
24897 description: returns l3-interface-ipv6-address-list
24898 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24904 description: successful operation
24906 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24908 description: Response codes found in [response codes](https://wiki.onap.org/).
24910 - name: equipment-name
24914 example: __EQUIPMENT-NAME__
24915 - name: interface-name
24917 description: Name that identifies the physical interface
24920 example: __INTERFACE-NAME__
24921 - name: interface-name
24923 description: Name given to the interface
24926 example: __INTERFACE-NAME__
24927 - name: l3-interface-ipv6-address
24929 description: IP address
24932 example: __L3-INTERFACE-IPV6-ADDRESS__
24936 summary: create or update an existing l3-interface-ipv6-address-list
24938 Create or update an existing l3-interface-ipv6-address-list.
24940 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24941 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24950 description: Response codes found in [response codes](https://wiki.onap.org/).
24952 - name: equipment-name
24956 example: __EQUIPMENT-NAME__
24957 - name: interface-name
24959 description: Name that identifies the physical interface
24962 example: __INTERFACE-NAME__
24963 - name: interface-name
24965 description: Name given to the interface
24968 example: __INTERFACE-NAME__
24969 - name: l3-interface-ipv6-address
24971 description: IP address
24974 example: __L3-INTERFACE-IPV6-ADDRESS__
24977 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24980 $ref: "#/definitions/l3-interface-ipv6-address-list"
24984 summary: update an existing l3-interface-ipv6-address-list
24986 Update an existing l3-interface-ipv6-address-list
24988 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24989 The PUT operation will entirely replace an existing object.
24990 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24992 Other differences between PUT and PATCH are:
24994 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24995 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24996 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24997 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25006 description: Response codes found in [response codes](https://wiki.onap.org/).
25008 - name: equipment-name
25012 example: __EQUIPMENT-NAME__
25013 - name: interface-name
25015 description: Name that identifies the physical interface
25018 example: __INTERFACE-NAME__
25019 - name: interface-name
25021 description: Name given to the interface
25024 example: __INTERFACE-NAME__
25025 - name: l3-interface-ipv6-address
25027 description: IP address
25030 example: __L3-INTERFACE-IPV6-ADDRESS__
25033 description: l3-interface-ipv6-address-list object that needs to be updated.
25036 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25040 summary: delete an existing l3-interface-ipv6-address-list
25041 description: delete an existing l3-interface-ipv6-address-list
25042 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25051 description: Response codes found in [response codes](https://wiki.onap.org/).
25053 - name: equipment-name
25057 example: __EQUIPMENT-NAME__
25058 - name: interface-name
25060 description: Name that identifies the physical interface
25063 example: __INTERFACE-NAME__
25064 - name: interface-name
25066 description: Name given to the interface
25069 example: __INTERFACE-NAME__
25070 - name: l3-interface-ipv6-address
25072 description: IP address
25075 example: __L3-INTERFACE-IPV6-ADDRESS__
25076 - name: resource-version
25078 description: resource-version for concurrency
25081 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
25085 summary: returns l-interface
25086 description: returns l-interface
25087 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
25093 description: successful operation
25095 $ref: "#/getDefinitions/l-interface"
25097 description: Response codes found in [response codes](https://wiki.onap.org/).
25099 - name: equipment-name
25103 example: __EQUIPMENT-NAME__
25104 - name: interface-name
25106 description: Name that identifies the physical interface
25109 example: __INTERFACE-NAME__
25110 - name: interface-name
25112 description: Name given to the interface
25115 example: __INTERFACE-NAME__
25119 summary: create or update an existing l-interface
25121 Create or update an existing l-interface.
25123 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25124 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
25133 description: Response codes found in [response codes](https://wiki.onap.org/).
25135 - name: equipment-name
25139 example: __EQUIPMENT-NAME__
25140 - name: interface-name
25142 description: Name that identifies the physical interface
25145 example: __INTERFACE-NAME__
25146 - name: interface-name
25148 description: Name given to the interface
25151 example: __INTERFACE-NAME__
25154 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
25157 $ref: "#/definitions/l-interface"
25161 summary: update an existing l-interface
25163 Update an existing l-interface
25165 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25166 The PUT operation will entirely replace an existing object.
25167 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25169 Other differences between PUT and PATCH are:
25171 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25172 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25173 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25174 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
25183 description: Response codes found in [response codes](https://wiki.onap.org/).
25185 - name: equipment-name
25189 example: __EQUIPMENT-NAME__
25190 - name: interface-name
25192 description: Name that identifies the physical interface
25195 example: __INTERFACE-NAME__
25196 - name: interface-name
25198 description: Name given to the interface
25201 example: __INTERFACE-NAME__
25204 description: l-interface object that needs to be updated.
25207 $ref: "#/patchDefinitions/l-interface"
25211 summary: delete an existing l-interface
25212 description: delete an existing l-interface
25213 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
25222 description: Response codes found in [response codes](https://wiki.onap.org/).
25224 - name: equipment-name
25228 example: __EQUIPMENT-NAME__
25229 - name: interface-name
25231 description: Name that identifies the physical interface
25234 example: __INTERFACE-NAME__
25235 - name: interface-name
25237 description: Name given to the interface
25240 example: __INTERFACE-NAME__
25241 - name: resource-version
25243 description: resource-version for concurrency
25246 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
25250 summary: returns l-interfaces
25251 description: returns l-interfaces
25252 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
25258 description: successful operation
25260 $ref: "#/getDefinitions/l-interfaces"
25262 description: Response codes found in [response codes](https://wiki.onap.org/).
25264 - name: equipment-name
25268 example: __EQUIPMENT-NAME__
25269 - name: interface-name
25271 description: Name that identifies the physical interface
25274 example: __INTERFACE-NAME__
25275 - name: interface-name
25280 - name: interface-id
25290 - name: network-name
25295 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
25299 summary: returns p-interface
25300 description: returns p-interface
25301 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
25307 description: successful operation
25309 $ref: "#/getDefinitions/p-interface"
25311 description: Response codes found in [response codes](https://wiki.onap.org/).
25313 - name: equipment-name
25317 example: __EQUIPMENT-NAME__
25318 - name: interface-name
25320 description: Name that identifies the physical interface
25323 example: __INTERFACE-NAME__
25327 summary: create or update an existing p-interface
25329 Create or update an existing p-interface.
25331 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25332 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
25341 description: Response codes found in [response codes](https://wiki.onap.org/).
25343 - name: equipment-name
25347 example: __EQUIPMENT-NAME__
25348 - name: interface-name
25350 description: Name that identifies the physical interface
25353 example: __INTERFACE-NAME__
25356 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)
25359 $ref: "#/definitions/p-interface"
25363 summary: update an existing p-interface
25365 Update an existing p-interface
25367 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25368 The PUT operation will entirely replace an existing object.
25369 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25371 Other differences between PUT and PATCH are:
25373 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25374 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25375 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25376 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
25385 description: Response codes found in [response codes](https://wiki.onap.org/).
25387 - name: equipment-name
25391 example: __EQUIPMENT-NAME__
25392 - name: interface-name
25394 description: Name that identifies the physical interface
25397 example: __INTERFACE-NAME__
25400 description: p-interface object that needs to be updated.
25403 $ref: "#/patchDefinitions/p-interface"
25407 summary: delete an existing p-interface
25408 description: delete an existing p-interface
25409 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
25418 description: Response codes found in [response codes](https://wiki.onap.org/).
25420 - name: equipment-name
25424 example: __EQUIPMENT-NAME__
25425 - name: interface-name
25427 description: Name that identifies the physical interface
25430 example: __INTERFACE-NAME__
25431 - name: resource-version
25433 description: resource-version for concurrency
25436 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
25440 summary: returns p-interfaces
25441 description: returns p-interfaces
25442 operationId: getNetworkVplsPesVplsPePInterfaces
25448 description: successful operation
25450 $ref: "#/getDefinitions/p-interfaces"
25452 description: Response codes found in [response codes](https://wiki.onap.org/).
25454 - name: equipment-name
25458 example: __EQUIPMENT-NAME__
25459 - name: interface-name
25464 - name: prov-status
25469 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
25473 summary: see node definition for valid relationships
25474 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
25483 description: Response codes found in [response codes](https://wiki.onap.org/).
25485 - name: equipment-name
25489 example: __EQUIPMENT-NAME__
25490 - name: interface-name
25492 description: Name that identifies the link aggregate interface
25495 example: __INTERFACE-NAME__
25498 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
25501 $ref: "#/definitions/relationship"
25505 summary: delete an existing relationship
25506 description: delete an existing relationship
25507 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
25516 description: Response codes found in [response codes](https://wiki.onap.org/).
25518 - name: equipment-name
25522 example: __EQUIPMENT-NAME__
25523 - name: interface-name
25525 description: Name that identifies the link aggregate interface
25528 example: __INTERFACE-NAME__
25529 /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:
25533 summary: see node definition for valid relationships
25534 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25543 description: Response codes found in [response codes](https://wiki.onap.org/).
25545 - name: equipment-name
25549 example: __EQUIPMENT-NAME__
25550 - name: interface-name
25552 description: Name that identifies the link aggregate interface
25555 example: __INTERFACE-NAME__
25556 - name: interface-name
25558 description: Name given to the interface
25561 example: __INTERFACE-NAME__
25562 - name: vlan-interface
25564 description: String that identifies the interface
25567 example: __VLAN-INTERFACE__
25570 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
25573 $ref: "#/definitions/relationship"
25577 summary: delete an existing relationship
25578 description: delete an existing relationship
25579 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25588 description: Response codes found in [response codes](https://wiki.onap.org/).
25590 - name: equipment-name
25594 example: __EQUIPMENT-NAME__
25595 - name: interface-name
25597 description: Name that identifies the link aggregate interface
25600 example: __INTERFACE-NAME__
25601 - name: interface-name
25603 description: Name given to the interface
25606 example: __INTERFACE-NAME__
25607 - name: vlan-interface
25609 description: String that identifies the interface
25612 example: __VLAN-INTERFACE__
25613 /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:
25617 summary: see node definition for valid relationships
25618 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25627 description: Response codes found in [response codes](https://wiki.onap.org/).
25629 - name: equipment-name
25633 example: __EQUIPMENT-NAME__
25634 - name: interface-name
25636 description: Name that identifies the link aggregate interface
25639 example: __INTERFACE-NAME__
25640 - name: interface-name
25642 description: Name given to the interface
25645 example: __INTERFACE-NAME__
25646 - name: vlan-interface
25648 description: String that identifies the interface
25651 example: __VLAN-INTERFACE__
25652 - name: l3-interface-ipv4-address
25654 description: IP address
25657 example: __L3-INTERFACE-IPV4-ADDRESS__
25660 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25663 $ref: "#/definitions/relationship"
25667 summary: delete an existing relationship
25668 description: delete an existing relationship
25669 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25678 description: Response codes found in [response codes](https://wiki.onap.org/).
25680 - name: equipment-name
25684 example: __EQUIPMENT-NAME__
25685 - name: interface-name
25687 description: Name that identifies the link aggregate interface
25690 example: __INTERFACE-NAME__
25691 - name: interface-name
25693 description: Name given to the interface
25696 example: __INTERFACE-NAME__
25697 - name: vlan-interface
25699 description: String that identifies the interface
25702 example: __VLAN-INTERFACE__
25703 - name: l3-interface-ipv4-address
25705 description: IP address
25708 example: __L3-INTERFACE-IPV4-ADDRESS__
25709 /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}:
25713 summary: returns l3-interface-ipv4-address-list
25714 description: returns l3-interface-ipv4-address-list
25715 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25721 description: successful operation
25723 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25725 description: Response codes found in [response codes](https://wiki.onap.org/).
25727 - name: equipment-name
25731 example: __EQUIPMENT-NAME__
25732 - name: interface-name
25734 description: Name that identifies the link aggregate interface
25737 example: __INTERFACE-NAME__
25738 - name: interface-name
25740 description: Name given to the interface
25743 example: __INTERFACE-NAME__
25744 - name: vlan-interface
25746 description: String that identifies the interface
25749 example: __VLAN-INTERFACE__
25750 - name: l3-interface-ipv4-address
25752 description: IP address
25755 example: __L3-INTERFACE-IPV4-ADDRESS__
25759 summary: create or update an existing l3-interface-ipv4-address-list
25761 Create or update an existing l3-interface-ipv4-address-list.
25763 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25764 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25773 description: Response codes found in [response codes](https://wiki.onap.org/).
25775 - name: equipment-name
25779 example: __EQUIPMENT-NAME__
25780 - name: interface-name
25782 description: Name that identifies the link aggregate interface
25785 example: __INTERFACE-NAME__
25786 - name: interface-name
25788 description: Name given to the interface
25791 example: __INTERFACE-NAME__
25792 - name: vlan-interface
25794 description: String that identifies the interface
25797 example: __VLAN-INTERFACE__
25798 - name: l3-interface-ipv4-address
25800 description: IP address
25803 example: __L3-INTERFACE-IPV4-ADDRESS__
25806 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25809 $ref: "#/definitions/l3-interface-ipv4-address-list"
25813 summary: update an existing l3-interface-ipv4-address-list
25815 Update an existing l3-interface-ipv4-address-list
25817 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25818 The PUT operation will entirely replace an existing object.
25819 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25821 Other differences between PUT and PATCH are:
25823 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25824 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25825 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25826 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25835 description: Response codes found in [response codes](https://wiki.onap.org/).
25837 - name: equipment-name
25841 example: __EQUIPMENT-NAME__
25842 - name: interface-name
25844 description: Name that identifies the link aggregate interface
25847 example: __INTERFACE-NAME__
25848 - name: interface-name
25850 description: Name given to the interface
25853 example: __INTERFACE-NAME__
25854 - name: vlan-interface
25856 description: String that identifies the interface
25859 example: __VLAN-INTERFACE__
25860 - name: l3-interface-ipv4-address
25862 description: IP address
25865 example: __L3-INTERFACE-IPV4-ADDRESS__
25868 description: l3-interface-ipv4-address-list object that needs to be updated.
25871 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25875 summary: delete an existing l3-interface-ipv4-address-list
25876 description: delete an existing l3-interface-ipv4-address-list
25877 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25886 description: Response codes found in [response codes](https://wiki.onap.org/).
25888 - name: equipment-name
25892 example: __EQUIPMENT-NAME__
25893 - name: interface-name
25895 description: Name that identifies the link aggregate interface
25898 example: __INTERFACE-NAME__
25899 - name: interface-name
25901 description: Name given to the interface
25904 example: __INTERFACE-NAME__
25905 - name: vlan-interface
25907 description: String that identifies the interface
25910 example: __VLAN-INTERFACE__
25911 - name: l3-interface-ipv4-address
25913 description: IP address
25916 example: __L3-INTERFACE-IPV4-ADDRESS__
25917 - name: resource-version
25919 description: resource-version for concurrency
25922 /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:
25926 summary: see node definition for valid relationships
25927 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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: vlan-interface
25957 description: String that identifies the interface
25960 example: __VLAN-INTERFACE__
25961 - name: l3-interface-ipv6-address
25963 description: IP address
25966 example: __L3-INTERFACE-IPV6-ADDRESS__
25969 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25972 $ref: "#/definitions/relationship"
25976 summary: delete an existing relationship
25977 description: delete an existing relationship
25978 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25987 description: Response codes found in [response codes](https://wiki.onap.org/).
25989 - name: equipment-name
25993 example: __EQUIPMENT-NAME__
25994 - name: interface-name
25996 description: Name that identifies the link aggregate interface
25999 example: __INTERFACE-NAME__
26000 - name: interface-name
26002 description: Name given to the interface
26005 example: __INTERFACE-NAME__
26006 - name: vlan-interface
26008 description: String that identifies the interface
26011 example: __VLAN-INTERFACE__
26012 - name: l3-interface-ipv6-address
26014 description: IP address
26017 example: __L3-INTERFACE-IPV6-ADDRESS__
26018 /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}:
26022 summary: returns l3-interface-ipv6-address-list
26023 description: returns l3-interface-ipv6-address-list
26024 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26030 description: successful operation
26032 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26034 description: Response codes found in [response codes](https://wiki.onap.org/).
26036 - name: equipment-name
26040 example: __EQUIPMENT-NAME__
26041 - name: interface-name
26043 description: Name that identifies the link aggregate interface
26046 example: __INTERFACE-NAME__
26047 - name: interface-name
26049 description: Name given to the interface
26052 example: __INTERFACE-NAME__
26053 - name: vlan-interface
26055 description: String that identifies the interface
26058 example: __VLAN-INTERFACE__
26059 - name: l3-interface-ipv6-address
26061 description: IP address
26064 example: __L3-INTERFACE-IPV6-ADDRESS__
26068 summary: create or update an existing l3-interface-ipv6-address-list
26070 Create or update an existing l3-interface-ipv6-address-list.
26072 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26073 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26082 description: Response codes found in [response codes](https://wiki.onap.org/).
26084 - name: equipment-name
26088 example: __EQUIPMENT-NAME__
26089 - name: interface-name
26091 description: Name that identifies the link aggregate interface
26094 example: __INTERFACE-NAME__
26095 - name: interface-name
26097 description: Name given to the interface
26100 example: __INTERFACE-NAME__
26101 - name: vlan-interface
26103 description: String that identifies the interface
26106 example: __VLAN-INTERFACE__
26107 - name: l3-interface-ipv6-address
26109 description: IP address
26112 example: __L3-INTERFACE-IPV6-ADDRESS__
26115 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
26118 $ref: "#/definitions/l3-interface-ipv6-address-list"
26122 summary: update an existing l3-interface-ipv6-address-list
26124 Update an existing l3-interface-ipv6-address-list
26126 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26127 The PUT operation will entirely replace an existing object.
26128 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26130 Other differences between PUT and PATCH are:
26132 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26133 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26134 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26135 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26144 description: Response codes found in [response codes](https://wiki.onap.org/).
26146 - name: equipment-name
26150 example: __EQUIPMENT-NAME__
26151 - name: interface-name
26153 description: Name that identifies the link aggregate interface
26156 example: __INTERFACE-NAME__
26157 - name: interface-name
26159 description: Name given to the interface
26162 example: __INTERFACE-NAME__
26163 - name: vlan-interface
26165 description: String that identifies the interface
26168 example: __VLAN-INTERFACE__
26169 - name: l3-interface-ipv6-address
26171 description: IP address
26174 example: __L3-INTERFACE-IPV6-ADDRESS__
26177 description: l3-interface-ipv6-address-list object that needs to be updated.
26180 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26184 summary: delete an existing l3-interface-ipv6-address-list
26185 description: delete an existing l3-interface-ipv6-address-list
26186 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26195 description: Response codes found in [response codes](https://wiki.onap.org/).
26197 - name: equipment-name
26201 example: __EQUIPMENT-NAME__
26202 - name: interface-name
26204 description: Name that identifies the link aggregate interface
26207 example: __INTERFACE-NAME__
26208 - name: interface-name
26210 description: Name given to the interface
26213 example: __INTERFACE-NAME__
26214 - name: vlan-interface
26216 description: String that identifies the interface
26219 example: __VLAN-INTERFACE__
26220 - name: l3-interface-ipv6-address
26222 description: IP address
26225 example: __L3-INTERFACE-IPV6-ADDRESS__
26226 - name: resource-version
26228 description: resource-version for concurrency
26231 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
26235 summary: returns vlan
26236 description: returns vlan
26237 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26243 description: successful operation
26245 $ref: "#/getDefinitions/vlan"
26247 description: Response codes found in [response codes](https://wiki.onap.org/).
26249 - name: equipment-name
26253 example: __EQUIPMENT-NAME__
26254 - name: interface-name
26256 description: Name that identifies the link aggregate interface
26259 example: __INTERFACE-NAME__
26260 - name: interface-name
26262 description: Name given to the interface
26265 example: __INTERFACE-NAME__
26266 - name: vlan-interface
26268 description: String that identifies the interface
26271 example: __VLAN-INTERFACE__
26275 summary: create or update an existing vlan
26277 Create or update an existing vlan.
26279 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26280 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26289 description: Response codes found in [response codes](https://wiki.onap.org/).
26291 - name: equipment-name
26295 example: __EQUIPMENT-NAME__
26296 - name: interface-name
26298 description: Name that identifies the link aggregate interface
26301 example: __INTERFACE-NAME__
26302 - name: interface-name
26304 description: Name given to the interface
26307 example: __INTERFACE-NAME__
26308 - name: vlan-interface
26310 description: String that identifies the interface
26313 example: __VLAN-INTERFACE__
26316 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
26319 $ref: "#/definitions/vlan"
26323 summary: update an existing vlan
26325 Update an existing vlan
26327 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26328 The PUT operation will entirely replace an existing object.
26329 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26331 Other differences between PUT and PATCH are:
26333 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26334 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26335 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26336 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26345 description: Response codes found in [response codes](https://wiki.onap.org/).
26347 - name: equipment-name
26351 example: __EQUIPMENT-NAME__
26352 - name: interface-name
26354 description: Name that identifies the link aggregate interface
26357 example: __INTERFACE-NAME__
26358 - name: interface-name
26360 description: Name given to the interface
26363 example: __INTERFACE-NAME__
26364 - name: vlan-interface
26366 description: String that identifies the interface
26369 example: __VLAN-INTERFACE__
26372 description: vlan object that needs to be updated.
26375 $ref: "#/patchDefinitions/vlan"
26379 summary: delete an existing vlan
26380 description: delete an existing vlan
26381 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26390 description: Response codes found in [response codes](https://wiki.onap.org/).
26392 - name: equipment-name
26396 example: __EQUIPMENT-NAME__
26397 - name: interface-name
26399 description: Name that identifies the link aggregate interface
26402 example: __INTERFACE-NAME__
26403 - name: interface-name
26405 description: Name given to the interface
26408 example: __INTERFACE-NAME__
26409 - name: vlan-interface
26411 description: String that identifies the interface
26414 example: __VLAN-INTERFACE__
26415 - name: resource-version
26417 description: resource-version for concurrency
26420 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
26424 summary: returns vlans
26425 description: returns vlans
26426 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
26432 description: successful operation
26434 $ref: "#/getDefinitions/vlans"
26436 description: Response codes found in [response codes](https://wiki.onap.org/).
26438 - name: equipment-name
26442 example: __EQUIPMENT-NAME__
26443 - name: interface-name
26445 description: Name that identifies the link aggregate interface
26448 example: __INTERFACE-NAME__
26449 - name: interface-name
26451 description: Name given to the interface
26454 example: __INTERFACE-NAME__
26455 - name: vlan-interface
26460 - name: vlan-id-inner
26471 /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:
26475 summary: see node definition for valid relationships
26476 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26485 description: Response codes found in [response codes](https://wiki.onap.org/).
26487 - name: equipment-name
26491 example: __EQUIPMENT-NAME__
26492 - name: interface-name
26494 description: Name that identifies the link aggregate interface
26497 example: __INTERFACE-NAME__
26498 - name: interface-name
26500 description: Name given to the interface
26503 example: __INTERFACE-NAME__
26506 description: PCI ID used to identify the sriov-vf
26509 example: __PCI-ID__
26512 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26515 $ref: "#/definitions/relationship"
26519 summary: delete an existing relationship
26520 description: delete an existing relationship
26521 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26530 description: Response codes found in [response codes](https://wiki.onap.org/).
26532 - name: equipment-name
26536 example: __EQUIPMENT-NAME__
26537 - name: interface-name
26539 description: Name that identifies the link aggregate interface
26542 example: __INTERFACE-NAME__
26543 - name: interface-name
26545 description: Name given to the interface
26548 example: __INTERFACE-NAME__
26551 description: PCI ID used to identify the sriov-vf
26554 example: __PCI-ID__
26555 /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}:
26559 summary: returns sriov-vf
26560 description: returns sriov-vf
26561 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26567 description: successful operation
26569 $ref: "#/getDefinitions/sriov-vf"
26571 description: Response codes found in [response codes](https://wiki.onap.org/).
26573 - name: equipment-name
26577 example: __EQUIPMENT-NAME__
26578 - name: interface-name
26580 description: Name that identifies the link aggregate interface
26583 example: __INTERFACE-NAME__
26584 - name: interface-name
26586 description: Name given to the interface
26589 example: __INTERFACE-NAME__
26592 description: PCI ID used to identify the sriov-vf
26595 example: __PCI-ID__
26599 summary: create or update an existing sriov-vf
26601 Create or update an existing sriov-vf.
26603 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26604 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26613 description: Response codes found in [response codes](https://wiki.onap.org/).
26615 - name: equipment-name
26619 example: __EQUIPMENT-NAME__
26620 - name: interface-name
26622 description: Name that identifies the link aggregate interface
26625 example: __INTERFACE-NAME__
26626 - name: interface-name
26628 description: Name given to the interface
26631 example: __INTERFACE-NAME__
26634 description: PCI ID used to identify the sriov-vf
26637 example: __PCI-ID__
26640 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26643 $ref: "#/definitions/sriov-vf"
26647 summary: update an existing sriov-vf
26649 Update an existing sriov-vf
26651 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26652 The PUT operation will entirely replace an existing object.
26653 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26655 Other differences between PUT and PATCH are:
26657 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26658 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26659 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26660 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26669 description: Response codes found in [response codes](https://wiki.onap.org/).
26671 - name: equipment-name
26675 example: __EQUIPMENT-NAME__
26676 - name: interface-name
26678 description: Name that identifies the link aggregate interface
26681 example: __INTERFACE-NAME__
26682 - name: interface-name
26684 description: Name given to the interface
26687 example: __INTERFACE-NAME__
26690 description: PCI ID used to identify the sriov-vf
26693 example: __PCI-ID__
26696 description: sriov-vf object that needs to be updated.
26699 $ref: "#/patchDefinitions/sriov-vf"
26703 summary: delete an existing sriov-vf
26704 description: delete an existing sriov-vf
26705 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26714 description: Response codes found in [response codes](https://wiki.onap.org/).
26716 - name: equipment-name
26720 example: __EQUIPMENT-NAME__
26721 - name: interface-name
26723 description: Name that identifies the link aggregate interface
26726 example: __INTERFACE-NAME__
26727 - name: interface-name
26729 description: Name given to the interface
26732 example: __INTERFACE-NAME__
26735 description: PCI ID used to identify the sriov-vf
26738 example: __PCI-ID__
26739 - name: resource-version
26741 description: resource-version for concurrency
26744 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
26748 summary: returns sriov-vfs
26749 description: returns sriov-vfs
26750 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
26756 description: successful operation
26758 $ref: "#/getDefinitions/sriov-vfs"
26760 description: Response codes found in [response codes](https://wiki.onap.org/).
26762 - name: equipment-name
26766 example: __EQUIPMENT-NAME__
26767 - name: interface-name
26769 description: Name that identifies the link aggregate interface
26772 example: __INTERFACE-NAME__
26773 - name: interface-name
26775 description: Name given to the interface
26778 example: __INTERFACE-NAME__
26784 - name: vf-vlan-filter
26789 - name: vf-mac-filter
26794 - name: vf-vlan-strip
26799 - name: neutron-network-id
26804 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26808 summary: see node definition for valid relationships
26809 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26818 description: Response codes found in [response codes](https://wiki.onap.org/).
26820 - name: equipment-name
26824 example: __EQUIPMENT-NAME__
26825 - name: interface-name
26827 description: Name that identifies the link aggregate interface
26830 example: __INTERFACE-NAME__
26831 - name: interface-name
26833 description: Name given to the interface
26836 example: __INTERFACE-NAME__
26839 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26842 $ref: "#/definitions/relationship"
26846 summary: delete an existing relationship
26847 description: delete an existing relationship
26848 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26857 description: Response codes found in [response codes](https://wiki.onap.org/).
26859 - name: equipment-name
26863 example: __EQUIPMENT-NAME__
26864 - name: interface-name
26866 description: Name that identifies the link aggregate interface
26869 example: __INTERFACE-NAME__
26870 - name: interface-name
26872 description: Name given to the interface
26875 example: __INTERFACE-NAME__
26876 /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:
26880 summary: see node definition for valid relationships
26881 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26890 description: Response codes found in [response codes](https://wiki.onap.org/).
26892 - name: equipment-name
26896 example: __EQUIPMENT-NAME__
26897 - name: interface-name
26899 description: Name that identifies the link aggregate interface
26902 example: __INTERFACE-NAME__
26903 - name: interface-name
26905 description: Name given to the interface
26908 example: __INTERFACE-NAME__
26909 - name: l3-interface-ipv4-address
26911 description: IP address
26914 example: __L3-INTERFACE-IPV4-ADDRESS__
26917 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26920 $ref: "#/definitions/relationship"
26924 summary: delete an existing relationship
26925 description: delete an existing relationship
26926 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26935 description: Response codes found in [response codes](https://wiki.onap.org/).
26937 - name: equipment-name
26941 example: __EQUIPMENT-NAME__
26942 - name: interface-name
26944 description: Name that identifies the link aggregate interface
26947 example: __INTERFACE-NAME__
26948 - name: interface-name
26950 description: Name given to the interface
26953 example: __INTERFACE-NAME__
26954 - name: l3-interface-ipv4-address
26956 description: IP address
26959 example: __L3-INTERFACE-IPV4-ADDRESS__
26960 /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}:
26964 summary: returns l3-interface-ipv4-address-list
26965 description: returns l3-interface-ipv4-address-list
26966 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26972 description: successful operation
26974 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26976 description: Response codes found in [response codes](https://wiki.onap.org/).
26978 - name: equipment-name
26982 example: __EQUIPMENT-NAME__
26983 - name: interface-name
26985 description: Name that identifies the link aggregate interface
26988 example: __INTERFACE-NAME__
26989 - name: interface-name
26991 description: Name given to the interface
26994 example: __INTERFACE-NAME__
26995 - name: l3-interface-ipv4-address
26997 description: IP address
27000 example: __L3-INTERFACE-IPV4-ADDRESS__
27004 summary: create or update an existing l3-interface-ipv4-address-list
27006 Create or update an existing l3-interface-ipv4-address-list.
27008 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27009 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27018 description: Response codes found in [response codes](https://wiki.onap.org/).
27020 - name: equipment-name
27024 example: __EQUIPMENT-NAME__
27025 - name: interface-name
27027 description: Name that identifies the link aggregate interface
27030 example: __INTERFACE-NAME__
27031 - name: interface-name
27033 description: Name given to the interface
27036 example: __INTERFACE-NAME__
27037 - name: l3-interface-ipv4-address
27039 description: IP address
27042 example: __L3-INTERFACE-IPV4-ADDRESS__
27045 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
27048 $ref: "#/definitions/l3-interface-ipv4-address-list"
27052 summary: update an existing l3-interface-ipv4-address-list
27054 Update an existing l3-interface-ipv4-address-list
27056 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27057 The PUT operation will entirely replace an existing object.
27058 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27060 Other differences between PUT and PATCH are:
27062 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27063 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27064 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27065 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27074 description: Response codes found in [response codes](https://wiki.onap.org/).
27076 - name: equipment-name
27080 example: __EQUIPMENT-NAME__
27081 - name: interface-name
27083 description: Name that identifies the link aggregate interface
27086 example: __INTERFACE-NAME__
27087 - name: interface-name
27089 description: Name given to the interface
27092 example: __INTERFACE-NAME__
27093 - name: l3-interface-ipv4-address
27095 description: IP address
27098 example: __L3-INTERFACE-IPV4-ADDRESS__
27101 description: l3-interface-ipv4-address-list object that needs to be updated.
27104 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27108 summary: delete an existing l3-interface-ipv4-address-list
27109 description: delete an existing l3-interface-ipv4-address-list
27110 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27119 description: Response codes found in [response codes](https://wiki.onap.org/).
27121 - name: equipment-name
27125 example: __EQUIPMENT-NAME__
27126 - name: interface-name
27128 description: Name that identifies the link aggregate interface
27131 example: __INTERFACE-NAME__
27132 - name: interface-name
27134 description: Name given to the interface
27137 example: __INTERFACE-NAME__
27138 - name: l3-interface-ipv4-address
27140 description: IP address
27143 example: __L3-INTERFACE-IPV4-ADDRESS__
27144 - name: resource-version
27146 description: resource-version for concurrency
27149 /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:
27153 summary: see node definition for valid relationships
27154 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
27163 description: Response codes found in [response codes](https://wiki.onap.org/).
27165 - name: equipment-name
27169 example: __EQUIPMENT-NAME__
27170 - name: interface-name
27172 description: Name that identifies the link aggregate interface
27175 example: __INTERFACE-NAME__
27176 - name: interface-name
27178 description: Name given to the interface
27181 example: __INTERFACE-NAME__
27182 - name: l3-interface-ipv6-address
27184 description: IP address
27187 example: __L3-INTERFACE-IPV6-ADDRESS__
27190 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27193 $ref: "#/definitions/relationship"
27197 summary: delete an existing relationship
27198 description: delete an existing relationship
27199 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
27208 description: Response codes found in [response codes](https://wiki.onap.org/).
27210 - name: equipment-name
27214 example: __EQUIPMENT-NAME__
27215 - name: interface-name
27217 description: Name that identifies the link aggregate interface
27220 example: __INTERFACE-NAME__
27221 - name: interface-name
27223 description: Name given to the interface
27226 example: __INTERFACE-NAME__
27227 - name: l3-interface-ipv6-address
27229 description: IP address
27232 example: __L3-INTERFACE-IPV6-ADDRESS__
27233 /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}:
27237 summary: returns l3-interface-ipv6-address-list
27238 description: returns l3-interface-ipv6-address-list
27239 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27245 description: successful operation
27247 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27249 description: Response codes found in [response codes](https://wiki.onap.org/).
27251 - name: equipment-name
27255 example: __EQUIPMENT-NAME__
27256 - name: interface-name
27258 description: Name that identifies the link aggregate interface
27261 example: __INTERFACE-NAME__
27262 - name: interface-name
27264 description: Name given to the interface
27267 example: __INTERFACE-NAME__
27268 - name: l3-interface-ipv6-address
27270 description: IP address
27273 example: __L3-INTERFACE-IPV6-ADDRESS__
27277 summary: create or update an existing l3-interface-ipv6-address-list
27279 Create or update an existing l3-interface-ipv6-address-list.
27281 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27282 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27291 description: Response codes found in [response codes](https://wiki.onap.org/).
27293 - name: equipment-name
27297 example: __EQUIPMENT-NAME__
27298 - name: interface-name
27300 description: Name that identifies the link aggregate interface
27303 example: __INTERFACE-NAME__
27304 - name: interface-name
27306 description: Name given to the interface
27309 example: __INTERFACE-NAME__
27310 - name: l3-interface-ipv6-address
27312 description: IP address
27315 example: __L3-INTERFACE-IPV6-ADDRESS__
27318 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27321 $ref: "#/definitions/l3-interface-ipv6-address-list"
27325 summary: update an existing l3-interface-ipv6-address-list
27327 Update an existing l3-interface-ipv6-address-list
27329 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27330 The PUT operation will entirely replace an existing object.
27331 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27333 Other differences between PUT and PATCH are:
27335 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27336 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27337 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27338 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27347 description: Response codes found in [response codes](https://wiki.onap.org/).
27349 - name: equipment-name
27353 example: __EQUIPMENT-NAME__
27354 - name: interface-name
27356 description: Name that identifies the link aggregate interface
27359 example: __INTERFACE-NAME__
27360 - name: interface-name
27362 description: Name given to the interface
27365 example: __INTERFACE-NAME__
27366 - name: l3-interface-ipv6-address
27368 description: IP address
27371 example: __L3-INTERFACE-IPV6-ADDRESS__
27374 description: l3-interface-ipv6-address-list object that needs to be updated.
27377 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27381 summary: delete an existing l3-interface-ipv6-address-list
27382 description: delete an existing l3-interface-ipv6-address-list
27383 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27392 description: Response codes found in [response codes](https://wiki.onap.org/).
27394 - name: equipment-name
27398 example: __EQUIPMENT-NAME__
27399 - name: interface-name
27401 description: Name that identifies the link aggregate interface
27404 example: __INTERFACE-NAME__
27405 - name: interface-name
27407 description: Name given to the interface
27410 example: __INTERFACE-NAME__
27411 - name: l3-interface-ipv6-address
27413 description: IP address
27416 example: __L3-INTERFACE-IPV6-ADDRESS__
27417 - name: resource-version
27419 description: resource-version for concurrency
27422 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
27426 summary: returns l-interface
27427 description: returns l-interface
27428 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27434 description: successful operation
27436 $ref: "#/getDefinitions/l-interface"
27438 description: Response codes found in [response codes](https://wiki.onap.org/).
27440 - name: equipment-name
27444 example: __EQUIPMENT-NAME__
27445 - name: interface-name
27447 description: Name that identifies the link aggregate interface
27450 example: __INTERFACE-NAME__
27451 - name: interface-name
27453 description: Name given to the interface
27456 example: __INTERFACE-NAME__
27460 summary: create or update an existing l-interface
27462 Create or update an existing l-interface.
27464 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27465 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27474 description: Response codes found in [response codes](https://wiki.onap.org/).
27476 - name: equipment-name
27480 example: __EQUIPMENT-NAME__
27481 - name: interface-name
27483 description: Name that identifies the link aggregate interface
27486 example: __INTERFACE-NAME__
27487 - name: interface-name
27489 description: Name given to the interface
27492 example: __INTERFACE-NAME__
27495 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
27498 $ref: "#/definitions/l-interface"
27502 summary: update an existing l-interface
27504 Update an existing l-interface
27506 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27507 The PUT operation will entirely replace an existing object.
27508 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27510 Other differences between PUT and PATCH are:
27512 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27513 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27514 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27515 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27524 description: Response codes found in [response codes](https://wiki.onap.org/).
27526 - name: equipment-name
27530 example: __EQUIPMENT-NAME__
27531 - name: interface-name
27533 description: Name that identifies the link aggregate interface
27536 example: __INTERFACE-NAME__
27537 - name: interface-name
27539 description: Name given to the interface
27542 example: __INTERFACE-NAME__
27545 description: l-interface object that needs to be updated.
27548 $ref: "#/patchDefinitions/l-interface"
27552 summary: delete an existing l-interface
27553 description: delete an existing l-interface
27554 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27563 description: Response codes found in [response codes](https://wiki.onap.org/).
27565 - name: equipment-name
27569 example: __EQUIPMENT-NAME__
27570 - name: interface-name
27572 description: Name that identifies the link aggregate interface
27575 example: __INTERFACE-NAME__
27576 - name: interface-name
27578 description: Name given to the interface
27581 example: __INTERFACE-NAME__
27582 - name: resource-version
27584 description: resource-version for concurrency
27587 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
27591 summary: returns l-interfaces
27592 description: returns l-interfaces
27593 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
27599 description: successful operation
27601 $ref: "#/getDefinitions/l-interfaces"
27603 description: Response codes found in [response codes](https://wiki.onap.org/).
27605 - name: equipment-name
27609 example: __EQUIPMENT-NAME__
27610 - name: interface-name
27612 description: Name that identifies the link aggregate interface
27615 example: __INTERFACE-NAME__
27616 - name: interface-name
27621 - name: interface-id
27631 - name: network-name
27636 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
27640 summary: returns lag-interface
27641 description: returns lag-interface
27642 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
27648 description: successful operation
27650 $ref: "#/getDefinitions/lag-interface"
27652 description: Response codes found in [response codes](https://wiki.onap.org/).
27654 - name: equipment-name
27658 example: __EQUIPMENT-NAME__
27659 - name: interface-name
27661 description: Name that identifies the link aggregate interface
27664 example: __INTERFACE-NAME__
27668 summary: create or update an existing lag-interface
27670 Create or update an existing lag-interface.
27672 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27673 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27682 description: Response codes found in [response codes](https://wiki.onap.org/).
27684 - name: equipment-name
27688 example: __EQUIPMENT-NAME__
27689 - name: interface-name
27691 description: Name that identifies the link aggregate interface
27694 example: __INTERFACE-NAME__
27697 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
27700 $ref: "#/definitions/lag-interface"
27704 summary: update an existing lag-interface
27706 Update an existing lag-interface
27708 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27709 The PUT operation will entirely replace an existing object.
27710 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27712 Other differences between PUT and PATCH are:
27714 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27715 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27716 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27717 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27726 description: Response codes found in [response codes](https://wiki.onap.org/).
27728 - name: equipment-name
27732 example: __EQUIPMENT-NAME__
27733 - name: interface-name
27735 description: Name that identifies the link aggregate interface
27738 example: __INTERFACE-NAME__
27741 description: lag-interface object that needs to be updated.
27744 $ref: "#/patchDefinitions/lag-interface"
27748 summary: delete an existing lag-interface
27749 description: delete an existing lag-interface
27750 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
27759 description: Response codes found in [response codes](https://wiki.onap.org/).
27761 - name: equipment-name
27765 example: __EQUIPMENT-NAME__
27766 - name: interface-name
27768 description: Name that identifies the link aggregate interface
27771 example: __INTERFACE-NAME__
27772 - name: resource-version
27774 description: resource-version for concurrency
27777 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
27781 summary: returns lag-interfaces
27782 description: returns lag-interfaces
27783 operationId: getNetworkVplsPesVplsPeLagInterfaces
27789 description: successful operation
27791 $ref: "#/getDefinitions/lag-interfaces"
27793 description: Response codes found in [response codes](https://wiki.onap.org/).
27795 - name: equipment-name
27799 example: __EQUIPMENT-NAME__
27800 - name: interface-name
27805 - name: interface-id
27810 - name: interface-role
27815 /network/vpls-pes/vpls-pe/{equipment-name}:
27819 summary: returns vpls-pe
27820 description: returns vpls-pe
27821 operationId: getNetworkVplsPesVplsPe
27827 description: successful operation
27829 $ref: "#/getDefinitions/vpls-pe"
27831 description: Response codes found in [response codes](https://wiki.onap.org/).
27833 - name: equipment-name
27837 example: __EQUIPMENT-NAME__
27841 summary: create or update an existing vpls-pe
27843 Create or update an existing vpls-pe.
27845 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27846 operationId: createOrUpdateNetworkVplsPesVplsPe
27855 description: Response codes found in [response codes](https://wiki.onap.org/).
27857 - name: equipment-name
27861 example: __EQUIPMENT-NAME__
27864 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json)
27867 $ref: "#/definitions/vpls-pe"
27871 summary: update an existing vpls-pe
27873 Update an existing vpls-pe
27875 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27876 The PUT operation will entirely replace an existing object.
27877 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27879 Other differences between PUT and PATCH are:
27881 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27882 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27883 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27884 operationId: UpdateNetworkVplsPesVplsPe
27893 description: Response codes found in [response codes](https://wiki.onap.org/).
27895 - name: equipment-name
27899 example: __EQUIPMENT-NAME__
27902 description: vpls-pe object that needs to be updated.
27905 $ref: "#/patchDefinitions/vpls-pe"
27909 summary: delete an existing vpls-pe
27910 description: delete an existing vpls-pe
27911 operationId: deleteNetworkVplsPesVplsPe
27920 description: Response codes found in [response codes](https://wiki.onap.org/).
27922 - name: equipment-name
27926 example: __EQUIPMENT-NAME__
27927 - name: resource-version
27929 description: resource-version for concurrency
27936 summary: returns vpls-pes
27937 description: returns vpls-pes
27938 operationId: getNetworkVplsPes
27944 description: successful operation
27946 $ref: "#/getDefinitions/vpls-pes"
27948 description: Response codes found in [response codes](https://wiki.onap.org/).
27950 - name: equipment-name
27955 - name: prov-status
27960 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
27964 summary: see node definition for valid relationships
27965 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27974 description: Response codes found in [response codes](https://wiki.onap.org/).
27976 - name: multicast-configuration-id
27978 description: Unique id of multicast configuration.
27981 example: __MULTICAST-CONFIGURATION-ID__
27984 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)
27987 $ref: "#/definitions/relationship"
27991 summary: delete an existing relationship
27992 description: delete an existing relationship
27993 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
28002 description: Response codes found in [response codes](https://wiki.onap.org/).
28004 - name: multicast-configuration-id
28006 description: Unique id of multicast configuration.
28009 example: __MULTICAST-CONFIGURATION-ID__
28010 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
28014 summary: returns multicast-configuration
28015 description: returns multicast-configuration
28016 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
28022 description: successful operation
28024 $ref: "#/getDefinitions/multicast-configuration"
28026 description: Response codes found in [response codes](https://wiki.onap.org/).
28028 - name: multicast-configuration-id
28030 description: Unique id of multicast configuration.
28033 example: __MULTICAST-CONFIGURATION-ID__
28037 summary: create or update an existing multicast-configuration
28039 Create or update an existing multicast-configuration.
28041 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28042 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
28051 description: Response codes found in [response codes](https://wiki.onap.org/).
28053 - name: multicast-configuration-id
28055 description: Unique id of multicast configuration.
28058 example: __MULTICAST-CONFIGURATION-ID__
28061 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)
28064 $ref: "#/definitions/multicast-configuration"
28068 summary: update an existing multicast-configuration
28070 Update an existing multicast-configuration
28072 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28073 The PUT operation will entirely replace an existing object.
28074 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28076 Other differences between PUT and PATCH are:
28078 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28079 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28080 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28081 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
28090 description: Response codes found in [response codes](https://wiki.onap.org/).
28092 - name: multicast-configuration-id
28094 description: Unique id of multicast configuration.
28097 example: __MULTICAST-CONFIGURATION-ID__
28100 description: multicast-configuration object that needs to be updated.
28103 $ref: "#/patchDefinitions/multicast-configuration"
28107 summary: delete an existing multicast-configuration
28108 description: delete an existing multicast-configuration
28109 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
28118 description: Response codes found in [response codes](https://wiki.onap.org/).
28120 - name: multicast-configuration-id
28122 description: Unique id of multicast configuration.
28125 example: __MULTICAST-CONFIGURATION-ID__
28126 - name: resource-version
28128 description: resource-version for concurrency
28131 /network/multicast-configurations:
28135 summary: returns multicast-configurations
28136 description: returns multicast-configurations
28137 operationId: getNetworkMulticastConfigurations
28143 description: successful operation
28145 $ref: "#/getDefinitions/multicast-configurations"
28147 description: Response codes found in [response codes](https://wiki.onap.org/).
28149 - name: multicast-configuration-id
28154 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
28158 summary: see node definition for valid relationships
28159 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
28168 description: Response codes found in [response codes](https://wiki.onap.org/).
28172 description: Unique id of VNF. This is unique across the graph.
28175 example: __VNF-ID__
28176 - name: interface-id
28178 description: Unique ID of the interface
28181 example: __INTERFACE-ID__
28184 description: See mis-na-virtualization-platform.yang
28188 example: __CVLAN-TAG__
28191 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
28194 $ref: "#/definitions/relationship"
28198 summary: delete an existing relationship
28199 description: delete an existing relationship
28200 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
28209 description: Response codes found in [response codes](https://wiki.onap.org/).
28213 description: Unique id of VNF. This is unique across the graph.
28216 example: __VNF-ID__
28217 - name: interface-id
28219 description: Unique ID of the interface
28222 example: __INTERFACE-ID__
28225 description: See mis-na-virtualization-platform.yang
28229 example: __CVLAN-TAG__
28230 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
28234 summary: returns cvlan-tag-entry
28235 description: returns cvlan-tag-entry
28236 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28242 description: successful operation
28244 $ref: "#/getDefinitions/cvlan-tag-entry"
28246 description: Response codes found in [response codes](https://wiki.onap.org/).
28250 description: Unique id of VNF. This is unique across the graph.
28253 example: __VNF-ID__
28254 - name: interface-id
28256 description: Unique ID of the interface
28259 example: __INTERFACE-ID__
28262 description: See mis-na-virtualization-platform.yang
28266 example: __CVLAN-TAG__
28270 summary: create or update an existing cvlan-tag-entry
28272 Create or update an existing cvlan-tag-entry.
28274 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28275 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28284 description: Response codes found in [response codes](https://wiki.onap.org/).
28288 description: Unique id of VNF. This is unique across the graph.
28291 example: __VNF-ID__
28292 - name: interface-id
28294 description: Unique ID of the interface
28297 example: __INTERFACE-ID__
28300 description: See mis-na-virtualization-platform.yang
28304 example: __CVLAN-TAG__
28307 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
28310 $ref: "#/definitions/cvlan-tag-entry"
28314 summary: update an existing cvlan-tag-entry
28316 Update an existing cvlan-tag-entry
28318 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28319 The PUT operation will entirely replace an existing object.
28320 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28322 Other differences between PUT and PATCH are:
28324 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28325 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28326 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28327 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28336 description: Response codes found in [response codes](https://wiki.onap.org/).
28340 description: Unique id of VNF. This is unique across the graph.
28343 example: __VNF-ID__
28344 - name: interface-id
28346 description: Unique ID of the interface
28349 example: __INTERFACE-ID__
28352 description: See mis-na-virtualization-platform.yang
28356 example: __CVLAN-TAG__
28359 description: cvlan-tag-entry object that needs to be updated.
28362 $ref: "#/patchDefinitions/cvlan-tag-entry"
28366 summary: delete an existing cvlan-tag-entry
28367 description: delete an existing cvlan-tag-entry
28368 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28377 description: Response codes found in [response codes](https://wiki.onap.org/).
28381 description: Unique id of VNF. This is unique across the graph.
28384 example: __VNF-ID__
28385 - name: interface-id
28387 description: Unique ID of the interface
28390 example: __INTERFACE-ID__
28393 description: See mis-na-virtualization-platform.yang
28397 example: __CVLAN-TAG__
28398 - name: resource-version
28400 description: resource-version for concurrency
28403 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
28407 summary: returns cvlan-tags
28408 description: returns cvlan-tags
28409 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
28415 description: successful operation
28417 $ref: "#/getDefinitions/cvlan-tags"
28419 description: Response codes found in [response codes](https://wiki.onap.org/).
28423 description: Unique id of VNF. This is unique across the graph.
28426 example: __VNF-ID__
28427 - name: interface-id
28429 description: Unique ID of the interface
28432 example: __INTERFACE-ID__
28439 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
28443 summary: see node definition for valid relationships
28444 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
28453 description: Response codes found in [response codes](https://wiki.onap.org/).
28457 description: Unique id of VNF. This is unique across the graph.
28460 example: __VNF-ID__
28461 - name: interface-id
28463 description: Unique ID of the interface
28466 example: __INTERFACE-ID__
28469 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroup.json)
28472 $ref: "#/definitions/relationship"
28476 summary: delete an existing relationship
28477 description: delete an existing relationship
28478 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
28487 description: Response codes found in [response codes](https://wiki.onap.org/).
28491 description: Unique id of VNF. This is unique across the graph.
28494 example: __VNF-ID__
28495 - name: interface-id
28497 description: Unique ID of the interface
28500 example: __INTERFACE-ID__
28501 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
28505 summary: returns port-group
28506 description: returns port-group
28507 operationId: getNetworkVcesVcePortGroupsPortGroup
28513 description: successful operation
28515 $ref: "#/getDefinitions/port-group"
28517 description: Response codes found in [response codes](https://wiki.onap.org/).
28521 description: Unique id of VNF. This is unique across the graph.
28524 example: __VNF-ID__
28525 - name: interface-id
28527 description: Unique ID of the interface
28530 example: __INTERFACE-ID__
28534 summary: create or update an existing port-group
28536 Create or update an existing port-group.
28538 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28539 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
28548 description: Response codes found in [response codes](https://wiki.onap.org/).
28552 description: Unique id of VNF. This is unique across the graph.
28555 example: __VNF-ID__
28556 - name: interface-id
28558 description: Unique ID of the interface
28561 example: __INTERFACE-ID__
28564 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroup.json)
28567 $ref: "#/definitions/port-group"
28571 summary: update an existing port-group
28573 Update an existing port-group
28575 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28576 The PUT operation will entirely replace an existing object.
28577 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28579 Other differences between PUT and PATCH are:
28581 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28582 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28583 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28584 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
28593 description: Response codes found in [response codes](https://wiki.onap.org/).
28597 description: Unique id of VNF. This is unique across the graph.
28600 example: __VNF-ID__
28601 - name: interface-id
28603 description: Unique ID of the interface
28606 example: __INTERFACE-ID__
28609 description: port-group object that needs to be updated.
28612 $ref: "#/patchDefinitions/port-group"
28616 summary: delete an existing port-group
28617 description: delete an existing port-group
28618 operationId: deleteNetworkVcesVcePortGroupsPortGroup
28627 description: Response codes found in [response codes](https://wiki.onap.org/).
28631 description: Unique id of VNF. This is unique across the graph.
28634 example: __VNF-ID__
28635 - name: interface-id
28637 description: Unique ID of the interface
28640 example: __INTERFACE-ID__
28641 - name: resource-version
28643 description: resource-version for concurrency
28646 /network/vces/vce/{vnf-id}/port-groups:
28650 summary: returns port-groups
28651 description: returns port-groups
28652 operationId: getNetworkVcesVcePortGroups
28658 description: successful operation
28660 $ref: "#/getDefinitions/port-groups"
28662 description: Response codes found in [response codes](https://wiki.onap.org/).
28666 description: Unique id of VNF. This is unique across the graph.
28669 example: __VNF-ID__
28670 - name: interface-id
28675 - name: port-group-id
28680 - name: switch-name
28685 - name: heat-stack-id
28690 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28694 summary: see node definition for valid relationships
28695 operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
28704 description: Response codes found in [response codes](https://wiki.onap.org/).
28708 description: Unique id of VNF. This is unique across the graph.
28711 example: __VNF-ID__
28714 description: Unique ID for the license group the resource belongs to, should be uuid.
28717 example: __GROUP-UUID__
28718 - name: resource-uuid
28720 description: Unique ID of a license resource.
28723 example: __RESOURCE-UUID__
28726 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceLicensesLicense.json)
28729 $ref: "#/definitions/relationship"
28733 summary: delete an existing relationship
28734 description: delete an existing relationship
28735 operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
28744 description: Response codes found in [response codes](https://wiki.onap.org/).
28748 description: Unique id of VNF. This is unique across the graph.
28751 example: __VNF-ID__
28754 description: Unique ID for the license group the resource belongs to, should be uuid.
28757 example: __GROUP-UUID__
28758 - name: resource-uuid
28760 description: Unique ID of a license resource.
28763 example: __RESOURCE-UUID__
28764 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
28768 summary: returns license
28769 description: returns license
28770 operationId: getNetworkVcesVceLicensesLicense
28776 description: successful operation
28778 $ref: "#/getDefinitions/license"
28780 description: Response codes found in [response codes](https://wiki.onap.org/).
28784 description: Unique id of VNF. This is unique across the graph.
28787 example: __VNF-ID__
28790 description: Unique ID for the license group the resource belongs to, should be uuid.
28793 example: __GROUP-UUID__
28794 - name: resource-uuid
28796 description: Unique ID of a license resource.
28799 example: __RESOURCE-UUID__
28803 summary: create or update an existing license
28805 Create or update an existing license.
28807 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28808 operationId: createOrUpdateNetworkVcesVceLicensesLicense
28817 description: Response codes found in [response codes](https://wiki.onap.org/).
28821 description: Unique id of VNF. This is unique across the graph.
28824 example: __VNF-ID__
28827 description: Unique ID for the license group the resource belongs to, should be uuid.
28830 example: __GROUP-UUID__
28831 - name: resource-uuid
28833 description: Unique ID of a license resource.
28836 example: __RESOURCE-UUID__
28839 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceLicensesLicense.json)
28842 $ref: "#/definitions/license"
28846 summary: update an existing license
28848 Update an existing license
28850 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28851 The PUT operation will entirely replace an existing object.
28852 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28854 Other differences between PUT and PATCH are:
28856 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28857 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28858 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28859 operationId: UpdateNetworkVcesVceLicensesLicense
28868 description: Response codes found in [response codes](https://wiki.onap.org/).
28872 description: Unique id of VNF. This is unique across the graph.
28875 example: __VNF-ID__
28878 description: Unique ID for the license group the resource belongs to, should be uuid.
28881 example: __GROUP-UUID__
28882 - name: resource-uuid
28884 description: Unique ID of a license resource.
28887 example: __RESOURCE-UUID__
28890 description: license object that needs to be updated.
28893 $ref: "#/patchDefinitions/license"
28897 summary: delete an existing license
28898 description: delete an existing license
28899 operationId: deleteNetworkVcesVceLicensesLicense
28908 description: Response codes found in [response codes](https://wiki.onap.org/).
28912 description: Unique id of VNF. This is unique across the graph.
28915 example: __VNF-ID__
28918 description: Unique ID for the license group the resource belongs to, should be uuid.
28921 example: __GROUP-UUID__
28922 - name: resource-uuid
28924 description: Unique ID of a license resource.
28927 example: __RESOURCE-UUID__
28928 - name: resource-version
28930 description: resource-version for concurrency
28933 /network/vces/vce/{vnf-id}/licenses:
28937 summary: returns licenses
28938 description: returns licenses
28939 operationId: getNetworkVcesVceLicenses
28945 description: successful operation
28947 $ref: "#/getDefinitions/licenses"
28949 description: Response codes found in [response codes](https://wiki.onap.org/).
28953 description: Unique id of VNF. This is unique across the graph.
28956 example: __VNF-ID__
28962 - name: resource-uuid
28967 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28971 summary: see node definition for valid relationships
28972 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28981 description: Response codes found in [response codes](https://wiki.onap.org/).
28985 description: Unique id of VNF. This is unique across the graph.
28988 example: __VNF-ID__
28991 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28994 example: __GROUP-UUID__
28995 - name: resource-uuid
28997 description: Unique ID of an entitlement resource.
29000 example: __RESOURCE-UUID__
29003 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceEntitlementsEntitlement.json)
29006 $ref: "#/definitions/relationship"
29010 summary: delete an existing relationship
29011 description: delete an existing relationship
29012 operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
29021 description: Response codes found in [response codes](https://wiki.onap.org/).
29025 description: Unique id of VNF. This is unique across the graph.
29028 example: __VNF-ID__
29031 description: Unique ID for the entitlement group the resource comes from, should be uuid.
29034 example: __GROUP-UUID__
29035 - name: resource-uuid
29037 description: Unique ID of an entitlement resource.
29040 example: __RESOURCE-UUID__
29041 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
29045 summary: returns entitlement
29046 description: returns entitlement
29047 operationId: getNetworkVcesVceEntitlementsEntitlement
29053 description: successful operation
29055 $ref: "#/getDefinitions/entitlement"
29057 description: Response codes found in [response codes](https://wiki.onap.org/).
29061 description: Unique id of VNF. This is unique across the graph.
29064 example: __VNF-ID__
29067 description: Unique ID for the entitlement group the resource comes from, should be uuid.
29070 example: __GROUP-UUID__
29071 - name: resource-uuid
29073 description: Unique ID of an entitlement resource.
29076 example: __RESOURCE-UUID__
29080 summary: create or update an existing entitlement
29082 Create or update an existing entitlement.
29084 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29085 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
29094 description: Response codes found in [response codes](https://wiki.onap.org/).
29098 description: Unique id of VNF. This is unique across the graph.
29101 example: __VNF-ID__
29104 description: Unique ID for the entitlement group the resource comes from, should be uuid.
29107 example: __GROUP-UUID__
29108 - name: resource-uuid
29110 description: Unique ID of an entitlement resource.
29113 example: __RESOURCE-UUID__
29116 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceEntitlementsEntitlement.json)
29119 $ref: "#/definitions/entitlement"
29123 summary: update an existing entitlement
29125 Update an existing entitlement
29127 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29128 The PUT operation will entirely replace an existing object.
29129 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29131 Other differences between PUT and PATCH are:
29133 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29134 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29135 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29136 operationId: UpdateNetworkVcesVceEntitlementsEntitlement
29145 description: Response codes found in [response codes](https://wiki.onap.org/).
29149 description: Unique id of VNF. This is unique across the graph.
29152 example: __VNF-ID__
29155 description: Unique ID for the entitlement group the resource comes from, should be uuid.
29158 example: __GROUP-UUID__
29159 - name: resource-uuid
29161 description: Unique ID of an entitlement resource.
29164 example: __RESOURCE-UUID__
29167 description: entitlement object that needs to be updated.
29170 $ref: "#/patchDefinitions/entitlement"
29174 summary: delete an existing entitlement
29175 description: delete an existing entitlement
29176 operationId: deleteNetworkVcesVceEntitlementsEntitlement
29185 description: Response codes found in [response codes](https://wiki.onap.org/).
29189 description: Unique id of VNF. This is unique across the graph.
29192 example: __VNF-ID__
29195 description: Unique ID for the entitlement group the resource comes from, should be uuid.
29198 example: __GROUP-UUID__
29199 - name: resource-uuid
29201 description: Unique ID of an entitlement resource.
29204 example: __RESOURCE-UUID__
29205 - name: resource-version
29207 description: resource-version for concurrency
29210 /network/vces/vce/{vnf-id}/entitlements:
29214 summary: returns entitlements
29215 description: returns entitlements
29216 operationId: getNetworkVcesVceEntitlements
29222 description: successful operation
29224 $ref: "#/getDefinitions/entitlements"
29226 description: Response codes found in [response codes](https://wiki.onap.org/).
29230 description: Unique id of VNF. This is unique across the graph.
29233 example: __VNF-ID__
29239 - name: resource-uuid
29244 /network/vces/vce/{vnf-id}/relationship-list/relationship:
29248 summary: see node definition for valid relationships
29249 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
29258 description: Response codes found in [response codes](https://wiki.onap.org/).
29262 description: Unique id of VNF. This is unique across the graph.
29265 example: __VNF-ID__
29268 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVce.json)
29271 $ref: "#/definitions/relationship"
29275 summary: delete an existing relationship
29276 description: delete an existing relationship
29277 operationId: deleteNetworkVcesVceRelationshipListRelationship
29286 description: Response codes found in [response codes](https://wiki.onap.org/).
29290 description: Unique id of VNF. This is unique across the graph.
29293 example: __VNF-ID__
29294 /network/vces/vce/{vnf-id}:
29298 summary: returns vce
29299 description: returns vce
29300 operationId: getNetworkVcesVce
29306 description: successful operation
29308 $ref: "#/getDefinitions/vce"
29310 description: Response codes found in [response codes](https://wiki.onap.org/).
29314 description: Unique id of VNF. This is unique across the graph.
29317 example: __VNF-ID__
29321 summary: create or update an existing vce
29323 Create or update an existing vce.
29325 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29326 operationId: createOrUpdateNetworkVcesVce
29335 description: Response codes found in [response codes](https://wiki.onap.org/).
29339 description: Unique id of VNF. This is unique across the graph.
29342 example: __VNF-ID__
29345 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVce.json)
29348 $ref: "#/definitions/vce"
29352 summary: update an existing vce
29354 Update an existing vce
29356 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29357 The PUT operation will entirely replace an existing object.
29358 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29360 Other differences between PUT and PATCH are:
29362 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29363 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29364 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29365 operationId: UpdateNetworkVcesVce
29374 description: Response codes found in [response codes](https://wiki.onap.org/).
29378 description: Unique id of VNF. This is unique across the graph.
29381 example: __VNF-ID__
29384 description: vce object that needs to be updated.
29387 $ref: "#/patchDefinitions/vce"
29391 summary: delete an existing vce
29392 description: delete an existing vce
29393 operationId: deleteNetworkVcesVce
29402 description: Response codes found in [response codes](https://wiki.onap.org/).
29406 description: Unique id of VNF. This is unique across the graph.
29409 example: __VNF-ID__
29410 - name: resource-version
29412 description: resource-version for concurrency
29419 summary: returns vces
29420 description: returns vces
29421 operationId: getNetworkVces
29427 description: successful operation
29429 $ref: "#/getDefinitions/vces"
29431 description: Response codes found in [response codes](https://wiki.onap.org/).
29458 - name: regional-resource-zone
29463 - name: prov-status
29468 - name: heat-stack-id
29478 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
29482 summary: see node definition for valid relationships
29483 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
29492 description: Response codes found in [response codes](https://wiki.onap.org/).
29496 description: Unique ID of vnfc.
29499 example: __VNFC-NAME__
29502 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfc.json)
29505 $ref: "#/definitions/relationship"
29509 summary: delete an existing relationship
29510 description: delete an existing relationship
29511 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
29520 description: Response codes found in [response codes](https://wiki.onap.org/).
29524 description: Unique ID of vnfc.
29527 example: __VNFC-NAME__
29528 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
29532 summary: see node definition for valid relationships
29533 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
29542 description: Response codes found in [response codes](https://wiki.onap.org/).
29546 description: Unique ID of vnfc.
29549 example: __VNFC-NAME__
29550 - name: l3-interface-ipv4-address
29552 description: IP address
29555 example: __L3-INTERFACE-IPV4-ADDRESS__
29558 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
29561 $ref: "#/definitions/relationship"
29565 summary: delete an existing relationship
29566 description: delete an existing relationship
29567 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
29576 description: Response codes found in [response codes](https://wiki.onap.org/).
29580 description: Unique ID of vnfc.
29583 example: __VNFC-NAME__
29584 - name: l3-interface-ipv4-address
29586 description: IP address
29589 example: __L3-INTERFACE-IPV4-ADDRESS__
29590 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
29594 summary: returns l3-interface-ipv4-address-list
29595 description: returns l3-interface-ipv4-address-list
29596 operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29602 description: successful operation
29604 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29606 description: Response codes found in [response codes](https://wiki.onap.org/).
29610 description: Unique ID of vnfc.
29613 example: __VNFC-NAME__
29614 - name: l3-interface-ipv4-address
29616 description: IP address
29619 example: __L3-INTERFACE-IPV4-ADDRESS__
29623 summary: create or update an existing l3-interface-ipv4-address-list
29625 Create or update an existing l3-interface-ipv4-address-list.
29627 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29628 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29637 description: Response codes found in [response codes](https://wiki.onap.org/).
29641 description: Unique ID of vnfc.
29644 example: __VNFC-NAME__
29645 - name: l3-interface-ipv4-address
29647 description: IP address
29650 example: __L3-INTERFACE-IPV4-ADDRESS__
29653 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
29656 $ref: "#/definitions/l3-interface-ipv4-address-list"
29660 summary: update an existing l3-interface-ipv4-address-list
29662 Update an existing l3-interface-ipv4-address-list
29664 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29665 The PUT operation will entirely replace an existing object.
29666 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29668 Other differences between PUT and PATCH are:
29670 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29671 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29672 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29673 operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29682 description: Response codes found in [response codes](https://wiki.onap.org/).
29686 description: Unique ID of vnfc.
29689 example: __VNFC-NAME__
29690 - name: l3-interface-ipv4-address
29692 description: IP address
29695 example: __L3-INTERFACE-IPV4-ADDRESS__
29698 description: l3-interface-ipv4-address-list object that needs to be updated.
29701 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29705 summary: delete an existing l3-interface-ipv4-address-list
29706 description: delete an existing l3-interface-ipv4-address-list
29707 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29716 description: Response codes found in [response codes](https://wiki.onap.org/).
29720 description: Unique ID of vnfc.
29723 example: __VNFC-NAME__
29724 - name: l3-interface-ipv4-address
29726 description: IP address
29729 example: __L3-INTERFACE-IPV4-ADDRESS__
29730 - name: resource-version
29732 description: resource-version for concurrency
29735 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
29739 summary: see node definition for valid relationships
29740 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
29749 description: Response codes found in [response codes](https://wiki.onap.org/).
29753 description: Unique ID of vnfc.
29756 example: __VNFC-NAME__
29757 - name: l3-interface-ipv6-address
29759 description: IP address
29762 example: __L3-INTERFACE-IPV6-ADDRESS__
29765 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
29768 $ref: "#/definitions/relationship"
29772 summary: delete an existing relationship
29773 description: delete an existing relationship
29774 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
29783 description: Response codes found in [response codes](https://wiki.onap.org/).
29787 description: Unique ID of vnfc.
29790 example: __VNFC-NAME__
29791 - name: l3-interface-ipv6-address
29793 description: IP address
29796 example: __L3-INTERFACE-IPV6-ADDRESS__
29797 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
29801 summary: returns l3-interface-ipv6-address-list
29802 description: returns l3-interface-ipv6-address-list
29803 operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29809 description: successful operation
29811 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29813 description: Response codes found in [response codes](https://wiki.onap.org/).
29817 description: Unique ID of vnfc.
29820 example: __VNFC-NAME__
29821 - name: l3-interface-ipv6-address
29823 description: IP address
29826 example: __L3-INTERFACE-IPV6-ADDRESS__
29830 summary: create or update an existing l3-interface-ipv6-address-list
29832 Create or update an existing l3-interface-ipv6-address-list.
29834 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29835 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29844 description: Response codes found in [response codes](https://wiki.onap.org/).
29848 description: Unique ID of vnfc.
29851 example: __VNFC-NAME__
29852 - name: l3-interface-ipv6-address
29854 description: IP address
29857 example: __L3-INTERFACE-IPV6-ADDRESS__
29860 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
29863 $ref: "#/definitions/l3-interface-ipv6-address-list"
29867 summary: update an existing l3-interface-ipv6-address-list
29869 Update an existing l3-interface-ipv6-address-list
29871 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29872 The PUT operation will entirely replace an existing object.
29873 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29875 Other differences between PUT and PATCH are:
29877 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29878 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29879 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29880 operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29889 description: Response codes found in [response codes](https://wiki.onap.org/).
29893 description: Unique ID of vnfc.
29896 example: __VNFC-NAME__
29897 - name: l3-interface-ipv6-address
29899 description: IP address
29902 example: __L3-INTERFACE-IPV6-ADDRESS__
29905 description: l3-interface-ipv6-address-list object that needs to be updated.
29908 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29912 summary: delete an existing l3-interface-ipv6-address-list
29913 description: delete an existing l3-interface-ipv6-address-list
29914 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29923 description: Response codes found in [response codes](https://wiki.onap.org/).
29927 description: Unique ID of vnfc.
29930 example: __VNFC-NAME__
29931 - name: l3-interface-ipv6-address
29933 description: IP address
29936 example: __L3-INTERFACE-IPV6-ADDRESS__
29937 - name: resource-version
29939 description: resource-version for concurrency
29942 /network/vnfcs/vnfc/{vnfc-name}:
29946 summary: returns vnfc
29947 description: returns vnfc
29948 operationId: getNetworkVnfcsVnfc
29954 description: successful operation
29956 $ref: "#/getDefinitions/vnfc"
29958 description: Response codes found in [response codes](https://wiki.onap.org/).
29962 description: Unique ID of vnfc.
29965 example: __VNFC-NAME__
29969 summary: create or update an existing vnfc
29971 Create or update an existing vnfc.
29973 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29974 operationId: createOrUpdateNetworkVnfcsVnfc
29983 description: Response codes found in [response codes](https://wiki.onap.org/).
29987 description: Unique ID of vnfc.
29990 example: __VNFC-NAME__
29993 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfc.json)
29996 $ref: "#/definitions/vnfc"
30000 summary: update an existing vnfc
30002 Update an existing vnfc
30004 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30005 The PUT operation will entirely replace an existing object.
30006 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30008 Other differences between PUT and PATCH are:
30010 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30011 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30012 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30013 operationId: UpdateNetworkVnfcsVnfc
30022 description: Response codes found in [response codes](https://wiki.onap.org/).
30026 description: Unique ID of vnfc.
30029 example: __VNFC-NAME__
30032 description: vnfc object that needs to be updated.
30035 $ref: "#/patchDefinitions/vnfc"
30039 summary: delete an existing vnfc
30040 description: delete an existing vnfc
30041 operationId: deleteNetworkVnfcsVnfc
30050 description: Response codes found in [response codes](https://wiki.onap.org/).
30054 description: Unique ID of vnfc.
30057 example: __VNFC-NAME__
30058 - name: resource-version
30060 description: resource-version for concurrency
30067 summary: returns vnfcs
30068 description: returns vnfcs
30069 operationId: getNetworkVnfcs
30075 description: successful operation
30077 $ref: "#/getDefinitions/vnfcs"
30079 description: Response codes found in [response codes](https://wiki.onap.org/).
30086 - name: nfc-naming-code
30091 - name: nfc-function
30096 - name: prov-status
30101 - name: ipaddress-v4-oam-vip
30111 - name: is-closed-loop-disabled
30116 - name: group-notation
30121 - name: model-invariant-id
30126 - name: model-version-id
30131 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
30135 summary: see node definition for valid relationships
30136 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
30145 description: Response codes found in [response codes](https://wiki.onap.org/).
30149 description: Network ID, should be uuid. Unique across A&AI.
30152 example: __NETWORK-ID__
30155 description: Subnet ID, should be UUID.
30158 example: __SUBNET-ID__
30159 - name: host-route-id
30161 description: host-route id
30164 example: __HOST-ROUTE-ID__
30167 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
30170 $ref: "#/definitions/relationship"
30174 summary: delete an existing relationship
30175 description: delete an existing relationship
30176 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
30185 description: Response codes found in [response codes](https://wiki.onap.org/).
30189 description: Network ID, should be uuid. Unique across A&AI.
30192 example: __NETWORK-ID__
30195 description: Subnet ID, should be UUID.
30198 example: __SUBNET-ID__
30199 - name: host-route-id
30201 description: host-route id
30204 example: __HOST-ROUTE-ID__
30205 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
30209 summary: returns host-route
30210 description: returns host-route
30211 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30217 description: successful operation
30219 $ref: "#/getDefinitions/host-route"
30221 description: Response codes found in [response codes](https://wiki.onap.org/).
30225 description: Network ID, should be uuid. Unique across A&AI.
30228 example: __NETWORK-ID__
30231 description: Subnet ID, should be UUID.
30234 example: __SUBNET-ID__
30235 - name: host-route-id
30237 description: host-route id
30240 example: __HOST-ROUTE-ID__
30244 summary: create or update an existing host-route
30246 Create or update an existing host-route.
30248 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30249 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30258 description: Response codes found in [response codes](https://wiki.onap.org/).
30262 description: Network ID, should be uuid. Unique across A&AI.
30265 example: __NETWORK-ID__
30268 description: Subnet ID, should be UUID.
30271 example: __SUBNET-ID__
30272 - name: host-route-id
30274 description: host-route id
30277 example: __HOST-ROUTE-ID__
30280 description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
30283 $ref: "#/definitions/host-route"
30287 summary: update an existing host-route
30289 Update an existing host-route
30291 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30292 The PUT operation will entirely replace an existing object.
30293 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30295 Other differences between PUT and PATCH are:
30297 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30298 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30299 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30300 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30309 description: Response codes found in [response codes](https://wiki.onap.org/).
30313 description: Network ID, should be uuid. Unique across A&AI.
30316 example: __NETWORK-ID__
30319 description: Subnet ID, should be UUID.
30322 example: __SUBNET-ID__
30323 - name: host-route-id
30325 description: host-route id
30328 example: __HOST-ROUTE-ID__
30331 description: host-route object that needs to be updated.
30334 $ref: "#/patchDefinitions/host-route"
30338 summary: delete an existing host-route
30339 description: delete an existing host-route
30340 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30349 description: Response codes found in [response codes](https://wiki.onap.org/).
30353 description: Network ID, should be uuid. Unique across A&AI.
30356 example: __NETWORK-ID__
30359 description: Subnet ID, should be UUID.
30362 example: __SUBNET-ID__
30363 - name: host-route-id
30365 description: host-route id
30368 example: __HOST-ROUTE-ID__
30369 - name: resource-version
30371 description: resource-version for concurrency
30374 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
30378 summary: returns host-routes
30379 description: returns host-routes
30380 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
30386 description: successful operation
30388 $ref: "#/getDefinitions/host-routes"
30390 description: Response codes found in [response codes](https://wiki.onap.org/).
30394 description: Network ID, should be uuid. Unique across A&AI.
30397 example: __NETWORK-ID__
30400 description: Subnet ID, should be UUID.
30403 example: __SUBNET-ID__
30404 - name: host-route-id
30409 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
30413 summary: see node definition for valid relationships
30414 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
30423 description: Response codes found in [response codes](https://wiki.onap.org/).
30427 description: Network ID, should be uuid. Unique across A&AI.
30430 example: __NETWORK-ID__
30433 description: Subnet ID, should be UUID.
30436 example: __SUBNET-ID__
30439 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
30442 $ref: "#/definitions/relationship"
30446 summary: delete an existing relationship
30447 description: delete an existing relationship
30448 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
30457 description: Response codes found in [response codes](https://wiki.onap.org/).
30461 description: Network ID, should be uuid. Unique across A&AI.
30464 example: __NETWORK-ID__
30467 description: Subnet ID, should be UUID.
30470 example: __SUBNET-ID__
30471 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
30475 summary: returns subnet
30476 description: returns subnet
30477 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
30483 description: successful operation
30485 $ref: "#/getDefinitions/subnet"
30487 description: Response codes found in [response codes](https://wiki.onap.org/).
30491 description: Network ID, should be uuid. Unique across A&AI.
30494 example: __NETWORK-ID__
30497 description: Subnet ID, should be UUID.
30500 example: __SUBNET-ID__
30504 summary: create or update an existing subnet
30506 Create or update an existing subnet.
30508 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30509 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
30518 description: Response codes found in [response codes](https://wiki.onap.org/).
30522 description: Network ID, should be uuid. Unique across A&AI.
30525 example: __NETWORK-ID__
30528 description: Subnet ID, should be UUID.
30531 example: __SUBNET-ID__
30534 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
30537 $ref: "#/definitions/subnet"
30541 summary: update an existing subnet
30543 Update an existing subnet
30545 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30546 The PUT operation will entirely replace an existing object.
30547 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30549 Other differences between PUT and PATCH are:
30551 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30552 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30553 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30554 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
30563 description: Response codes found in [response codes](https://wiki.onap.org/).
30567 description: Network ID, should be uuid. Unique across A&AI.
30570 example: __NETWORK-ID__
30573 description: Subnet ID, should be UUID.
30576 example: __SUBNET-ID__
30579 description: subnet object that needs to be updated.
30582 $ref: "#/patchDefinitions/subnet"
30586 summary: delete an existing subnet
30587 description: delete an existing subnet
30588 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
30597 description: Response codes found in [response codes](https://wiki.onap.org/).
30601 description: Network ID, should be uuid. Unique across A&AI.
30604 example: __NETWORK-ID__
30607 description: Subnet ID, should be UUID.
30610 example: __SUBNET-ID__
30611 - name: resource-version
30613 description: resource-version for concurrency
30616 /network/l3-networks/l3-network/{network-id}/subnets:
30620 summary: returns subnets
30621 description: returns subnets
30622 operationId: getNetworkL3NetworksL3NetworkSubnets
30628 description: successful operation
30630 $ref: "#/getDefinitions/subnets"
30632 description: Response codes found in [response codes](https://wiki.onap.org/).
30636 description: Network ID, should be uuid. Unique across A&AI.
30639 example: __NETWORK-ID__
30645 - name: subnet-name
30650 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
30654 summary: see node definition for valid relationships
30655 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
30664 description: Response codes found in [response codes](https://wiki.onap.org/).
30668 description: Network ID, should be uuid. Unique across A&AI.
30671 example: __NETWORK-ID__
30672 - name: vlan-id-inner
30678 example: __VLAN-ID-INNER__
30681 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
30684 $ref: "#/definitions/relationship"
30688 summary: delete an existing relationship
30689 description: delete an existing relationship
30690 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
30699 description: Response codes found in [response codes](https://wiki.onap.org/).
30703 description: Network ID, should be uuid. Unique across A&AI.
30706 example: __NETWORK-ID__
30707 - name: vlan-id-inner
30713 example: __VLAN-ID-INNER__
30714 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
30718 summary: returns ctag-assignment
30719 description: returns ctag-assignment
30720 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30726 description: successful operation
30728 $ref: "#/getDefinitions/ctag-assignment"
30730 description: Response codes found in [response codes](https://wiki.onap.org/).
30734 description: Network ID, should be uuid. Unique across A&AI.
30737 example: __NETWORK-ID__
30738 - name: vlan-id-inner
30744 example: __VLAN-ID-INNER__
30748 summary: create or update an existing ctag-assignment
30750 Create or update an existing ctag-assignment.
30752 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30753 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30762 description: Response codes found in [response codes](https://wiki.onap.org/).
30766 description: Network ID, should be uuid. Unique across A&AI.
30769 example: __NETWORK-ID__
30770 - name: vlan-id-inner
30776 example: __VLAN-ID-INNER__
30779 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
30782 $ref: "#/definitions/ctag-assignment"
30786 summary: update an existing ctag-assignment
30788 Update an existing ctag-assignment
30790 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30791 The PUT operation will entirely replace an existing object.
30792 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30794 Other differences between PUT and PATCH are:
30796 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30797 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30798 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30799 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30808 description: Response codes found in [response codes](https://wiki.onap.org/).
30812 description: Network ID, should be uuid. Unique across A&AI.
30815 example: __NETWORK-ID__
30816 - name: vlan-id-inner
30822 example: __VLAN-ID-INNER__
30825 description: ctag-assignment object that needs to be updated.
30828 $ref: "#/patchDefinitions/ctag-assignment"
30832 summary: delete an existing ctag-assignment
30833 description: delete an existing ctag-assignment
30834 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30843 description: Response codes found in [response codes](https://wiki.onap.org/).
30847 description: Network ID, should be uuid. Unique across A&AI.
30850 example: __NETWORK-ID__
30851 - name: vlan-id-inner
30857 example: __VLAN-ID-INNER__
30858 - name: resource-version
30860 description: resource-version for concurrency
30863 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
30867 summary: returns ctag-assignments
30868 description: returns ctag-assignments
30869 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
30875 description: successful operation
30877 $ref: "#/getDefinitions/ctag-assignments"
30879 description: Response codes found in [response codes](https://wiki.onap.org/).
30883 description: Network ID, should be uuid. Unique across A&AI.
30886 example: __NETWORK-ID__
30887 - name: vlan-id-inner
30893 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
30897 summary: see node definition for valid relationships
30898 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30907 description: Response codes found in [response codes](https://wiki.onap.org/).
30911 description: Network ID, should be uuid. Unique across A&AI.
30914 example: __NETWORK-ID__
30915 - name: segmentation-id
30917 description: Route Table Reference id, UUID assigned to this instance.
30920 example: __SEGMENTATION-ID__
30923 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30926 $ref: "#/definitions/relationship"
30930 summary: delete an existing relationship
30931 description: delete an existing relationship
30932 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30941 description: Response codes found in [response codes](https://wiki.onap.org/).
30945 description: Network ID, should be uuid. Unique across A&AI.
30948 example: __NETWORK-ID__
30949 - name: segmentation-id
30951 description: Route Table Reference id, UUID assigned to this instance.
30954 example: __SEGMENTATION-ID__
30955 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
30959 summary: returns segmentation-assignment
30960 description: returns segmentation-assignment
30961 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30967 description: successful operation
30969 $ref: "#/getDefinitions/segmentation-assignment"
30971 description: Response codes found in [response codes](https://wiki.onap.org/).
30975 description: Network ID, should be uuid. Unique across A&AI.
30978 example: __NETWORK-ID__
30979 - name: segmentation-id
30981 description: Route Table Reference id, UUID assigned to this instance.
30984 example: __SEGMENTATION-ID__
30988 summary: create or update an existing segmentation-assignment
30990 Create or update an existing segmentation-assignment.
30992 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30993 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
31002 description: Response codes found in [response codes](https://wiki.onap.org/).
31006 description: Network ID, should be uuid. Unique across A&AI.
31009 example: __NETWORK-ID__
31010 - name: segmentation-id
31012 description: Route Table Reference id, UUID assigned to this instance.
31015 example: __SEGMENTATION-ID__
31018 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
31021 $ref: "#/definitions/segmentation-assignment"
31025 summary: update an existing segmentation-assignment
31027 Update an existing segmentation-assignment
31029 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31030 The PUT operation will entirely replace an existing object.
31031 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31033 Other differences between PUT and PATCH are:
31035 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31036 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31037 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31038 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
31047 description: Response codes found in [response codes](https://wiki.onap.org/).
31051 description: Network ID, should be uuid. Unique across A&AI.
31054 example: __NETWORK-ID__
31055 - name: segmentation-id
31057 description: Route Table Reference id, UUID assigned to this instance.
31060 example: __SEGMENTATION-ID__
31063 description: segmentation-assignment object that needs to be updated.
31066 $ref: "#/patchDefinitions/segmentation-assignment"
31070 summary: delete an existing segmentation-assignment
31071 description: delete an existing segmentation-assignment
31072 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
31081 description: Response codes found in [response codes](https://wiki.onap.org/).
31085 description: Network ID, should be uuid. Unique across A&AI.
31088 example: __NETWORK-ID__
31089 - name: segmentation-id
31091 description: Route Table Reference id, UUID assigned to this instance.
31094 example: __SEGMENTATION-ID__
31095 - name: resource-version
31097 description: resource-version for concurrency
31100 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
31104 summary: returns segmentation-assignments
31105 description: returns segmentation-assignments
31106 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
31112 description: successful operation
31114 $ref: "#/getDefinitions/segmentation-assignments"
31116 description: Response codes found in [response codes](https://wiki.onap.org/).
31120 description: Network ID, should be uuid. Unique across A&AI.
31123 example: __NETWORK-ID__
31124 - name: segmentation-id
31129 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
31133 summary: see node definition for valid relationships
31134 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
31143 description: Response codes found in [response codes](https://wiki.onap.org/).
31147 description: Network ID, should be uuid. Unique across A&AI.
31150 example: __NETWORK-ID__
31153 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json)
31156 $ref: "#/definitions/relationship"
31160 summary: delete an existing relationship
31161 description: delete an existing relationship
31162 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
31171 description: Response codes found in [response codes](https://wiki.onap.org/).
31175 description: Network ID, should be uuid. Unique across A&AI.
31178 example: __NETWORK-ID__
31179 /network/l3-networks/l3-network/{network-id}:
31183 summary: returns l3-network
31184 description: returns l3-network
31185 operationId: getNetworkL3NetworksL3Network
31191 description: successful operation
31193 $ref: "#/getDefinitions/l3-network"
31195 description: Response codes found in [response codes](https://wiki.onap.org/).
31199 description: Network ID, should be uuid. Unique across A&AI.
31202 example: __NETWORK-ID__
31206 summary: create or update an existing l3-network
31208 Create or update an existing l3-network.
31210 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31211 operationId: createOrUpdateNetworkL3NetworksL3Network
31220 description: Response codes found in [response codes](https://wiki.onap.org/).
31224 description: Network ID, should be uuid. Unique across A&AI.
31227 example: __NETWORK-ID__
31230 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json)
31233 $ref: "#/definitions/l3-network"
31237 summary: update an existing l3-network
31239 Update an existing l3-network
31241 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31242 The PUT operation will entirely replace an existing object.
31243 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31245 Other differences between PUT and PATCH are:
31247 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31248 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31249 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31250 operationId: UpdateNetworkL3NetworksL3Network
31259 description: Response codes found in [response codes](https://wiki.onap.org/).
31263 description: Network ID, should be uuid. Unique across A&AI.
31266 example: __NETWORK-ID__
31269 description: l3-network object that needs to be updated.
31272 $ref: "#/patchDefinitions/l3-network"
31276 summary: delete an existing l3-network
31277 description: delete an existing l3-network
31278 operationId: deleteNetworkL3NetworksL3Network
31287 description: Response codes found in [response codes](https://wiki.onap.org/).
31291 description: Network ID, should be uuid. Unique across A&AI.
31294 example: __NETWORK-ID__
31295 - name: resource-version
31297 description: resource-version for concurrency
31300 /network/l3-networks:
31304 summary: returns l3-networks
31305 description: returns l3-networks
31306 operationId: getNetworkL3Networks
31312 description: successful operation
31314 $ref: "#/getDefinitions/l3-networks"
31316 description: Response codes found in [response codes](https://wiki.onap.org/).
31323 - name: network-name
31328 - name: network-role
31338 - name: heat-stack-id
31343 - name: contrail-network-fqdn
31348 - name: model-invariant-id
31353 - name: model-version-id
31358 - name: widget-model-id
31363 - name: widget-model-version
31368 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
31372 summary: see node definition for valid relationships
31373 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
31382 description: Response codes found in [response codes](https://wiki.onap.org/).
31384 - name: network-policy-id
31386 description: UUID representing unique key to this instance
31389 example: __NETWORK-POLICY-ID__
31392 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json)
31395 $ref: "#/definitions/relationship"
31399 summary: delete an existing relationship
31400 description: delete an existing relationship
31401 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
31410 description: Response codes found in [response codes](https://wiki.onap.org/).
31412 - name: network-policy-id
31414 description: UUID representing unique key to this instance
31417 example: __NETWORK-POLICY-ID__
31418 /network/network-policies/network-policy/{network-policy-id}:
31422 summary: returns network-policy
31423 description: returns network-policy
31424 operationId: getNetworkNetworkPoliciesNetworkPolicy
31430 description: successful operation
31432 $ref: "#/getDefinitions/network-policy"
31434 description: Response codes found in [response codes](https://wiki.onap.org/).
31436 - name: network-policy-id
31438 description: UUID representing unique key to this instance
31441 example: __NETWORK-POLICY-ID__
31445 summary: create or update an existing network-policy
31447 Create or update an existing network-policy.
31449 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31450 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
31459 description: Response codes found in [response codes](https://wiki.onap.org/).
31461 - name: network-policy-id
31463 description: UUID representing unique key to this instance
31466 example: __NETWORK-POLICY-ID__
31469 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json)
31472 $ref: "#/definitions/network-policy"
31476 summary: update an existing network-policy
31478 Update an existing network-policy
31480 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31481 The PUT operation will entirely replace an existing object.
31482 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31484 Other differences between PUT and PATCH are:
31486 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31487 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31488 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31489 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
31498 description: Response codes found in [response codes](https://wiki.onap.org/).
31500 - name: network-policy-id
31502 description: UUID representing unique key to this instance
31505 example: __NETWORK-POLICY-ID__
31508 description: network-policy object that needs to be updated.
31511 $ref: "#/patchDefinitions/network-policy"
31515 summary: delete an existing network-policy
31516 description: delete an existing network-policy
31517 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
31526 description: Response codes found in [response codes](https://wiki.onap.org/).
31528 - name: network-policy-id
31530 description: UUID representing unique key to this instance
31533 example: __NETWORK-POLICY-ID__
31534 - name: resource-version
31536 description: resource-version for concurrency
31539 /network/network-policies:
31543 summary: returns network-policies
31544 description: returns network-policies
31545 operationId: getNetworkNetworkPolicies
31551 description: successful operation
31553 $ref: "#/getDefinitions/network-policies"
31555 description: Response codes found in [response codes](https://wiki.onap.org/).
31557 - name: network-policy-id
31562 - name: network-policy-fqdn
31567 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
31571 summary: see node definition for valid relationships
31572 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
31581 description: Response codes found in [response codes](https://wiki.onap.org/).
31585 description: Unique id of VNF. This is unique across the graph.
31588 example: __VNF-ID__
31591 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)
31594 $ref: "#/definitions/relationship"
31598 summary: delete an existing relationship
31599 description: delete an existing relationship
31600 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
31609 description: Response codes found in [response codes](https://wiki.onap.org/).
31613 description: Unique id of VNF. This is unique across the graph.
31616 example: __VNF-ID__
31617 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
31621 summary: see node definition for valid relationships
31622 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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: vlan-interface
31647 description: String that identifies the interface
31650 example: __VLAN-INTERFACE__
31653 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
31656 $ref: "#/definitions/relationship"
31660 summary: delete an existing relationship
31661 description: delete an existing relationship
31662 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
31671 description: Response codes found in [response codes](https://wiki.onap.org/).
31675 description: Unique id of VNF. This is unique across the graph.
31678 example: __VNF-ID__
31679 - name: interface-name
31681 description: Name given to the interface
31684 example: __INTERFACE-NAME__
31685 - name: vlan-interface
31687 description: String that identifies the interface
31690 example: __VLAN-INTERFACE__
31691 /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:
31695 summary: see node definition for valid relationships
31696 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
31705 description: Response codes found in [response codes](https://wiki.onap.org/).
31709 description: Unique id of VNF. This is unique across the graph.
31712 example: __VNF-ID__
31713 - name: interface-name
31715 description: Name given to the interface
31718 example: __INTERFACE-NAME__
31719 - name: vlan-interface
31721 description: String that identifies the interface
31724 example: __VLAN-INTERFACE__
31725 - name: l3-interface-ipv4-address
31727 description: IP address
31730 example: __L3-INTERFACE-IPV4-ADDRESS__
31733 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31736 $ref: "#/definitions/relationship"
31740 summary: delete an existing relationship
31741 description: delete an existing relationship
31742 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
31751 description: Response codes found in [response codes](https://wiki.onap.org/).
31755 description: Unique id of VNF. This is unique across the graph.
31758 example: __VNF-ID__
31759 - name: interface-name
31761 description: Name given to the interface
31764 example: __INTERFACE-NAME__
31765 - name: vlan-interface
31767 description: String that identifies the interface
31770 example: __VLAN-INTERFACE__
31771 - name: l3-interface-ipv4-address
31773 description: IP address
31776 example: __L3-INTERFACE-IPV4-ADDRESS__
31777 /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}:
31781 summary: returns l3-interface-ipv4-address-list
31782 description: returns l3-interface-ipv4-address-list
31783 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31789 description: successful operation
31791 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31793 description: Response codes found in [response codes](https://wiki.onap.org/).
31797 description: Unique id of VNF. This is unique across the graph.
31800 example: __VNF-ID__
31801 - name: interface-name
31803 description: Name given to the interface
31806 example: __INTERFACE-NAME__
31807 - name: vlan-interface
31809 description: String that identifies the interface
31812 example: __VLAN-INTERFACE__
31813 - name: l3-interface-ipv4-address
31815 description: IP address
31818 example: __L3-INTERFACE-IPV4-ADDRESS__
31822 summary: create or update an existing l3-interface-ipv4-address-list
31824 Create or update an existing l3-interface-ipv4-address-list.
31826 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31827 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31836 description: Response codes found in [response codes](https://wiki.onap.org/).
31840 description: Unique id of VNF. This is unique across the graph.
31843 example: __VNF-ID__
31844 - name: interface-name
31846 description: Name given to the interface
31849 example: __INTERFACE-NAME__
31850 - name: vlan-interface
31852 description: String that identifies the interface
31855 example: __VLAN-INTERFACE__
31856 - name: l3-interface-ipv4-address
31858 description: IP address
31861 example: __L3-INTERFACE-IPV4-ADDRESS__
31864 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31867 $ref: "#/definitions/l3-interface-ipv4-address-list"
31871 summary: update an existing l3-interface-ipv4-address-list
31873 Update an existing l3-interface-ipv4-address-list
31875 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31876 The PUT operation will entirely replace an existing object.
31877 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31879 Other differences between PUT and PATCH are:
31881 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31882 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31883 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31884 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31893 description: Response codes found in [response codes](https://wiki.onap.org/).
31897 description: Unique id of VNF. This is unique across the graph.
31900 example: __VNF-ID__
31901 - name: interface-name
31903 description: Name given to the interface
31906 example: __INTERFACE-NAME__
31907 - name: vlan-interface
31909 description: String that identifies the interface
31912 example: __VLAN-INTERFACE__
31913 - name: l3-interface-ipv4-address
31915 description: IP address
31918 example: __L3-INTERFACE-IPV4-ADDRESS__
31921 description: l3-interface-ipv4-address-list object that needs to be updated.
31924 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31928 summary: delete an existing l3-interface-ipv4-address-list
31929 description: delete an existing l3-interface-ipv4-address-list
31930 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31939 description: Response codes found in [response codes](https://wiki.onap.org/).
31943 description: Unique id of VNF. This is unique across the graph.
31946 example: __VNF-ID__
31947 - name: interface-name
31949 description: Name given to the interface
31952 example: __INTERFACE-NAME__
31953 - name: vlan-interface
31955 description: String that identifies the interface
31958 example: __VLAN-INTERFACE__
31959 - name: l3-interface-ipv4-address
31961 description: IP address
31964 example: __L3-INTERFACE-IPV4-ADDRESS__
31965 - name: resource-version
31967 description: resource-version for concurrency
31970 /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:
31974 summary: see node definition for valid relationships
31975 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31984 description: Response codes found in [response codes](https://wiki.onap.org/).
31988 description: Unique id of VNF. This is unique across the graph.
31991 example: __VNF-ID__
31992 - name: interface-name
31994 description: Name given to the interface
31997 example: __INTERFACE-NAME__
31998 - name: vlan-interface
32000 description: String that identifies the interface
32003 example: __VLAN-INTERFACE__
32004 - name: l3-interface-ipv6-address
32006 description: IP address
32009 example: __L3-INTERFACE-IPV6-ADDRESS__
32012 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32015 $ref: "#/definitions/relationship"
32019 summary: delete an existing relationship
32020 description: delete an existing relationship
32021 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
32030 description: Response codes found in [response codes](https://wiki.onap.org/).
32034 description: Unique id of VNF. This is unique across the graph.
32037 example: __VNF-ID__
32038 - name: interface-name
32040 description: Name given to the interface
32043 example: __INTERFACE-NAME__
32044 - name: vlan-interface
32046 description: String that identifies the interface
32049 example: __VLAN-INTERFACE__
32050 - name: l3-interface-ipv6-address
32052 description: IP address
32055 example: __L3-INTERFACE-IPV6-ADDRESS__
32056 /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}:
32060 summary: returns l3-interface-ipv6-address-list
32061 description: returns l3-interface-ipv6-address-list
32062 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32068 description: successful operation
32070 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32072 description: Response codes found in [response codes](https://wiki.onap.org/).
32076 description: Unique id of VNF. This is unique across the graph.
32079 example: __VNF-ID__
32080 - name: interface-name
32082 description: Name given to the interface
32085 example: __INTERFACE-NAME__
32086 - name: vlan-interface
32088 description: String that identifies the interface
32091 example: __VLAN-INTERFACE__
32092 - name: l3-interface-ipv6-address
32094 description: IP address
32097 example: __L3-INTERFACE-IPV6-ADDRESS__
32101 summary: create or update an existing l3-interface-ipv6-address-list
32103 Create or update an existing l3-interface-ipv6-address-list.
32105 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32106 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32115 description: Response codes found in [response codes](https://wiki.onap.org/).
32119 description: Unique id of VNF. This is unique across the graph.
32122 example: __VNF-ID__
32123 - name: interface-name
32125 description: Name given to the interface
32128 example: __INTERFACE-NAME__
32129 - name: vlan-interface
32131 description: String that identifies the interface
32134 example: __VLAN-INTERFACE__
32135 - name: l3-interface-ipv6-address
32137 description: IP address
32140 example: __L3-INTERFACE-IPV6-ADDRESS__
32143 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32146 $ref: "#/definitions/l3-interface-ipv6-address-list"
32150 summary: update an existing l3-interface-ipv6-address-list
32152 Update an existing l3-interface-ipv6-address-list
32154 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32155 The PUT operation will entirely replace an existing object.
32156 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32158 Other differences between PUT and PATCH are:
32160 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32161 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32162 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32163 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32172 description: Response codes found in [response codes](https://wiki.onap.org/).
32176 description: Unique id of VNF. This is unique across the graph.
32179 example: __VNF-ID__
32180 - name: interface-name
32182 description: Name given to the interface
32185 example: __INTERFACE-NAME__
32186 - name: vlan-interface
32188 description: String that identifies the interface
32191 example: __VLAN-INTERFACE__
32192 - name: l3-interface-ipv6-address
32194 description: IP address
32197 example: __L3-INTERFACE-IPV6-ADDRESS__
32200 description: l3-interface-ipv6-address-list object that needs to be updated.
32203 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32207 summary: delete an existing l3-interface-ipv6-address-list
32208 description: delete an existing l3-interface-ipv6-address-list
32209 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32218 description: Response codes found in [response codes](https://wiki.onap.org/).
32222 description: Unique id of VNF. This is unique across the graph.
32225 example: __VNF-ID__
32226 - name: interface-name
32228 description: Name given to the interface
32231 example: __INTERFACE-NAME__
32232 - name: vlan-interface
32234 description: String that identifies the interface
32237 example: __VLAN-INTERFACE__
32238 - name: l3-interface-ipv6-address
32240 description: IP address
32243 example: __L3-INTERFACE-IPV6-ADDRESS__
32244 - name: resource-version
32246 description: resource-version for concurrency
32249 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
32253 summary: returns vlan
32254 description: returns vlan
32255 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32261 description: successful operation
32263 $ref: "#/getDefinitions/vlan"
32265 description: Response codes found in [response codes](https://wiki.onap.org/).
32269 description: Unique id of VNF. This is unique across the graph.
32272 example: __VNF-ID__
32273 - name: interface-name
32275 description: Name given to the interface
32278 example: __INTERFACE-NAME__
32279 - name: vlan-interface
32281 description: String that identifies the interface
32284 example: __VLAN-INTERFACE__
32288 summary: create or update an existing vlan
32290 Create or update an existing vlan.
32292 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32293 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
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 given to the interface
32315 example: __INTERFACE-NAME__
32316 - name: vlan-interface
32318 description: String that identifies the interface
32321 example: __VLAN-INTERFACE__
32324 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
32327 $ref: "#/definitions/vlan"
32331 summary: update an existing vlan
32333 Update an existing vlan
32335 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32336 The PUT operation will entirely replace an existing object.
32337 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32339 Other differences between PUT and PATCH are:
32341 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32342 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32343 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32344 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32353 description: Response codes found in [response codes](https://wiki.onap.org/).
32357 description: Unique id of VNF. This is unique across the graph.
32360 example: __VNF-ID__
32361 - name: interface-name
32363 description: Name given to the interface
32366 example: __INTERFACE-NAME__
32367 - name: vlan-interface
32369 description: String that identifies the interface
32372 example: __VLAN-INTERFACE__
32375 description: vlan object that needs to be updated.
32378 $ref: "#/patchDefinitions/vlan"
32382 summary: delete an existing vlan
32383 description: delete an existing vlan
32384 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32393 description: Response codes found in [response codes](https://wiki.onap.org/).
32397 description: Unique id of VNF. This is unique across the graph.
32400 example: __VNF-ID__
32401 - name: interface-name
32403 description: Name given to the interface
32406 example: __INTERFACE-NAME__
32407 - name: vlan-interface
32409 description: String that identifies the interface
32412 example: __VLAN-INTERFACE__
32413 - name: resource-version
32415 description: resource-version for concurrency
32418 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
32422 summary: returns vlans
32423 description: returns vlans
32424 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
32430 description: successful operation
32432 $ref: "#/getDefinitions/vlans"
32434 description: Response codes found in [response codes](https://wiki.onap.org/).
32438 description: Unique id of VNF. This is unique across the graph.
32441 example: __VNF-ID__
32442 - name: interface-name
32444 description: Name given to the interface
32447 example: __INTERFACE-NAME__
32448 - name: vlan-interface
32453 - name: vlan-id-inner
32464 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
32468 summary: see node definition for valid relationships
32469 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32478 description: Response codes found in [response codes](https://wiki.onap.org/).
32482 description: Unique id of VNF. This is unique across the graph.
32485 example: __VNF-ID__
32486 - name: interface-name
32488 description: Name given to the interface
32491 example: __INTERFACE-NAME__
32494 description: PCI ID used to identify the sriov-vf
32497 example: __PCI-ID__
32500 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32503 $ref: "#/definitions/relationship"
32507 summary: delete an existing relationship
32508 description: delete an existing relationship
32509 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32518 description: Response codes found in [response codes](https://wiki.onap.org/).
32522 description: Unique id of VNF. This is unique across the graph.
32525 example: __VNF-ID__
32526 - name: interface-name
32528 description: Name given to the interface
32531 example: __INTERFACE-NAME__
32534 description: PCI ID used to identify the sriov-vf
32537 example: __PCI-ID__
32538 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
32542 summary: returns sriov-vf
32543 description: returns sriov-vf
32544 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32550 description: successful operation
32552 $ref: "#/getDefinitions/sriov-vf"
32554 description: Response codes found in [response codes](https://wiki.onap.org/).
32558 description: Unique id of VNF. This is unique across the graph.
32561 example: __VNF-ID__
32562 - name: interface-name
32564 description: Name given to the interface
32567 example: __INTERFACE-NAME__
32570 description: PCI ID used to identify the sriov-vf
32573 example: __PCI-ID__
32577 summary: create or update an existing sriov-vf
32579 Create or update an existing sriov-vf.
32581 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32582 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32591 description: Response codes found in [response codes](https://wiki.onap.org/).
32595 description: Unique id of VNF. This is unique across the graph.
32598 example: __VNF-ID__
32599 - name: interface-name
32601 description: Name given to the interface
32604 example: __INTERFACE-NAME__
32607 description: PCI ID used to identify the sriov-vf
32610 example: __PCI-ID__
32613 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32616 $ref: "#/definitions/sriov-vf"
32620 summary: update an existing sriov-vf
32622 Update an existing sriov-vf
32624 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32625 The PUT operation will entirely replace an existing object.
32626 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32628 Other differences between PUT and PATCH are:
32630 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32631 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32632 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32633 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32642 description: Response codes found in [response codes](https://wiki.onap.org/).
32646 description: Unique id of VNF. This is unique across the graph.
32649 example: __VNF-ID__
32650 - name: interface-name
32652 description: Name given to the interface
32655 example: __INTERFACE-NAME__
32658 description: PCI ID used to identify the sriov-vf
32661 example: __PCI-ID__
32664 description: sriov-vf object that needs to be updated.
32667 $ref: "#/patchDefinitions/sriov-vf"
32671 summary: delete an existing sriov-vf
32672 description: delete an existing sriov-vf
32673 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32682 description: Response codes found in [response codes](https://wiki.onap.org/).
32686 description: Unique id of VNF. This is unique across the graph.
32689 example: __VNF-ID__
32690 - name: interface-name
32692 description: Name given to the interface
32695 example: __INTERFACE-NAME__
32698 description: PCI ID used to identify the sriov-vf
32701 example: __PCI-ID__
32702 - name: resource-version
32704 description: resource-version for concurrency
32707 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32711 summary: returns sriov-vfs
32712 description: returns sriov-vfs
32713 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
32719 description: successful operation
32721 $ref: "#/getDefinitions/sriov-vfs"
32723 description: Response codes found in [response codes](https://wiki.onap.org/).
32727 description: Unique id of VNF. This is unique across the graph.
32730 example: __VNF-ID__
32731 - name: interface-name
32733 description: Name given to the interface
32736 example: __INTERFACE-NAME__
32742 - name: vf-vlan-filter
32747 - name: vf-mac-filter
32752 - name: vf-vlan-strip
32757 - name: neutron-network-id
32762 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32766 summary: see node definition for valid relationships
32767 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32776 description: Response codes found in [response codes](https://wiki.onap.org/).
32780 description: Unique id of VNF. This is unique across the graph.
32783 example: __VNF-ID__
32784 - name: interface-name
32786 description: Name given to the interface
32789 example: __INTERFACE-NAME__
32792 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
32795 $ref: "#/definitions/relationship"
32799 summary: delete an existing relationship
32800 description: delete an existing relationship
32801 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32810 description: Response codes found in [response codes](https://wiki.onap.org/).
32814 description: Unique id of VNF. This is unique across the graph.
32817 example: __VNF-ID__
32818 - name: interface-name
32820 description: Name given to the interface
32823 example: __INTERFACE-NAME__
32824 /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:
32828 summary: see node definition for valid relationships
32829 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32838 description: Response codes found in [response codes](https://wiki.onap.org/).
32842 description: Unique id of VNF. This is unique across the graph.
32845 example: __VNF-ID__
32846 - name: interface-name
32848 description: Name given to the interface
32851 example: __INTERFACE-NAME__
32852 - name: l3-interface-ipv4-address
32854 description: IP address
32857 example: __L3-INTERFACE-IPV4-ADDRESS__
32860 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32863 $ref: "#/definitions/relationship"
32867 summary: delete an existing relationship
32868 description: delete an existing relationship
32869 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32878 description: Response codes found in [response codes](https://wiki.onap.org/).
32882 description: Unique id of VNF. This is unique across the graph.
32885 example: __VNF-ID__
32886 - name: interface-name
32888 description: Name given to the interface
32891 example: __INTERFACE-NAME__
32892 - name: l3-interface-ipv4-address
32894 description: IP address
32897 example: __L3-INTERFACE-IPV4-ADDRESS__
32898 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32902 summary: returns l3-interface-ipv4-address-list
32903 description: returns l3-interface-ipv4-address-list
32904 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32910 description: successful operation
32912 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32914 description: Response codes found in [response codes](https://wiki.onap.org/).
32918 description: Unique id of VNF. This is unique across the graph.
32921 example: __VNF-ID__
32922 - name: interface-name
32924 description: Name given to the interface
32927 example: __INTERFACE-NAME__
32928 - name: l3-interface-ipv4-address
32930 description: IP address
32933 example: __L3-INTERFACE-IPV4-ADDRESS__
32937 summary: create or update an existing l3-interface-ipv4-address-list
32939 Create or update an existing l3-interface-ipv4-address-list.
32941 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32942 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32951 description: Response codes found in [response codes](https://wiki.onap.org/).
32955 description: Unique id of VNF. This is unique across the graph.
32958 example: __VNF-ID__
32959 - name: interface-name
32961 description: Name given to the interface
32964 example: __INTERFACE-NAME__
32965 - name: l3-interface-ipv4-address
32967 description: IP address
32970 example: __L3-INTERFACE-IPV4-ADDRESS__
32973 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32976 $ref: "#/definitions/l3-interface-ipv4-address-list"
32980 summary: update an existing l3-interface-ipv4-address-list
32982 Update an existing l3-interface-ipv4-address-list
32984 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32985 The PUT operation will entirely replace an existing object.
32986 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32988 Other differences between PUT and PATCH are:
32990 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32991 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32992 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32993 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
33002 description: Response codes found in [response codes](https://wiki.onap.org/).
33006 description: Unique id of VNF. This is unique across the graph.
33009 example: __VNF-ID__
33010 - name: interface-name
33012 description: Name given to the interface
33015 example: __INTERFACE-NAME__
33016 - name: l3-interface-ipv4-address
33018 description: IP address
33021 example: __L3-INTERFACE-IPV4-ADDRESS__
33024 description: l3-interface-ipv4-address-list object that needs to be updated.
33027 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33031 summary: delete an existing l3-interface-ipv4-address-list
33032 description: delete an existing l3-interface-ipv4-address-list
33033 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
33042 description: Response codes found in [response codes](https://wiki.onap.org/).
33046 description: Unique id of VNF. This is unique across the graph.
33049 example: __VNF-ID__
33050 - name: interface-name
33052 description: Name given to the interface
33055 example: __INTERFACE-NAME__
33056 - name: l3-interface-ipv4-address
33058 description: IP address
33061 example: __L3-INTERFACE-IPV4-ADDRESS__
33062 - name: resource-version
33064 description: resource-version for concurrency
33067 /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:
33071 summary: see node definition for valid relationships
33072 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33081 description: Response codes found in [response codes](https://wiki.onap.org/).
33085 description: Unique id of VNF. This is unique across the graph.
33088 example: __VNF-ID__
33089 - name: interface-name
33091 description: Name given to the interface
33094 example: __INTERFACE-NAME__
33095 - name: l3-interface-ipv6-address
33097 description: IP address
33100 example: __L3-INTERFACE-IPV6-ADDRESS__
33103 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33106 $ref: "#/definitions/relationship"
33110 summary: delete an existing relationship
33111 description: delete an existing relationship
33112 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33121 description: Response codes found in [response codes](https://wiki.onap.org/).
33125 description: Unique id of VNF. This is unique across the graph.
33128 example: __VNF-ID__
33129 - name: interface-name
33131 description: Name given to the interface
33134 example: __INTERFACE-NAME__
33135 - name: l3-interface-ipv6-address
33137 description: IP address
33140 example: __L3-INTERFACE-IPV6-ADDRESS__
33141 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33145 summary: returns l3-interface-ipv6-address-list
33146 description: returns l3-interface-ipv6-address-list
33147 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33153 description: successful operation
33155 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33157 description: Response codes found in [response codes](https://wiki.onap.org/).
33161 description: Unique id of VNF. This is unique across the graph.
33164 example: __VNF-ID__
33165 - name: interface-name
33167 description: Name given to the interface
33170 example: __INTERFACE-NAME__
33171 - name: l3-interface-ipv6-address
33173 description: IP address
33176 example: __L3-INTERFACE-IPV6-ADDRESS__
33180 summary: create or update an existing l3-interface-ipv6-address-list
33182 Create or update an existing l3-interface-ipv6-address-list.
33184 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33185 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33194 description: Response codes found in [response codes](https://wiki.onap.org/).
33198 description: Unique id of VNF. This is unique across the graph.
33201 example: __VNF-ID__
33202 - name: interface-name
33204 description: Name given to the interface
33207 example: __INTERFACE-NAME__
33208 - name: l3-interface-ipv6-address
33210 description: IP address
33213 example: __L3-INTERFACE-IPV6-ADDRESS__
33216 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33219 $ref: "#/definitions/l3-interface-ipv6-address-list"
33223 summary: update an existing l3-interface-ipv6-address-list
33225 Update an existing l3-interface-ipv6-address-list
33227 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33228 The PUT operation will entirely replace an existing object.
33229 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33231 Other differences between PUT and PATCH are:
33233 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33234 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33235 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33236 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33245 description: Response codes found in [response codes](https://wiki.onap.org/).
33249 description: Unique id of VNF. This is unique across the graph.
33252 example: __VNF-ID__
33253 - name: interface-name
33255 description: Name given to the interface
33258 example: __INTERFACE-NAME__
33259 - name: l3-interface-ipv6-address
33261 description: IP address
33264 example: __L3-INTERFACE-IPV6-ADDRESS__
33267 description: l3-interface-ipv6-address-list object that needs to be updated.
33270 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33274 summary: delete an existing l3-interface-ipv6-address-list
33275 description: delete an existing l3-interface-ipv6-address-list
33276 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33285 description: Response codes found in [response codes](https://wiki.onap.org/).
33289 description: Unique id of VNF. This is unique across the graph.
33292 example: __VNF-ID__
33293 - name: interface-name
33295 description: Name given to the interface
33298 example: __INTERFACE-NAME__
33299 - name: l3-interface-ipv6-address
33301 description: IP address
33304 example: __L3-INTERFACE-IPV6-ADDRESS__
33305 - name: resource-version
33307 description: resource-version for concurrency
33310 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
33314 summary: returns l-interface
33315 description: returns l-interface
33316 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
33322 description: successful operation
33324 $ref: "#/getDefinitions/l-interface"
33326 description: Response codes found in [response codes](https://wiki.onap.org/).
33330 description: Unique id of VNF. This is unique across the graph.
33333 example: __VNF-ID__
33334 - name: interface-name
33336 description: Name given to the interface
33339 example: __INTERFACE-NAME__
33343 summary: create or update an existing l-interface
33345 Create or update an existing l-interface.
33347 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33348 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33357 description: Response codes found in [response codes](https://wiki.onap.org/).
33361 description: Unique id of VNF. This is unique across the graph.
33364 example: __VNF-ID__
33365 - name: interface-name
33367 description: Name given to the interface
33370 example: __INTERFACE-NAME__
33373 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
33376 $ref: "#/definitions/l-interface"
33380 summary: update an existing l-interface
33382 Update an existing l-interface
33384 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33385 The PUT operation will entirely replace an existing object.
33386 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33388 Other differences between PUT and PATCH are:
33390 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33391 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33392 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33393 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33402 description: Response codes found in [response codes](https://wiki.onap.org/).
33406 description: Unique id of VNF. This is unique across the graph.
33409 example: __VNF-ID__
33410 - name: interface-name
33412 description: Name given to the interface
33415 example: __INTERFACE-NAME__
33418 description: l-interface object that needs to be updated.
33421 $ref: "#/patchDefinitions/l-interface"
33425 summary: delete an existing l-interface
33426 description: delete an existing l-interface
33427 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
33436 description: Response codes found in [response codes](https://wiki.onap.org/).
33440 description: Unique id of VNF. This is unique across the graph.
33443 example: __VNF-ID__
33444 - name: interface-name
33446 description: Name given to the interface
33449 example: __INTERFACE-NAME__
33450 - name: resource-version
33452 description: resource-version for concurrency
33455 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
33459 summary: returns l-interfaces
33460 description: returns l-interfaces
33461 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
33467 description: successful operation
33469 $ref: "#/getDefinitions/l-interfaces"
33471 description: Response codes found in [response codes](https://wiki.onap.org/).
33475 description: Unique id of VNF. This is unique across the graph.
33478 example: __VNF-ID__
33479 - name: interface-name
33484 - name: interface-id
33494 - name: network-name
33499 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
33503 summary: see node definition for valid relationships
33504 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33513 description: Response codes found in [response codes](https://wiki.onap.org/).
33517 description: Unique id of VNF. This is unique across the graph.
33520 example: __VNF-ID__
33521 - name: interface-name
33523 description: Name that identifies the link aggregate interface
33526 example: __INTERFACE-NAME__
33529 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33532 $ref: "#/definitions/relationship"
33536 summary: delete an existing relationship
33537 description: delete an existing relationship
33538 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33547 description: Response codes found in [response codes](https://wiki.onap.org/).
33551 description: Unique id of VNF. This is unique across the graph.
33554 example: __VNF-ID__
33555 - name: interface-name
33557 description: Name that identifies the link aggregate interface
33560 example: __INTERFACE-NAME__
33561 /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:
33565 summary: see node definition for valid relationships
33566 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33575 description: Response codes found in [response codes](https://wiki.onap.org/).
33579 description: Unique id of VNF. This is unique across the graph.
33582 example: __VNF-ID__
33583 - name: interface-name
33585 description: Name that identifies the link aggregate interface
33588 example: __INTERFACE-NAME__
33589 - name: interface-name
33591 description: Name given to the interface
33594 example: __INTERFACE-NAME__
33595 - name: vlan-interface
33597 description: String that identifies the interface
33600 example: __VLAN-INTERFACE__
33603 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
33606 $ref: "#/definitions/relationship"
33610 summary: delete an existing relationship
33611 description: delete an existing relationship
33612 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33621 description: Response codes found in [response codes](https://wiki.onap.org/).
33625 description: Unique id of VNF. This is unique across the graph.
33628 example: __VNF-ID__
33629 - name: interface-name
33631 description: Name that identifies the link aggregate interface
33634 example: __INTERFACE-NAME__
33635 - name: interface-name
33637 description: Name given to the interface
33640 example: __INTERFACE-NAME__
33641 - name: vlan-interface
33643 description: String that identifies the interface
33646 example: __VLAN-INTERFACE__
33647 /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:
33651 summary: see node definition for valid relationships
33652 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33661 description: Response codes found in [response codes](https://wiki.onap.org/).
33665 description: Unique id of VNF. This is unique across the graph.
33668 example: __VNF-ID__
33669 - name: interface-name
33671 description: Name that identifies the link aggregate interface
33674 example: __INTERFACE-NAME__
33675 - name: interface-name
33677 description: Name given to the interface
33680 example: __INTERFACE-NAME__
33681 - name: vlan-interface
33683 description: String that identifies the interface
33686 example: __VLAN-INTERFACE__
33687 - name: l3-interface-ipv4-address
33689 description: IP address
33692 example: __L3-INTERFACE-IPV4-ADDRESS__
33695 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33698 $ref: "#/definitions/relationship"
33702 summary: delete an existing relationship
33703 description: delete an existing relationship
33704 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33713 description: Response codes found in [response codes](https://wiki.onap.org/).
33717 description: Unique id of VNF. This is unique across the graph.
33720 example: __VNF-ID__
33721 - name: interface-name
33723 description: Name that identifies the link aggregate interface
33726 example: __INTERFACE-NAME__
33727 - name: interface-name
33729 description: Name given to the interface
33732 example: __INTERFACE-NAME__
33733 - name: vlan-interface
33735 description: String that identifies the interface
33738 example: __VLAN-INTERFACE__
33739 - name: l3-interface-ipv4-address
33741 description: IP address
33744 example: __L3-INTERFACE-IPV4-ADDRESS__
33745 /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}:
33749 summary: returns l3-interface-ipv4-address-list
33750 description: returns l3-interface-ipv4-address-list
33751 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33757 description: successful operation
33759 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33761 description: Response codes found in [response codes](https://wiki.onap.org/).
33765 description: Unique id of VNF. This is unique across the graph.
33768 example: __VNF-ID__
33769 - name: interface-name
33771 description: Name that identifies the link aggregate interface
33774 example: __INTERFACE-NAME__
33775 - name: interface-name
33777 description: Name given to the interface
33780 example: __INTERFACE-NAME__
33781 - name: vlan-interface
33783 description: String that identifies the interface
33786 example: __VLAN-INTERFACE__
33787 - name: l3-interface-ipv4-address
33789 description: IP address
33792 example: __L3-INTERFACE-IPV4-ADDRESS__
33796 summary: create or update an existing l3-interface-ipv4-address-list
33798 Create or update an existing l3-interface-ipv4-address-list.
33800 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33801 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33810 description: Response codes found in [response codes](https://wiki.onap.org/).
33814 description: Unique id of VNF. This is unique across the graph.
33817 example: __VNF-ID__
33818 - name: interface-name
33820 description: Name that identifies the link aggregate interface
33823 example: __INTERFACE-NAME__
33824 - name: interface-name
33826 description: Name given to the interface
33829 example: __INTERFACE-NAME__
33830 - name: vlan-interface
33832 description: String that identifies the interface
33835 example: __VLAN-INTERFACE__
33836 - name: l3-interface-ipv4-address
33838 description: IP address
33841 example: __L3-INTERFACE-IPV4-ADDRESS__
33844 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33847 $ref: "#/definitions/l3-interface-ipv4-address-list"
33851 summary: update an existing l3-interface-ipv4-address-list
33853 Update an existing l3-interface-ipv4-address-list
33855 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33856 The PUT operation will entirely replace an existing object.
33857 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33859 Other differences between PUT and PATCH are:
33861 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33862 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33863 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33864 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33873 description: Response codes found in [response codes](https://wiki.onap.org/).
33877 description: Unique id of VNF. This is unique across the graph.
33880 example: __VNF-ID__
33881 - name: interface-name
33883 description: Name that identifies the link aggregate interface
33886 example: __INTERFACE-NAME__
33887 - name: interface-name
33889 description: Name given to the interface
33892 example: __INTERFACE-NAME__
33893 - name: vlan-interface
33895 description: String that identifies the interface
33898 example: __VLAN-INTERFACE__
33899 - name: l3-interface-ipv4-address
33901 description: IP address
33904 example: __L3-INTERFACE-IPV4-ADDRESS__
33907 description: l3-interface-ipv4-address-list object that needs to be updated.
33910 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33914 summary: delete an existing l3-interface-ipv4-address-list
33915 description: delete an existing l3-interface-ipv4-address-list
33916 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33925 description: Response codes found in [response codes](https://wiki.onap.org/).
33929 description: Unique id of VNF. This is unique across the graph.
33932 example: __VNF-ID__
33933 - name: interface-name
33935 description: Name that identifies the link aggregate interface
33938 example: __INTERFACE-NAME__
33939 - name: interface-name
33941 description: Name given to the interface
33944 example: __INTERFACE-NAME__
33945 - name: vlan-interface
33947 description: String that identifies the interface
33950 example: __VLAN-INTERFACE__
33951 - name: l3-interface-ipv4-address
33953 description: IP address
33956 example: __L3-INTERFACE-IPV4-ADDRESS__
33957 - name: resource-version
33959 description: resource-version for concurrency
33962 /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:
33966 summary: see node definition for valid relationships
33967 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33976 description: Response codes found in [response codes](https://wiki.onap.org/).
33980 description: Unique id of VNF. This is unique across the graph.
33983 example: __VNF-ID__
33984 - name: interface-name
33986 description: Name that identifies the link aggregate interface
33989 example: __INTERFACE-NAME__
33990 - name: interface-name
33992 description: Name given to the interface
33995 example: __INTERFACE-NAME__
33996 - name: vlan-interface
33998 description: String that identifies the interface
34001 example: __VLAN-INTERFACE__
34002 - name: l3-interface-ipv6-address
34004 description: IP address
34007 example: __L3-INTERFACE-IPV6-ADDRESS__
34010 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34013 $ref: "#/definitions/relationship"
34017 summary: delete an existing relationship
34018 description: delete an existing relationship
34019 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34028 description: Response codes found in [response codes](https://wiki.onap.org/).
34032 description: Unique id of VNF. This is unique across the graph.
34035 example: __VNF-ID__
34036 - name: interface-name
34038 description: Name that identifies the link aggregate interface
34041 example: __INTERFACE-NAME__
34042 - name: interface-name
34044 description: Name given to the interface
34047 example: __INTERFACE-NAME__
34048 - name: vlan-interface
34050 description: String that identifies the interface
34053 example: __VLAN-INTERFACE__
34054 - name: l3-interface-ipv6-address
34056 description: IP address
34059 example: __L3-INTERFACE-IPV6-ADDRESS__
34060 /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}:
34064 summary: returns l3-interface-ipv6-address-list
34065 description: returns l3-interface-ipv6-address-list
34066 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34072 description: successful operation
34074 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34076 description: Response codes found in [response codes](https://wiki.onap.org/).
34080 description: Unique id of VNF. This is unique across the graph.
34083 example: __VNF-ID__
34084 - name: interface-name
34086 description: Name that identifies the link aggregate interface
34089 example: __INTERFACE-NAME__
34090 - name: interface-name
34092 description: Name given to the interface
34095 example: __INTERFACE-NAME__
34096 - name: vlan-interface
34098 description: String that identifies the interface
34101 example: __VLAN-INTERFACE__
34102 - name: l3-interface-ipv6-address
34104 description: IP address
34107 example: __L3-INTERFACE-IPV6-ADDRESS__
34111 summary: create or update an existing l3-interface-ipv6-address-list
34113 Create or update an existing l3-interface-ipv6-address-list.
34115 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34116 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34125 description: Response codes found in [response codes](https://wiki.onap.org/).
34129 description: Unique id of VNF. This is unique across the graph.
34132 example: __VNF-ID__
34133 - name: interface-name
34135 description: Name that identifies the link aggregate interface
34138 example: __INTERFACE-NAME__
34139 - name: interface-name
34141 description: Name given to the interface
34144 example: __INTERFACE-NAME__
34145 - name: vlan-interface
34147 description: String that identifies the interface
34150 example: __VLAN-INTERFACE__
34151 - name: l3-interface-ipv6-address
34153 description: IP address
34156 example: __L3-INTERFACE-IPV6-ADDRESS__
34159 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34162 $ref: "#/definitions/l3-interface-ipv6-address-list"
34166 summary: update an existing l3-interface-ipv6-address-list
34168 Update an existing l3-interface-ipv6-address-list
34170 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34171 The PUT operation will entirely replace an existing object.
34172 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34174 Other differences between PUT and PATCH are:
34176 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34177 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34178 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34179 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34188 description: Response codes found in [response codes](https://wiki.onap.org/).
34192 description: Unique id of VNF. This is unique across the graph.
34195 example: __VNF-ID__
34196 - name: interface-name
34198 description: Name that identifies the link aggregate interface
34201 example: __INTERFACE-NAME__
34202 - name: interface-name
34204 description: Name given to the interface
34207 example: __INTERFACE-NAME__
34208 - name: vlan-interface
34210 description: String that identifies the interface
34213 example: __VLAN-INTERFACE__
34214 - name: l3-interface-ipv6-address
34216 description: IP address
34219 example: __L3-INTERFACE-IPV6-ADDRESS__
34222 description: l3-interface-ipv6-address-list object that needs to be updated.
34225 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34229 summary: delete an existing l3-interface-ipv6-address-list
34230 description: delete an existing l3-interface-ipv6-address-list
34231 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34240 description: Response codes found in [response codes](https://wiki.onap.org/).
34244 description: Unique id of VNF. This is unique across the graph.
34247 example: __VNF-ID__
34248 - name: interface-name
34250 description: Name that identifies the link aggregate interface
34253 example: __INTERFACE-NAME__
34254 - name: interface-name
34256 description: Name given to the interface
34259 example: __INTERFACE-NAME__
34260 - name: vlan-interface
34262 description: String that identifies the interface
34265 example: __VLAN-INTERFACE__
34266 - name: l3-interface-ipv6-address
34268 description: IP address
34271 example: __L3-INTERFACE-IPV6-ADDRESS__
34272 - name: resource-version
34274 description: resource-version for concurrency
34277 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34281 summary: returns vlan
34282 description: returns vlan
34283 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34289 description: successful operation
34291 $ref: "#/getDefinitions/vlan"
34293 description: Response codes found in [response codes](https://wiki.onap.org/).
34297 description: Unique id of VNF. This is unique across the graph.
34300 example: __VNF-ID__
34301 - name: interface-name
34303 description: Name that identifies the link aggregate interface
34306 example: __INTERFACE-NAME__
34307 - name: interface-name
34309 description: Name given to the interface
34312 example: __INTERFACE-NAME__
34313 - name: vlan-interface
34315 description: String that identifies the interface
34318 example: __VLAN-INTERFACE__
34322 summary: create or update an existing vlan
34324 Create or update an existing vlan.
34326 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34327 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34336 description: Response codes found in [response codes](https://wiki.onap.org/).
34340 description: Unique id of VNF. This is unique across the graph.
34343 example: __VNF-ID__
34344 - name: interface-name
34346 description: Name that identifies the link aggregate interface
34349 example: __INTERFACE-NAME__
34350 - name: interface-name
34352 description: Name given to the interface
34355 example: __INTERFACE-NAME__
34356 - name: vlan-interface
34358 description: String that identifies the interface
34361 example: __VLAN-INTERFACE__
34364 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34367 $ref: "#/definitions/vlan"
34371 summary: update an existing vlan
34373 Update an existing vlan
34375 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34376 The PUT operation will entirely replace an existing object.
34377 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34379 Other differences between PUT and PATCH are:
34381 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34382 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34383 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34384 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34393 description: Response codes found in [response codes](https://wiki.onap.org/).
34397 description: Unique id of VNF. This is unique across the graph.
34400 example: __VNF-ID__
34401 - name: interface-name
34403 description: Name that identifies the link aggregate interface
34406 example: __INTERFACE-NAME__
34407 - name: interface-name
34409 description: Name given to the interface
34412 example: __INTERFACE-NAME__
34413 - name: vlan-interface
34415 description: String that identifies the interface
34418 example: __VLAN-INTERFACE__
34421 description: vlan object that needs to be updated.
34424 $ref: "#/patchDefinitions/vlan"
34428 summary: delete an existing vlan
34429 description: delete an existing vlan
34430 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34439 description: Response codes found in [response codes](https://wiki.onap.org/).
34443 description: Unique id of VNF. This is unique across the graph.
34446 example: __VNF-ID__
34447 - name: interface-name
34449 description: Name that identifies the link aggregate interface
34452 example: __INTERFACE-NAME__
34453 - name: interface-name
34455 description: Name given to the interface
34458 example: __INTERFACE-NAME__
34459 - name: vlan-interface
34461 description: String that identifies the interface
34464 example: __VLAN-INTERFACE__
34465 - name: resource-version
34467 description: resource-version for concurrency
34470 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
34474 summary: returns vlans
34475 description: returns vlans
34476 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
34482 description: successful operation
34484 $ref: "#/getDefinitions/vlans"
34486 description: Response codes found in [response codes](https://wiki.onap.org/).
34490 description: Unique id of VNF. This is unique across the graph.
34493 example: __VNF-ID__
34494 - name: interface-name
34496 description: Name that identifies the link aggregate interface
34499 example: __INTERFACE-NAME__
34500 - name: interface-name
34502 description: Name given to the interface
34505 example: __INTERFACE-NAME__
34506 - name: vlan-interface
34511 - name: vlan-id-inner
34522 /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:
34526 summary: see node definition for valid relationships
34527 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34536 description: Response codes found in [response codes](https://wiki.onap.org/).
34540 description: Unique id of VNF. This is unique across the graph.
34543 example: __VNF-ID__
34544 - name: interface-name
34546 description: Name that identifies the link aggregate interface
34549 example: __INTERFACE-NAME__
34550 - name: interface-name
34552 description: Name given to the interface
34555 example: __INTERFACE-NAME__
34558 description: PCI ID used to identify the sriov-vf
34561 example: __PCI-ID__
34564 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34567 $ref: "#/definitions/relationship"
34571 summary: delete an existing relationship
34572 description: delete an existing relationship
34573 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34582 description: Response codes found in [response codes](https://wiki.onap.org/).
34586 description: Unique id of VNF. This is unique across the graph.
34589 example: __VNF-ID__
34590 - name: interface-name
34592 description: Name that identifies the link aggregate interface
34595 example: __INTERFACE-NAME__
34596 - name: interface-name
34598 description: Name given to the interface
34601 example: __INTERFACE-NAME__
34604 description: PCI ID used to identify the sriov-vf
34607 example: __PCI-ID__
34608 /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}:
34612 summary: returns sriov-vf
34613 description: returns sriov-vf
34614 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34620 description: successful operation
34622 $ref: "#/getDefinitions/sriov-vf"
34624 description: Response codes found in [response codes](https://wiki.onap.org/).
34628 description: Unique id of VNF. This is unique across the graph.
34631 example: __VNF-ID__
34632 - name: interface-name
34634 description: Name that identifies the link aggregate interface
34637 example: __INTERFACE-NAME__
34638 - name: interface-name
34640 description: Name given to the interface
34643 example: __INTERFACE-NAME__
34646 description: PCI ID used to identify the sriov-vf
34649 example: __PCI-ID__
34653 summary: create or update an existing sriov-vf
34655 Create or update an existing sriov-vf.
34657 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34658 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34667 description: Response codes found in [response codes](https://wiki.onap.org/).
34671 description: Unique id of VNF. This is unique across the graph.
34674 example: __VNF-ID__
34675 - name: interface-name
34677 description: Name that identifies the link aggregate interface
34680 example: __INTERFACE-NAME__
34681 - name: interface-name
34683 description: Name given to the interface
34686 example: __INTERFACE-NAME__
34689 description: PCI ID used to identify the sriov-vf
34692 example: __PCI-ID__
34695 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34698 $ref: "#/definitions/sriov-vf"
34702 summary: update an existing sriov-vf
34704 Update an existing sriov-vf
34706 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34707 The PUT operation will entirely replace an existing object.
34708 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34710 Other differences between PUT and PATCH are:
34712 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34713 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34714 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34715 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34724 description: Response codes found in [response codes](https://wiki.onap.org/).
34728 description: Unique id of VNF. This is unique across the graph.
34731 example: __VNF-ID__
34732 - name: interface-name
34734 description: Name that identifies the link aggregate interface
34737 example: __INTERFACE-NAME__
34738 - name: interface-name
34740 description: Name given to the interface
34743 example: __INTERFACE-NAME__
34746 description: PCI ID used to identify the sriov-vf
34749 example: __PCI-ID__
34752 description: sriov-vf object that needs to be updated.
34755 $ref: "#/patchDefinitions/sriov-vf"
34759 summary: delete an existing sriov-vf
34760 description: delete an existing sriov-vf
34761 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34770 description: Response codes found in [response codes](https://wiki.onap.org/).
34774 description: Unique id of VNF. This is unique across the graph.
34777 example: __VNF-ID__
34778 - name: interface-name
34780 description: Name that identifies the link aggregate interface
34783 example: __INTERFACE-NAME__
34784 - name: interface-name
34786 description: Name given to the interface
34789 example: __INTERFACE-NAME__
34792 description: PCI ID used to identify the sriov-vf
34795 example: __PCI-ID__
34796 - name: resource-version
34798 description: resource-version for concurrency
34801 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
34805 summary: returns sriov-vfs
34806 description: returns sriov-vfs
34807 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
34813 description: successful operation
34815 $ref: "#/getDefinitions/sriov-vfs"
34817 description: Response codes found in [response codes](https://wiki.onap.org/).
34821 description: Unique id of VNF. This is unique across the graph.
34824 example: __VNF-ID__
34825 - name: interface-name
34827 description: Name that identifies the link aggregate interface
34830 example: __INTERFACE-NAME__
34831 - name: interface-name
34833 description: Name given to the interface
34836 example: __INTERFACE-NAME__
34842 - name: vf-vlan-filter
34847 - name: vf-mac-filter
34852 - name: vf-vlan-strip
34857 - name: neutron-network-id
34862 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
34866 summary: see node definition for valid relationships
34867 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
34876 description: Response codes found in [response codes](https://wiki.onap.org/).
34880 description: Unique id of VNF. This is unique across the graph.
34883 example: __VNF-ID__
34884 - name: interface-name
34886 description: Name that identifies the link aggregate interface
34889 example: __INTERFACE-NAME__
34890 - name: interface-name
34892 description: Name given to the interface
34895 example: __INTERFACE-NAME__
34898 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
34901 $ref: "#/definitions/relationship"
34905 summary: delete an existing relationship
34906 description: delete an existing relationship
34907 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
34916 description: Response codes found in [response codes](https://wiki.onap.org/).
34920 description: Unique id of VNF. This is unique across the graph.
34923 example: __VNF-ID__
34924 - name: interface-name
34926 description: Name that identifies the link aggregate interface
34929 example: __INTERFACE-NAME__
34930 - name: interface-name
34932 description: Name given to the interface
34935 example: __INTERFACE-NAME__
34936 /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:
34940 summary: see node definition for valid relationships
34941 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34950 description: Response codes found in [response codes](https://wiki.onap.org/).
34954 description: Unique id of VNF. This is unique across the graph.
34957 example: __VNF-ID__
34958 - name: interface-name
34960 description: Name that identifies the link aggregate interface
34963 example: __INTERFACE-NAME__
34964 - name: interface-name
34966 description: Name given to the interface
34969 example: __INTERFACE-NAME__
34970 - name: l3-interface-ipv4-address
34972 description: IP address
34975 example: __L3-INTERFACE-IPV4-ADDRESS__
34978 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34981 $ref: "#/definitions/relationship"
34985 summary: delete an existing relationship
34986 description: delete an existing relationship
34987 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34996 description: Response codes found in [response codes](https://wiki.onap.org/).
35000 description: Unique id of VNF. This is unique across the graph.
35003 example: __VNF-ID__
35004 - name: interface-name
35006 description: Name that identifies the link aggregate interface
35009 example: __INTERFACE-NAME__
35010 - name: interface-name
35012 description: Name given to the interface
35015 example: __INTERFACE-NAME__
35016 - name: l3-interface-ipv4-address
35018 description: IP address
35021 example: __L3-INTERFACE-IPV4-ADDRESS__
35022 /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}:
35026 summary: returns l3-interface-ipv4-address-list
35027 description: returns l3-interface-ipv4-address-list
35028 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35034 description: successful operation
35036 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35038 description: Response codes found in [response codes](https://wiki.onap.org/).
35042 description: Unique id of VNF. This is unique across the graph.
35045 example: __VNF-ID__
35046 - name: interface-name
35048 description: Name that identifies the link aggregate interface
35051 example: __INTERFACE-NAME__
35052 - name: interface-name
35054 description: Name given to the interface
35057 example: __INTERFACE-NAME__
35058 - name: l3-interface-ipv4-address
35060 description: IP address
35063 example: __L3-INTERFACE-IPV4-ADDRESS__
35067 summary: create or update an existing l3-interface-ipv4-address-list
35069 Create or update an existing l3-interface-ipv4-address-list.
35071 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35072 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35081 description: Response codes found in [response codes](https://wiki.onap.org/).
35085 description: Unique id of VNF. This is unique across the graph.
35088 example: __VNF-ID__
35089 - name: interface-name
35091 description: Name that identifies the link aggregate interface
35094 example: __INTERFACE-NAME__
35095 - name: interface-name
35097 description: Name given to the interface
35100 example: __INTERFACE-NAME__
35101 - name: l3-interface-ipv4-address
35103 description: IP address
35106 example: __L3-INTERFACE-IPV4-ADDRESS__
35109 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35112 $ref: "#/definitions/l3-interface-ipv4-address-list"
35116 summary: update an existing l3-interface-ipv4-address-list
35118 Update an existing l3-interface-ipv4-address-list
35120 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35121 The PUT operation will entirely replace an existing object.
35122 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35124 Other differences between PUT and PATCH are:
35126 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35127 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35128 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35129 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35138 description: Response codes found in [response codes](https://wiki.onap.org/).
35142 description: Unique id of VNF. This is unique across the graph.
35145 example: __VNF-ID__
35146 - name: interface-name
35148 description: Name that identifies the link aggregate interface
35151 example: __INTERFACE-NAME__
35152 - name: interface-name
35154 description: Name given to the interface
35157 example: __INTERFACE-NAME__
35158 - name: l3-interface-ipv4-address
35160 description: IP address
35163 example: __L3-INTERFACE-IPV4-ADDRESS__
35166 description: l3-interface-ipv4-address-list object that needs to be updated.
35169 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35173 summary: delete an existing l3-interface-ipv4-address-list
35174 description: delete an existing l3-interface-ipv4-address-list
35175 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35184 description: Response codes found in [response codes](https://wiki.onap.org/).
35188 description: Unique id of VNF. This is unique across the graph.
35191 example: __VNF-ID__
35192 - name: interface-name
35194 description: Name that identifies the link aggregate interface
35197 example: __INTERFACE-NAME__
35198 - name: interface-name
35200 description: Name given to the interface
35203 example: __INTERFACE-NAME__
35204 - name: l3-interface-ipv4-address
35206 description: IP address
35209 example: __L3-INTERFACE-IPV4-ADDRESS__
35210 - name: resource-version
35212 description: resource-version for concurrency
35215 /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:
35219 summary: see node definition for valid relationships
35220 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
35229 description: Response codes found in [response codes](https://wiki.onap.org/).
35233 description: Unique id of VNF. This is unique across the graph.
35236 example: __VNF-ID__
35237 - name: interface-name
35239 description: Name that identifies the link aggregate interface
35242 example: __INTERFACE-NAME__
35243 - name: interface-name
35245 description: Name given to the interface
35248 example: __INTERFACE-NAME__
35249 - name: l3-interface-ipv6-address
35251 description: IP address
35254 example: __L3-INTERFACE-IPV6-ADDRESS__
35257 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35260 $ref: "#/definitions/relationship"
35264 summary: delete an existing relationship
35265 description: delete an existing relationship
35266 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
35275 description: Response codes found in [response codes](https://wiki.onap.org/).
35279 description: Unique id of VNF. This is unique across the graph.
35282 example: __VNF-ID__
35283 - name: interface-name
35285 description: Name that identifies the link aggregate interface
35288 example: __INTERFACE-NAME__
35289 - name: interface-name
35291 description: Name given to the interface
35294 example: __INTERFACE-NAME__
35295 - name: l3-interface-ipv6-address
35297 description: IP address
35300 example: __L3-INTERFACE-IPV6-ADDRESS__
35301 /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}:
35305 summary: returns l3-interface-ipv6-address-list
35306 description: returns l3-interface-ipv6-address-list
35307 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35313 description: successful operation
35315 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35317 description: Response codes found in [response codes](https://wiki.onap.org/).
35321 description: Unique id of VNF. This is unique across the graph.
35324 example: __VNF-ID__
35325 - name: interface-name
35327 description: Name that identifies the link aggregate interface
35330 example: __INTERFACE-NAME__
35331 - name: interface-name
35333 description: Name given to the interface
35336 example: __INTERFACE-NAME__
35337 - name: l3-interface-ipv6-address
35339 description: IP address
35342 example: __L3-INTERFACE-IPV6-ADDRESS__
35346 summary: create or update an existing l3-interface-ipv6-address-list
35348 Create or update an existing l3-interface-ipv6-address-list.
35350 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35351 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35360 description: Response codes found in [response codes](https://wiki.onap.org/).
35364 description: Unique id of VNF. This is unique across the graph.
35367 example: __VNF-ID__
35368 - name: interface-name
35370 description: Name that identifies the link aggregate interface
35373 example: __INTERFACE-NAME__
35374 - name: interface-name
35376 description: Name given to the interface
35379 example: __INTERFACE-NAME__
35380 - name: l3-interface-ipv6-address
35382 description: IP address
35385 example: __L3-INTERFACE-IPV6-ADDRESS__
35388 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35391 $ref: "#/definitions/l3-interface-ipv6-address-list"
35395 summary: update an existing l3-interface-ipv6-address-list
35397 Update an existing l3-interface-ipv6-address-list
35399 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35400 The PUT operation will entirely replace an existing object.
35401 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35403 Other differences between PUT and PATCH are:
35405 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35406 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35407 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35408 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35417 description: Response codes found in [response codes](https://wiki.onap.org/).
35421 description: Unique id of VNF. This is unique across the graph.
35424 example: __VNF-ID__
35425 - name: interface-name
35427 description: Name that identifies the link aggregate interface
35430 example: __INTERFACE-NAME__
35431 - name: interface-name
35433 description: Name given to the interface
35436 example: __INTERFACE-NAME__
35437 - name: l3-interface-ipv6-address
35439 description: IP address
35442 example: __L3-INTERFACE-IPV6-ADDRESS__
35445 description: l3-interface-ipv6-address-list object that needs to be updated.
35448 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35452 summary: delete an existing l3-interface-ipv6-address-list
35453 description: delete an existing l3-interface-ipv6-address-list
35454 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35463 description: Response codes found in [response codes](https://wiki.onap.org/).
35467 description: Unique id of VNF. This is unique across the graph.
35470 example: __VNF-ID__
35471 - name: interface-name
35473 description: Name that identifies the link aggregate interface
35476 example: __INTERFACE-NAME__
35477 - name: interface-name
35479 description: Name given to the interface
35482 example: __INTERFACE-NAME__
35483 - name: l3-interface-ipv6-address
35485 description: IP address
35488 example: __L3-INTERFACE-IPV6-ADDRESS__
35489 - name: resource-version
35491 description: resource-version for concurrency
35494 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
35498 summary: returns l-interface
35499 description: returns l-interface
35500 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35506 description: successful operation
35508 $ref: "#/getDefinitions/l-interface"
35510 description: Response codes found in [response codes](https://wiki.onap.org/).
35514 description: Unique id of VNF. This is unique across the graph.
35517 example: __VNF-ID__
35518 - name: interface-name
35520 description: Name that identifies the link aggregate interface
35523 example: __INTERFACE-NAME__
35524 - name: interface-name
35526 description: Name given to the interface
35529 example: __INTERFACE-NAME__
35533 summary: create or update an existing l-interface
35535 Create or update an existing l-interface.
35537 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35538 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35547 description: Response codes found in [response codes](https://wiki.onap.org/).
35551 description: Unique id of VNF. This is unique across the graph.
35554 example: __VNF-ID__
35555 - name: interface-name
35557 description: Name that identifies the link aggregate interface
35560 example: __INTERFACE-NAME__
35561 - name: interface-name
35563 description: Name given to the interface
35566 example: __INTERFACE-NAME__
35569 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
35572 $ref: "#/definitions/l-interface"
35576 summary: update an existing l-interface
35578 Update an existing l-interface
35580 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35581 The PUT operation will entirely replace an existing object.
35582 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35584 Other differences between PUT and PATCH are:
35586 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35587 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35588 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35589 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35598 description: Response codes found in [response codes](https://wiki.onap.org/).
35602 description: Unique id of VNF. This is unique across the graph.
35605 example: __VNF-ID__
35606 - name: interface-name
35608 description: Name that identifies the link aggregate interface
35611 example: __INTERFACE-NAME__
35612 - name: interface-name
35614 description: Name given to the interface
35617 example: __INTERFACE-NAME__
35620 description: l-interface object that needs to be updated.
35623 $ref: "#/patchDefinitions/l-interface"
35627 summary: delete an existing l-interface
35628 description: delete an existing l-interface
35629 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35638 description: Response codes found in [response codes](https://wiki.onap.org/).
35642 description: Unique id of VNF. This is unique across the graph.
35645 example: __VNF-ID__
35646 - name: interface-name
35648 description: Name that identifies the link aggregate interface
35651 example: __INTERFACE-NAME__
35652 - name: interface-name
35654 description: Name given to the interface
35657 example: __INTERFACE-NAME__
35658 - name: resource-version
35660 description: resource-version for concurrency
35663 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
35667 summary: returns l-interfaces
35668 description: returns l-interfaces
35669 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
35675 description: successful operation
35677 $ref: "#/getDefinitions/l-interfaces"
35679 description: Response codes found in [response codes](https://wiki.onap.org/).
35683 description: Unique id of VNF. This is unique across the graph.
35686 example: __VNF-ID__
35687 - name: interface-name
35689 description: Name that identifies the link aggregate interface
35692 example: __INTERFACE-NAME__
35693 - name: interface-name
35698 - name: interface-id
35708 - name: network-name
35713 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
35717 summary: returns lag-interface
35718 description: returns lag-interface
35719 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35725 description: successful operation
35727 $ref: "#/getDefinitions/lag-interface"
35729 description: Response codes found in [response codes](https://wiki.onap.org/).
35733 description: Unique id of VNF. This is unique across the graph.
35736 example: __VNF-ID__
35737 - name: interface-name
35739 description: Name that identifies the link aggregate interface
35742 example: __INTERFACE-NAME__
35746 summary: create or update an existing lag-interface
35748 Create or update an existing lag-interface.
35750 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35751 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35760 description: Response codes found in [response codes](https://wiki.onap.org/).
35764 description: Unique id of VNF. This is unique across the graph.
35767 example: __VNF-ID__
35768 - name: interface-name
35770 description: Name that identifies the link aggregate interface
35773 example: __INTERFACE-NAME__
35776 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
35779 $ref: "#/definitions/lag-interface"
35783 summary: update an existing lag-interface
35785 Update an existing lag-interface
35787 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35788 The PUT operation will entirely replace an existing object.
35789 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35791 Other differences between PUT and PATCH are:
35793 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35794 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35795 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35796 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35805 description: Response codes found in [response codes](https://wiki.onap.org/).
35809 description: Unique id of VNF. This is unique across the graph.
35812 example: __VNF-ID__
35813 - name: interface-name
35815 description: Name that identifies the link aggregate interface
35818 example: __INTERFACE-NAME__
35821 description: lag-interface object that needs to be updated.
35824 $ref: "#/patchDefinitions/lag-interface"
35828 summary: delete an existing lag-interface
35829 description: delete an existing lag-interface
35830 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35839 description: Response codes found in [response codes](https://wiki.onap.org/).
35843 description: Unique id of VNF. This is unique across the graph.
35846 example: __VNF-ID__
35847 - name: interface-name
35849 description: Name that identifies the link aggregate interface
35852 example: __INTERFACE-NAME__
35853 - name: resource-version
35855 description: resource-version for concurrency
35858 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
35862 summary: returns lag-interfaces
35863 description: returns lag-interfaces
35864 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
35870 description: successful operation
35872 $ref: "#/getDefinitions/lag-interfaces"
35874 description: Response codes found in [response codes](https://wiki.onap.org/).
35878 description: Unique id of VNF. This is unique across the graph.
35881 example: __VNF-ID__
35882 - name: interface-name
35887 - name: interface-id
35892 - name: interface-role
35897 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
35901 summary: see node definition for valid relationships
35902 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
35911 description: Response codes found in [response codes](https://wiki.onap.org/).
35915 description: Unique id of VNF. This is unique across the graph.
35918 example: __VNF-ID__
35919 - name: vf-module-id
35921 description: Unique ID of vf-module.
35924 example: __VF-MODULE-ID__
35927 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
35930 $ref: "#/definitions/relationship"
35934 summary: delete an existing relationship
35935 description: delete an existing relationship
35936 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
35945 description: Response codes found in [response codes](https://wiki.onap.org/).
35949 description: Unique id of VNF. This is unique across the graph.
35952 example: __VNF-ID__
35953 - name: vf-module-id
35955 description: Unique ID of vf-module.
35958 example: __VF-MODULE-ID__
35959 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
35963 summary: returns vf-module
35964 description: returns vf-module
35965 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
35971 description: successful operation
35973 $ref: "#/getDefinitions/vf-module"
35975 description: Response codes found in [response codes](https://wiki.onap.org/).
35979 description: Unique id of VNF. This is unique across the graph.
35982 example: __VNF-ID__
35983 - name: vf-module-id
35985 description: Unique ID of vf-module.
35988 example: __VF-MODULE-ID__
35992 summary: create or update an existing vf-module
35994 Create or update an existing vf-module.
35996 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35997 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
36006 description: Response codes found in [response codes](https://wiki.onap.org/).
36010 description: Unique id of VNF. This is unique across the graph.
36013 example: __VNF-ID__
36014 - name: vf-module-id
36016 description: Unique ID of vf-module.
36019 example: __VF-MODULE-ID__
36022 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
36025 $ref: "#/definitions/vf-module"
36029 summary: update an existing vf-module
36031 Update an existing vf-module
36033 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36034 The PUT operation will entirely replace an existing object.
36035 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36037 Other differences between PUT and PATCH are:
36039 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36040 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36041 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36042 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
36051 description: Response codes found in [response codes](https://wiki.onap.org/).
36055 description: Unique id of VNF. This is unique across the graph.
36058 example: __VNF-ID__
36059 - name: vf-module-id
36061 description: Unique ID of vf-module.
36064 example: __VF-MODULE-ID__
36067 description: vf-module object that needs to be updated.
36070 $ref: "#/patchDefinitions/vf-module"
36074 summary: delete an existing vf-module
36075 description: delete an existing vf-module
36076 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
36085 description: Response codes found in [response codes](https://wiki.onap.org/).
36089 description: Unique id of VNF. This is unique across the graph.
36092 example: __VNF-ID__
36093 - name: vf-module-id
36095 description: Unique ID of vf-module.
36098 example: __VF-MODULE-ID__
36099 - name: resource-version
36101 description: resource-version for concurrency
36104 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
36108 summary: returns vf-modules
36109 description: returns vf-modules
36110 operationId: getNetworkGenericVnfsGenericVnfVfModules
36116 description: successful operation
36118 $ref: "#/getDefinitions/vf-modules"
36120 description: Response codes found in [response codes](https://wiki.onap.org/).
36124 description: Unique id of VNF. This is unique across the graph.
36127 example: __VNF-ID__
36128 - name: vf-module-id
36133 - name: vf-module-name
36138 - name: heat-stack-id
36143 - name: model-invariant-id
36148 - name: model-version-id
36153 - name: widget-model-id
36158 - name: widget-model-version
36163 - name: contrail-service-instance-fqdn
36168 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
36172 summary: see node definition for valid relationships
36173 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
36182 description: Response codes found in [response codes](https://wiki.onap.org/).
36186 description: Unique id of VNF. This is unique across the graph.
36189 example: __VNF-ID__
36192 description: Unique ID for the license group the resource belongs to, should be uuid.
36195 example: __GROUP-UUID__
36196 - name: resource-uuid
36198 description: Unique ID of a license resource.
36201 example: __RESOURCE-UUID__
36204 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)
36207 $ref: "#/definitions/relationship"
36211 summary: delete an existing relationship
36212 description: delete an existing relationship
36213 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
36222 description: Response codes found in [response codes](https://wiki.onap.org/).
36226 description: Unique id of VNF. This is unique across the graph.
36229 example: __VNF-ID__
36232 description: Unique ID for the license group the resource belongs to, should be uuid.
36235 example: __GROUP-UUID__
36236 - name: resource-uuid
36238 description: Unique ID of a license resource.
36241 example: __RESOURCE-UUID__
36242 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
36246 summary: returns license
36247 description: returns license
36248 operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
36254 description: successful operation
36256 $ref: "#/getDefinitions/license"
36258 description: Response codes found in [response codes](https://wiki.onap.org/).
36262 description: Unique id of VNF. This is unique across the graph.
36265 example: __VNF-ID__
36268 description: Unique ID for the license group the resource belongs to, should be uuid.
36271 example: __GROUP-UUID__
36272 - name: resource-uuid
36274 description: Unique ID of a license resource.
36277 example: __RESOURCE-UUID__
36281 summary: create or update an existing license
36283 Create or update an existing license.
36285 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36286 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
36295 description: Response codes found in [response codes](https://wiki.onap.org/).
36299 description: Unique id of VNF. This is unique across the graph.
36302 example: __VNF-ID__
36305 description: Unique ID for the license group the resource belongs to, should be uuid.
36308 example: __GROUP-UUID__
36309 - name: resource-uuid
36311 description: Unique ID of a license resource.
36314 example: __RESOURCE-UUID__
36317 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)
36320 $ref: "#/definitions/license"
36324 summary: update an existing license
36326 Update an existing license
36328 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36329 The PUT operation will entirely replace an existing object.
36330 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36332 Other differences between PUT and PATCH are:
36334 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36335 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36336 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36337 operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
36346 description: Response codes found in [response codes](https://wiki.onap.org/).
36350 description: Unique id of VNF. This is unique across the graph.
36353 example: __VNF-ID__
36356 description: Unique ID for the license group the resource belongs to, should be uuid.
36359 example: __GROUP-UUID__
36360 - name: resource-uuid
36362 description: Unique ID of a license resource.
36365 example: __RESOURCE-UUID__
36368 description: license object that needs to be updated.
36371 $ref: "#/patchDefinitions/license"
36375 summary: delete an existing license
36376 description: delete an existing license
36377 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
36386 description: Response codes found in [response codes](https://wiki.onap.org/).
36390 description: Unique id of VNF. This is unique across the graph.
36393 example: __VNF-ID__
36396 description: Unique ID for the license group the resource belongs to, should be uuid.
36399 example: __GROUP-UUID__
36400 - name: resource-uuid
36402 description: Unique ID of a license resource.
36405 example: __RESOURCE-UUID__
36406 - name: resource-version
36408 description: resource-version for concurrency
36411 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
36415 summary: returns licenses
36416 description: returns licenses
36417 operationId: getNetworkGenericVnfsGenericVnfLicenses
36423 description: successful operation
36425 $ref: "#/getDefinitions/licenses"
36427 description: Response codes found in [response codes](https://wiki.onap.org/).
36431 description: Unique id of VNF. This is unique across the graph.
36434 example: __VNF-ID__
36440 - name: resource-uuid
36445 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
36449 summary: see node definition for valid relationships
36450 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
36459 description: Response codes found in [response codes](https://wiki.onap.org/).
36463 description: Unique id of VNF. This is unique across the graph.
36466 example: __VNF-ID__
36469 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36472 example: __GROUP-UUID__
36473 - name: resource-uuid
36475 description: Unique ID of an entitlement resource.
36478 example: __RESOURCE-UUID__
36481 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
36484 $ref: "#/definitions/relationship"
36488 summary: delete an existing relationship
36489 description: delete an existing relationship
36490 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
36499 description: Response codes found in [response codes](https://wiki.onap.org/).
36503 description: Unique id of VNF. This is unique across the graph.
36506 example: __VNF-ID__
36509 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36512 example: __GROUP-UUID__
36513 - name: resource-uuid
36515 description: Unique ID of an entitlement resource.
36518 example: __RESOURCE-UUID__
36519 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
36523 summary: returns entitlement
36524 description: returns entitlement
36525 operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36531 description: successful operation
36533 $ref: "#/getDefinitions/entitlement"
36535 description: Response codes found in [response codes](https://wiki.onap.org/).
36539 description: Unique id of VNF. This is unique across the graph.
36542 example: __VNF-ID__
36545 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36548 example: __GROUP-UUID__
36549 - name: resource-uuid
36551 description: Unique ID of an entitlement resource.
36554 example: __RESOURCE-UUID__
36558 summary: create or update an existing entitlement
36560 Create or update an existing entitlement.
36562 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36563 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36572 description: Response codes found in [response codes](https://wiki.onap.org/).
36576 description: Unique id of VNF. This is unique across the graph.
36579 example: __VNF-ID__
36582 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36585 example: __GROUP-UUID__
36586 - name: resource-uuid
36588 description: Unique ID of an entitlement resource.
36591 example: __RESOURCE-UUID__
36594 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
36597 $ref: "#/definitions/entitlement"
36601 summary: update an existing entitlement
36603 Update an existing entitlement
36605 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36606 The PUT operation will entirely replace an existing object.
36607 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36609 Other differences between PUT and PATCH are:
36611 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36612 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36613 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36614 operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36623 description: Response codes found in [response codes](https://wiki.onap.org/).
36627 description: Unique id of VNF. This is unique across the graph.
36630 example: __VNF-ID__
36633 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36636 example: __GROUP-UUID__
36637 - name: resource-uuid
36639 description: Unique ID of an entitlement resource.
36642 example: __RESOURCE-UUID__
36645 description: entitlement object that needs to be updated.
36648 $ref: "#/patchDefinitions/entitlement"
36652 summary: delete an existing entitlement
36653 description: delete an existing entitlement
36654 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36663 description: Response codes found in [response codes](https://wiki.onap.org/).
36667 description: Unique id of VNF. This is unique across the graph.
36670 example: __VNF-ID__
36673 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36676 example: __GROUP-UUID__
36677 - name: resource-uuid
36679 description: Unique ID of an entitlement resource.
36682 example: __RESOURCE-UUID__
36683 - name: resource-version
36685 description: resource-version for concurrency
36688 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
36692 summary: returns entitlements
36693 description: returns entitlements
36694 operationId: getNetworkGenericVnfsGenericVnfEntitlements
36700 description: successful operation
36702 $ref: "#/getDefinitions/entitlements"
36704 description: Response codes found in [response codes](https://wiki.onap.org/).
36708 description: Unique id of VNF. This is unique across the graph.
36711 example: __VNF-ID__
36717 - name: resource-uuid
36722 /network/generic-vnfs/generic-vnf/{vnf-id}:
36726 summary: returns generic-vnf
36727 description: returns generic-vnf
36728 operationId: getNetworkGenericVnfsGenericVnf
36734 description: successful operation
36736 $ref: "#/getDefinitions/generic-vnf"
36738 description: Response codes found in [response codes](https://wiki.onap.org/).
36742 description: Unique id of VNF. This is unique across the graph.
36745 example: __VNF-ID__
36749 summary: create or update an existing generic-vnf
36751 Create or update an existing generic-vnf.
36753 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36754 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
36763 description: Response codes found in [response codes](https://wiki.onap.org/).
36767 description: Unique id of VNF. This is unique across the graph.
36770 example: __VNF-ID__
36773 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)
36776 $ref: "#/definitions/generic-vnf"
36780 summary: update an existing generic-vnf
36782 Update an existing generic-vnf
36784 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36785 The PUT operation will entirely replace an existing object.
36786 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36788 Other differences between PUT and PATCH are:
36790 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36791 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36792 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36793 operationId: UpdateNetworkGenericVnfsGenericVnf
36802 description: Response codes found in [response codes](https://wiki.onap.org/).
36806 description: Unique id of VNF. This is unique across the graph.
36809 example: __VNF-ID__
36812 description: generic-vnf object that needs to be updated.
36815 $ref: "#/patchDefinitions/generic-vnf"
36819 summary: delete an existing generic-vnf
36820 description: delete an existing generic-vnf
36821 operationId: deleteNetworkGenericVnfsGenericVnf
36830 description: Response codes found in [response codes](https://wiki.onap.org/).
36834 description: Unique id of VNF. This is unique across the graph.
36837 example: __VNF-ID__
36838 - name: resource-version
36840 description: resource-version for concurrency
36843 /network/generic-vnfs:
36847 summary: returns generic-vnfs
36848 description: returns generic-vnfs
36849 operationId: getNetworkGenericVnfs
36855 description: successful operation
36857 $ref: "#/getDefinitions/generic-vnfs"
36859 description: Response codes found in [response codes](https://wiki.onap.org/).
36886 - name: regional-resource-zone
36891 - name: prov-status
36896 - name: heat-stack-id
36906 - name: is-closed-loop-disabled
36911 - name: model-invariant-id
36916 - name: model-version-id
36921 - name: widget-model-id
36926 - name: widget-model-version
36936 - name: nf-function
36946 - name: nf-naming-code
36951 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
36955 summary: see node definition for valid relationships
36956 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
36965 description: Response codes found in [response codes](https://wiki.onap.org/).
36969 description: Alphabetical concatenation of lag-interface names
36972 example: __LINK-NAME__
36975 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json)
36978 $ref: "#/definitions/relationship"
36982 summary: delete an existing relationship
36983 description: delete an existing relationship
36984 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
36993 description: Response codes found in [response codes](https://wiki.onap.org/).
36997 description: Alphabetical concatenation of lag-interface names
37000 example: __LINK-NAME__
37001 /network/lag-links/lag-link/{link-name}:
37005 summary: returns lag-link
37006 description: returns lag-link
37007 operationId: getNetworkLagLinksLagLink
37013 description: successful operation
37015 $ref: "#/getDefinitions/lag-link"
37017 description: Response codes found in [response codes](https://wiki.onap.org/).
37021 description: Alphabetical concatenation of lag-interface names
37024 example: __LINK-NAME__
37028 summary: create or update an existing lag-link
37030 Create or update an existing lag-link.
37032 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37033 operationId: createOrUpdateNetworkLagLinksLagLink
37042 description: Response codes found in [response codes](https://wiki.onap.org/).
37046 description: Alphabetical concatenation of lag-interface names
37049 example: __LINK-NAME__
37052 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json)
37055 $ref: "#/definitions/lag-link"
37059 summary: update an existing lag-link
37061 Update an existing lag-link
37063 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37064 The PUT operation will entirely replace an existing object.
37065 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37067 Other differences between PUT and PATCH are:
37069 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37070 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37071 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37072 operationId: UpdateNetworkLagLinksLagLink
37081 description: Response codes found in [response codes](https://wiki.onap.org/).
37085 description: Alphabetical concatenation of lag-interface names
37088 example: __LINK-NAME__
37091 description: lag-link object that needs to be updated.
37094 $ref: "#/patchDefinitions/lag-link"
37098 summary: delete an existing lag-link
37099 description: delete an existing lag-link
37100 operationId: deleteNetworkLagLinksLagLink
37109 description: Response codes found in [response codes](https://wiki.onap.org/).
37113 description: Alphabetical concatenation of lag-interface names
37116 example: __LINK-NAME__
37117 - name: resource-version
37119 description: resource-version for concurrency
37122 /network/lag-links:
37126 summary: returns lag-links
37127 description: returns lag-links
37128 operationId: getNetworkLagLinks
37134 description: successful operation
37136 $ref: "#/getDefinitions/lag-links"
37138 description: Response codes found in [response codes](https://wiki.onap.org/).
37145 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
37149 summary: see node definition for valid relationships
37150 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
37159 description: Response codes found in [response codes](https://wiki.onap.org/).
37163 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37166 example: __VNF-ID2__
37169 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvce.json)
37172 $ref: "#/definitions/relationship"
37176 summary: delete an existing relationship
37177 description: delete an existing relationship
37178 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
37187 description: Response codes found in [response codes](https://wiki.onap.org/).
37191 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37194 example: __VNF-ID2__
37195 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
37199 summary: see node definition for valid relationships
37200 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
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: vlan-interface
37225 description: String that identifies the interface
37228 example: __VLAN-INTERFACE__
37231 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
37234 $ref: "#/definitions/relationship"
37238 summary: delete an existing relationship
37239 description: delete an existing relationship
37240 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37249 description: Response codes found in [response codes](https://wiki.onap.org/).
37253 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37256 example: __VNF-ID2__
37257 - name: interface-name
37259 description: Name given to the interface
37262 example: __INTERFACE-NAME__
37263 - name: vlan-interface
37265 description: String that identifies the interface
37268 example: __VLAN-INTERFACE__
37269 /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:
37273 summary: see node definition for valid relationships
37274 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37283 description: Response codes found in [response codes](https://wiki.onap.org/).
37287 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37290 example: __VNF-ID2__
37291 - name: interface-name
37293 description: Name given to the interface
37296 example: __INTERFACE-NAME__
37297 - name: vlan-interface
37299 description: String that identifies the interface
37302 example: __VLAN-INTERFACE__
37303 - name: l3-interface-ipv4-address
37305 description: IP address
37308 example: __L3-INTERFACE-IPV4-ADDRESS__
37311 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37314 $ref: "#/definitions/relationship"
37318 summary: delete an existing relationship
37319 description: delete an existing relationship
37320 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37329 description: Response codes found in [response codes](https://wiki.onap.org/).
37333 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37336 example: __VNF-ID2__
37337 - name: interface-name
37339 description: Name given to the interface
37342 example: __INTERFACE-NAME__
37343 - name: vlan-interface
37345 description: String that identifies the interface
37348 example: __VLAN-INTERFACE__
37349 - name: l3-interface-ipv4-address
37351 description: IP address
37354 example: __L3-INTERFACE-IPV4-ADDRESS__
37355 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
37359 summary: returns l3-interface-ipv4-address-list
37360 description: returns l3-interface-ipv4-address-list
37361 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37367 description: successful operation
37369 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37371 description: Response codes found in [response codes](https://wiki.onap.org/).
37375 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37378 example: __VNF-ID2__
37379 - name: interface-name
37381 description: Name given to the interface
37384 example: __INTERFACE-NAME__
37385 - name: vlan-interface
37387 description: String that identifies the interface
37390 example: __VLAN-INTERFACE__
37391 - name: l3-interface-ipv4-address
37393 description: IP address
37396 example: __L3-INTERFACE-IPV4-ADDRESS__
37400 summary: create or update an existing l3-interface-ipv4-address-list
37402 Create or update an existing l3-interface-ipv4-address-list.
37404 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37405 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37414 description: Response codes found in [response codes](https://wiki.onap.org/).
37418 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37421 example: __VNF-ID2__
37422 - name: interface-name
37424 description: Name given to the interface
37427 example: __INTERFACE-NAME__
37428 - name: vlan-interface
37430 description: String that identifies the interface
37433 example: __VLAN-INTERFACE__
37434 - name: l3-interface-ipv4-address
37436 description: IP address
37439 example: __L3-INTERFACE-IPV4-ADDRESS__
37442 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37445 $ref: "#/definitions/l3-interface-ipv4-address-list"
37449 summary: update an existing l3-interface-ipv4-address-list
37451 Update an existing l3-interface-ipv4-address-list
37453 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37454 The PUT operation will entirely replace an existing object.
37455 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37457 Other differences between PUT and PATCH are:
37459 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37460 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37461 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37462 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37471 description: Response codes found in [response codes](https://wiki.onap.org/).
37475 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37478 example: __VNF-ID2__
37479 - name: interface-name
37481 description: Name given to the interface
37484 example: __INTERFACE-NAME__
37485 - name: vlan-interface
37487 description: String that identifies the interface
37490 example: __VLAN-INTERFACE__
37491 - name: l3-interface-ipv4-address
37493 description: IP address
37496 example: __L3-INTERFACE-IPV4-ADDRESS__
37499 description: l3-interface-ipv4-address-list object that needs to be updated.
37502 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37506 summary: delete an existing l3-interface-ipv4-address-list
37507 description: delete an existing l3-interface-ipv4-address-list
37508 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37517 description: Response codes found in [response codes](https://wiki.onap.org/).
37521 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37524 example: __VNF-ID2__
37525 - name: interface-name
37527 description: Name given to the interface
37530 example: __INTERFACE-NAME__
37531 - name: vlan-interface
37533 description: String that identifies the interface
37536 example: __VLAN-INTERFACE__
37537 - name: l3-interface-ipv4-address
37539 description: IP address
37542 example: __L3-INTERFACE-IPV4-ADDRESS__
37543 - name: resource-version
37545 description: resource-version for concurrency
37548 /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:
37552 summary: see node definition for valid relationships
37553 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37562 description: Response codes found in [response codes](https://wiki.onap.org/).
37566 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37569 example: __VNF-ID2__
37570 - name: interface-name
37572 description: Name given to the interface
37575 example: __INTERFACE-NAME__
37576 - name: vlan-interface
37578 description: String that identifies the interface
37581 example: __VLAN-INTERFACE__
37582 - name: l3-interface-ipv6-address
37584 description: IP address
37587 example: __L3-INTERFACE-IPV6-ADDRESS__
37590 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37593 $ref: "#/definitions/relationship"
37597 summary: delete an existing relationship
37598 description: delete an existing relationship
37599 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37608 description: Response codes found in [response codes](https://wiki.onap.org/).
37612 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37615 example: __VNF-ID2__
37616 - name: interface-name
37618 description: Name given to the interface
37621 example: __INTERFACE-NAME__
37622 - name: vlan-interface
37624 description: String that identifies the interface
37627 example: __VLAN-INTERFACE__
37628 - name: l3-interface-ipv6-address
37630 description: IP address
37633 example: __L3-INTERFACE-IPV6-ADDRESS__
37634 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
37638 summary: returns l3-interface-ipv6-address-list
37639 description: returns l3-interface-ipv6-address-list
37640 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37646 description: successful operation
37648 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37650 description: Response codes found in [response codes](https://wiki.onap.org/).
37654 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37657 example: __VNF-ID2__
37658 - name: interface-name
37660 description: Name given to the interface
37663 example: __INTERFACE-NAME__
37664 - name: vlan-interface
37666 description: String that identifies the interface
37669 example: __VLAN-INTERFACE__
37670 - name: l3-interface-ipv6-address
37672 description: IP address
37675 example: __L3-INTERFACE-IPV6-ADDRESS__
37679 summary: create or update an existing l3-interface-ipv6-address-list
37681 Create or update an existing l3-interface-ipv6-address-list.
37683 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37684 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37693 description: Response codes found in [response codes](https://wiki.onap.org/).
37697 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37700 example: __VNF-ID2__
37701 - name: interface-name
37703 description: Name given to the interface
37706 example: __INTERFACE-NAME__
37707 - name: vlan-interface
37709 description: String that identifies the interface
37712 example: __VLAN-INTERFACE__
37713 - name: l3-interface-ipv6-address
37715 description: IP address
37718 example: __L3-INTERFACE-IPV6-ADDRESS__
37721 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37724 $ref: "#/definitions/l3-interface-ipv6-address-list"
37728 summary: update an existing l3-interface-ipv6-address-list
37730 Update an existing l3-interface-ipv6-address-list
37732 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37733 The PUT operation will entirely replace an existing object.
37734 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37736 Other differences between PUT and PATCH are:
37738 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37739 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37740 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37741 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37750 description: Response codes found in [response codes](https://wiki.onap.org/).
37754 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37757 example: __VNF-ID2__
37758 - name: interface-name
37760 description: Name given to the interface
37763 example: __INTERFACE-NAME__
37764 - name: vlan-interface
37766 description: String that identifies the interface
37769 example: __VLAN-INTERFACE__
37770 - name: l3-interface-ipv6-address
37772 description: IP address
37775 example: __L3-INTERFACE-IPV6-ADDRESS__
37778 description: l3-interface-ipv6-address-list object that needs to be updated.
37781 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37785 summary: delete an existing l3-interface-ipv6-address-list
37786 description: delete an existing l3-interface-ipv6-address-list
37787 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37796 description: Response codes found in [response codes](https://wiki.onap.org/).
37800 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37803 example: __VNF-ID2__
37804 - name: interface-name
37806 description: Name given to the interface
37809 example: __INTERFACE-NAME__
37810 - name: vlan-interface
37812 description: String that identifies the interface
37815 example: __VLAN-INTERFACE__
37816 - name: l3-interface-ipv6-address
37818 description: IP address
37821 example: __L3-INTERFACE-IPV6-ADDRESS__
37822 - name: resource-version
37824 description: resource-version for concurrency
37827 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
37831 summary: returns vlan
37832 description: returns vlan
37833 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37839 description: successful operation
37841 $ref: "#/getDefinitions/vlan"
37843 description: Response codes found in [response codes](https://wiki.onap.org/).
37847 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37850 example: __VNF-ID2__
37851 - name: interface-name
37853 description: Name given to the interface
37856 example: __INTERFACE-NAME__
37857 - name: vlan-interface
37859 description: String that identifies the interface
37862 example: __VLAN-INTERFACE__
37866 summary: create or update an existing vlan
37868 Create or update an existing vlan.
37870 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37871 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37880 description: Response codes found in [response codes](https://wiki.onap.org/).
37884 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37887 example: __VNF-ID2__
37888 - name: interface-name
37890 description: Name given to the interface
37893 example: __INTERFACE-NAME__
37894 - name: vlan-interface
37896 description: String that identifies the interface
37899 example: __VLAN-INTERFACE__
37902 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
37905 $ref: "#/definitions/vlan"
37909 summary: update an existing vlan
37911 Update an existing vlan
37913 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37914 The PUT operation will entirely replace an existing object.
37915 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37917 Other differences between PUT and PATCH are:
37919 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37920 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37921 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37922 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37931 description: Response codes found in [response codes](https://wiki.onap.org/).
37935 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37938 example: __VNF-ID2__
37939 - name: interface-name
37941 description: Name given to the interface
37944 example: __INTERFACE-NAME__
37945 - name: vlan-interface
37947 description: String that identifies the interface
37950 example: __VLAN-INTERFACE__
37953 description: vlan object that needs to be updated.
37956 $ref: "#/patchDefinitions/vlan"
37960 summary: delete an existing vlan
37961 description: delete an existing vlan
37962 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37971 description: Response codes found in [response codes](https://wiki.onap.org/).
37975 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37978 example: __VNF-ID2__
37979 - name: interface-name
37981 description: Name given to the interface
37984 example: __INTERFACE-NAME__
37985 - name: vlan-interface
37987 description: String that identifies the interface
37990 example: __VLAN-INTERFACE__
37991 - name: resource-version
37993 description: resource-version for concurrency
37996 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
38000 summary: returns vlans
38001 description: returns vlans
38002 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
38008 description: successful operation
38010 $ref: "#/getDefinitions/vlans"
38012 description: Response codes found in [response codes](https://wiki.onap.org/).
38016 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38019 example: __VNF-ID2__
38020 - name: interface-name
38022 description: Name given to the interface
38025 example: __INTERFACE-NAME__
38026 - name: vlan-interface
38031 - name: vlan-id-inner
38042 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
38046 summary: see node definition for valid relationships
38047 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38056 description: Response codes found in [response codes](https://wiki.onap.org/).
38060 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38063 example: __VNF-ID2__
38064 - name: interface-name
38066 description: Name given to the interface
38069 example: __INTERFACE-NAME__
38072 description: PCI ID used to identify the sriov-vf
38075 example: __PCI-ID__
38078 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
38081 $ref: "#/definitions/relationship"
38085 summary: delete an existing relationship
38086 description: delete an existing relationship
38087 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38096 description: Response codes found in [response codes](https://wiki.onap.org/).
38100 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38103 example: __VNF-ID2__
38104 - name: interface-name
38106 description: Name given to the interface
38109 example: __INTERFACE-NAME__
38112 description: PCI ID used to identify the sriov-vf
38115 example: __PCI-ID__
38116 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
38120 summary: returns sriov-vf
38121 description: returns sriov-vf
38122 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
38128 description: successful operation
38130 $ref: "#/getDefinitions/sriov-vf"
38132 description: Response codes found in [response codes](https://wiki.onap.org/).
38136 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38139 example: __VNF-ID2__
38140 - name: interface-name
38142 description: Name given to the interface
38145 example: __INTERFACE-NAME__
38148 description: PCI ID used to identify the sriov-vf
38151 example: __PCI-ID__
38155 summary: create or update an existing sriov-vf
38157 Create or update an existing sriov-vf.
38159 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38160 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
38169 description: Response codes found in [response codes](https://wiki.onap.org/).
38173 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38176 example: __VNF-ID2__
38177 - name: interface-name
38179 description: Name given to the interface
38182 example: __INTERFACE-NAME__
38185 description: PCI ID used to identify the sriov-vf
38188 example: __PCI-ID__
38191 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
38194 $ref: "#/definitions/sriov-vf"
38198 summary: update an existing sriov-vf
38200 Update an existing sriov-vf
38202 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38203 The PUT operation will entirely replace an existing object.
38204 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38206 Other differences between PUT and PATCH are:
38208 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38209 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38210 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38211 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
38220 description: Response codes found in [response codes](https://wiki.onap.org/).
38224 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38227 example: __VNF-ID2__
38228 - name: interface-name
38230 description: Name given to the interface
38233 example: __INTERFACE-NAME__
38236 description: PCI ID used to identify the sriov-vf
38239 example: __PCI-ID__
38242 description: sriov-vf object that needs to be updated.
38245 $ref: "#/patchDefinitions/sriov-vf"
38249 summary: delete an existing sriov-vf
38250 description: delete an existing sriov-vf
38251 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
38260 description: Response codes found in [response codes](https://wiki.onap.org/).
38264 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38267 example: __VNF-ID2__
38268 - name: interface-name
38270 description: Name given to the interface
38273 example: __INTERFACE-NAME__
38276 description: PCI ID used to identify the sriov-vf
38279 example: __PCI-ID__
38280 - name: resource-version
38282 description: resource-version for concurrency
38285 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38289 summary: returns sriov-vfs
38290 description: returns sriov-vfs
38291 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
38297 description: successful operation
38299 $ref: "#/getDefinitions/sriov-vfs"
38301 description: Response codes found in [response codes](https://wiki.onap.org/).
38305 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38308 example: __VNF-ID2__
38309 - name: interface-name
38311 description: Name given to the interface
38314 example: __INTERFACE-NAME__
38320 - name: vf-vlan-filter
38325 - name: vf-mac-filter
38330 - name: vf-vlan-strip
38335 - name: neutron-network-id
38340 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38344 summary: see node definition for valid relationships
38345 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
38354 description: Response codes found in [response codes](https://wiki.onap.org/).
38358 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38361 example: __VNF-ID2__
38362 - name: interface-name
38364 description: Name given to the interface
38367 example: __INTERFACE-NAME__
38370 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)
38373 $ref: "#/definitions/relationship"
38377 summary: delete an existing relationship
38378 description: delete an existing relationship
38379 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
38388 description: Response codes found in [response codes](https://wiki.onap.org/).
38392 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38395 example: __VNF-ID2__
38396 - name: interface-name
38398 description: Name given to the interface
38401 example: __INTERFACE-NAME__
38402 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
38406 summary: see node definition for valid relationships
38407 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38416 description: Response codes found in [response codes](https://wiki.onap.org/).
38420 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38423 example: __VNF-ID2__
38424 - name: interface-name
38426 description: Name given to the interface
38429 example: __INTERFACE-NAME__
38430 - name: l3-interface-ipv4-address
38432 description: IP address
38435 example: __L3-INTERFACE-IPV4-ADDRESS__
38438 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38441 $ref: "#/definitions/relationship"
38445 summary: delete an existing relationship
38446 description: delete an existing relationship
38447 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38456 description: Response codes found in [response codes](https://wiki.onap.org/).
38460 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38463 example: __VNF-ID2__
38464 - name: interface-name
38466 description: Name given to the interface
38469 example: __INTERFACE-NAME__
38470 - name: l3-interface-ipv4-address
38472 description: IP address
38475 example: __L3-INTERFACE-IPV4-ADDRESS__
38476 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
38480 summary: returns l3-interface-ipv4-address-list
38481 description: returns l3-interface-ipv4-address-list
38482 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38488 description: successful operation
38490 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38492 description: Response codes found in [response codes](https://wiki.onap.org/).
38496 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38499 example: __VNF-ID2__
38500 - name: interface-name
38502 description: Name given to the interface
38505 example: __INTERFACE-NAME__
38506 - name: l3-interface-ipv4-address
38508 description: IP address
38511 example: __L3-INTERFACE-IPV4-ADDRESS__
38515 summary: create or update an existing l3-interface-ipv4-address-list
38517 Create or update an existing l3-interface-ipv4-address-list.
38519 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38520 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38529 description: Response codes found in [response codes](https://wiki.onap.org/).
38533 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38536 example: __VNF-ID2__
38537 - name: interface-name
38539 description: Name given to the interface
38542 example: __INTERFACE-NAME__
38543 - name: l3-interface-ipv4-address
38545 description: IP address
38548 example: __L3-INTERFACE-IPV4-ADDRESS__
38551 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38554 $ref: "#/definitions/l3-interface-ipv4-address-list"
38558 summary: update an existing l3-interface-ipv4-address-list
38560 Update an existing l3-interface-ipv4-address-list
38562 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38563 The PUT operation will entirely replace an existing object.
38564 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38566 Other differences between PUT and PATCH are:
38568 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38569 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38570 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38571 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38580 description: Response codes found in [response codes](https://wiki.onap.org/).
38584 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38587 example: __VNF-ID2__
38588 - name: interface-name
38590 description: Name given to the interface
38593 example: __INTERFACE-NAME__
38594 - name: l3-interface-ipv4-address
38596 description: IP address
38599 example: __L3-INTERFACE-IPV4-ADDRESS__
38602 description: l3-interface-ipv4-address-list object that needs to be updated.
38605 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38609 summary: delete an existing l3-interface-ipv4-address-list
38610 description: delete an existing l3-interface-ipv4-address-list
38611 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38620 description: Response codes found in [response codes](https://wiki.onap.org/).
38624 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38627 example: __VNF-ID2__
38628 - name: interface-name
38630 description: Name given to the interface
38633 example: __INTERFACE-NAME__
38634 - name: l3-interface-ipv4-address
38636 description: IP address
38639 example: __L3-INTERFACE-IPV4-ADDRESS__
38640 - name: resource-version
38642 description: resource-version for concurrency
38645 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
38649 summary: see node definition for valid relationships
38650 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38659 description: Response codes found in [response codes](https://wiki.onap.org/).
38663 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38666 example: __VNF-ID2__
38667 - name: interface-name
38669 description: Name given to the interface
38672 example: __INTERFACE-NAME__
38673 - name: l3-interface-ipv6-address
38675 description: IP address
38678 example: __L3-INTERFACE-IPV6-ADDRESS__
38681 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38684 $ref: "#/definitions/relationship"
38688 summary: delete an existing relationship
38689 description: delete an existing relationship
38690 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38699 description: Response codes found in [response codes](https://wiki.onap.org/).
38703 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38706 example: __VNF-ID2__
38707 - name: interface-name
38709 description: Name given to the interface
38712 example: __INTERFACE-NAME__
38713 - name: l3-interface-ipv6-address
38715 description: IP address
38718 example: __L3-INTERFACE-IPV6-ADDRESS__
38719 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
38723 summary: returns l3-interface-ipv6-address-list
38724 description: returns l3-interface-ipv6-address-list
38725 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38731 description: successful operation
38733 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38735 description: Response codes found in [response codes](https://wiki.onap.org/).
38739 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38742 example: __VNF-ID2__
38743 - name: interface-name
38745 description: Name given to the interface
38748 example: __INTERFACE-NAME__
38749 - name: l3-interface-ipv6-address
38751 description: IP address
38754 example: __L3-INTERFACE-IPV6-ADDRESS__
38758 summary: create or update an existing l3-interface-ipv6-address-list
38760 Create or update an existing l3-interface-ipv6-address-list.
38762 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38763 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38772 description: Response codes found in [response codes](https://wiki.onap.org/).
38776 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38779 example: __VNF-ID2__
38780 - name: interface-name
38782 description: Name given to the interface
38785 example: __INTERFACE-NAME__
38786 - name: l3-interface-ipv6-address
38788 description: IP address
38791 example: __L3-INTERFACE-IPV6-ADDRESS__
38794 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38797 $ref: "#/definitions/l3-interface-ipv6-address-list"
38801 summary: update an existing l3-interface-ipv6-address-list
38803 Update an existing l3-interface-ipv6-address-list
38805 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38806 The PUT operation will entirely replace an existing object.
38807 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38809 Other differences between PUT and PATCH are:
38811 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38812 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38813 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38814 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38823 description: Response codes found in [response codes](https://wiki.onap.org/).
38827 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38830 example: __VNF-ID2__
38831 - name: interface-name
38833 description: Name given to the interface
38836 example: __INTERFACE-NAME__
38837 - name: l3-interface-ipv6-address
38839 description: IP address
38842 example: __L3-INTERFACE-IPV6-ADDRESS__
38845 description: l3-interface-ipv6-address-list object that needs to be updated.
38848 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38852 summary: delete an existing l3-interface-ipv6-address-list
38853 description: delete an existing l3-interface-ipv6-address-list
38854 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38863 description: Response codes found in [response codes](https://wiki.onap.org/).
38867 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38870 example: __VNF-ID2__
38871 - name: interface-name
38873 description: Name given to the interface
38876 example: __INTERFACE-NAME__
38877 - name: l3-interface-ipv6-address
38879 description: IP address
38882 example: __L3-INTERFACE-IPV6-ADDRESS__
38883 - name: resource-version
38885 description: resource-version for concurrency
38888 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
38892 summary: returns l-interface
38893 description: returns l-interface
38894 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
38900 description: successful operation
38902 $ref: "#/getDefinitions/l-interface"
38904 description: Response codes found in [response codes](https://wiki.onap.org/).
38908 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38911 example: __VNF-ID2__
38912 - name: interface-name
38914 description: Name given to the interface
38917 example: __INTERFACE-NAME__
38921 summary: create or update an existing l-interface
38923 Create or update an existing l-interface.
38925 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38926 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
38935 description: Response codes found in [response codes](https://wiki.onap.org/).
38939 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38942 example: __VNF-ID2__
38943 - name: interface-name
38945 description: Name given to the interface
38948 example: __INTERFACE-NAME__
38951 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)
38954 $ref: "#/definitions/l-interface"
38958 summary: update an existing l-interface
38960 Update an existing l-interface
38962 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38963 The PUT operation will entirely replace an existing object.
38964 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38966 Other differences between PUT and PATCH are:
38968 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38969 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38970 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38971 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
38980 description: Response codes found in [response codes](https://wiki.onap.org/).
38984 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38987 example: __VNF-ID2__
38988 - name: interface-name
38990 description: Name given to the interface
38993 example: __INTERFACE-NAME__
38996 description: l-interface object that needs to be updated.
38999 $ref: "#/patchDefinitions/l-interface"
39003 summary: delete an existing l-interface
39004 description: delete an existing l-interface
39005 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
39014 description: Response codes found in [response codes](https://wiki.onap.org/).
39018 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39021 example: __VNF-ID2__
39022 - name: interface-name
39024 description: Name given to the interface
39027 example: __INTERFACE-NAME__
39028 - name: resource-version
39030 description: resource-version for concurrency
39033 /network/newvces/newvce/{vnf-id2}/l-interfaces:
39037 summary: returns l-interfaces
39038 description: returns l-interfaces
39039 operationId: getNetworkNewvcesNewvceLInterfaces
39045 description: successful operation
39047 $ref: "#/getDefinitions/l-interfaces"
39049 description: Response codes found in [response codes](https://wiki.onap.org/).
39053 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39056 example: __VNF-ID2__
39057 - name: interface-name
39062 - name: interface-id
39072 - name: network-name
39077 /network/newvces/newvce/{vnf-id2}:
39081 summary: returns newvce
39082 description: returns newvce
39083 operationId: getNetworkNewvcesNewvce
39089 description: successful operation
39091 $ref: "#/getDefinitions/newvce"
39093 description: Response codes found in [response codes](https://wiki.onap.org/).
39097 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39100 example: __VNF-ID2__
39104 summary: create or update an existing newvce
39106 Create or update an existing newvce.
39108 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39109 operationId: createOrUpdateNetworkNewvcesNewvce
39118 description: Response codes found in [response codes](https://wiki.onap.org/).
39122 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39125 example: __VNF-ID2__
39128 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvce.json)
39131 $ref: "#/definitions/newvce"
39135 summary: update an existing newvce
39137 Update an existing newvce
39139 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39140 The PUT operation will entirely replace an existing object.
39141 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39143 Other differences between PUT and PATCH are:
39145 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39146 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39147 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39148 operationId: UpdateNetworkNewvcesNewvce
39157 description: Response codes found in [response codes](https://wiki.onap.org/).
39161 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39164 example: __VNF-ID2__
39167 description: newvce object that needs to be updated.
39170 $ref: "#/patchDefinitions/newvce"
39174 summary: delete an existing newvce
39175 description: delete an existing newvce
39176 operationId: deleteNetworkNewvcesNewvce
39185 description: Response codes found in [response codes](https://wiki.onap.org/).
39189 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39192 example: __VNF-ID2__
39193 - name: resource-version
39195 description: resource-version for concurrency
39202 summary: returns newvces
39203 description: returns newvces
39204 operationId: getNetworkNewvces
39210 description: successful operation
39212 $ref: "#/getDefinitions/newvces"
39214 description: Response codes found in [response codes](https://wiki.onap.org/).
39236 - name: prov-status
39241 - name: heat-stack-id
39246 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
39250 summary: see node definition for valid relationships
39251 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
39260 description: Response codes found in [response codes](https://wiki.onap.org/).
39264 description: unique name of Physical Network Function.
39267 example: __PNF-NAME__
39270 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnf.json)
39273 $ref: "#/definitions/relationship"
39277 summary: delete an existing relationship
39278 description: delete an existing relationship
39279 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
39300 summary: see node definition for valid relationships
39301 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
39310 description: Response codes found in [response codes](https://wiki.onap.org/).
39314 description: unique name of Physical Network Function.
39317 example: __PNF-NAME__
39318 - name: interface-name
39320 description: Name that identifies the physical interface
39323 example: __INTERFACE-NAME__
39326 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterface.json)
39329 $ref: "#/definitions/relationship"
39333 summary: delete an existing relationship
39334 description: delete an existing relationship
39335 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
39344 description: Response codes found in [response codes](https://wiki.onap.org/).
39348 description: unique name of Physical Network Function.
39351 example: __PNF-NAME__
39352 - name: interface-name
39354 description: Name that identifies the physical interface
39357 example: __INTERFACE-NAME__
39358 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
39362 summary: see node definition for valid relationships
39363 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
39372 description: Response codes found in [response codes](https://wiki.onap.org/).
39376 description: unique name of Physical Network Function.
39379 example: __PNF-NAME__
39380 - name: interface-name
39382 description: Name that identifies the physical interface
39385 example: __INTERFACE-NAME__
39388 description: Identifier for the sriov-pf
39391 example: __PF-PCI-ID__
39394 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
39397 $ref: "#/definitions/relationship"
39401 summary: delete an existing relationship
39402 description: delete an existing relationship
39403 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
39412 description: Response codes found in [response codes](https://wiki.onap.org/).
39416 description: unique name of Physical Network Function.
39419 example: __PNF-NAME__
39420 - name: interface-name
39422 description: Name that identifies the physical interface
39425 example: __INTERFACE-NAME__
39428 description: Identifier for the sriov-pf
39431 example: __PF-PCI-ID__
39432 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
39436 summary: returns sriov-pf
39437 description: returns sriov-pf
39438 operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39444 description: successful operation
39446 $ref: "#/getDefinitions/sriov-pf"
39448 description: Response codes found in [response codes](https://wiki.onap.org/).
39452 description: unique name of Physical Network Function.
39455 example: __PNF-NAME__
39456 - name: interface-name
39458 description: Name that identifies the physical interface
39461 example: __INTERFACE-NAME__
39464 description: Identifier for the sriov-pf
39467 example: __PF-PCI-ID__
39471 summary: create or update an existing sriov-pf
39473 Create or update an existing sriov-pf.
39475 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39476 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39485 description: Response codes found in [response codes](https://wiki.onap.org/).
39489 description: unique name of Physical Network Function.
39492 example: __PNF-NAME__
39493 - name: interface-name
39495 description: Name that identifies the physical interface
39498 example: __INTERFACE-NAME__
39501 description: Identifier for the sriov-pf
39504 example: __PF-PCI-ID__
39507 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
39510 $ref: "#/definitions/sriov-pf"
39514 summary: update an existing sriov-pf
39516 Update an existing sriov-pf
39518 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39519 The PUT operation will entirely replace an existing object.
39520 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39522 Other differences between PUT and PATCH are:
39524 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39525 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39526 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39527 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39536 description: Response codes found in [response codes](https://wiki.onap.org/).
39540 description: unique name of Physical Network Function.
39543 example: __PNF-NAME__
39544 - name: interface-name
39546 description: Name that identifies the physical interface
39549 example: __INTERFACE-NAME__
39552 description: Identifier for the sriov-pf
39555 example: __PF-PCI-ID__
39558 description: sriov-pf object that needs to be updated.
39561 $ref: "#/patchDefinitions/sriov-pf"
39565 summary: delete an existing sriov-pf
39566 description: delete an existing sriov-pf
39567 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39576 description: Response codes found in [response codes](https://wiki.onap.org/).
39580 description: unique name of Physical Network Function.
39583 example: __PNF-NAME__
39584 - name: interface-name
39586 description: Name that identifies the physical interface
39589 example: __INTERFACE-NAME__
39592 description: Identifier for the sriov-pf
39595 example: __PF-PCI-ID__
39596 - name: resource-version
39598 description: resource-version for concurrency
39601 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
39605 summary: returns sriov-pfs
39606 description: returns sriov-pfs
39607 operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
39613 description: successful operation
39615 $ref: "#/getDefinitions/sriov-pfs"
39617 description: Response codes found in [response codes](https://wiki.onap.org/).
39621 description: unique name of Physical Network Function.
39624 example: __PNF-NAME__
39625 - name: interface-name
39627 description: Name that identifies the physical interface
39630 example: __INTERFACE-NAME__
39636 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
39640 summary: see node definition for valid relationships
39641 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39650 description: Response codes found in [response codes](https://wiki.onap.org/).
39654 description: unique name of Physical Network Function.
39657 example: __PNF-NAME__
39658 - name: interface-name
39660 description: Name that identifies the physical interface
39663 example: __INTERFACE-NAME__
39664 - name: interface-name
39666 description: Name given to the interface
39669 example: __INTERFACE-NAME__
39670 - name: vlan-interface
39672 description: String that identifies the interface
39675 example: __VLAN-INTERFACE__
39678 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
39681 $ref: "#/definitions/relationship"
39685 summary: delete an existing relationship
39686 description: delete an existing relationship
39687 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39696 description: Response codes found in [response codes](https://wiki.onap.org/).
39700 description: unique name of Physical Network Function.
39703 example: __PNF-NAME__
39704 - name: interface-name
39706 description: Name that identifies the physical interface
39709 example: __INTERFACE-NAME__
39710 - name: interface-name
39712 description: Name given to the interface
39715 example: __INTERFACE-NAME__
39716 - name: vlan-interface
39718 description: String that identifies the interface
39721 example: __VLAN-INTERFACE__
39722 /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:
39726 summary: see node definition for valid relationships
39727 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39736 description: Response codes found in [response codes](https://wiki.onap.org/).
39740 description: unique name of Physical Network Function.
39743 example: __PNF-NAME__
39744 - name: interface-name
39746 description: Name that identifies the physical interface
39749 example: __INTERFACE-NAME__
39750 - name: interface-name
39752 description: Name given to the interface
39755 example: __INTERFACE-NAME__
39756 - name: vlan-interface
39758 description: String that identifies the interface
39761 example: __VLAN-INTERFACE__
39762 - name: l3-interface-ipv4-address
39764 description: IP address
39767 example: __L3-INTERFACE-IPV4-ADDRESS__
39770 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39773 $ref: "#/definitions/relationship"
39777 summary: delete an existing relationship
39778 description: delete an existing relationship
39779 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39788 description: Response codes found in [response codes](https://wiki.onap.org/).
39792 description: unique name of Physical Network Function.
39795 example: __PNF-NAME__
39796 - name: interface-name
39798 description: Name that identifies the physical interface
39801 example: __INTERFACE-NAME__
39802 - name: interface-name
39804 description: Name given to the interface
39807 example: __INTERFACE-NAME__
39808 - name: vlan-interface
39810 description: String that identifies the interface
39813 example: __VLAN-INTERFACE__
39814 - name: l3-interface-ipv4-address
39816 description: IP address
39819 example: __L3-INTERFACE-IPV4-ADDRESS__
39820 /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}:
39824 summary: returns l3-interface-ipv4-address-list
39825 description: returns l3-interface-ipv4-address-list
39826 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39832 description: successful operation
39834 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39836 description: Response codes found in [response codes](https://wiki.onap.org/).
39840 description: unique name of Physical Network Function.
39843 example: __PNF-NAME__
39844 - name: interface-name
39846 description: Name that identifies the physical interface
39849 example: __INTERFACE-NAME__
39850 - name: interface-name
39852 description: Name given to the interface
39855 example: __INTERFACE-NAME__
39856 - name: vlan-interface
39858 description: String that identifies the interface
39861 example: __VLAN-INTERFACE__
39862 - name: l3-interface-ipv4-address
39864 description: IP address
39867 example: __L3-INTERFACE-IPV4-ADDRESS__
39871 summary: create or update an existing l3-interface-ipv4-address-list
39873 Create or update an existing l3-interface-ipv4-address-list.
39875 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39876 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39885 description: Response codes found in [response codes](https://wiki.onap.org/).
39889 description: unique name of Physical Network Function.
39892 example: __PNF-NAME__
39893 - name: interface-name
39895 description: Name that identifies the physical interface
39898 example: __INTERFACE-NAME__
39899 - name: interface-name
39901 description: Name given to the interface
39904 example: __INTERFACE-NAME__
39905 - name: vlan-interface
39907 description: String that identifies the interface
39910 example: __VLAN-INTERFACE__
39911 - name: l3-interface-ipv4-address
39913 description: IP address
39916 example: __L3-INTERFACE-IPV4-ADDRESS__
39919 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39922 $ref: "#/definitions/l3-interface-ipv4-address-list"
39926 summary: update an existing l3-interface-ipv4-address-list
39928 Update an existing l3-interface-ipv4-address-list
39930 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39931 The PUT operation will entirely replace an existing object.
39932 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39934 Other differences between PUT and PATCH are:
39936 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39937 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39938 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39939 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39948 description: Response codes found in [response codes](https://wiki.onap.org/).
39952 description: unique name of Physical Network Function.
39955 example: __PNF-NAME__
39956 - name: interface-name
39958 description: Name that identifies the physical interface
39961 example: __INTERFACE-NAME__
39962 - name: interface-name
39964 description: Name given to the interface
39967 example: __INTERFACE-NAME__
39968 - name: vlan-interface
39970 description: String that identifies the interface
39973 example: __VLAN-INTERFACE__
39974 - name: l3-interface-ipv4-address
39976 description: IP address
39979 example: __L3-INTERFACE-IPV4-ADDRESS__
39982 description: l3-interface-ipv4-address-list object that needs to be updated.
39985 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39989 summary: delete an existing l3-interface-ipv4-address-list
39990 description: delete an existing l3-interface-ipv4-address-list
39991 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40000 description: Response codes found in [response codes](https://wiki.onap.org/).
40004 description: unique name of Physical Network Function.
40007 example: __PNF-NAME__
40008 - name: interface-name
40010 description: Name that identifies the physical interface
40013 example: __INTERFACE-NAME__
40014 - name: interface-name
40016 description: Name given to the interface
40019 example: __INTERFACE-NAME__
40020 - name: vlan-interface
40022 description: String that identifies the interface
40025 example: __VLAN-INTERFACE__
40026 - name: l3-interface-ipv4-address
40028 description: IP address
40031 example: __L3-INTERFACE-IPV4-ADDRESS__
40032 - name: resource-version
40034 description: resource-version for concurrency
40037 /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:
40041 summary: see node definition for valid relationships
40042 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
40051 description: Response codes found in [response codes](https://wiki.onap.org/).
40055 description: unique name of Physical Network Function.
40058 example: __PNF-NAME__
40059 - name: interface-name
40061 description: Name that identifies the physical interface
40064 example: __INTERFACE-NAME__
40065 - name: interface-name
40067 description: Name given to the interface
40070 example: __INTERFACE-NAME__
40071 - name: vlan-interface
40073 description: String that identifies the interface
40076 example: __VLAN-INTERFACE__
40077 - name: l3-interface-ipv6-address
40079 description: IP address
40082 example: __L3-INTERFACE-IPV6-ADDRESS__
40085 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
40088 $ref: "#/definitions/relationship"
40092 summary: delete an existing relationship
40093 description: delete an existing relationship
40094 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
40103 description: Response codes found in [response codes](https://wiki.onap.org/).
40107 description: unique name of Physical Network Function.
40110 example: __PNF-NAME__
40111 - name: interface-name
40113 description: Name that identifies the physical interface
40116 example: __INTERFACE-NAME__
40117 - name: interface-name
40119 description: Name given to the interface
40122 example: __INTERFACE-NAME__
40123 - name: vlan-interface
40125 description: String that identifies the interface
40128 example: __VLAN-INTERFACE__
40129 - name: l3-interface-ipv6-address
40131 description: IP address
40134 example: __L3-INTERFACE-IPV6-ADDRESS__
40135 /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}:
40139 summary: returns l3-interface-ipv6-address-list
40140 description: returns l3-interface-ipv6-address-list
40141 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40147 description: successful operation
40149 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
40151 description: Response codes found in [response codes](https://wiki.onap.org/).
40155 description: unique name of Physical Network Function.
40158 example: __PNF-NAME__
40159 - name: interface-name
40161 description: Name that identifies the physical interface
40164 example: __INTERFACE-NAME__
40165 - name: interface-name
40167 description: Name given to the interface
40170 example: __INTERFACE-NAME__
40171 - name: vlan-interface
40173 description: String that identifies the interface
40176 example: __VLAN-INTERFACE__
40177 - name: l3-interface-ipv6-address
40179 description: IP address
40182 example: __L3-INTERFACE-IPV6-ADDRESS__
40186 summary: create or update an existing l3-interface-ipv6-address-list
40188 Create or update an existing l3-interface-ipv6-address-list.
40190 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40191 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40200 description: Response codes found in [response codes](https://wiki.onap.org/).
40204 description: unique name of Physical Network Function.
40207 example: __PNF-NAME__
40208 - name: interface-name
40210 description: Name that identifies the physical interface
40213 example: __INTERFACE-NAME__
40214 - name: interface-name
40216 description: Name given to the interface
40219 example: __INTERFACE-NAME__
40220 - name: vlan-interface
40222 description: String that identifies the interface
40225 example: __VLAN-INTERFACE__
40226 - name: l3-interface-ipv6-address
40228 description: IP address
40231 example: __L3-INTERFACE-IPV6-ADDRESS__
40234 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
40237 $ref: "#/definitions/l3-interface-ipv6-address-list"
40241 summary: update an existing l3-interface-ipv6-address-list
40243 Update an existing l3-interface-ipv6-address-list
40245 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40246 The PUT operation will entirely replace an existing object.
40247 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40249 Other differences between PUT and PATCH are:
40251 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40252 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40253 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40254 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40263 description: Response codes found in [response codes](https://wiki.onap.org/).
40267 description: unique name of Physical Network Function.
40270 example: __PNF-NAME__
40271 - name: interface-name
40273 description: Name that identifies the physical interface
40276 example: __INTERFACE-NAME__
40277 - name: interface-name
40279 description: Name given to the interface
40282 example: __INTERFACE-NAME__
40283 - name: vlan-interface
40285 description: String that identifies the interface
40288 example: __VLAN-INTERFACE__
40289 - name: l3-interface-ipv6-address
40291 description: IP address
40294 example: __L3-INTERFACE-IPV6-ADDRESS__
40297 description: l3-interface-ipv6-address-list object that needs to be updated.
40300 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40304 summary: delete an existing l3-interface-ipv6-address-list
40305 description: delete an existing l3-interface-ipv6-address-list
40306 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40315 description: Response codes found in [response codes](https://wiki.onap.org/).
40319 description: unique name of Physical Network Function.
40322 example: __PNF-NAME__
40323 - name: interface-name
40325 description: Name that identifies the physical interface
40328 example: __INTERFACE-NAME__
40329 - name: interface-name
40331 description: Name given to the interface
40334 example: __INTERFACE-NAME__
40335 - name: vlan-interface
40337 description: String that identifies the interface
40340 example: __VLAN-INTERFACE__
40341 - name: l3-interface-ipv6-address
40343 description: IP address
40346 example: __L3-INTERFACE-IPV6-ADDRESS__
40347 - name: resource-version
40349 description: resource-version for concurrency
40352 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
40356 summary: returns vlan
40357 description: returns vlan
40358 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40364 description: successful operation
40366 $ref: "#/getDefinitions/vlan"
40368 description: Response codes found in [response codes](https://wiki.onap.org/).
40372 description: unique name of Physical Network Function.
40375 example: __PNF-NAME__
40376 - name: interface-name
40378 description: Name that identifies the physical interface
40381 example: __INTERFACE-NAME__
40382 - name: interface-name
40384 description: Name given to the interface
40387 example: __INTERFACE-NAME__
40388 - name: vlan-interface
40390 description: String that identifies the interface
40393 example: __VLAN-INTERFACE__
40397 summary: create or update an existing vlan
40399 Create or update an existing vlan.
40401 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40402 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40411 description: Response codes found in [response codes](https://wiki.onap.org/).
40415 description: unique name of Physical Network Function.
40418 example: __PNF-NAME__
40419 - name: interface-name
40421 description: Name that identifies the physical interface
40424 example: __INTERFACE-NAME__
40425 - name: interface-name
40427 description: Name given to the interface
40430 example: __INTERFACE-NAME__
40431 - name: vlan-interface
40433 description: String that identifies the interface
40436 example: __VLAN-INTERFACE__
40439 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
40442 $ref: "#/definitions/vlan"
40446 summary: update an existing vlan
40448 Update an existing vlan
40450 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40451 The PUT operation will entirely replace an existing object.
40452 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40454 Other differences between PUT and PATCH are:
40456 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40457 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40458 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40459 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40468 description: Response codes found in [response codes](https://wiki.onap.org/).
40472 description: unique name of Physical Network Function.
40475 example: __PNF-NAME__
40476 - name: interface-name
40478 description: Name that identifies the physical interface
40481 example: __INTERFACE-NAME__
40482 - name: interface-name
40484 description: Name given to the interface
40487 example: __INTERFACE-NAME__
40488 - name: vlan-interface
40490 description: String that identifies the interface
40493 example: __VLAN-INTERFACE__
40496 description: vlan object that needs to be updated.
40499 $ref: "#/patchDefinitions/vlan"
40503 summary: delete an existing vlan
40504 description: delete an existing vlan
40505 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40514 description: Response codes found in [response codes](https://wiki.onap.org/).
40518 description: unique name of Physical Network Function.
40521 example: __PNF-NAME__
40522 - name: interface-name
40524 description: Name that identifies the physical interface
40527 example: __INTERFACE-NAME__
40528 - name: interface-name
40530 description: Name given to the interface
40533 example: __INTERFACE-NAME__
40534 - name: vlan-interface
40536 description: String that identifies the interface
40539 example: __VLAN-INTERFACE__
40540 - name: resource-version
40542 description: resource-version for concurrency
40545 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
40549 summary: returns vlans
40550 description: returns vlans
40551 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
40557 description: successful operation
40559 $ref: "#/getDefinitions/vlans"
40561 description: Response codes found in [response codes](https://wiki.onap.org/).
40565 description: unique name of Physical Network Function.
40568 example: __PNF-NAME__
40569 - name: interface-name
40571 description: Name that identifies the physical interface
40574 example: __INTERFACE-NAME__
40575 - name: interface-name
40577 description: Name given to the interface
40580 example: __INTERFACE-NAME__
40581 - name: vlan-interface
40586 - name: vlan-id-inner
40597 /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:
40601 summary: see node definition for valid relationships
40602 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40611 description: Response codes found in [response codes](https://wiki.onap.org/).
40615 description: unique name of Physical Network Function.
40618 example: __PNF-NAME__
40619 - name: interface-name
40621 description: Name that identifies the physical interface
40624 example: __INTERFACE-NAME__
40625 - name: interface-name
40627 description: Name given to the interface
40630 example: __INTERFACE-NAME__
40633 description: PCI ID used to identify the sriov-vf
40636 example: __PCI-ID__
40639 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40642 $ref: "#/definitions/relationship"
40646 summary: delete an existing relationship
40647 description: delete an existing relationship
40648 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40657 description: Response codes found in [response codes](https://wiki.onap.org/).
40661 description: unique name of Physical Network Function.
40664 example: __PNF-NAME__
40665 - name: interface-name
40667 description: Name that identifies the physical interface
40670 example: __INTERFACE-NAME__
40671 - name: interface-name
40673 description: Name given to the interface
40676 example: __INTERFACE-NAME__
40679 description: PCI ID used to identify the sriov-vf
40682 example: __PCI-ID__
40683 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
40687 summary: returns sriov-vf
40688 description: returns sriov-vf
40689 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40695 description: successful operation
40697 $ref: "#/getDefinitions/sriov-vf"
40699 description: Response codes found in [response codes](https://wiki.onap.org/).
40703 description: unique name of Physical Network Function.
40706 example: __PNF-NAME__
40707 - name: interface-name
40709 description: Name that identifies the physical interface
40712 example: __INTERFACE-NAME__
40713 - name: interface-name
40715 description: Name given to the interface
40718 example: __INTERFACE-NAME__
40721 description: PCI ID used to identify the sriov-vf
40724 example: __PCI-ID__
40728 summary: create or update an existing sriov-vf
40730 Create or update an existing sriov-vf.
40732 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40733 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40742 description: Response codes found in [response codes](https://wiki.onap.org/).
40746 description: unique name of Physical Network Function.
40749 example: __PNF-NAME__
40750 - name: interface-name
40752 description: Name that identifies the physical interface
40755 example: __INTERFACE-NAME__
40756 - name: interface-name
40758 description: Name given to the interface
40761 example: __INTERFACE-NAME__
40764 description: PCI ID used to identify the sriov-vf
40767 example: __PCI-ID__
40770 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40773 $ref: "#/definitions/sriov-vf"
40777 summary: update an existing sriov-vf
40779 Update an existing sriov-vf
40781 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40782 The PUT operation will entirely replace an existing object.
40783 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40785 Other differences between PUT and PATCH are:
40787 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40788 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40789 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40790 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40799 description: Response codes found in [response codes](https://wiki.onap.org/).
40803 description: unique name of Physical Network Function.
40806 example: __PNF-NAME__
40807 - name: interface-name
40809 description: Name that identifies the physical interface
40812 example: __INTERFACE-NAME__
40813 - name: interface-name
40815 description: Name given to the interface
40818 example: __INTERFACE-NAME__
40821 description: PCI ID used to identify the sriov-vf
40824 example: __PCI-ID__
40827 description: sriov-vf object that needs to be updated.
40830 $ref: "#/patchDefinitions/sriov-vf"
40834 summary: delete an existing sriov-vf
40835 description: delete an existing sriov-vf
40836 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40845 description: Response codes found in [response codes](https://wiki.onap.org/).
40849 description: unique name of Physical Network Function.
40852 example: __PNF-NAME__
40853 - name: interface-name
40855 description: Name that identifies the physical interface
40858 example: __INTERFACE-NAME__
40859 - name: interface-name
40861 description: Name given to the interface
40864 example: __INTERFACE-NAME__
40867 description: PCI ID used to identify the sriov-vf
40870 example: __PCI-ID__
40871 - name: resource-version
40873 description: resource-version for concurrency
40876 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
40880 summary: returns sriov-vfs
40881 description: returns sriov-vfs
40882 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
40888 description: successful operation
40890 $ref: "#/getDefinitions/sriov-vfs"
40892 description: Response codes found in [response codes](https://wiki.onap.org/).
40896 description: unique name of Physical Network Function.
40899 example: __PNF-NAME__
40900 - name: interface-name
40902 description: Name that identifies the physical interface
40905 example: __INTERFACE-NAME__
40906 - name: interface-name
40908 description: Name given to the interface
40911 example: __INTERFACE-NAME__
40917 - name: vf-vlan-filter
40922 - name: vf-mac-filter
40927 - name: vf-vlan-strip
40932 - name: neutron-network-id
40937 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
40941 summary: see node definition for valid relationships
40942 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
40951 description: Response codes found in [response codes](https://wiki.onap.org/).
40955 description: unique name of Physical Network Function.
40958 example: __PNF-NAME__
40959 - name: interface-name
40961 description: Name that identifies the physical interface
40964 example: __INTERFACE-NAME__
40965 - name: interface-name
40967 description: Name given to the interface
40970 example: __INTERFACE-NAME__
40973 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
40976 $ref: "#/definitions/relationship"
40980 summary: delete an existing relationship
40981 description: delete an existing relationship
40982 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
40991 description: Response codes found in [response codes](https://wiki.onap.org/).
40995 description: unique name of Physical Network Function.
40998 example: __PNF-NAME__
40999 - name: interface-name
41001 description: Name that identifies the physical interface
41004 example: __INTERFACE-NAME__
41005 - name: interface-name
41007 description: Name given to the interface
41010 example: __INTERFACE-NAME__
41011 /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:
41015 summary: see node definition for valid relationships
41016 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41025 description: Response codes found in [response codes](https://wiki.onap.org/).
41029 description: unique name of Physical Network Function.
41032 example: __PNF-NAME__
41033 - name: interface-name
41035 description: Name that identifies the physical interface
41038 example: __INTERFACE-NAME__
41039 - name: interface-name
41041 description: Name given to the interface
41044 example: __INTERFACE-NAME__
41045 - name: l3-interface-ipv4-address
41047 description: IP address
41050 example: __L3-INTERFACE-IPV4-ADDRESS__
41053 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
41056 $ref: "#/definitions/relationship"
41060 summary: delete an existing relationship
41061 description: delete an existing relationship
41062 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41071 description: Response codes found in [response codes](https://wiki.onap.org/).
41075 description: unique name of Physical Network Function.
41078 example: __PNF-NAME__
41079 - name: interface-name
41081 description: Name that identifies the physical interface
41084 example: __INTERFACE-NAME__
41085 - name: interface-name
41087 description: Name given to the interface
41090 example: __INTERFACE-NAME__
41091 - name: l3-interface-ipv4-address
41093 description: IP address
41096 example: __L3-INTERFACE-IPV4-ADDRESS__
41097 /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}:
41101 summary: returns l3-interface-ipv4-address-list
41102 description: returns l3-interface-ipv4-address-list
41103 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41109 description: successful operation
41111 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41113 description: Response codes found in [response codes](https://wiki.onap.org/).
41117 description: unique name of Physical Network Function.
41120 example: __PNF-NAME__
41121 - name: interface-name
41123 description: Name that identifies the physical interface
41126 example: __INTERFACE-NAME__
41127 - name: interface-name
41129 description: Name given to the interface
41132 example: __INTERFACE-NAME__
41133 - name: l3-interface-ipv4-address
41135 description: IP address
41138 example: __L3-INTERFACE-IPV4-ADDRESS__
41142 summary: create or update an existing l3-interface-ipv4-address-list
41144 Create or update an existing l3-interface-ipv4-address-list.
41146 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41147 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41156 description: Response codes found in [response codes](https://wiki.onap.org/).
41160 description: unique name of Physical Network Function.
41163 example: __PNF-NAME__
41164 - name: interface-name
41166 description: Name that identifies the physical interface
41169 example: __INTERFACE-NAME__
41170 - name: interface-name
41172 description: Name given to the interface
41175 example: __INTERFACE-NAME__
41176 - name: l3-interface-ipv4-address
41178 description: IP address
41181 example: __L3-INTERFACE-IPV4-ADDRESS__
41184 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
41187 $ref: "#/definitions/l3-interface-ipv4-address-list"
41191 summary: update an existing l3-interface-ipv4-address-list
41193 Update an existing l3-interface-ipv4-address-list
41195 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41196 The PUT operation will entirely replace an existing object.
41197 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41199 Other differences between PUT and PATCH are:
41201 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41202 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41203 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41204 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41213 description: Response codes found in [response codes](https://wiki.onap.org/).
41217 description: unique name of Physical Network Function.
41220 example: __PNF-NAME__
41221 - name: interface-name
41223 description: Name that identifies the physical interface
41226 example: __INTERFACE-NAME__
41227 - name: interface-name
41229 description: Name given to the interface
41232 example: __INTERFACE-NAME__
41233 - name: l3-interface-ipv4-address
41235 description: IP address
41238 example: __L3-INTERFACE-IPV4-ADDRESS__
41241 description: l3-interface-ipv4-address-list object that needs to be updated.
41244 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
41248 summary: delete an existing l3-interface-ipv4-address-list
41249 description: delete an existing l3-interface-ipv4-address-list
41250 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41259 description: Response codes found in [response codes](https://wiki.onap.org/).
41263 description: unique name of Physical Network Function.
41266 example: __PNF-NAME__
41267 - name: interface-name
41269 description: Name that identifies the physical interface
41272 example: __INTERFACE-NAME__
41273 - name: interface-name
41275 description: Name given to the interface
41278 example: __INTERFACE-NAME__
41279 - name: l3-interface-ipv4-address
41281 description: IP address
41284 example: __L3-INTERFACE-IPV4-ADDRESS__
41285 - name: resource-version
41287 description: resource-version for concurrency
41290 /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:
41294 summary: see node definition for valid relationships
41295 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41304 description: Response codes found in [response codes](https://wiki.onap.org/).
41308 description: unique name of Physical Network Function.
41311 example: __PNF-NAME__
41312 - name: interface-name
41314 description: Name that identifies the physical interface
41317 example: __INTERFACE-NAME__
41318 - name: interface-name
41320 description: Name given to the interface
41323 example: __INTERFACE-NAME__
41324 - name: l3-interface-ipv6-address
41326 description: IP address
41329 example: __L3-INTERFACE-IPV6-ADDRESS__
41332 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41335 $ref: "#/definitions/relationship"
41339 summary: delete an existing relationship
41340 description: delete an existing relationship
41341 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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 physical interface
41363 example: __INTERFACE-NAME__
41364 - name: interface-name
41366 description: Name given to the interface
41369 example: __INTERFACE-NAME__
41370 - name: l3-interface-ipv6-address
41372 description: IP address
41375 example: __L3-INTERFACE-IPV6-ADDRESS__
41376 /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}:
41380 summary: returns l3-interface-ipv6-address-list
41381 description: returns l3-interface-ipv6-address-list
41382 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41388 description: successful operation
41390 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41392 description: Response codes found in [response codes](https://wiki.onap.org/).
41396 description: unique name of Physical Network Function.
41399 example: __PNF-NAME__
41400 - name: interface-name
41402 description: Name that identifies the physical interface
41405 example: __INTERFACE-NAME__
41406 - name: interface-name
41408 description: Name given to the interface
41411 example: __INTERFACE-NAME__
41412 - name: l3-interface-ipv6-address
41414 description: IP address
41417 example: __L3-INTERFACE-IPV6-ADDRESS__
41421 summary: create or update an existing l3-interface-ipv6-address-list
41423 Create or update an existing l3-interface-ipv6-address-list.
41425 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41426 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41435 description: Response codes found in [response codes](https://wiki.onap.org/).
41439 description: unique name of Physical Network Function.
41442 example: __PNF-NAME__
41443 - name: interface-name
41445 description: Name that identifies the physical interface
41448 example: __INTERFACE-NAME__
41449 - name: interface-name
41451 description: Name given to the interface
41454 example: __INTERFACE-NAME__
41455 - name: l3-interface-ipv6-address
41457 description: IP address
41460 example: __L3-INTERFACE-IPV6-ADDRESS__
41463 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41466 $ref: "#/definitions/l3-interface-ipv6-address-list"
41470 summary: update an existing l3-interface-ipv6-address-list
41472 Update an existing l3-interface-ipv6-address-list
41474 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41475 The PUT operation will entirely replace an existing object.
41476 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41478 Other differences between PUT and PATCH are:
41480 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41481 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41482 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41483 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41492 description: Response codes found in [response codes](https://wiki.onap.org/).
41496 description: unique name of Physical Network Function.
41499 example: __PNF-NAME__
41500 - name: interface-name
41502 description: Name that identifies the physical interface
41505 example: __INTERFACE-NAME__
41506 - name: interface-name
41508 description: Name given to the interface
41511 example: __INTERFACE-NAME__
41512 - name: l3-interface-ipv6-address
41514 description: IP address
41517 example: __L3-INTERFACE-IPV6-ADDRESS__
41520 description: l3-interface-ipv6-address-list object that needs to be updated.
41523 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41527 summary: delete an existing l3-interface-ipv6-address-list
41528 description: delete an existing l3-interface-ipv6-address-list
41529 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41538 description: Response codes found in [response codes](https://wiki.onap.org/).
41542 description: unique name of Physical Network Function.
41545 example: __PNF-NAME__
41546 - name: interface-name
41548 description: Name that identifies the physical interface
41551 example: __INTERFACE-NAME__
41552 - name: interface-name
41554 description: Name given to the interface
41557 example: __INTERFACE-NAME__
41558 - name: l3-interface-ipv6-address
41560 description: IP address
41563 example: __L3-INTERFACE-IPV6-ADDRESS__
41564 - name: resource-version
41566 description: resource-version for concurrency
41569 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
41573 summary: returns l-interface
41574 description: returns l-interface
41575 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41581 description: successful operation
41583 $ref: "#/getDefinitions/l-interface"
41585 description: Response codes found in [response codes](https://wiki.onap.org/).
41589 description: unique name of Physical Network Function.
41592 example: __PNF-NAME__
41593 - name: interface-name
41595 description: Name that identifies the physical interface
41598 example: __INTERFACE-NAME__
41599 - name: interface-name
41601 description: Name given to the interface
41604 example: __INTERFACE-NAME__
41608 summary: create or update an existing l-interface
41610 Create or update an existing l-interface.
41612 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41613 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41622 description: Response codes found in [response codes](https://wiki.onap.org/).
41626 description: unique name of Physical Network Function.
41629 example: __PNF-NAME__
41630 - name: interface-name
41632 description: Name that identifies the physical interface
41635 example: __INTERFACE-NAME__
41636 - name: interface-name
41638 description: Name given to the interface
41641 example: __INTERFACE-NAME__
41644 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
41647 $ref: "#/definitions/l-interface"
41651 summary: update an existing l-interface
41653 Update an existing l-interface
41655 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41656 The PUT operation will entirely replace an existing object.
41657 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41659 Other differences between PUT and PATCH are:
41661 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41662 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41663 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41664 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41673 description: Response codes found in [response codes](https://wiki.onap.org/).
41677 description: unique name of Physical Network Function.
41680 example: __PNF-NAME__
41681 - name: interface-name
41683 description: Name that identifies the physical interface
41686 example: __INTERFACE-NAME__
41687 - name: interface-name
41689 description: Name given to the interface
41692 example: __INTERFACE-NAME__
41695 description: l-interface object that needs to be updated.
41698 $ref: "#/patchDefinitions/l-interface"
41702 summary: delete an existing l-interface
41703 description: delete an existing l-interface
41704 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41713 description: Response codes found in [response codes](https://wiki.onap.org/).
41717 description: unique name of Physical Network Function.
41720 example: __PNF-NAME__
41721 - name: interface-name
41723 description: Name that identifies the physical interface
41726 example: __INTERFACE-NAME__
41727 - name: interface-name
41729 description: Name given to the interface
41732 example: __INTERFACE-NAME__
41733 - name: resource-version
41735 description: resource-version for concurrency
41738 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
41742 summary: returns l-interfaces
41743 description: returns l-interfaces
41744 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
41750 description: successful operation
41752 $ref: "#/getDefinitions/l-interfaces"
41754 description: Response codes found in [response codes](https://wiki.onap.org/).
41758 description: unique name of Physical Network Function.
41761 example: __PNF-NAME__
41762 - name: interface-name
41764 description: Name that identifies the physical interface
41767 example: __INTERFACE-NAME__
41768 - name: interface-name
41773 - name: interface-id
41783 - name: network-name
41788 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
41792 summary: returns p-interface
41793 description: returns p-interface
41794 operationId: getNetworkPnfsPnfPInterfacesPInterface
41800 description: successful operation
41802 $ref: "#/getDefinitions/p-interface"
41804 description: Response codes found in [response codes](https://wiki.onap.org/).
41808 description: unique name of Physical Network Function.
41811 example: __PNF-NAME__
41812 - name: interface-name
41814 description: Name that identifies the physical interface
41817 example: __INTERFACE-NAME__
41821 summary: create or update an existing p-interface
41823 Create or update an existing p-interface.
41825 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41826 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
41835 description: Response codes found in [response codes](https://wiki.onap.org/).
41839 description: unique name of Physical Network Function.
41842 example: __PNF-NAME__
41843 - name: interface-name
41845 description: Name that identifies the physical interface
41848 example: __INTERFACE-NAME__
41851 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterface.json)
41854 $ref: "#/definitions/p-interface"
41858 summary: update an existing p-interface
41860 Update an existing p-interface
41862 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41863 The PUT operation will entirely replace an existing object.
41864 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41866 Other differences between PUT and PATCH are:
41868 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41869 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41870 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41871 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
41880 description: Response codes found in [response codes](https://wiki.onap.org/).
41884 description: unique name of Physical Network Function.
41887 example: __PNF-NAME__
41888 - name: interface-name
41890 description: Name that identifies the physical interface
41893 example: __INTERFACE-NAME__
41896 description: p-interface object that needs to be updated.
41899 $ref: "#/patchDefinitions/p-interface"
41903 summary: delete an existing p-interface
41904 description: delete an existing p-interface
41905 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
41914 description: Response codes found in [response codes](https://wiki.onap.org/).
41918 description: unique name of Physical Network Function.
41921 example: __PNF-NAME__
41922 - name: interface-name
41924 description: Name that identifies the physical interface
41927 example: __INTERFACE-NAME__
41928 - name: resource-version
41930 description: resource-version for concurrency
41933 /network/pnfs/pnf/{pnf-name}/p-interfaces:
41937 summary: returns p-interfaces
41938 description: returns p-interfaces
41939 operationId: getNetworkPnfsPnfPInterfaces
41945 description: successful operation
41947 $ref: "#/getDefinitions/p-interfaces"
41949 description: Response codes found in [response codes](https://wiki.onap.org/).
41953 description: unique name of Physical Network Function.
41956 example: __PNF-NAME__
41957 - name: interface-name
41962 - name: prov-status
41967 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
41971 summary: see node definition for valid relationships
41972 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
41981 description: Response codes found in [response codes](https://wiki.onap.org/).
41985 description: unique name of Physical Network Function.
41988 example: __PNF-NAME__
41989 - name: interface-name
41991 description: Name that identifies the link aggregate interface
41994 example: __INTERFACE-NAME__
41997 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)
42000 $ref: "#/definitions/relationship"
42004 summary: delete an existing relationship
42005 description: delete an existing relationship
42006 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
42015 description: Response codes found in [response codes](https://wiki.onap.org/).
42019 description: unique name of Physical Network Function.
42022 example: __PNF-NAME__
42023 - name: interface-name
42025 description: Name that identifies the link aggregate interface
42028 example: __INTERFACE-NAME__
42029 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
42033 summary: see node definition for valid relationships
42034 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42043 description: Response codes found in [response codes](https://wiki.onap.org/).
42047 description: unique name of Physical Network Function.
42050 example: __PNF-NAME__
42051 - name: interface-name
42053 description: Name that identifies the link aggregate interface
42056 example: __INTERFACE-NAME__
42057 - name: interface-name
42059 description: Name given to the interface
42062 example: __INTERFACE-NAME__
42063 - name: vlan-interface
42065 description: String that identifies the interface
42068 example: __VLAN-INTERFACE__
42071 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
42074 $ref: "#/definitions/relationship"
42078 summary: delete an existing relationship
42079 description: delete an existing relationship
42080 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42089 description: Response codes found in [response codes](https://wiki.onap.org/).
42093 description: unique name of Physical Network Function.
42096 example: __PNF-NAME__
42097 - name: interface-name
42099 description: Name that identifies the link aggregate interface
42102 example: __INTERFACE-NAME__
42103 - name: interface-name
42105 description: Name given to the interface
42108 example: __INTERFACE-NAME__
42109 - name: vlan-interface
42111 description: String that identifies the interface
42114 example: __VLAN-INTERFACE__
42115 /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:
42119 summary: see node definition for valid relationships
42120 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42129 description: Response codes found in [response codes](https://wiki.onap.org/).
42133 description: unique name of Physical Network Function.
42136 example: __PNF-NAME__
42137 - name: interface-name
42139 description: Name that identifies the link aggregate interface
42142 example: __INTERFACE-NAME__
42143 - name: interface-name
42145 description: Name given to the interface
42148 example: __INTERFACE-NAME__
42149 - name: vlan-interface
42151 description: String that identifies the interface
42154 example: __VLAN-INTERFACE__
42155 - name: l3-interface-ipv4-address
42157 description: IP address
42160 example: __L3-INTERFACE-IPV4-ADDRESS__
42163 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42166 $ref: "#/definitions/relationship"
42170 summary: delete an existing relationship
42171 description: delete an existing relationship
42172 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42181 description: Response codes found in [response codes](https://wiki.onap.org/).
42185 description: unique name of Physical Network Function.
42188 example: __PNF-NAME__
42189 - name: interface-name
42191 description: Name that identifies the link aggregate interface
42194 example: __INTERFACE-NAME__
42195 - name: interface-name
42197 description: Name given to the interface
42200 example: __INTERFACE-NAME__
42201 - name: vlan-interface
42203 description: String that identifies the interface
42206 example: __VLAN-INTERFACE__
42207 - name: l3-interface-ipv4-address
42209 description: IP address
42212 example: __L3-INTERFACE-IPV4-ADDRESS__
42213 /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}:
42217 summary: returns l3-interface-ipv4-address-list
42218 description: returns l3-interface-ipv4-address-list
42219 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42225 description: successful operation
42227 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42229 description: Response codes found in [response codes](https://wiki.onap.org/).
42233 description: unique name of Physical Network Function.
42236 example: __PNF-NAME__
42237 - name: interface-name
42239 description: Name that identifies the link aggregate interface
42242 example: __INTERFACE-NAME__
42243 - name: interface-name
42245 description: Name given to the interface
42248 example: __INTERFACE-NAME__
42249 - name: vlan-interface
42251 description: String that identifies the interface
42254 example: __VLAN-INTERFACE__
42255 - name: l3-interface-ipv4-address
42257 description: IP address
42260 example: __L3-INTERFACE-IPV4-ADDRESS__
42264 summary: create or update an existing l3-interface-ipv4-address-list
42266 Create or update an existing l3-interface-ipv4-address-list.
42268 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42269 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42278 description: Response codes found in [response codes](https://wiki.onap.org/).
42282 description: unique name of Physical Network Function.
42285 example: __PNF-NAME__
42286 - name: interface-name
42288 description: Name that identifies the link aggregate interface
42291 example: __INTERFACE-NAME__
42292 - name: interface-name
42294 description: Name given to the interface
42297 example: __INTERFACE-NAME__
42298 - name: vlan-interface
42300 description: String that identifies the interface
42303 example: __VLAN-INTERFACE__
42304 - name: l3-interface-ipv4-address
42306 description: IP address
42309 example: __L3-INTERFACE-IPV4-ADDRESS__
42312 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42315 $ref: "#/definitions/l3-interface-ipv4-address-list"
42319 summary: update an existing l3-interface-ipv4-address-list
42321 Update an existing l3-interface-ipv4-address-list
42323 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42324 The PUT operation will entirely replace an existing object.
42325 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42327 Other differences between PUT and PATCH are:
42329 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42330 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42331 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42332 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42341 description: Response codes found in [response codes](https://wiki.onap.org/).
42345 description: unique name of Physical Network Function.
42348 example: __PNF-NAME__
42349 - name: interface-name
42351 description: Name that identifies the link aggregate interface
42354 example: __INTERFACE-NAME__
42355 - name: interface-name
42357 description: Name given to the interface
42360 example: __INTERFACE-NAME__
42361 - name: vlan-interface
42363 description: String that identifies the interface
42366 example: __VLAN-INTERFACE__
42367 - name: l3-interface-ipv4-address
42369 description: IP address
42372 example: __L3-INTERFACE-IPV4-ADDRESS__
42375 description: l3-interface-ipv4-address-list object that needs to be updated.
42378 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42382 summary: delete an existing l3-interface-ipv4-address-list
42383 description: delete an existing l3-interface-ipv4-address-list
42384 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42393 description: Response codes found in [response codes](https://wiki.onap.org/).
42397 description: unique name of Physical Network Function.
42400 example: __PNF-NAME__
42401 - name: interface-name
42403 description: Name that identifies the link aggregate interface
42406 example: __INTERFACE-NAME__
42407 - name: interface-name
42409 description: Name given to the interface
42412 example: __INTERFACE-NAME__
42413 - name: vlan-interface
42415 description: String that identifies the interface
42418 example: __VLAN-INTERFACE__
42419 - name: l3-interface-ipv4-address
42421 description: IP address
42424 example: __L3-INTERFACE-IPV4-ADDRESS__
42425 - name: resource-version
42427 description: resource-version for concurrency
42430 /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:
42434 summary: see node definition for valid relationships
42435 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42444 description: Response codes found in [response codes](https://wiki.onap.org/).
42448 description: unique name of Physical Network Function.
42451 example: __PNF-NAME__
42452 - name: interface-name
42454 description: Name that identifies the link aggregate interface
42457 example: __INTERFACE-NAME__
42458 - name: interface-name
42460 description: Name given to the interface
42463 example: __INTERFACE-NAME__
42464 - name: vlan-interface
42466 description: String that identifies the interface
42469 example: __VLAN-INTERFACE__
42470 - name: l3-interface-ipv6-address
42472 description: IP address
42475 example: __L3-INTERFACE-IPV6-ADDRESS__
42478 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42481 $ref: "#/definitions/relationship"
42485 summary: delete an existing relationship
42486 description: delete an existing relationship
42487 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42496 description: Response codes found in [response codes](https://wiki.onap.org/).
42500 description: unique name of Physical Network Function.
42503 example: __PNF-NAME__
42504 - name: interface-name
42506 description: Name that identifies the link aggregate interface
42509 example: __INTERFACE-NAME__
42510 - name: interface-name
42512 description: Name given to the interface
42515 example: __INTERFACE-NAME__
42516 - name: vlan-interface
42518 description: String that identifies the interface
42521 example: __VLAN-INTERFACE__
42522 - name: l3-interface-ipv6-address
42524 description: IP address
42527 example: __L3-INTERFACE-IPV6-ADDRESS__
42528 /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}:
42532 summary: returns l3-interface-ipv6-address-list
42533 description: returns l3-interface-ipv6-address-list
42534 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42540 description: successful operation
42542 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42544 description: Response codes found in [response codes](https://wiki.onap.org/).
42548 description: unique name of Physical Network Function.
42551 example: __PNF-NAME__
42552 - name: interface-name
42554 description: Name that identifies the link aggregate interface
42557 example: __INTERFACE-NAME__
42558 - name: interface-name
42560 description: Name given to the interface
42563 example: __INTERFACE-NAME__
42564 - name: vlan-interface
42566 description: String that identifies the interface
42569 example: __VLAN-INTERFACE__
42570 - name: l3-interface-ipv6-address
42572 description: IP address
42575 example: __L3-INTERFACE-IPV6-ADDRESS__
42579 summary: create or update an existing l3-interface-ipv6-address-list
42581 Create or update an existing l3-interface-ipv6-address-list.
42583 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42584 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42593 description: Response codes found in [response codes](https://wiki.onap.org/).
42597 description: unique name of Physical Network Function.
42600 example: __PNF-NAME__
42601 - name: interface-name
42603 description: Name that identifies the link aggregate interface
42606 example: __INTERFACE-NAME__
42607 - name: interface-name
42609 description: Name given to the interface
42612 example: __INTERFACE-NAME__
42613 - name: vlan-interface
42615 description: String that identifies the interface
42618 example: __VLAN-INTERFACE__
42619 - name: l3-interface-ipv6-address
42621 description: IP address
42624 example: __L3-INTERFACE-IPV6-ADDRESS__
42627 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42630 $ref: "#/definitions/l3-interface-ipv6-address-list"
42634 summary: update an existing l3-interface-ipv6-address-list
42636 Update an existing l3-interface-ipv6-address-list
42638 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42639 The PUT operation will entirely replace an existing object.
42640 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42642 Other differences between PUT and PATCH are:
42644 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42645 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42646 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42647 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42656 description: Response codes found in [response codes](https://wiki.onap.org/).
42660 description: unique name of Physical Network Function.
42663 example: __PNF-NAME__
42664 - name: interface-name
42666 description: Name that identifies the link aggregate interface
42669 example: __INTERFACE-NAME__
42670 - name: interface-name
42672 description: Name given to the interface
42675 example: __INTERFACE-NAME__
42676 - name: vlan-interface
42678 description: String that identifies the interface
42681 example: __VLAN-INTERFACE__
42682 - name: l3-interface-ipv6-address
42684 description: IP address
42687 example: __L3-INTERFACE-IPV6-ADDRESS__
42690 description: l3-interface-ipv6-address-list object that needs to be updated.
42693 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42697 summary: delete an existing l3-interface-ipv6-address-list
42698 description: delete an existing l3-interface-ipv6-address-list
42699 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42708 description: Response codes found in [response codes](https://wiki.onap.org/).
42712 description: unique name of Physical Network Function.
42715 example: __PNF-NAME__
42716 - name: interface-name
42718 description: Name that identifies the link aggregate interface
42721 example: __INTERFACE-NAME__
42722 - name: interface-name
42724 description: Name given to the interface
42727 example: __INTERFACE-NAME__
42728 - name: vlan-interface
42730 description: String that identifies the interface
42733 example: __VLAN-INTERFACE__
42734 - name: l3-interface-ipv6-address
42736 description: IP address
42739 example: __L3-INTERFACE-IPV6-ADDRESS__
42740 - name: resource-version
42742 description: resource-version for concurrency
42745 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
42749 summary: returns vlan
42750 description: returns vlan
42751 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42757 description: successful operation
42759 $ref: "#/getDefinitions/vlan"
42761 description: Response codes found in [response codes](https://wiki.onap.org/).
42765 description: unique name of Physical Network Function.
42768 example: __PNF-NAME__
42769 - name: interface-name
42771 description: Name that identifies the link aggregate interface
42774 example: __INTERFACE-NAME__
42775 - name: interface-name
42777 description: Name given to the interface
42780 example: __INTERFACE-NAME__
42781 - name: vlan-interface
42783 description: String that identifies the interface
42786 example: __VLAN-INTERFACE__
42790 summary: create or update an existing vlan
42792 Create or update an existing vlan.
42794 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42795 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42804 description: Response codes found in [response codes](https://wiki.onap.org/).
42808 description: unique name of Physical Network Function.
42811 example: __PNF-NAME__
42812 - name: interface-name
42814 description: Name that identifies the link aggregate interface
42817 example: __INTERFACE-NAME__
42818 - name: interface-name
42820 description: Name given to the interface
42823 example: __INTERFACE-NAME__
42824 - name: vlan-interface
42826 description: String that identifies the interface
42829 example: __VLAN-INTERFACE__
42832 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
42835 $ref: "#/definitions/vlan"
42839 summary: update an existing vlan
42841 Update an existing vlan
42843 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42844 The PUT operation will entirely replace an existing object.
42845 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42847 Other differences between PUT and PATCH are:
42849 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42850 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42851 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42852 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42861 description: Response codes found in [response codes](https://wiki.onap.org/).
42865 description: unique name of Physical Network Function.
42868 example: __PNF-NAME__
42869 - name: interface-name
42871 description: Name that identifies the link aggregate interface
42874 example: __INTERFACE-NAME__
42875 - name: interface-name
42877 description: Name given to the interface
42880 example: __INTERFACE-NAME__
42881 - name: vlan-interface
42883 description: String that identifies the interface
42886 example: __VLAN-INTERFACE__
42889 description: vlan object that needs to be updated.
42892 $ref: "#/patchDefinitions/vlan"
42896 summary: delete an existing vlan
42897 description: delete an existing vlan
42898 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42907 description: Response codes found in [response codes](https://wiki.onap.org/).
42911 description: unique name of Physical Network Function.
42914 example: __PNF-NAME__
42915 - name: interface-name
42917 description: Name that identifies the link aggregate interface
42920 example: __INTERFACE-NAME__
42921 - name: interface-name
42923 description: Name given to the interface
42926 example: __INTERFACE-NAME__
42927 - name: vlan-interface
42929 description: String that identifies the interface
42932 example: __VLAN-INTERFACE__
42933 - name: resource-version
42935 description: resource-version for concurrency
42938 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
42942 summary: returns vlans
42943 description: returns vlans
42944 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
42950 description: successful operation
42952 $ref: "#/getDefinitions/vlans"
42954 description: Response codes found in [response codes](https://wiki.onap.org/).
42958 description: unique name of Physical Network Function.
42961 example: __PNF-NAME__
42962 - name: interface-name
42964 description: Name that identifies the link aggregate interface
42967 example: __INTERFACE-NAME__
42968 - name: interface-name
42970 description: Name given to the interface
42973 example: __INTERFACE-NAME__
42974 - name: vlan-interface
42979 - name: vlan-id-inner
42990 /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:
42994 summary: see node definition for valid relationships
42995 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43004 description: Response codes found in [response codes](https://wiki.onap.org/).
43008 description: unique name of Physical Network Function.
43011 example: __PNF-NAME__
43012 - name: interface-name
43014 description: Name that identifies the link aggregate interface
43017 example: __INTERFACE-NAME__
43018 - name: interface-name
43020 description: Name given to the interface
43023 example: __INTERFACE-NAME__
43026 description: PCI ID used to identify the sriov-vf
43029 example: __PCI-ID__
43032 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
43035 $ref: "#/definitions/relationship"
43039 summary: delete an existing relationship
43040 description: delete an existing relationship
43041 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43050 description: Response codes found in [response codes](https://wiki.onap.org/).
43054 description: unique name of Physical Network Function.
43057 example: __PNF-NAME__
43058 - name: interface-name
43060 description: Name that identifies the link aggregate interface
43063 example: __INTERFACE-NAME__
43064 - name: interface-name
43066 description: Name given to the interface
43069 example: __INTERFACE-NAME__
43072 description: PCI ID used to identify the sriov-vf
43075 example: __PCI-ID__
43076 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
43080 summary: returns sriov-vf
43081 description: returns sriov-vf
43082 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43088 description: successful operation
43090 $ref: "#/getDefinitions/sriov-vf"
43092 description: Response codes found in [response codes](https://wiki.onap.org/).
43096 description: unique name of Physical Network Function.
43099 example: __PNF-NAME__
43100 - name: interface-name
43102 description: Name that identifies the link aggregate interface
43105 example: __INTERFACE-NAME__
43106 - name: interface-name
43108 description: Name given to the interface
43111 example: __INTERFACE-NAME__
43114 description: PCI ID used to identify the sriov-vf
43117 example: __PCI-ID__
43121 summary: create or update an existing sriov-vf
43123 Create or update an existing sriov-vf.
43125 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43126 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43135 description: Response codes found in [response codes](https://wiki.onap.org/).
43139 description: unique name of Physical Network Function.
43142 example: __PNF-NAME__
43143 - name: interface-name
43145 description: Name that identifies the link aggregate interface
43148 example: __INTERFACE-NAME__
43149 - name: interface-name
43151 description: Name given to the interface
43154 example: __INTERFACE-NAME__
43157 description: PCI ID used to identify the sriov-vf
43160 example: __PCI-ID__
43163 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
43166 $ref: "#/definitions/sriov-vf"
43170 summary: update an existing sriov-vf
43172 Update an existing sriov-vf
43174 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43175 The PUT operation will entirely replace an existing object.
43176 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43178 Other differences between PUT and PATCH are:
43180 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43181 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43182 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43183 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43192 description: Response codes found in [response codes](https://wiki.onap.org/).
43196 description: unique name of Physical Network Function.
43199 example: __PNF-NAME__
43200 - name: interface-name
43202 description: Name that identifies the link aggregate interface
43205 example: __INTERFACE-NAME__
43206 - name: interface-name
43208 description: Name given to the interface
43211 example: __INTERFACE-NAME__
43214 description: PCI ID used to identify the sriov-vf
43217 example: __PCI-ID__
43220 description: sriov-vf object that needs to be updated.
43223 $ref: "#/patchDefinitions/sriov-vf"
43227 summary: delete an existing sriov-vf
43228 description: delete an existing sriov-vf
43229 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43238 description: Response codes found in [response codes](https://wiki.onap.org/).
43242 description: unique name of Physical Network Function.
43245 example: __PNF-NAME__
43246 - name: interface-name
43248 description: Name that identifies the link aggregate interface
43251 example: __INTERFACE-NAME__
43252 - name: interface-name
43254 description: Name given to the interface
43257 example: __INTERFACE-NAME__
43260 description: PCI ID used to identify the sriov-vf
43263 example: __PCI-ID__
43264 - name: resource-version
43266 description: resource-version for concurrency
43269 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
43273 summary: returns sriov-vfs
43274 description: returns sriov-vfs
43275 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
43281 description: successful operation
43283 $ref: "#/getDefinitions/sriov-vfs"
43285 description: Response codes found in [response codes](https://wiki.onap.org/).
43289 description: unique name of Physical Network Function.
43292 example: __PNF-NAME__
43293 - name: interface-name
43295 description: Name that identifies the link aggregate interface
43298 example: __INTERFACE-NAME__
43299 - name: interface-name
43301 description: Name given to the interface
43304 example: __INTERFACE-NAME__
43310 - name: vf-vlan-filter
43315 - name: vf-mac-filter
43320 - name: vf-vlan-strip
43325 - name: neutron-network-id
43330 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43334 summary: see node definition for valid relationships
43335 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
43344 description: Response codes found in [response codes](https://wiki.onap.org/).
43348 description: unique name of Physical Network Function.
43351 example: __PNF-NAME__
43352 - name: interface-name
43354 description: Name that identifies the link aggregate interface
43357 example: __INTERFACE-NAME__
43358 - name: interface-name
43360 description: Name given to the interface
43363 example: __INTERFACE-NAME__
43366 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
43369 $ref: "#/definitions/relationship"
43373 summary: delete an existing relationship
43374 description: delete an existing relationship
43375 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
43384 description: Response codes found in [response codes](https://wiki.onap.org/).
43388 description: unique name of Physical Network Function.
43391 example: __PNF-NAME__
43392 - name: interface-name
43394 description: Name that identifies the link aggregate interface
43397 example: __INTERFACE-NAME__
43398 - name: interface-name
43400 description: Name given to the interface
43403 example: __INTERFACE-NAME__
43404 /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:
43408 summary: see node definition for valid relationships
43409 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43418 description: Response codes found in [response codes](https://wiki.onap.org/).
43422 description: unique name of Physical Network Function.
43425 example: __PNF-NAME__
43426 - name: interface-name
43428 description: Name that identifies the link aggregate interface
43431 example: __INTERFACE-NAME__
43432 - name: interface-name
43434 description: Name given to the interface
43437 example: __INTERFACE-NAME__
43438 - name: l3-interface-ipv4-address
43440 description: IP address
43443 example: __L3-INTERFACE-IPV4-ADDRESS__
43446 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43449 $ref: "#/definitions/relationship"
43453 summary: delete an existing relationship
43454 description: delete an existing relationship
43455 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43464 description: Response codes found in [response codes](https://wiki.onap.org/).
43468 description: unique name of Physical Network Function.
43471 example: __PNF-NAME__
43472 - name: interface-name
43474 description: Name that identifies the link aggregate interface
43477 example: __INTERFACE-NAME__
43478 - name: interface-name
43480 description: Name given to the interface
43483 example: __INTERFACE-NAME__
43484 - name: l3-interface-ipv4-address
43486 description: IP address
43489 example: __L3-INTERFACE-IPV4-ADDRESS__
43490 /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}:
43494 summary: returns l3-interface-ipv4-address-list
43495 description: returns l3-interface-ipv4-address-list
43496 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43502 description: successful operation
43504 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43506 description: Response codes found in [response codes](https://wiki.onap.org/).
43510 description: unique name of Physical Network Function.
43513 example: __PNF-NAME__
43514 - name: interface-name
43516 description: Name that identifies the link aggregate interface
43519 example: __INTERFACE-NAME__
43520 - name: interface-name
43522 description: Name given to the interface
43525 example: __INTERFACE-NAME__
43526 - name: l3-interface-ipv4-address
43528 description: IP address
43531 example: __L3-INTERFACE-IPV4-ADDRESS__
43535 summary: create or update an existing l3-interface-ipv4-address-list
43537 Create or update an existing l3-interface-ipv4-address-list.
43539 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43540 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43549 description: Response codes found in [response codes](https://wiki.onap.org/).
43553 description: unique name of Physical Network Function.
43556 example: __PNF-NAME__
43557 - name: interface-name
43559 description: Name that identifies the link aggregate interface
43562 example: __INTERFACE-NAME__
43563 - name: interface-name
43565 description: Name given to the interface
43568 example: __INTERFACE-NAME__
43569 - name: l3-interface-ipv4-address
43571 description: IP address
43574 example: __L3-INTERFACE-IPV4-ADDRESS__
43577 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43580 $ref: "#/definitions/l3-interface-ipv4-address-list"
43584 summary: update an existing l3-interface-ipv4-address-list
43586 Update an existing l3-interface-ipv4-address-list
43588 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43589 The PUT operation will entirely replace an existing object.
43590 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43592 Other differences between PUT and PATCH are:
43594 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43595 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43596 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43597 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43606 description: Response codes found in [response codes](https://wiki.onap.org/).
43610 description: unique name of Physical Network Function.
43613 example: __PNF-NAME__
43614 - name: interface-name
43616 description: Name that identifies the link aggregate interface
43619 example: __INTERFACE-NAME__
43620 - name: interface-name
43622 description: Name given to the interface
43625 example: __INTERFACE-NAME__
43626 - name: l3-interface-ipv4-address
43628 description: IP address
43631 example: __L3-INTERFACE-IPV4-ADDRESS__
43634 description: l3-interface-ipv4-address-list object that needs to be updated.
43637 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43641 summary: delete an existing l3-interface-ipv4-address-list
43642 description: delete an existing l3-interface-ipv4-address-list
43643 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43652 description: Response codes found in [response codes](https://wiki.onap.org/).
43656 description: unique name of Physical Network Function.
43659 example: __PNF-NAME__
43660 - name: interface-name
43662 description: Name that identifies the link aggregate interface
43665 example: __INTERFACE-NAME__
43666 - name: interface-name
43668 description: Name given to the interface
43671 example: __INTERFACE-NAME__
43672 - name: l3-interface-ipv4-address
43674 description: IP address
43677 example: __L3-INTERFACE-IPV4-ADDRESS__
43678 - name: resource-version
43680 description: resource-version for concurrency
43683 /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:
43687 summary: see node definition for valid relationships
43688 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43697 description: Response codes found in [response codes](https://wiki.onap.org/).
43701 description: unique name of Physical Network Function.
43704 example: __PNF-NAME__
43705 - name: interface-name
43707 description: Name that identifies the link aggregate interface
43710 example: __INTERFACE-NAME__
43711 - name: interface-name
43713 description: Name given to the interface
43716 example: __INTERFACE-NAME__
43717 - name: l3-interface-ipv6-address
43719 description: IP address
43722 example: __L3-INTERFACE-IPV6-ADDRESS__
43725 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43728 $ref: "#/definitions/relationship"
43732 summary: delete an existing relationship
43733 description: delete an existing relationship
43734 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43743 description: Response codes found in [response codes](https://wiki.onap.org/).
43747 description: unique name of Physical Network Function.
43750 example: __PNF-NAME__
43751 - name: interface-name
43753 description: Name that identifies the link aggregate interface
43756 example: __INTERFACE-NAME__
43757 - name: interface-name
43759 description: Name given to the interface
43762 example: __INTERFACE-NAME__
43763 - name: l3-interface-ipv6-address
43765 description: IP address
43768 example: __L3-INTERFACE-IPV6-ADDRESS__
43769 /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}:
43773 summary: returns l3-interface-ipv6-address-list
43774 description: returns l3-interface-ipv6-address-list
43775 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43781 description: successful operation
43783 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
43785 description: Response codes found in [response codes](https://wiki.onap.org/).
43789 description: unique name of Physical Network Function.
43792 example: __PNF-NAME__
43793 - name: interface-name
43795 description: Name that identifies the link aggregate interface
43798 example: __INTERFACE-NAME__
43799 - name: interface-name
43801 description: Name given to the interface
43804 example: __INTERFACE-NAME__
43805 - name: l3-interface-ipv6-address
43807 description: IP address
43810 example: __L3-INTERFACE-IPV6-ADDRESS__
43814 summary: create or update an existing l3-interface-ipv6-address-list
43816 Create or update an existing l3-interface-ipv6-address-list.
43818 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43819 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43828 description: Response codes found in [response codes](https://wiki.onap.org/).
43832 description: unique name of Physical Network Function.
43835 example: __PNF-NAME__
43836 - name: interface-name
43838 description: Name that identifies the link aggregate interface
43841 example: __INTERFACE-NAME__
43842 - name: interface-name
43844 description: Name given to the interface
43847 example: __INTERFACE-NAME__
43848 - name: l3-interface-ipv6-address
43850 description: IP address
43853 example: __L3-INTERFACE-IPV6-ADDRESS__
43856 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43859 $ref: "#/definitions/l3-interface-ipv6-address-list"
43863 summary: update an existing l3-interface-ipv6-address-list
43865 Update an existing l3-interface-ipv6-address-list
43867 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43868 The PUT operation will entirely replace an existing object.
43869 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43871 Other differences between PUT and PATCH are:
43873 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43874 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43875 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43876 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43885 description: Response codes found in [response codes](https://wiki.onap.org/).
43889 description: unique name of Physical Network Function.
43892 example: __PNF-NAME__
43893 - name: interface-name
43895 description: Name that identifies the link aggregate interface
43898 example: __INTERFACE-NAME__
43899 - name: interface-name
43901 description: Name given to the interface
43904 example: __INTERFACE-NAME__
43905 - name: l3-interface-ipv6-address
43907 description: IP address
43910 example: __L3-INTERFACE-IPV6-ADDRESS__
43913 description: l3-interface-ipv6-address-list object that needs to be updated.
43916 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43920 summary: delete an existing l3-interface-ipv6-address-list
43921 description: delete an existing l3-interface-ipv6-address-list
43922 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43931 description: Response codes found in [response codes](https://wiki.onap.org/).
43935 description: unique name of Physical Network Function.
43938 example: __PNF-NAME__
43939 - name: interface-name
43941 description: Name that identifies the link aggregate interface
43944 example: __INTERFACE-NAME__
43945 - name: interface-name
43947 description: Name given to the interface
43950 example: __INTERFACE-NAME__
43951 - name: l3-interface-ipv6-address
43953 description: IP address
43956 example: __L3-INTERFACE-IPV6-ADDRESS__
43957 - name: resource-version
43959 description: resource-version for concurrency
43962 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
43966 summary: returns l-interface
43967 description: returns l-interface
43968 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43974 description: successful operation
43976 $ref: "#/getDefinitions/l-interface"
43978 description: Response codes found in [response codes](https://wiki.onap.org/).
43982 description: unique name of Physical Network Function.
43985 example: __PNF-NAME__
43986 - name: interface-name
43988 description: Name that identifies the link aggregate interface
43991 example: __INTERFACE-NAME__
43992 - name: interface-name
43994 description: Name given to the interface
43997 example: __INTERFACE-NAME__
44001 summary: create or update an existing l-interface
44003 Create or update an existing l-interface.
44005 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44006 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
44015 description: Response codes found in [response codes](https://wiki.onap.org/).
44019 description: unique name of Physical Network Function.
44022 example: __PNF-NAME__
44023 - name: interface-name
44025 description: Name that identifies the link aggregate interface
44028 example: __INTERFACE-NAME__
44029 - name: interface-name
44031 description: Name given to the interface
44034 example: __INTERFACE-NAME__
44037 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
44040 $ref: "#/definitions/l-interface"
44044 summary: update an existing l-interface
44046 Update an existing l-interface
44048 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44049 The PUT operation will entirely replace an existing object.
44050 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44052 Other differences between PUT and PATCH are:
44054 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44055 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44056 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44057 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
44066 description: Response codes found in [response codes](https://wiki.onap.org/).
44070 description: unique name of Physical Network Function.
44073 example: __PNF-NAME__
44074 - name: interface-name
44076 description: Name that identifies the link aggregate interface
44079 example: __INTERFACE-NAME__
44080 - name: interface-name
44082 description: Name given to the interface
44085 example: __INTERFACE-NAME__
44088 description: l-interface object that needs to be updated.
44091 $ref: "#/patchDefinitions/l-interface"
44095 summary: delete an existing l-interface
44096 description: delete an existing l-interface
44097 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
44106 description: Response codes found in [response codes](https://wiki.onap.org/).
44110 description: unique name of Physical Network Function.
44113 example: __PNF-NAME__
44114 - name: interface-name
44116 description: Name that identifies the link aggregate interface
44119 example: __INTERFACE-NAME__
44120 - name: interface-name
44122 description: Name given to the interface
44125 example: __INTERFACE-NAME__
44126 - name: resource-version
44128 description: resource-version for concurrency
44131 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
44135 summary: returns l-interfaces
44136 description: returns l-interfaces
44137 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
44143 description: successful operation
44145 $ref: "#/getDefinitions/l-interfaces"
44147 description: Response codes found in [response codes](https://wiki.onap.org/).
44151 description: unique name of Physical Network Function.
44154 example: __PNF-NAME__
44155 - name: interface-name
44157 description: Name that identifies the link aggregate interface
44160 example: __INTERFACE-NAME__
44161 - name: interface-name
44166 - name: interface-id
44176 - name: network-name
44181 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
44185 summary: returns lag-interface
44186 description: returns lag-interface
44187 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
44193 description: successful operation
44195 $ref: "#/getDefinitions/lag-interface"
44197 description: Response codes found in [response codes](https://wiki.onap.org/).
44201 description: unique name of Physical Network Function.
44204 example: __PNF-NAME__
44205 - name: interface-name
44207 description: Name that identifies the link aggregate interface
44210 example: __INTERFACE-NAME__
44214 summary: create or update an existing lag-interface
44216 Create or update an existing lag-interface.
44218 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44219 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
44228 description: Response codes found in [response codes](https://wiki.onap.org/).
44232 description: unique name of Physical Network Function.
44235 example: __PNF-NAME__
44236 - name: interface-name
44238 description: Name that identifies the link aggregate interface
44241 example: __INTERFACE-NAME__
44244 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)
44247 $ref: "#/definitions/lag-interface"
44251 summary: update an existing lag-interface
44253 Update an existing lag-interface
44255 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44256 The PUT operation will entirely replace an existing object.
44257 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44259 Other differences between PUT and PATCH are:
44261 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44262 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44263 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44264 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
44273 description: Response codes found in [response codes](https://wiki.onap.org/).
44277 description: unique name of Physical Network Function.
44280 example: __PNF-NAME__
44281 - name: interface-name
44283 description: Name that identifies the link aggregate interface
44286 example: __INTERFACE-NAME__
44289 description: lag-interface object that needs to be updated.
44292 $ref: "#/patchDefinitions/lag-interface"
44296 summary: delete an existing lag-interface
44297 description: delete an existing lag-interface
44298 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
44307 description: Response codes found in [response codes](https://wiki.onap.org/).
44311 description: unique name of Physical Network Function.
44314 example: __PNF-NAME__
44315 - name: interface-name
44317 description: Name that identifies the link aggregate interface
44320 example: __INTERFACE-NAME__
44321 - name: resource-version
44323 description: resource-version for concurrency
44326 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
44330 summary: returns lag-interfaces
44331 description: returns lag-interfaces
44332 operationId: getNetworkPnfsPnfLagInterfaces
44338 description: successful operation
44340 $ref: "#/getDefinitions/lag-interfaces"
44342 description: Response codes found in [response codes](https://wiki.onap.org/).
44346 description: unique name of Physical Network Function.
44349 example: __PNF-NAME__
44350 - name: interface-name
44355 - name: interface-id
44360 - name: interface-role
44365 /network/pnfs/pnf/{pnf-name}:
44369 summary: returns pnf
44370 description: returns pnf
44371 operationId: getNetworkPnfsPnf
44377 description: successful operation
44379 $ref: "#/getDefinitions/pnf"
44381 description: Response codes found in [response codes](https://wiki.onap.org/).
44385 description: unique name of Physical Network Function.
44388 example: __PNF-NAME__
44392 summary: create or update an existing pnf
44394 Create or update an existing pnf.
44396 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44397 operationId: createOrUpdateNetworkPnfsPnf
44406 description: Response codes found in [response codes](https://wiki.onap.org/).
44410 description: unique name of Physical Network Function.
44413 example: __PNF-NAME__
44416 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnf.json)
44419 $ref: "#/definitions/pnf"
44423 summary: update an existing pnf
44425 Update an existing pnf
44427 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44428 The PUT operation will entirely replace an existing object.
44429 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44431 Other differences between PUT and PATCH are:
44433 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44434 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44435 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44436 operationId: UpdateNetworkPnfsPnf
44445 description: Response codes found in [response codes](https://wiki.onap.org/).
44449 description: unique name of Physical Network Function.
44452 example: __PNF-NAME__
44455 description: pnf object that needs to be updated.
44458 $ref: "#/patchDefinitions/pnf"
44462 summary: delete an existing pnf
44463 description: delete an existing pnf
44464 operationId: deleteNetworkPnfsPnf
44473 description: Response codes found in [response codes](https://wiki.onap.org/).
44477 description: unique name of Physical Network Function.
44480 example: __PNF-NAME__
44481 - name: resource-version
44483 description: resource-version for concurrency
44490 summary: returns pnfs
44491 description: returns pnfs
44492 operationId: getNetworkPnfs
44498 description: successful operation
44500 $ref: "#/getDefinitions/pnfs"
44502 description: Response codes found in [response codes](https://wiki.onap.org/).
44514 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
44518 summary: see node definition for valid relationships
44519 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
44528 description: Response codes found in [response codes](https://wiki.onap.org/).
44532 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44535 example: __LINK-NAME__
44538 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json)
44541 $ref: "#/definitions/relationship"
44545 summary: delete an existing relationship
44546 description: delete an existing relationship
44547 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
44556 description: Response codes found in [response codes](https://wiki.onap.org/).
44560 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44563 example: __LINK-NAME__
44564 /network/physical-links/physical-link/{link-name}:
44568 summary: returns physical-link
44569 description: returns physical-link
44570 operationId: getNetworkPhysicalLinksPhysicalLink
44576 description: successful operation
44578 $ref: "#/getDefinitions/physical-link"
44580 description: Response codes found in [response codes](https://wiki.onap.org/).
44584 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44587 example: __LINK-NAME__
44591 summary: create or update an existing physical-link
44593 Create or update an existing physical-link.
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: createOrUpdateNetworkPhysicalLinksPhysicalLink
44605 description: Response codes found in [response codes](https://wiki.onap.org/).
44609 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44612 example: __LINK-NAME__
44615 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json)
44618 $ref: "#/definitions/physical-link"
44622 summary: update an existing physical-link
44624 Update an existing physical-link
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: UpdateNetworkPhysicalLinksPhysicalLink
44644 description: Response codes found in [response codes](https://wiki.onap.org/).
44648 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44651 example: __LINK-NAME__
44654 description: physical-link object that needs to be updated.
44657 $ref: "#/patchDefinitions/physical-link"
44661 summary: delete an existing physical-link
44662 description: delete an existing physical-link
44663 operationId: deleteNetworkPhysicalLinksPhysicalLink
44672 description: Response codes found in [response codes](https://wiki.onap.org/).
44676 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44679 example: __LINK-NAME__
44680 - name: resource-version
44682 description: resource-version for concurrency
44685 /network/physical-links:
44689 summary: returns physical-links
44690 description: returns physical-links
44691 operationId: getNetworkPhysicalLinks
44697 description: successful operation
44699 $ref: "#/getDefinitions/physical-links"
44701 description: Response codes found in [response codes](https://wiki.onap.org/).
44713 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
44717 summary: see node definition for valid relationships
44718 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
44727 description: Response codes found in [response codes](https://wiki.onap.org/).
44729 - name: ipsec-configuration-id
44731 description: UUID of this configuration
44734 example: __IPSEC-CONFIGURATION-ID__
44737 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)
44740 $ref: "#/definitions/relationship"
44744 summary: delete an existing relationship
44745 description: delete an existing relationship
44746 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
44755 description: Response codes found in [response codes](https://wiki.onap.org/).
44757 - name: ipsec-configuration-id
44759 description: UUID of this configuration
44762 example: __IPSEC-CONFIGURATION-ID__
44763 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
44767 summary: see node definition for valid relationships
44768 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
44777 description: Response codes found in [response codes](https://wiki.onap.org/).
44779 - name: ipsec-configuration-id
44781 description: UUID of this configuration
44784 example: __IPSEC-CONFIGURATION-ID__
44785 - name: vig-address-type
44787 description: indicates whether the VIG is for AVPN or INTERNET
44790 example: __VIG-ADDRESS-TYPE__
44793 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
44796 $ref: "#/definitions/relationship"
44800 summary: delete an existing relationship
44801 description: delete an existing relationship
44802 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
44811 description: Response codes found in [response codes](https://wiki.onap.org/).
44813 - name: ipsec-configuration-id
44815 description: UUID of this configuration
44818 example: __IPSEC-CONFIGURATION-ID__
44819 - name: vig-address-type
44821 description: indicates whether the VIG is for AVPN or INTERNET
44824 example: __VIG-ADDRESS-TYPE__
44825 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
44829 summary: returns vig-server
44830 description: returns vig-server
44831 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44837 description: successful operation
44839 $ref: "#/getDefinitions/vig-server"
44841 description: Response codes found in [response codes](https://wiki.onap.org/).
44843 - name: ipsec-configuration-id
44845 description: UUID of this configuration
44848 example: __IPSEC-CONFIGURATION-ID__
44849 - name: vig-address-type
44851 description: indicates whether the VIG is for AVPN or INTERNET
44854 example: __VIG-ADDRESS-TYPE__
44858 summary: create or update an existing vig-server
44860 Create or update an existing vig-server.
44862 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44863 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44872 description: Response codes found in [response codes](https://wiki.onap.org/).
44874 - name: ipsec-configuration-id
44876 description: UUID of this configuration
44879 example: __IPSEC-CONFIGURATION-ID__
44880 - name: vig-address-type
44882 description: indicates whether the VIG is for AVPN or INTERNET
44885 example: __VIG-ADDRESS-TYPE__
44888 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
44891 $ref: "#/definitions/vig-server"
44895 summary: update an existing vig-server
44897 Update an existing vig-server
44899 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44900 The PUT operation will entirely replace an existing object.
44901 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44903 Other differences between PUT and PATCH are:
44905 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44906 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44907 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44908 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44917 description: Response codes found in [response codes](https://wiki.onap.org/).
44919 - name: ipsec-configuration-id
44921 description: UUID of this configuration
44924 example: __IPSEC-CONFIGURATION-ID__
44925 - name: vig-address-type
44927 description: indicates whether the VIG is for AVPN or INTERNET
44930 example: __VIG-ADDRESS-TYPE__
44933 description: vig-server object that needs to be updated.
44936 $ref: "#/patchDefinitions/vig-server"
44940 summary: delete an existing vig-server
44941 description: delete an existing vig-server
44942 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44951 description: Response codes found in [response codes](https://wiki.onap.org/).
44953 - name: ipsec-configuration-id
44955 description: UUID of this configuration
44958 example: __IPSEC-CONFIGURATION-ID__
44959 - name: vig-address-type
44961 description: indicates whether the VIG is for AVPN or INTERNET
44964 example: __VIG-ADDRESS-TYPE__
44965 - name: resource-version
44967 description: resource-version for concurrency
44970 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
44974 summary: returns vig-servers
44975 description: returns vig-servers
44976 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
44982 description: successful operation
44984 $ref: "#/getDefinitions/vig-servers"
44986 description: Response codes found in [response codes](https://wiki.onap.org/).
44988 - name: ipsec-configuration-id
44990 description: UUID of this configuration
44993 example: __IPSEC-CONFIGURATION-ID__
44994 - name: vig-address-type
44999 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
45003 summary: returns ipsec-configuration
45004 description: returns ipsec-configuration
45005 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
45011 description: successful operation
45013 $ref: "#/getDefinitions/ipsec-configuration"
45015 description: Response codes found in [response codes](https://wiki.onap.org/).
45017 - name: ipsec-configuration-id
45019 description: UUID of this configuration
45022 example: __IPSEC-CONFIGURATION-ID__
45026 summary: create or update an existing ipsec-configuration
45028 Create or update an existing ipsec-configuration.
45030 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45031 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
45040 description: Response codes found in [response codes](https://wiki.onap.org/).
45042 - name: ipsec-configuration-id
45044 description: UUID of this configuration
45047 example: __IPSEC-CONFIGURATION-ID__
45050 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)
45053 $ref: "#/definitions/ipsec-configuration"
45057 summary: update an existing ipsec-configuration
45059 Update an existing ipsec-configuration
45061 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45062 The PUT operation will entirely replace an existing object.
45063 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45065 Other differences between PUT and PATCH are:
45067 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45068 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45069 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45070 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
45079 description: Response codes found in [response codes](https://wiki.onap.org/).
45081 - name: ipsec-configuration-id
45083 description: UUID of this configuration
45086 example: __IPSEC-CONFIGURATION-ID__
45089 description: ipsec-configuration object that needs to be updated.
45092 $ref: "#/patchDefinitions/ipsec-configuration"
45096 summary: delete an existing ipsec-configuration
45097 description: delete an existing ipsec-configuration
45098 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
45107 description: Response codes found in [response codes](https://wiki.onap.org/).
45109 - name: ipsec-configuration-id
45111 description: UUID of this configuration
45114 example: __IPSEC-CONFIGURATION-ID__
45115 - name: resource-version
45117 description: resource-version for concurrency
45120 /network/ipsec-configurations:
45124 summary: returns ipsec-configurations
45125 description: returns ipsec-configurations
45126 operationId: getNetworkIpsecConfigurations
45132 description: successful operation
45134 $ref: "#/getDefinitions/ipsec-configurations"
45136 description: Response codes found in [response codes](https://wiki.onap.org/).
45138 - name: ipsec-configuration-id
45143 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
45147 summary: see node definition for valid relationships
45148 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
45157 description: Response codes found in [response codes](https://wiki.onap.org/).
45159 - name: route-table-reference-id
45161 description: Route Table Reference id, UUID assigned to this instance.
45164 example: __ROUTE-TABLE-REFERENCE-ID__
45167 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkRouteTableReferencesRouteTableReference.json)
45170 $ref: "#/definitions/relationship"
45174 summary: delete an existing relationship
45175 description: delete an existing relationship
45176 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
45185 description: Response codes found in [response codes](https://wiki.onap.org/).
45187 - name: route-table-reference-id
45189 description: Route Table Reference id, UUID assigned to this instance.
45192 example: __ROUTE-TABLE-REFERENCE-ID__
45193 /network/route-table-references/route-table-reference/{route-table-reference-id}:
45197 summary: returns route-table-reference
45198 description: returns route-table-reference
45199 operationId: getNetworkRouteTableReferencesRouteTableReference
45205 description: successful operation
45207 $ref: "#/getDefinitions/route-table-reference"
45209 description: Response codes found in [response codes](https://wiki.onap.org/).
45211 - name: route-table-reference-id
45213 description: Route Table Reference id, UUID assigned to this instance.
45216 example: __ROUTE-TABLE-REFERENCE-ID__
45220 summary: create or update an existing route-table-reference
45222 Create or update an existing route-table-reference.
45224 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45225 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
45234 description: Response codes found in [response codes](https://wiki.onap.org/).
45236 - name: route-table-reference-id
45238 description: Route Table Reference id, UUID assigned to this instance.
45241 example: __ROUTE-TABLE-REFERENCE-ID__
45244 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkRouteTableReferencesRouteTableReference.json)
45247 $ref: "#/definitions/route-table-reference"
45251 summary: update an existing route-table-reference
45253 Update an existing route-table-reference
45255 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45256 The PUT operation will entirely replace an existing object.
45257 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45259 Other differences between PUT and PATCH are:
45261 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45262 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45263 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45264 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
45273 description: Response codes found in [response codes](https://wiki.onap.org/).
45275 - name: route-table-reference-id
45277 description: Route Table Reference id, UUID assigned to this instance.
45280 example: __ROUTE-TABLE-REFERENCE-ID__
45283 description: route-table-reference object that needs to be updated.
45286 $ref: "#/patchDefinitions/route-table-reference"
45290 summary: delete an existing route-table-reference
45291 description: delete an existing route-table-reference
45292 operationId: deleteNetworkRouteTableReferencesRouteTableReference
45301 description: Response codes found in [response codes](https://wiki.onap.org/).
45303 - name: route-table-reference-id
45305 description: Route Table Reference id, UUID assigned to this instance.
45308 example: __ROUTE-TABLE-REFERENCE-ID__
45309 - name: resource-version
45311 description: resource-version for concurrency
45314 /network/route-table-references:
45318 summary: returns route-table-references
45319 description: returns route-table-references
45320 operationId: getNetworkRouteTableReferences
45326 description: successful operation
45328 $ref: "#/getDefinitions/route-table-references"
45330 description: Response codes found in [response codes](https://wiki.onap.org/).
45332 - name: route-table-reference-id
45337 - name: route-table-reference-fqdn
45342 /network/instance-groups/instance-group/{id}/relationship-list/relationship:
45346 summary: see node definition for valid relationships
45347 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
45356 description: Response codes found in [response codes](https://wiki.onap.org/).
45360 description: Instance Group ID, UUID assigned to this instance.
45366 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkInstanceGroupsInstanceGroup.json)
45369 $ref: "#/definitions/relationship"
45373 summary: delete an existing relationship
45374 description: delete an existing relationship
45375 operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
45384 description: Response codes found in [response codes](https://wiki.onap.org/).
45388 description: Instance Group ID, UUID assigned to this instance.
45392 /network/instance-groups/instance-group/{id}:
45396 summary: returns instance-group
45397 description: returns instance-group
45398 operationId: getNetworkInstanceGroupsInstanceGroup
45404 description: successful operation
45406 $ref: "#/getDefinitions/instance-group"
45408 description: Response codes found in [response codes](https://wiki.onap.org/).
45412 description: Instance Group ID, UUID assigned to this instance.
45419 summary: create or update an existing instance-group
45421 Create or update an existing instance-group.
45423 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45424 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
45433 description: Response codes found in [response codes](https://wiki.onap.org/).
45437 description: Instance Group ID, UUID assigned to this instance.
45443 description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkInstanceGroupsInstanceGroup.json)
45446 $ref: "#/definitions/instance-group"
45450 summary: update an existing instance-group
45452 Update an existing instance-group
45454 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45455 The PUT operation will entirely replace an existing object.
45456 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45458 Other differences between PUT and PATCH are:
45460 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45461 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45462 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45463 operationId: UpdateNetworkInstanceGroupsInstanceGroup
45472 description: Response codes found in [response codes](https://wiki.onap.org/).
45476 description: Instance Group ID, UUID assigned to this instance.
45482 description: instance-group object that needs to be updated.
45485 $ref: "#/patchDefinitions/instance-group"
45489 summary: delete an existing instance-group
45490 description: delete an existing instance-group
45491 operationId: deleteNetworkInstanceGroupsInstanceGroup
45500 description: Response codes found in [response codes](https://wiki.onap.org/).
45504 description: Instance Group ID, UUID assigned to this instance.
45508 - name: resource-version
45510 description: resource-version for concurrency
45513 /network/instance-groups:
45517 summary: returns instance-groups
45518 description: returns instance-groups
45519 operationId: getNetworkInstanceGroups
45525 description: successful operation
45527 $ref: "#/getDefinitions/instance-groups"
45529 description: Response codes found in [response codes](https://wiki.onap.org/).
45536 - name: description
45551 /network/zones/zone/{zone-id}/relationship-list/relationship:
45555 summary: see node definition for valid relationships
45556 operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
45565 description: Response codes found in [response codes](https://wiki.onap.org/).
45569 description: Code assigned by AIC to the zone
45572 example: __ZONE-ID__
45575 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkZonesZone.json)
45578 $ref: "#/definitions/relationship"
45582 summary: delete an existing relationship
45583 description: delete an existing relationship
45584 operationId: deleteNetworkZonesZoneRelationshipListRelationship
45593 description: Response codes found in [response codes](https://wiki.onap.org/).
45597 description: Code assigned by AIC to the zone
45600 example: __ZONE-ID__
45601 /network/zones/zone/{zone-id}:
45605 summary: returns zone
45606 description: returns zone
45607 operationId: getNetworkZonesZone
45613 description: successful operation
45615 $ref: "#/getDefinitions/zone"
45617 description: Response codes found in [response codes](https://wiki.onap.org/).
45621 description: Code assigned by AIC to the zone
45624 example: __ZONE-ID__
45628 summary: create or update an existing zone
45630 Create or update an existing zone.
45632 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45633 operationId: createOrUpdateNetworkZonesZone
45642 description: Response codes found in [response codes](https://wiki.onap.org/).
45646 description: Code assigned by AIC to the zone
45649 example: __ZONE-ID__
45652 description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkZonesZone.json)
45655 $ref: "#/definitions/zone"
45659 summary: update an existing zone
45661 Update an existing zone
45663 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45664 The PUT operation will entirely replace an existing object.
45665 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45667 Other differences between PUT and PATCH are:
45669 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45670 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45671 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45672 operationId: UpdateNetworkZonesZone
45681 description: Response codes found in [response codes](https://wiki.onap.org/).
45685 description: Code assigned by AIC to the zone
45688 example: __ZONE-ID__
45691 description: zone object that needs to be updated.
45694 $ref: "#/patchDefinitions/zone"
45698 summary: delete an existing zone
45699 description: delete an existing zone
45700 operationId: deleteNetworkZonesZone
45709 description: Response codes found in [response codes](https://wiki.onap.org/).
45713 description: Code assigned by AIC to the zone
45716 example: __ZONE-ID__
45717 - name: resource-version
45719 description: resource-version for concurrency
45726 summary: returns zones
45727 description: returns zones
45728 operationId: getNetworkZones
45734 description: successful operation
45736 $ref: "#/getDefinitions/zones"
45738 description: Response codes found in [response codes](https://wiki.onap.org/).
45745 - name: design-type
45750 - name: zone-context
45755 /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
45759 summary: see node definition for valid relationships
45760 operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
45769 description: Response codes found in [response codes](https://wiki.onap.org/).
45771 - name: configuration-id
45773 description: UUID assigned to configuration.
45776 example: __CONFIGURATION-ID__
45779 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfiguration.json)
45782 $ref: "#/definitions/relationship"
45786 summary: delete an existing relationship
45787 description: delete an existing relationship
45788 operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
45797 description: Response codes found in [response codes](https://wiki.onap.org/).
45799 - name: configuration-id
45801 description: UUID assigned to configuration.
45804 example: __CONFIGURATION-ID__
45805 /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
45809 summary: returns metadatum
45810 description: returns metadatum
45811 operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
45817 description: successful operation
45819 $ref: "#/getDefinitions/metadatum"
45821 description: Response codes found in [response codes](https://wiki.onap.org/).
45823 - name: configuration-id
45825 description: UUID assigned to configuration.
45828 example: __CONFIGURATION-ID__
45833 example: __METANAME__
45837 summary: create or update an existing metadatum
45839 Create or update an existing metadatum.
45841 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45842 operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
45851 description: Response codes found in [response codes](https://wiki.onap.org/).
45853 - name: configuration-id
45855 description: UUID assigned to configuration.
45858 example: __CONFIGURATION-ID__
45863 example: __METANAME__
45866 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationMetadataMetadatum.json)
45869 $ref: "#/definitions/metadatum"
45873 summary: update an existing metadatum
45875 Update an existing metadatum
45877 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45878 The PUT operation will entirely replace an existing object.
45879 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45881 Other differences between PUT and PATCH are:
45883 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45884 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45885 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45886 operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
45895 description: Response codes found in [response codes](https://wiki.onap.org/).
45897 - name: configuration-id
45899 description: UUID assigned to configuration.
45902 example: __CONFIGURATION-ID__
45907 example: __METANAME__
45910 description: metadatum object that needs to be updated.
45913 $ref: "#/patchDefinitions/metadatum"
45917 summary: delete an existing metadatum
45918 description: delete an existing metadatum
45919 operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
45928 description: Response codes found in [response codes](https://wiki.onap.org/).
45930 - name: configuration-id
45932 description: UUID assigned to configuration.
45935 example: __CONFIGURATION-ID__
45940 example: __METANAME__
45941 - name: resource-version
45943 description: resource-version for concurrency
45946 /network/configurations/configuration/{configuration-id}/metadata:
45950 summary: returns metadata
45951 description: returns metadata
45952 operationId: getNetworkConfigurationsConfigurationMetadata
45958 description: successful operation
45960 $ref: "#/getDefinitions/metadata"
45962 description: Response codes found in [response codes](https://wiki.onap.org/).
45964 - name: configuration-id
45966 description: UUID assigned to configuration.
45969 example: __CONFIGURATION-ID__
45975 /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
45979 summary: see node definition for valid relationships
45980 operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
45989 description: Response codes found in [response codes](https://wiki.onap.org/).
45991 - name: configuration-id
45993 description: UUID assigned to configuration.
45996 example: __CONFIGURATION-ID__
45997 - name: forwarder-evc-id
45999 description: Key for forwarder-evc object
46002 example: __FORWARDER-EVC-ID__
46005 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
46008 $ref: "#/definitions/relationship"
46012 summary: delete an existing relationship
46013 description: delete an existing relationship
46014 operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
46023 description: Response codes found in [response codes](https://wiki.onap.org/).
46025 - name: configuration-id
46027 description: UUID assigned to configuration.
46030 example: __CONFIGURATION-ID__
46031 - name: forwarder-evc-id
46033 description: Key for forwarder-evc object
46036 example: __FORWARDER-EVC-ID__
46037 /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}:
46041 summary: returns forwarder-evc
46042 description: returns forwarder-evc
46043 operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
46049 description: successful operation
46051 $ref: "#/getDefinitions/forwarder-evc"
46053 description: Response codes found in [response codes](https://wiki.onap.org/).
46055 - name: configuration-id
46057 description: UUID assigned to configuration.
46060 example: __CONFIGURATION-ID__
46061 - name: forwarder-evc-id
46063 description: Key for forwarder-evc object
46066 example: __FORWARDER-EVC-ID__
46070 summary: create or update an existing forwarder-evc
46072 Create or update an existing forwarder-evc.
46074 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46075 operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
46084 description: Response codes found in [response codes](https://wiki.onap.org/).
46086 - name: configuration-id
46088 description: UUID assigned to configuration.
46091 example: __CONFIGURATION-ID__
46092 - name: forwarder-evc-id
46094 description: Key for forwarder-evc object
46097 example: __FORWARDER-EVC-ID__
46100 description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
46103 $ref: "#/definitions/forwarder-evc"
46107 summary: update an existing forwarder-evc
46109 Update an existing forwarder-evc
46111 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46112 The PUT operation will entirely replace an existing object.
46113 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46115 Other differences between PUT and PATCH are:
46117 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46118 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46119 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46120 operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
46129 description: Response codes found in [response codes](https://wiki.onap.org/).
46131 - name: configuration-id
46133 description: UUID assigned to configuration.
46136 example: __CONFIGURATION-ID__
46137 - name: forwarder-evc-id
46139 description: Key for forwarder-evc object
46142 example: __FORWARDER-EVC-ID__
46145 description: forwarder-evc object that needs to be updated.
46148 $ref: "#/patchDefinitions/forwarder-evc"
46152 summary: delete an existing forwarder-evc
46153 description: delete an existing forwarder-evc
46154 operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
46163 description: Response codes found in [response codes](https://wiki.onap.org/).
46165 - name: configuration-id
46167 description: UUID assigned to configuration.
46170 example: __CONFIGURATION-ID__
46171 - name: forwarder-evc-id
46173 description: Key for forwarder-evc object
46176 example: __FORWARDER-EVC-ID__
46177 - name: resource-version
46179 description: resource-version for concurrency
46182 /network/configurations/configuration/{configuration-id}/forwarder-evcs:
46186 summary: returns forwarder-evcs
46187 description: returns forwarder-evcs
46188 operationId: getNetworkConfigurationsConfigurationForwarderEvcs
46194 description: successful operation
46196 $ref: "#/getDefinitions/forwarder-evcs"
46198 description: Response codes found in [response codes](https://wiki.onap.org/).
46200 - name: configuration-id
46202 description: UUID assigned to configuration.
46205 example: __CONFIGURATION-ID__
46206 /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship:
46210 summary: see node definition for valid relationships
46211 operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
46220 description: Response codes found in [response codes](https://wiki.onap.org/).
46222 - name: configuration-id
46224 description: UUID assigned to configuration.
46227 example: __CONFIGURATION-ID__
46230 description: Unique/key field for the evc object
46233 example: __EVC-ID__
46236 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationEvcsEvc.json)
46239 $ref: "#/definitions/relationship"
46243 summary: delete an existing relationship
46244 description: delete an existing relationship
46245 operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
46254 description: Response codes found in [response codes](https://wiki.onap.org/).
46256 - name: configuration-id
46258 description: UUID assigned to configuration.
46261 example: __CONFIGURATION-ID__
46264 description: Unique/key field for the evc object
46267 example: __EVC-ID__
46268 /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}:
46272 summary: returns evc
46273 description: returns evc
46274 operationId: getNetworkConfigurationsConfigurationEvcsEvc
46280 description: successful operation
46282 $ref: "#/getDefinitions/evc"
46284 description: Response codes found in [response codes](https://wiki.onap.org/).
46286 - name: configuration-id
46288 description: UUID assigned to configuration.
46291 example: __CONFIGURATION-ID__
46294 description: Unique/key field for the evc object
46297 example: __EVC-ID__
46301 summary: create or update an existing evc
46303 Create or update an existing evc.
46305 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46306 operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc
46315 description: Response codes found in [response codes](https://wiki.onap.org/).
46317 - name: configuration-id
46319 description: UUID assigned to configuration.
46322 example: __CONFIGURATION-ID__
46325 description: Unique/key field for the evc object
46328 example: __EVC-ID__
46331 description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationEvcsEvc.json)
46334 $ref: "#/definitions/evc"
46338 summary: update an existing evc
46340 Update an existing evc
46342 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46343 The PUT operation will entirely replace an existing object.
46344 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46346 Other differences between PUT and PATCH are:
46348 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46349 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46350 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46351 operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc
46360 description: Response codes found in [response codes](https://wiki.onap.org/).
46362 - name: configuration-id
46364 description: UUID assigned to configuration.
46367 example: __CONFIGURATION-ID__
46370 description: Unique/key field for the evc object
46373 example: __EVC-ID__
46376 description: evc object that needs to be updated.
46379 $ref: "#/patchDefinitions/evc"
46383 summary: delete an existing evc
46384 description: delete an existing evc
46385 operationId: deleteNetworkConfigurationsConfigurationEvcsEvc
46394 description: Response codes found in [response codes](https://wiki.onap.org/).
46396 - name: configuration-id
46398 description: UUID assigned to configuration.
46401 example: __CONFIGURATION-ID__
46404 description: Unique/key field for the evc object
46407 example: __EVC-ID__
46408 - name: resource-version
46410 description: resource-version for concurrency
46413 /network/configurations/configuration/{configuration-id}/evcs:
46417 summary: returns evcs
46418 description: returns evcs
46419 operationId: getNetworkConfigurationsConfigurationEvcs
46425 description: successful operation
46427 $ref: "#/getDefinitions/evcs"
46429 description: Response codes found in [response codes](https://wiki.onap.org/).
46431 - name: configuration-id
46433 description: UUID assigned to configuration.
46436 example: __CONFIGURATION-ID__
46437 /network/configurations/configuration/{configuration-id}:
46441 summary: returns configuration
46442 description: returns configuration
46443 operationId: getNetworkConfigurationsConfiguration
46449 description: successful operation
46451 $ref: "#/getDefinitions/configuration"
46453 description: Response codes found in [response codes](https://wiki.onap.org/).
46455 - name: configuration-id
46457 description: UUID assigned to configuration.
46460 example: __CONFIGURATION-ID__
46464 summary: create or update an existing configuration
46466 Create or update an existing configuration.
46468 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46469 operationId: createOrUpdateNetworkConfigurationsConfiguration
46478 description: Response codes found in [response codes](https://wiki.onap.org/).
46480 - name: configuration-id
46482 description: UUID assigned to configuration.
46485 example: __CONFIGURATION-ID__
46488 description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfiguration.json)
46491 $ref: "#/definitions/configuration"
46495 summary: update an existing configuration
46497 Update an existing configuration
46499 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46500 The PUT operation will entirely replace an existing object.
46501 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46503 Other differences between PUT and PATCH are:
46505 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46506 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46507 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46508 operationId: UpdateNetworkConfigurationsConfiguration
46517 description: Response codes found in [response codes](https://wiki.onap.org/).
46519 - name: configuration-id
46521 description: UUID assigned to configuration.
46524 example: __CONFIGURATION-ID__
46527 description: configuration object that needs to be updated.
46530 $ref: "#/patchDefinitions/configuration"
46534 summary: delete an existing configuration
46535 description: delete an existing configuration
46536 operationId: deleteNetworkConfigurationsConfiguration
46545 description: Response codes found in [response codes](https://wiki.onap.org/).
46547 - name: configuration-id
46549 description: UUID assigned to configuration.
46552 example: __CONFIGURATION-ID__
46553 - name: resource-version
46555 description: resource-version for concurrency
46558 /network/configurations:
46562 summary: returns configurations
46563 description: returns configurations
46564 operationId: getNetworkConfigurations
46570 description: successful operation
46572 $ref: "#/getDefinitions/configurations"
46574 description: Response codes found in [response codes](https://wiki.onap.org/).
46576 - name: configuration-id
46581 - name: model-invariant-id
46586 - name: model-version-id
46591 /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
46595 summary: see node definition for valid relationships
46596 operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship
46605 description: Response codes found in [response codes](https://wiki.onap.org/).
46607 - name: forwarding-path-id
46609 description: Unique ID of this FP
46612 example: __FORWARDING-PATH-ID__
46615 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json)
46618 $ref: "#/definitions/relationship"
46622 summary: delete an existing relationship
46623 description: delete an existing relationship
46624 operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship
46633 description: Response codes found in [response codes](https://wiki.onap.org/).
46635 - name: forwarding-path-id
46637 description: Unique ID of this FP
46640 example: __FORWARDING-PATH-ID__
46641 /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship:
46645 summary: see node definition for valid relationships
46646 operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
46655 description: Response codes found in [response codes](https://wiki.onap.org/).
46657 - name: forwarding-path-id
46659 description: Unique ID of this FP
46662 example: __FORWARDING-PATH-ID__
46665 description: Unique ID of this segmentation
46669 example: __SEQUENCE__
46672 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
46675 $ref: "#/definitions/relationship"
46679 summary: delete an existing relationship
46680 description: delete an existing relationship
46681 operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
46690 description: Response codes found in [response codes](https://wiki.onap.org/).
46692 - name: forwarding-path-id
46694 description: Unique ID of this FP
46697 example: __FORWARDING-PATH-ID__
46700 description: Unique ID of this segmentation
46704 example: __SEQUENCE__
46705 /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}:
46709 summary: returns forwarder
46710 description: returns forwarder
46711 operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder
46717 description: successful operation
46719 $ref: "#/getDefinitions/forwarder"
46721 description: Response codes found in [response codes](https://wiki.onap.org/).
46723 - name: forwarding-path-id
46725 description: Unique ID of this FP
46728 example: __FORWARDING-PATH-ID__
46731 description: Unique ID of this segmentation
46735 example: __SEQUENCE__
46739 summary: create or update an existing forwarder
46741 Create or update an existing forwarder.
46743 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46744 operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder
46753 description: Response codes found in [response codes](https://wiki.onap.org/).
46755 - name: forwarding-path-id
46757 description: Unique ID of this FP
46760 example: __FORWARDING-PATH-ID__
46763 description: Unique ID of this segmentation
46767 example: __SEQUENCE__
46770 description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
46773 $ref: "#/definitions/forwarder"
46777 summary: update an existing forwarder
46779 Update an existing forwarder
46781 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46782 The PUT operation will entirely replace an existing object.
46783 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46785 Other differences between PUT and PATCH are:
46787 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46788 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46789 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46790 operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder
46799 description: Response codes found in [response codes](https://wiki.onap.org/).
46801 - name: forwarding-path-id
46803 description: Unique ID of this FP
46806 example: __FORWARDING-PATH-ID__
46809 description: Unique ID of this segmentation
46813 example: __SEQUENCE__
46816 description: forwarder object that needs to be updated.
46819 $ref: "#/patchDefinitions/forwarder"
46823 summary: delete an existing forwarder
46824 description: delete an existing forwarder
46825 operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder
46834 description: Response codes found in [response codes](https://wiki.onap.org/).
46836 - name: forwarding-path-id
46838 description: Unique ID of this FP
46841 example: __FORWARDING-PATH-ID__
46844 description: Unique ID of this segmentation
46848 example: __SEQUENCE__
46849 - name: resource-version
46851 description: resource-version for concurrency
46854 /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders:
46858 summary: returns forwarders
46859 description: returns forwarders
46860 operationId: getNetworkForwardingPathsForwardingPathForwarders
46866 description: successful operation
46868 $ref: "#/getDefinitions/forwarders"
46870 description: Response codes found in [response codes](https://wiki.onap.org/).
46872 - name: forwarding-path-id
46874 description: Unique ID of this FP
46877 example: __FORWARDING-PATH-ID__
46884 /network/forwarding-paths/forwarding-path/{forwarding-path-id}:
46888 summary: returns forwarding-path
46889 description: returns forwarding-path
46890 operationId: getNetworkForwardingPathsForwardingPath
46896 description: successful operation
46898 $ref: "#/getDefinitions/forwarding-path"
46900 description: Response codes found in [response codes](https://wiki.onap.org/).
46902 - name: forwarding-path-id
46904 description: Unique ID of this FP
46907 example: __FORWARDING-PATH-ID__
46911 summary: create or update an existing forwarding-path
46913 Create or update an existing forwarding-path.
46915 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46916 operationId: createOrUpdateNetworkForwardingPathsForwardingPath
46925 description: Response codes found in [response codes](https://wiki.onap.org/).
46927 - name: forwarding-path-id
46929 description: Unique ID of this FP
46932 example: __FORWARDING-PATH-ID__
46935 description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json)
46938 $ref: "#/definitions/forwarding-path"
46942 summary: update an existing forwarding-path
46944 Update an existing forwarding-path
46946 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46947 The PUT operation will entirely replace an existing object.
46948 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46950 Other differences between PUT and PATCH are:
46952 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46953 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46954 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46955 operationId: UpdateNetworkForwardingPathsForwardingPath
46964 description: Response codes found in [response codes](https://wiki.onap.org/).
46966 - name: forwarding-path-id
46968 description: Unique ID of this FP
46971 example: __FORWARDING-PATH-ID__
46974 description: forwarding-path object that needs to be updated.
46977 $ref: "#/patchDefinitions/forwarding-path"
46981 summary: delete an existing forwarding-path
46982 description: delete an existing forwarding-path
46983 operationId: deleteNetworkForwardingPathsForwardingPath
46992 description: Response codes found in [response codes](https://wiki.onap.org/).
46994 - name: forwarding-path-id
46996 description: Unique ID of this FP
46999 example: __FORWARDING-PATH-ID__
47000 - name: resource-version
47002 description: resource-version for concurrency
47005 /network/forwarding-paths:
47009 summary: returns forwarding-paths
47010 description: returns forwarding-paths
47011 operationId: getNetworkForwardingPaths
47017 description: successful operation
47019 $ref: "#/getDefinitions/forwarding-paths"
47021 description: Response codes found in [response codes](https://wiki.onap.org/).
47023 - name: forwarding-path-id
47028 - name: forwarding-path-name
47041 $ref: "#/definitions/action-data"
47050 APIs that are more action related than REST (e.g., notify, update).
47054 $ref: "#/definitions/update"
47057 $ref: "#/definitions/notify"
47060 Represents a slice or partial piece of a resource that gets separately allotted
47061 ###### Related Nodes
47062 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
47063 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
47064 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
47065 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
47066 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
47067 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
47068 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
47069 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
47070 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
47071 - TO model-ver( allotted-resource IsA model-ver, Many2One)
47072 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
47073 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
47074 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
47075 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
47077 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
47078 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
47079 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
47085 description: Allotted Resource id UUID assigned to this instance.
47088 description: The descriptive information assigned to this allotted resource instance
47091 description: Link back to more information in the controller
47092 model-invariant-id:
47094 description: the ASDC model id for this resource or service model.
47097 description: the ASDC model version for this resource or service model.
47098 persona-model-version:
47100 description: the ASDC model version for this resource or service model.
47103 description: Concurrency value
47104 orchestration-status:
47106 description: Orchestration status
47107 operational-status:
47109 description: Indicator for whether the resource is considered operational
47112 description: Generic description of the type of allotted resource.
47115 description: role in the network that this resource will be providing.
47119 $ref: "#/definitions/tunnel-xconnect"
47123 $ref: "#/definitions/relationship"
47124 allotted-resources:
47126 This object is used to store slices of services being offered
47131 $ref: "#/definitions/allotted-resource"
47134 Availability zone, a collection of compute hosts/pservers
47135 ###### Related Nodes
47136 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
47137 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
47138 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
47139 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
47140 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
47141 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
47142 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
47143 - FROM vce( vce Uses availability-zone, MANY2MANY)
47145 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
47146 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
47149 - availability-zone-name
47152 availability-zone-name:
47154 description: Name of the availability zone. Unique across a cloud region
47157 description: Type of hypervisor. Source of truth should define valid values.
47158 operational-status:
47160 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
47163 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47167 $ref: "#/definitions/relationship"
47168 availability-zones:
47170 Collection of availability zones
47175 $ref: "#/definitions/availability-zone"
47176 az-and-dvs-switches:
47180 $ref: "#/definitions/dvs-switches"
47183 $ref: "#/definitions/availability-zone"
47186 Namespace for business related constructs
47191 $ref: "#/definitions/connector"
47195 $ref: "#/definitions/customer"
47199 $ref: "#/definitions/line-of-business"
47203 $ref: "#/definitions/owning-entity"
47207 $ref: "#/definitions/platform"
47211 $ref: "#/definitions/project"
47214 ###### Related Nodes
47215 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
47217 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
47223 description: unique identifier of probe
47226 description: identifier of probe
47229 description: type of probe
47232 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47236 $ref: "#/definitions/relationship"
47237 classes-of-service:
47239 class-of-service of probe
47244 $ref: "#/definitions/class-of-service"
47245 cloud-infrastructure:
47247 Namespace for cloud infrastructure.
47252 $ref: "#/definitions/complex"
47256 $ref: "#/definitions/cloud-region"
47260 $ref: "#/definitions/network-profile"
47264 $ref: "#/definitions/pserver"
47265 virtual-data-centers:
47268 $ref: "#/definitions/virtual-data-center"
47269 operational-environments:
47272 $ref: "#/definitions/operational-environment"
47275 cloud-region designates an installation of a cloud cluster or region or instantiation.
47276 ###### Related Nodes
47277 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
47278 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
47279 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
47280 - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
47281 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
47282 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
47283 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
47284 - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
47285 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
47286 - FROM image( image BelongsTo cloud-region, MANY2ONE)
47287 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
47288 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
47289 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
47290 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
47291 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
47292 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
47293 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
47294 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
47296 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
47297 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
47306 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
47309 description: Identifier used by the vendor for the region. Second part of composite key
47312 description: Type of the cloud (e.g., openstack)
47313 owner-defined-type:
47315 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
47316 cloud-region-version:
47318 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
47321 description: URL of the keystone identity service
47324 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47327 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47330 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
47333 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
47336 description: MultiVIM will discover and expose EPA capabilities.
47339 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47343 $ref: "#/definitions/volume-group"
47347 $ref: "#/definitions/tenant"
47351 $ref: "#/definitions/flavor"
47355 $ref: "#/definitions/group-assignment"
47359 $ref: "#/definitions/snapshot"
47363 $ref: "#/definitions/image"
47367 $ref: "#/definitions/dvs-switch"
47371 $ref: "#/definitions/oam-network"
47372 availability-zones:
47375 $ref: "#/definitions/availability-zone"
47379 $ref: "#/definitions/relationship"
47380 vip-ipv4-address-list:
47383 $ref: "#/definitions/vip-ipv4-address-list"
47384 vip-ipv6-address-list:
47387 $ref: "#/definitions/vip-ipv6-address-list"
47391 $ref: "#/definitions/hpa-capability"
47392 description: List of cloud-region specific HPA Capabilities
47393 esr-system-info-list:
47396 $ref: "#/definitions/esr-system-info"
47402 $ref: "#/definitions/cloud-region"
47405 Collection of physical locations that can house cloud-regions.
47406 ###### Related Nodes
47407 - TO l3-network( complex Uses l3-network, MANY2MANY)
47408 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
47409 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
47410 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
47411 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
47412 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
47413 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
47414 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
47415 - FROM vce( vce LocatedIn complex, MANY2MANY)
47416 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
47417 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
47418 - FROM zone( zone LocatedIn complex, MANY2ONE)
47420 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
47421 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
47424 - physical-location-id
47425 - physical-location-type
47432 physical-location-id:
47434 description: Unique identifier for physical location, e.g., CLLI
47437 description: Data center code which can be an alternate way to identify a complex
47440 description: Gamma complex name for LCP instance.
47443 description: URL of the keystone identity service
47446 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47447 physical-location-type:
47449 description: Type, e.g., central office, data center.
47475 $ref: "#/definitions/ctag-pool"
47479 $ref: "#/definitions/relationship"
47482 Collection of physical locations that can house cloud-regions.
47487 $ref: "#/definitions/complex"
47490 Port Mirror Configuration.
47491 ###### Related Nodes
47492 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
47493 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
47494 - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
47495 - TO pnf( configuration AppliesTo pnf, ONE2MANY)
47496 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
47497 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
47498 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
47499 - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
47500 - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
47501 - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
47502 - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
47504 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
47505 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
47506 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
47509 - configuration-type
47510 - configuration-sub-type
47511 - orchestration-status
47512 - operational-status
47513 - configuration-selflink
47514 - model-customization-id
47518 description: UUID assigned to configuration.
47521 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
47522 configuration-name:
47524 description: Name of the configuration.
47525 configuration-type:
47527 description: port-mirroring-configuration.
47528 configuration-sub-type:
47530 description: vprobe, pprobe.
47531 model-invariant-id:
47533 description: the ASDC model id for this resource or service model.
47536 description: the ASDC model version for this resource or service model.
47537 orchestration-status:
47539 description: Orchestration status of the configuration.
47540 operational-status:
47542 description: Indicator for whether the resource is considered operational.
47543 configuration-selflink:
47545 description: URL to endpoint where AAI can get more details from SDN-GC.
47546 model-customization-id:
47548 description: id of the configuration used to customize the resource
47551 description: DHV Site Effective Bandwidth
47552 vendor-allowed-max-bandwidth:
47554 description: Velocloud Nominal Throughput - VNT
47557 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47561 $ref: "#/definitions/relationship"
47565 $ref: "#/definitions/metadatum"
47569 $ref: "#/definitions/forwarder-evc"
47573 $ref: "#/definitions/evc"
47576 Collection of configurations
47581 $ref: "#/definitions/configuration"
47584 Collection of resource instances used to connect a variety of disparate inventory widgets
47585 ###### Related Nodes
47586 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
47587 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
47588 - FROM service-instance( service-instance Uses connector, MANY2MANY)
47590 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
47592 - resource-instance-id
47594 resource-instance-id:
47596 description: Unique id of resource instance.
47599 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47600 model-invariant-id:
47602 description: the ASDC model id for this resource or service model.
47605 description: the ASDC model version for this resource or service model.
47606 persona-model-version:
47608 description: the ASDC model version for this resource or service model.
47611 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47612 widget-model-version:
47614 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47618 $ref: "#/definitions/relationship"
47622 $ref: "#/definitions/metadatum"
47625 Collection of resource instances used to connect a variety of disparate inventory widgets
47630 $ref: "#/definitions/connector"
47631 constrained-element-set:
47633 This is how we would capture constraints defining allowed sets of elements.
47634 ###### Related Nodes
47635 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
47636 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
47637 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
47639 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
47640 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
47642 - constrained-element-set-uuid
47646 constrained-element-set-uuid:
47654 element-choice-sets:
47657 $ref: "#/definitions/element-choice-set"
47661 $ref: "#/definitions/relationship"
47662 constrained-element-sets:
47664 constrained-element-set:
47667 $ref: "#/definitions/constrained-element-set"
47670 ###### Related Nodes
47671 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
47672 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
47674 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
47684 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47688 $ref: "#/definitions/relationship"
47694 $ref: "#/definitions/ctag-assignment"
47697 A collection of C tags (vlan tags) grouped for a specific purpose.
47698 ###### Related Nodes
47699 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
47700 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
47701 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
47702 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
47704 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
47707 - availability-zone-name
47708 - ctag-pool-purpose
47712 description: The Target provider edge router
47713 availability-zone-name:
47715 description: Name of the availability zone
47718 description: Describes what the intended purpose of this pool is.
47721 description: Comma separated list of ctags
47724 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47728 $ref: "#/definitions/relationship"
47734 $ref: "#/definitions/ctag-pool"
47737 customer identifiers to provide linkage back to BSS information.
47738 ###### Related Nodes
47739 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
47741 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
47743 - global-customer-id
47747 global-customer-id:
47749 description: Global customer id used across ECOMP to uniquely identify customer.
47752 description: Subscriber name, an alternate way to retrieve a customer.
47755 description: Subscriber type, a way to provide VID with only the INFRA customers.
47758 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47759 service-subscriptions:
47762 $ref: "#/definitions/service-subscription"
47766 $ref: "#/definitions/relationship"
47769 Collection of customer identifiers to provide linkage back to BSS information.
47774 $ref: "#/definitions/customer"
47782 description: See mis-na-virtualization-platform.yang
47785 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47789 $ref: "#/definitions/relationship"
47795 $ref: "#/definitions/cvlan-tag-entry"
47798 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.
47799 ###### Related Nodes
47800 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
47801 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
47809 description: DVS switch name
47812 description: URL used to reach the vcenter
47815 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47819 $ref: "#/definitions/relationship"
47822 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
47827 $ref: "#/definitions/dvs-switch"
47830 Internal map to define the properties of an edge and interpret the map EdgeRules
47848 edge-tag-query-request:
47859 $ref: "#/definitions/start-node-filter"
47860 include-node-filter:
47863 $ref: "#/definitions/include-node-filter"
47867 $ref: "#/definitions/secondary-filter"
47868 edge-tag-query-result:
47870 tagged-inventory-item-list:
47873 $ref: "#/definitions/tagged-inventory-item-list"
47874 element-choice-set:
47876 This is how we would capture constraints defining allowed sets of elements.
47877 ###### Related Nodes
47878 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
47879 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
47881 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
47882 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
47884 - element-choice-set-uuid
47885 - element-choice-set-name
47887 element-choice-set-uuid:
47889 element-choice-set-name:
47898 $ref: "#/definitions/model-element"
47902 $ref: "#/definitions/relationship"
47903 element-choice-sets:
47905 element-choice-set:
47908 $ref: "#/definitions/element-choice-set"
47911 Metadata for entitlement group.
47912 ###### Related Nodes
47913 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
47914 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
47916 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
47923 description: Unique ID for the entitlement group the resource comes from, should be uuid.
47926 description: Unique ID of an entitlement resource.
47929 description: Concurrency value
47933 $ref: "#/definitions/relationship"
47936 Entitlements, keyed by group-uuid and resource-uuid, related to license management
47941 $ref: "#/definitions/entitlement"
47944 Persist EMS address information used by EMS driver.
47945 ###### Related Nodes
47946 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
47948 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
47954 description: Unique ID of EMS.
47957 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47958 esr-system-info-list:
47960 $ref: "#/definitions/esr-system-info-list"
47963 $ref: "#/definitions/relationship-list"
47969 $ref: "#/definitions/esr-ems"
47972 Persist common address information of external systems.
47973 ###### Related Nodes
47974 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
47975 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
47976 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
47977 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
47979 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
47981 - esr-system-info-id
47986 esr-system-info-id:
47988 description: Unique ID of esr system info.
47991 description: name of external system.
47994 description: type of external systems.
47997 description: vendor of external systems.
48000 description: version of external systems.
48003 description: url used to access external systems.
48006 description: username used to access external systems.
48009 description: password used to access external systems.
48012 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
48015 description: protocol of third party SDNC, for example netconf/snmp.
48018 description: ca file content if enabled ssl on auth-url.
48021 description: Whether to verify VIM's certificate.
48024 description: service IP of ftp server.
48027 description: service port of ftp server.
48030 description: domain info for authentication.
48033 description: default tenant of VIM.
48036 description: ftp passive mode or not.
48039 description: resource or performance data file path.
48042 description: the status of external system.
48045 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48049 $ref: "#/definitions/relationship"
48050 esr-system-info-list:
48052 Collection of persistent block-level external system auth info.
48057 $ref: "#/definitions/esr-system-info"
48058 esr-thirdparty-sdnc:
48060 Persist SDNC address information used by ONAP SDNC.
48061 ###### Related Nodes
48062 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
48063 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
48065 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
48067 - thirdparty-sdnc-id
48069 thirdparty-sdnc-id:
48071 description: Unique ID of SDNC.
48074 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
48077 description: password used to access SDNC server.
48080 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48081 esr-system-info-list:
48083 $ref: "#/definitions/esr-system-info-list"
48086 $ref: "#/definitions/relationship-list"
48087 esr-thirdparty-sdnc-list:
48089 esr-thirdparty-sdnc:
48092 $ref: "#/definitions/esr-thirdparty-sdnc"
48095 Persist VNFM address information used by VF-C.
48096 ###### Related Nodes
48097 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
48099 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
48105 description: Unique ID of VNFM.
48108 description: indecate the VIM to deploy VNF.
48111 description: certificate url of VNFM.
48114 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48115 esr-system-info-list:
48117 $ref: "#/definitions/esr-system-info-list"
48120 $ref: "#/definitions/relationship-list"
48126 $ref: "#/definitions/esr-vnfm"
48129 evc object is an optional child object of the Configuration object.
48130 ###### Related Nodes
48131 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
48133 -(4) IF this TO node is deleted, this EVC is DELETED also
48139 description: Unique/key field for the evc object
48140 forwarding-path-topology:
48142 description: Point-to-Point, Multi-Point
48145 description: Commited Information Rate
48148 description: CIR units
48149 connection-diversity-group-id:
48151 description: Diversity Group ID
48154 description: formerly Performance Group
48155 esp-evc-circuit-id:
48157 description: EVC Circuit ID of ESP EVC
48160 description: Committed Information Rate (For ESP)
48163 description: CIR units (For ESP)
48166 description: Identifies ESP
48167 collector-pop-clli:
48169 description: Collector POP CLLI (from the hostname of the access pnf)
48170 inter-connect-type-ingress:
48172 description: Interconnect type on ingress side of EVC.
48173 tagmode-access-ingress:
48175 description: tagode for collector side of EVC
48176 tagmode-access-egress:
48178 description: tagMode for network side of EVC
48182 $ref: "#/definitions/relationship"
48185 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48191 $ref: "#/definitions/evc"
48194 Namespace for external system.
48198 $ref: "#/definitions/esr-ems-list"
48201 $ref: "#/definitions/esr-vnfm-list"
48202 esr-thirdparty-sdnc-list:
48204 $ref: "#/definitions/esr-thirdparty-sdnc-list"
48207 Extra properties for inventory item for response list
48212 $ref: "#/definitions/extra-property"
48222 ###### Related Nodes
48223 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
48224 - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
48225 - FROM vserver( vserver Uses flavor, MANY2ONE)
48227 -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
48236 description: Flavor id, expected to be unique across cloud-region.
48239 description: Cloud region Flavor name
48243 description: Number of CPUs
48247 description: Amount of memory
48251 description: Disk space
48255 description: Amount of ephemeral disk space
48258 description: amount of swap space allocation
48261 description: whether flavor is available to all users or private to the tenant it was created in.
48264 description: URL to endpoint where AAI can get more details
48267 description: Boolean as to whether this flavor is no longer enabled
48271 $ref: "#/definitions/hpa-capability"
48272 description: List of flavor specific HPA Capabilities
48275 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48279 $ref: "#/definitions/relationship"
48282 Collection of openstack flavors.
48287 $ref: "#/definitions/flavor"
48290 Entity describing a sequenced segment of forwarding path
48291 ###### Related Nodes
48292 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
48293 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
48294 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
48295 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
48296 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
48298 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
48299 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
48306 description: Unique ID of this segmentation
48309 description: ingress, intermediate, egress
48313 $ref: "#/definitions/relationship"
48316 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48319 forwarder object is an optional child object of the Configuration object.
48320 ###### Related Nodes
48321 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
48323 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
48329 description: Key for forwarder-evc object
48332 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
48335 description: Internal VLAN.
48338 description: SVLAN value for ingress of egress forwarder.
48341 description: CVLAN value for ingress of egress forwarder.
48345 $ref: "#/definitions/relationship"
48348 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48354 $ref: "#/definitions/forwarder-evc"
48360 $ref: "#/definitions/forwarder"
48363 Entity that describes the sequenced forwarding path between interfaces of services or resources
48364 ###### Related Nodes
48365 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
48366 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
48367 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
48369 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
48370 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
48371 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
48373 - forwarding-path-id
48374 - forwarding-path-name
48376 forwarding-path-id:
48378 description: Unique ID of this FP
48379 forwarding-path-name:
48381 description: Name of the FP
48385 $ref: "#/definitions/relationship"
48388 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48391 description: the self link for this FP
48395 $ref: "#/definitions/forwarder"
48401 $ref: "#/definitions/forwarding-path"
48404 General purpose VNF
48405 ###### Related Nodes
48406 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
48407 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
48408 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
48409 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
48410 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
48411 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
48412 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
48413 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
48414 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
48415 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
48416 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
48417 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
48418 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
48419 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
48420 - TO model-ver( generic-vnf IsA model-ver, Many2One)
48421 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
48422 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
48423 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
48424 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
48425 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
48426 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
48427 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
48428 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
48429 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
48430 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
48431 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
48432 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
48433 - FROM platform( platform Uses generic-vnf, MANY2MANY)
48435 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
48436 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
48442 - is-closed-loop-disabled
48446 description: Unique id of VNF. This is unique across the graph.
48449 description: vnf instance id.
48452 description: Name of VNF.
48455 description: Alternate name of VNF.
48458 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.
48461 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
48462 regional-resource-zone:
48464 description: Regional way of organizing pservers, source of truth should define values
48467 description: Trigger for operational monitoring of this resource by Service Assurance systems.
48468 operational-status:
48470 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
48473 description: OBSOLETE - do not use
48476 description: Client should send valid enumerated value
48477 orchestration-status:
48479 description: Orchestration status of this VNF, used by MSO.
48482 vnf-discriptor-name:
48484 description: vnf discriptor name
48487 description: job id corresponding to vnf
48490 description: Heat stack id corresponding to this instance, managed by MSO
48493 description: Corresponds to the SDN-C catalog id used to configure this VCE
48496 description: identifier of managed by ATT or customer
48499 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
48500 ipv4-loopback0-address:
48502 description: v4 Loopback0 address
48505 description: v6 Loopback address
48506 management-v6-address:
48508 description: v6 management address
48512 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
48515 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
48519 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
48522 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
48526 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
48529 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
48533 description: number of associated SHD in vnf.
48537 description: number of vms in vnf.
48541 description: number of network in vnf.
48544 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.
48545 is-closed-loop-disabled:
48547 description: used to indicate whether closed loop function is enabled on this node
48550 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48553 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
48554 encrypted-access-flag:
48556 description: indicates whether generic-vnf access uses SSH
48557 entitlement-assignment-group-uuid:
48559 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
48560 entitlement-resource-uuid:
48562 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
48563 license-assignment-group-uuid:
48565 description: UUID of the license assignment group. OBSOLETE - See child relationships.
48568 description: UUID of the actual license resource. OBSOLETE - See child relationships.
48569 model-invariant-id:
48571 description: the ASDC model id for this resource or service model.
48574 description: the ASDC model version for this resource or service model.
48575 persona-model-version:
48577 description: the ASDC model version for this resource or service model.
48578 model-customization-id:
48580 description: captures the id of all the configuration used to customize the resource for the service.
48583 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48584 widget-model-version:
48586 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48589 description: as-number of the VNF
48590 regional-resource-subzone:
48592 description: represents sub zone of the rr plane
48595 description: Generic description of the type of NF
48598 description: English description of Network function that the specific VNF deployment is providing
48601 description: role in the network that this model will be providing
48604 description: string assigned to this model used for naming purposes
48607 description: Path to the controller object.
48608 ipv4-oam-gateway-address:
48610 description: Gateway address
48611 ipv4-oam-gateway-address-prefix-length:
48614 description: Prefix length for oam-address
48618 description: Temporary location for S-TAG to get to VCE
48621 description: Network Management profile of this VNF
48625 $ref: "#/definitions/relationship"
48629 $ref: "#/definitions/l-interface"
48633 $ref: "#/definitions/lag-interface"
48637 $ref: "#/definitions/vf-module"
48641 $ref: "#/definitions/license"
48645 $ref: "#/definitions/entitlement"
48653 $ref: "#/definitions/generic-vnf"
48656 Openstack group-assignment used to store exclusivity groups (EG).
48657 ###### Related Nodes
48658 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
48659 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
48660 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
48669 description: Group id, expected to be unique across cloud-region.
48672 description: Group type - the type of group this instance refers to
48675 description: Group name - name assigned to the group
48678 description: Group description - description of the group
48681 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48685 $ref: "#/definitions/relationship"
48688 Collection of openstack group assignments
48693 $ref: "#/definitions/group-assignment"
48696 ###### Related Nodes
48697 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
48699 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
48707 description: host-route id
48710 description: subnet prefix
48713 description: Could be ip-address, hostname, or service-instance
48716 description: Should be ip-address, hostname, or service-instance to match next-hop
48719 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48723 $ref: "#/definitions/relationship"
48729 $ref: "#/definitions/host-route"
48732 Collection of HPA Capabilities
48737 $ref: "#/definitions/hpa-capability"
48740 Represents a HPA capability
48741 ###### Related Nodes
48742 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
48743 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
48744 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
48746 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
48748 - hpa-capability-id
48753 description: UUID to uniquely identify a HPA capability
48756 description: Name of the HPACapability
48759 description: HPA schema version
48762 description: Hardware architecture
48765 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48769 $ref: "#/definitions/relationship"
48770 hpa-feature-attributes:
48773 $ref: "#/definitions/hpa-feature-attributes"
48774 hpa-feature-attributes:
48776 HPA Capability Feature attributes
48777 ###### Related Nodes
48778 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
48780 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
48782 - hpa-attribute-key
48786 description: name of the specific HPA attribute
48787 hpa-attribute-value:
48789 description: JSON string specifying the value, unit and type of the specific HPA attribute
48792 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48796 $ref: "#/definitions/relationship"
48800 ###### Related Nodes
48801 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
48802 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
48803 - FROM vserver( vserver Uses image, MANY2ONE)
48805 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
48806 -IMAGE cannot be deleted if related to VSERVER
48817 description: Image id, expected to be unique across cloud region
48820 description: Image name
48821 image-architecture:
48823 description: Operating system architecture.
48826 description: The common name of the operating system distribution in lowercase
48829 description: The operating system version as specified by the distributor.
48832 description: The application that the image instantiates.
48833 application-vendor:
48835 description: The vendor of the application.
48836 application-version:
48838 description: The version of the application.
48841 description: URL to endpoint where AAI can get more details
48844 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48848 $ref: "#/definitions/relationship"
48852 $ref: "#/definitions/metadatum"
48855 Collectio of Openstack images.
48860 $ref: "#/definitions/image"
48861 include-node-filter:
48867 InstanceFilter for performing a named-query or model query
48870 InstanceFilters for performing a named-query or model query
48875 $ref: "#/definitions/instance-filter"
48878 General mechanism for grouping instances
48879 ###### Related Nodes
48880 - TO model( instance-group Targets model, MANY2MANY)
48881 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
48882 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
48883 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48884 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48885 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
48886 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
48887 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
48888 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
48889 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
48890 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
48891 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
48898 instance-group-role:
48900 description: role of the instance group.
48901 model-invariant-id:
48903 description: ASDC model id for this resource or service model.
48906 description: ASDC model version uid for this resource model.
48909 description: Instance Group ID, UUID assigned to this instance.
48912 description: Descriptive text to help identify the usage of this instance-group
48915 description: Only valid value today is lower case ha for high availability
48918 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
48921 description: Concurrency value
48925 $ref: "#/definitions/relationship"
48928 Collection of openstack route table references
48933 $ref: "#/definitions/instance-group"
48938 $ref: "#/definitions/search"
48941 $ref: "#/definitions/actions"
48942 cloud-infrastructure:
48944 $ref: "#/definitions/cloud-infrastructure"
48947 $ref: "#/definitions/external-system"
48950 $ref: "#/definitions/business"
48951 service-design-and-creation:
48953 $ref: "#/definitions/service-design-and-creation"
48956 $ref: "#/definitions/network"
48959 $ref: "#/definitions/nodes"
48962 inventory-item-type:
48964 inventory-item-link:
48966 inventory-item-data:
48969 $ref: "#/definitions/inventory-item-data"
48970 tagged-inventory-item-list:
48973 $ref: "#/definitions/tagged-inventory-item-list"
48974 inventory-item-data:
48980 inventory-response-item:
48982 Inventory item for response list
48988 $ref: "#/definitions/extra-properties"
48989 inventory-response-items:
48991 $ref: "#/definitions/inventory-response-items"
48992 inventory-response-items:
48994 Container for inventory items in response list
48996 inventory-response-item:
48999 $ref: "#/definitions/inventory-response-item"
49000 ipsec-configuration:
49002 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
49003 ###### Related Nodes
49004 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
49005 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
49007 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
49009 - ipsec-configuration-id
49011 ipsec-configuration-id:
49013 description: UUID of this configuration
49014 requested-vig-address-type:
49016 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
49017 requested-encryption-strength:
49019 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
49020 requested-dmz-type:
49022 description: ATT can offer a shared DMZ or a DMZ specific to a customer
49023 shared-dmz-network-address:
49025 description: Network address of shared DMZ
49026 requested-customer-name:
49028 description: If the DMZ is a custom DMZ, this field will indicate the customer information
49031 description: can be 1 or 2
49032 ikev1-authentication:
49034 description: Contains values like md5, sha1, sha256, sha384
49037 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
49040 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
49043 description: Group name defined in VIG for clients using aggressive mode
49046 description: pre-shared key for the above group name
49049 description: Lifetime for IKEv1 SA
49050 ipsec-authentication:
49052 description: md5, sha1, sha256, sha384
49055 description: 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
49058 description: Life time for IPSec SA
49061 description: enable PFS or not
49064 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
49065 xauth-user-password:
49067 description: Encrypted using the Juniper $9$ algorithm
49070 description: The time between DPD probe
49073 description: Maximum number of DPD before claiming the tunnel is down
49076 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49080 $ref: "#/definitions/relationship"
49084 $ref: "#/definitions/vig-server"
49085 ipsec-configurations:
49087 ipsec-configuration:
49090 $ref: "#/definitions/ipsec-configuration"
49099 Logical interfaces, e.g., a vnic.
49100 ###### Related Nodes
49101 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
49102 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
49103 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
49104 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
49105 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
49106 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
49107 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
49108 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
49109 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
49110 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
49111 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
49112 - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
49113 - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
49114 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
49115 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
49116 - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
49117 - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
49118 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
49120 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
49121 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
49122 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
49131 description: Name given to the interface
49134 description: E.g., CUSTOMER, UPLINK, etc.
49137 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
49140 description: URL to endpoint where AAI can get more details
49143 description: ID of interface
49146 description: MAC address for the interface
49149 description: Name of the network
49152 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
49153 interface-description:
49155 description: Human friendly text regarding this interface.
49158 description: boolean indicatating whether or not port is a mirrored.
49161 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49164 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
49167 description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
49170 description: Flag indicating the interface uses the IP Unnumbered configuration.
49171 allowed-address-pairs:
49173 description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
49177 $ref: "#/definitions/vlan"
49181 $ref: "#/definitions/sriov-vf"
49185 $ref: "#/definitions/l-interface"
49189 $ref: "#/definitions/relationship"
49190 l3-interface-ipv4-address-list:
49193 $ref: "#/definitions/l3-interface-ipv4-address-list"
49194 l3-interface-ipv6-address-list:
49197 $ref: "#/definitions/l3-interface-ipv6-address-list"
49200 Collection of logical interfaces.
49205 $ref: "#/definitions/l-interface"
49206 l3-interface-ipv4-address-list:
49209 ###### Related Nodes
49210 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
49211 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49212 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
49213 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
49214 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
49215 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
49217 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
49219 - l3-interface-ipv4-address
49221 l3-interface-ipv4-address:
49223 description: IP address
49224 l3-interface-ipv4-prefix-length:
49227 description: Prefix length, 32 for single address
49231 description: Inner VLAN tag
49235 description: Outer VLAN tag
49238 description: Indicator of fixed or floating address
49241 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49242 neutron-network-id:
49244 description: Neutron network id of the interface that address belongs to
49247 description: Neutron id of subnet that address belongs to
49251 $ref: "#/definitions/relationship"
49252 l3-interface-ipv6-address-list:
49255 ###### Related Nodes
49256 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
49257 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49258 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
49259 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
49260 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
49261 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
49263 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
49265 - l3-interface-ipv6-address
49267 l3-interface-ipv6-address:
49269 description: IP address
49270 l3-interface-ipv6-prefix-length:
49273 description: Prefix length, 128 for single address
49277 description: Inner VLAN tag
49281 description: Outer VLAN tag
49284 description: Indicator of fixed or floating address
49287 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49288 neutron-network-id:
49290 description: Neutron network id of the interface that address belongs to
49293 description: Neutron id of subnet that address belongs to
49297 $ref: "#/definitions/relationship"
49300 Generic network definition
49301 ###### Related Nodes
49302 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
49303 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
49304 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
49305 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
49306 - TO model-ver( l3-network IsA model-ver, Many2One)
49307 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
49308 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
49309 - FROM complex( complex Uses l3-network, MANY2MANY)
49310 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
49311 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49312 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49313 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
49314 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
49315 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
49316 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
49317 - FROM tenant( tenant Uses l3-network, MANY2MANY)
49318 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
49320 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
49325 - is-provider-network
49326 - is-shared-network
49327 - is-external-network
49331 description: Network ID, should be uuid. Unique across A&AI.
49334 description: Name of the network, governed by some naming convention..
49337 description: Type of the network - who defines these values?
49340 description: Role the network plans - who defines these values?
49341 network-technology:
49343 description: Network technology - who defines these values?
49344 neutron-network-id:
49346 description: Neutron network id of this Interface
49349 description: Set to true if bound to VPN
49352 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
49353 network-role-instance:
49356 description: network role instance
49359 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49360 orchestration-status:
49362 description: Orchestration status of this VNF, mastered by MSO
49365 description: Heat stack id corresponding to this instance, managed by MSO
49368 description: Corresponds to the SDN-C catalog id used to configure this VCE
49369 contrail-network-fqdn:
49371 description: Contrail FQDN for the network
49372 model-invariant-id:
49374 description: the ASDC model id for this resource or service model.
49377 description: the ASDC model version for this resource or service model.
49378 persona-model-version:
49380 description: the ASDC model version for this resource or service model.
49381 model-customization-id:
49383 description: captures the id of all the configuration used to customize the resource for the service.
49386 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49387 widget-model-version:
49389 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49390 physical-network-name:
49392 description: Name associated with the physical network.
49393 is-provider-network:
49395 description: boolean indicatating whether or not network is a provider network.
49398 description: boolean indicatating whether or not network is a shared network.
49399 is-external-network:
49401 description: boolean indicatating whether or not network is an external network.
49404 description: Path to the controller object.
49405 operational-status:
49407 description: Indicator for whether the resource is considered operational.
49411 $ref: "#/definitions/subnet"
49415 $ref: "#/definitions/ctag-assignment"
49416 segmentation-assignments:
49419 $ref: "#/definitions/segmentation-assignment"
49423 $ref: "#/definitions/relationship"
49424 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
49430 $ref: "#/definitions/l3-network"
49433 Link aggregate interface
49434 ###### Related Nodes
49435 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
49436 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
49437 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
49438 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
49439 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
49440 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
49441 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
49442 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
49443 - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
49445 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
49446 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
49447 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
49454 description: Name that identifies the link aggregate interface
49455 interface-description:
49457 description: Human friendly text regarding this interface.
49460 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49463 description: Captures the numeric part of the speed
49466 description: Captures the units corresponding to the speed
49469 description: ID of interface
49472 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49475 description: Trigger for operational monitoring of this resource by Service Assurance systems.
49478 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
49482 $ref: "#/definitions/relationship"
49486 $ref: "#/definitions/l-interface"
49489 Collection of link aggregate interfaces.
49494 $ref: "#/definitions/lag-interface"
49497 LAG links can connect lag-interfaces
49498 ###### Related Nodes
49499 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
49500 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
49502 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
49508 description: Alphabetical concatenation of lag-interface names
49511 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49515 $ref: "#/definitions/relationship"
49518 Collection of link aggregation connections
49523 $ref: "#/definitions/lag-link"
49526 Metadata for license group.
49527 ###### Related Nodes
49528 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
49529 - TO vce( license BelongsTo vce, MANY2ONE)(4)
49531 -(4) IF this TO node is deleted, this LICENSE is DELETED also
49538 description: Unique ID for the license group the resource belongs to, should be uuid.
49541 description: Unique ID of a license resource.
49544 description: Concurrency value
49548 $ref: "#/definitions/relationship"
49551 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
49556 $ref: "#/definitions/license"
49559 describes a line-of-business
49560 ###### Related Nodes
49561 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
49564 - line-of-business-name
49566 line-of-business-name:
49568 description: Name of the line-of-business (product)
49571 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49575 $ref: "#/definitions/relationship"
49578 Collection of lines-of-business
49583 $ref: "#/definitions/line-of-business"
49586 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
49587 ###### Related Nodes
49588 - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
49589 - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
49590 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
49591 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
49592 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
49593 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
49594 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
49595 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
49596 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
49597 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
49598 - TO model-ver( logical-link IsA model-ver, Many2One)
49599 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
49600 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
49601 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
49602 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
49603 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
49604 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
49605 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
49607 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
49608 -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
49616 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
49619 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.
49622 description: Type of logical link, e.g., evc
49625 description: Captures the numeric part of the speed
49628 description: Captures the units corresponding to the speed
49631 description: v4, v6, or ds for dual stack
49634 description: For example, static or BGP
49637 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49638 model-invariant-id:
49640 description: the ASDC model id for this resource or service model.
49643 description: the ASDC model version for this resource or service model.
49644 persona-model-version:
49646 description: the ASDC model version for this resource or service model.
49649 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49650 widget-model-version:
49652 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49653 operational-status:
49655 description: Indication of operational status of the logical link.
49658 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
49661 description: Indication of the network use of the logical link.
49664 description: Alias or alternate name (CLCI or D1 name).
49667 description: UUID of the logical-link, SDNC generates this.
49670 description: Circuit id
49673 description: Reason for this entity, role it is playing
49677 $ref: "#/definitions/relationship"
49680 Collection of logical connections
49685 $ref: "#/definitions/logical-link"
49688 Collection of metadatum (key/value pairs)
49693 $ref: "#/definitions/metadatum"
49697 ###### Related Nodes
49698 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
49699 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
49700 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
49701 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
49702 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
49704 -(4) IF this TO node is deleted, this METADATUM is DELETED also
49715 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49718 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
49719 ###### Related Nodes
49720 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
49721 - FROM instance-group( instance-group Targets model, MANY2MANY)
49722 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
49723 - FROM named-query( named-query AppliesTo model, ONE2MANY)
49724 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
49726 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
49727 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
49730 - model-invariant-id
49733 model-invariant-id:
49735 description: Unique identifier corresponding to the main definition of a model in ASDC
49738 description: Type of the model, e.g., service, resource, widget, etc.
49741 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49745 $ref: "#/definitions/model-ver"
49749 $ref: "#/definitions/relationship"
49750 model-and-named-query-search:
49752 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
49756 $ref: "#/definitions/query-parameters"
49759 $ref: "#/definitions/instance-filters"
49762 $ref: "#/definitions/secondary-filts"
49765 secondary-filter-cut-point:
49769 This is how we would capture constraints defining allowed sets of elements.
49770 ###### Related Nodes
49771 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
49772 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
49774 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
49775 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
49777 - model-constraint-uuid
49778 - constrained-element-set-uuid-to-replace
49780 model-constraint-uuid:
49782 constrained-element-set-uuid-to-replace:
49784 constrained-element-sets:
49787 $ref: "#/definitions/constrained-element-set"
49790 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49796 $ref: "#/definitions/model-constraint"
49799 Defines how other models combine to make up a higher-level model.
49800 ###### Related Nodes
49801 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
49802 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
49803 - TO model-ver( model-element IsA model-ver, MANY2ONE)
49804 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
49805 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
49806 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
49807 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
49809 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
49810 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
49812 - model-element-uuid
49813 - new-data-del-flag
49816 model-element-uuid:
49820 description: Indicates whether this element was created as part of instantiation from this model
49823 description: How many of this type of element are required/allowed
49828 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49832 $ref: "#/definitions/model-element"
49833 description: Defines how other models combine to make up a higher-level model
49837 $ref: "#/definitions/model-constraint"
49838 description: Describes new constraints on this model element that are not part of that model's definition
49842 $ref: "#/definitions/relationship"
49848 $ref: "#/definitions/model-element"
49851 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
49852 ###### Related Nodes
49853 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
49854 - FROM model-element( model-element IsA model-ver, MANY2ONE)
49855 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
49856 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
49857 - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
49858 - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
49859 - FROM l3-network( l3-network IsA model-ver, Many2One)
49860 - FROM logical-link( logical-link IsA model-ver, Many2One)
49861 - FROM service-instance( service-instance IsA model-ver, Many2One)
49862 - FROM vf-module( vf-module IsA model-ver, Many2One)
49864 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
49865 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
49866 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
49875 description: Unique identifier corresponding to one version of a model in ASDC
49878 description: Name of the model, which can change from version to version.
49881 description: Version
49882 distribution-status:
49884 description: Distribution Status
49887 description: Description
49890 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49894 $ref: "#/definitions/model-element"
49898 $ref: "#/definitions/metadatum"
49902 $ref: "#/definitions/relationship"
49908 $ref: "#/definitions/model-ver"
49911 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
49916 $ref: "#/definitions/model"
49917 multicast-configuration:
49919 ###### Related Nodes
49920 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
49923 - multicast-configuration-id
49924 - multicast-protocol
49927 multicast-configuration-id:
49929 description: Unique id of multicast configuration.
49930 multicast-protocol:
49932 description: protocol of multicast configuration
49935 description: rp type of multicast configuration
49938 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49942 $ref: "#/definitions/relationship"
49943 multicast-configurations:
49945 multicast configuration of generic-vnf ip-address
49947 multicast-configuration:
49950 $ref: "#/definitions/multicast-configuration"
49956 $ref: "#/definitions/named-query"
49960 ###### Related Nodes
49961 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
49962 - TO model( named-query AppliesTo model, ONE2MANY)
49963 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
49965 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
49969 - named-query-version
49975 named-query-version:
49977 required-input-param:
49983 named-query-elements:
49986 $ref: "#/definitions/named-query-element"
49990 $ref: "#/definitions/relationship"
49991 named-query-element:
49994 ###### Related Nodes
49995 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
49996 - TO model( named-query-element IsA model, MANY2ONE)
49997 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
49998 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
49999 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
50000 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
50002 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
50003 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
50005 - named-query-element-uuid
50007 named-query-element-uuid:
50009 property-collect-list:
50013 property-limit-desc:
50017 named-query-elements:
50020 $ref: "#/definitions/named-query-element"
50024 $ref: "#/definitions/related-lookup"
50025 property-constraints:
50028 $ref: "#/definitions/property-constraint"
50032 $ref: "#/definitions/relationship"
50033 named-query-elements:
50035 named-query-element:
50038 $ref: "#/definitions/named-query-element"
50041 Namespace for network inventory resources.
50046 $ref: "#/definitions/logical-link"
50050 $ref: "#/definitions/site-pair-set"
50054 $ref: "#/definitions/vpn-binding"
50058 $ref: "#/definitions/vpls-pe"
50059 multicast-configurations:
50062 $ref: "#/definitions/multicast-configuration"
50066 $ref: "#/definitions/vce"
50070 $ref: "#/definitions/vnfc"
50074 $ref: "#/definitions/l3-network"
50078 $ref: "#/definitions/network-policy"
50082 $ref: "#/definitions/generic-vnf"
50086 $ref: "#/definitions/lag-link"
50090 $ref: "#/definitions/newvce"
50094 $ref: "#/definitions/pnf"
50098 $ref: "#/definitions/physical-link"
50099 ipsec-configurations:
50102 $ref: "#/definitions/ipsec-configuration"
50103 route-table-references:
50106 $ref: "#/definitions/route-table-reference"
50110 $ref: "#/definitions/instance-group"
50114 $ref: "#/definitions/zone"
50118 $ref: "#/definitions/configuration"
50122 $ref: "#/definitions/forwarding-path"
50128 $ref: "#/definitions/network-policy"
50131 ###### Related Nodes
50132 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
50133 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
50136 - network-policy-id
50140 description: UUID representing unique key to this instance
50141 network-policy-fqdn:
50143 description: Contrail FQDN for the policy
50146 description: ID for the openStack Heat instance
50149 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50153 $ref: "#/definitions/relationship"
50156 Network profile populated by SDN-GP for SNMP
50157 ###### Related Nodes
50158 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
50165 description: Unique name of network profile.
50168 description: Encrypted SNMP community string
50171 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50175 $ref: "#/definitions/relationship"
50178 Collection of network profiles
50183 $ref: "#/definitions/network-profile"
50186 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
50187 ###### Related Nodes
50188 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
50190 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
50198 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
50201 description: Name of VNF.
50204 description: Alternate name of VNF.
50207 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.
50210 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50211 operational-status:
50213 description: Indicator for whether the resource is considered operational
50216 description: OBSOLETE - do not use
50219 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).
50222 description: Client should send valid enumerated value.
50225 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50226 ipv4-loopback0-address:
50228 description: v4 Loopback0 address
50229 orchestration-status:
50231 description: Orchestration status of this VNF, mastered by MSO.
50234 description: Heat stack id corresponding to this instance, managed by MSO
50237 description: Corresponds to the SDN-C catalog id used to configure this VCE
50241 $ref: "#/definitions/relationship"
50245 $ref: "#/definitions/l-interface"
50248 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
50253 $ref: "#/definitions/newvce"
50256 inventory-item-data:
50259 $ref: "#/definitions/inventory-item-data"
50260 notification-event:
50264 notification-event-header:
50266 $ref: "#/definitions/notification-event-header"
50267 notification-event-header:
50308 $ref: "#/definitions/key-data"
50313 OAM network, to be deprecated shortly. Do not use for new purposes.
50314 ###### Related Nodes
50315 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
50316 - TO complex( oam-network AppliesTo complex, MANY2MANY)
50317 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
50326 description: UUID of the network. Unique across a cloud-region
50329 description: Name of the network.
50333 description: cvlan-id
50334 ipv4-oam-gateway-address:
50336 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50337 ipv4-oam-gateway-address-prefix-length:
50340 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50343 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50347 $ref: "#/definitions/relationship"
50350 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
50355 $ref: "#/definitions/oam-network"
50356 operational-environment:
50358 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50359 ###### Related Nodes
50360 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50361 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50364 - operational-environment-id
50365 - operational-environment-name
50366 - operational-environment-type
50367 - operational-environment-status
50371 operational-environment-id:
50373 description: UUID of an operational environment
50374 operational-environment-name:
50376 description: Operational Environment name
50377 operational-environment-type:
50379 description: Operational Environment Type.
50380 operational-environment-status:
50382 description: Status
50385 description: Tenant Context.
50388 description: Workload Context.
50391 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50395 $ref: "#/definitions/relationship"
50396 operational-environments:
50398 a logical partition of the cloud which allows to have multiple environments in the production AIC.
50400 operational-environment:
50403 $ref: "#/definitions/operational-environment"
50406 Allows for legacy POST of old-style and new-style models
50408 - model-invariant-id
50409 - model-name-version-id
50415 model-invariant-id:
50417 description: Unique identifier corresponding to the main definition of a model in ASDC
50418 model-name-version-id:
50420 description: Unique identifier corresponding to one version of a model in ASDC
50423 description: Type of the model, e.g., service, resource, widget, etc.
50426 description: Name of the model, which can change from version to version.
50429 description: Invariant unique ID which does not change from version to version
50432 description: Version
50435 description: Description
50438 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50441 $ref: "#/definitions/model-vers"
50444 $ref: "#/definitions/relationship-list"
50447 Collection of owning-entities
50452 $ref: "#/definitions/owning-entity"
50455 describes an owning-entity
50456 ###### Related Nodes
50457 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
50461 - owning-entity-name
50465 description: UUID of an owning entity
50466 owning-entity-name:
50468 description: Owning entity name
50471 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50475 $ref: "#/definitions/relationship"
50478 Physical interface (e.g., nic)
50479 ###### Related Nodes
50480 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
50481 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
50482 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
50483 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
50484 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
50485 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
50486 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
50487 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
50488 - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
50490 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
50491 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
50492 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
50499 description: Name that identifies the physical interface
50502 description: URL to endpoint where AAI can get more details.
50505 description: Captures the numeric part of the speed
50508 description: Captures the units corresponding to the speed
50511 description: Nature of the services and connectivity on this port.
50512 equipment-identifier:
50514 description: CLEI or other specification for p-interface hardware.
50517 description: Role specification for p-interface hardware.
50520 description: Indicates the physical properties of the interface.
50523 description: Trigger for operational monitoring of this resource by Service Assurance systems.
50526 description: MAC Address of the p-interface.
50529 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50532 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50535 description: inventory status
50539 $ref: "#/definitions/relationship"
50543 $ref: "#/definitions/sriov-pf"
50547 $ref: "#/definitions/l-interface"
50550 Collection of physical interfaces.
50555 $ref: "#/definitions/p-interface"
50558 Collection of physical connections, typically between p-interfaces
50559 ###### Related Nodes
50560 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
50562 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
50568 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50571 description: Captures the numeric part of the speed
50574 description: Captures the units corresponding to the speed
50577 description: Circuit it
50580 description: Dual access mode (e.g., primary, secondary
50583 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50584 service-provider-name:
50586 description: Name of the service Provider on this link.
50587 service-provider-bandwidth-up-value:
50590 description: Upstream Bandwidth value agreed with the service provider
50591 service-provider-bandwidth-up-units:
50593 description: Units for the upstream BW value
50594 service-provider-bandwidth-down-value:
50597 description: Downstream Bandwidth value agreed with the service provider
50598 service-provider-bandwidth-down-units:
50600 description: Units for downstream BW value
50603 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50607 $ref: "#/definitions/relationship"
50610 Collection of physical connections, typically between p-interfaces
50615 $ref: "#/definitions/physical-link"
50618 describes a platform
50619 ###### Related Nodes
50620 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
50627 description: Name of the platform
50630 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50634 $ref: "#/definitions/relationship"
50637 Collection of platforms
50642 $ref: "#/definitions/platform"
50645 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.
50646 ###### Related Nodes
50647 - TO complex( pnf LocatedIn complex, MANY2ONE)
50648 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
50649 - TO zone( pnf LocatedIn zone, MANY2ONE)
50650 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
50651 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
50652 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
50653 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
50654 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
50655 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
50656 - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
50658 -(1) IF this PNF node is deleted, this FROM node is DELETED also
50665 description: unique name of Physical Network Function.
50668 description: name of Physical Network Function.
50671 description: URL to endpoint where AAI can get more details.
50674 description: source of name2
50677 description: id of pnf
50680 description: Equipment type. Source of truth should define valid values.
50683 description: Equipment vendor. Source of truth should define valid values.
50686 description: Equipment model. Source of truth should define valid values.
50689 description: identifier of managed by ATT or customer
50692 description: ipv4-oam-address with new naming convention for IP addresses
50695 description: sw-version is the version of SW for the hosted application on the PNF.
50698 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.
50701 description: ID of the physical frame (relay rack) where pnf is installed.
50704 description: Serial number of the device
50705 ipaddress-v4-loopback-0:
50707 description: IPV4 Loopback 0 address
50708 ipaddress-v6-loopback-0:
50710 description: IPV6 Loopback 0 address
50713 description: IPV4 AIM address
50716 description: IPV6 AIM address
50719 description: IPV6 OAM address
50722 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50725 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50728 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50731 description: Nf Role is the role performed by this instance in the network.
50735 $ref: "#/definitions/relationship"
50739 $ref: "#/definitions/p-interface"
50743 $ref: "#/definitions/lag-interface"
50746 Collection of Physical Network Functions.
50751 $ref: "#/definitions/pnf"
50754 Used to capture the network interfaces of this VCE
50755 ###### Related Nodes
50756 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
50757 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
50759 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
50760 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
50763 - orchestration-status
50767 description: Unique ID of the interface
50768 neutron-network-id:
50770 description: Neutron network id of this Interface
50771 neutron-network-name:
50773 description: Neutron network name of this Interface
50776 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50779 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50782 description: Unique ID for port group in vmware
50785 description: Likely to duplicate value of neutron network name
50788 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
50789 orchestration-status:
50791 description: Orchestration status of this VNF, mastered by MSO
50794 description: Heat stack id corresponding to this instance, managed by MSO
50797 description: Corresponds to the SDN-C catalog id used to configure this VCE
50801 $ref: "#/definitions/cvlan-tag-entry"
50805 $ref: "#/definitions/relationship"
50811 $ref: "#/definitions/port-group"
50814 describes the project
50815 ###### Related Nodes
50816 - TO service-instance( project Uses service-instance, ONE2MANY)
50823 description: Name of the project deploying a service
50826 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50830 $ref: "#/definitions/relationship"
50833 Collection of projects
50838 $ref: "#/definitions/project"
50841 Property holder for query properties or instance properties
50847 property-constraint:
50850 ###### Related Nodes
50851 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
50853 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
50855 - property-constraint-uuid
50860 property-constraint-uuid:
50870 property-constraints:
50872 property-constraint:
50875 $ref: "#/definitions/property-constraint"
50878 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
50879 ###### Related Nodes
50880 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
50881 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
50882 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
50883 - TO complex( pserver LocatedIn complex, MANY2ONE)
50884 - TO zone( pserver LocatedIn zone, MANY2ONE)
50885 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
50886 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
50887 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
50888 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
50889 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
50891 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
50892 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
50900 description: Value from executing hostname on the compute node.
50903 description: PTNII name
50907 description: Number of cpus
50911 description: Disk size, in GBs
50915 description: RAM size, in MBs
50918 description: Equipment type. Source of truth should define valid values.
50921 description: Equipment vendor. Source of truth should define valid values.
50924 description: Equipment model. Source of truth should define valid values.
50927 description: Fully-qualified domain name
50930 description: URL to endpoint where AAI can get more details
50933 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
50936 description: Serial number, may be queried
50937 ipaddress-v4-loopback-0:
50939 description: IPV4 Loopback 0 address
50940 ipaddress-v6-loopback-0:
50942 description: IPV6 Loopback 0 address
50945 description: IPV4 AIM address
50948 description: IPV6 AIM address
50951 description: IPV6 OAM address
50954 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50957 description: ID of Pserver
50960 description: internet topology of Pserver
50963 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.
50966 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50969 description: alternative pserver name
50972 description: purpose of pserver
50975 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50978 description: Indicates who owns and or manages the device.
50981 description: The host profile that defines the configuration of the pserver.
50985 $ref: "#/definitions/relationship"
50989 $ref: "#/definitions/p-interface"
50993 $ref: "#/definitions/lag-interface"
50996 Collection of compute hosts.
51001 $ref: "#/definitions/pserver"
51004 QueryParameters for performing a named-query or model query
51008 $ref: "#/definitions/named-query"
51011 $ref: "#/definitions/overloaded-model"
51015 ###### Related Nodes
51016 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
51018 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
51020 - related-lookup-uuid
51022 - source-node-property
51024 - target-node-property
51026 related-lookup-uuid:
51030 source-node-property:
51034 target-node-property:
51036 property-collect-list:
51043 $ref: "#/definitions/relationship"
51049 $ref: "#/definitions/related-lookup"
51050 related-to-property:
51054 description: Key part of a key/value pair
51057 description: Value part of a key/value pair
51062 description: A keyword provided by A&AI to indicate type of node.
51063 relationship-label:
51065 description: The edge label for this relationship.
51068 description: URL to the object in A&AI.
51072 $ref: "#/definitions/relationship-data"
51076 - relationship-value
51080 description: A keyword provided by A&AI to indicate an attribute.
51081 relationship-value:
51083 description: Value of the attribute.
51089 $ref: "#/definitions/relationship"
51090 reserved-prop-names:
51092 Internal map to define some reserved properties of a vertex
51094 last-mod-source-of-truth:
51112 Response container for the results of a named-query or model query
51114 inventory-response-items:
51116 $ref: "#/definitions/inventory-response-items"
51121 description: The specific type of node in the A&AI graph
51124 description: The URL to the specific resource
51125 route-table-reference:
51127 Openstack route table reference.
51128 ###### Related Nodes
51129 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
51132 - route-table-reference-id
51133 - route-table-reference-fqdn
51135 route-table-reference-id:
51137 description: Route Table Reference id, UUID assigned to this instance.
51138 route-table-reference-fqdn:
51140 description: FQDN entry in the route table.
51143 description: Concurrency value
51147 $ref: "#/definitions/relationship"
51148 route-table-references:
51150 Collection of openstack route table references
51152 route-table-reference:
51155 $ref: "#/definitions/route-table-reference"
51158 Route target information
51159 ###### Related Nodes
51160 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
51162 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
51164 - global-route-target
51165 - route-target-role
51167 global-route-target:
51169 description: Number used to identify an RT, globally unique in the network
51172 description: Role assigned to this route target
51175 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51179 $ref: "#/definitions/relationship"
51182 Collection of route target information
51187 $ref: "#/definitions/route-target"
51190 ###### Related Nodes
51191 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
51192 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
51194 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
51195 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
51197 - routing-instance-id
51199 routing-instance-id:
51201 description: Unique id of routing instance
51204 description: rpm owner
51207 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51211 $ref: "#/definitions/site-pair"
51215 $ref: "#/definitions/relationship"
51218 set of probes related to generic-vnf routing instance
51223 $ref: "#/definitions/routing-instance"
51228 $ref: "#/definitions/oam-networks"
51229 az-and-dvs-switches:
51232 $ref: "#/definitions/az-and-dvs-switches"
51235 edge-tag-query-result:
51237 $ref: "#/definitions/edge-tag-query-result"
51238 edge-tag-query-request:
51240 $ref: "#/definitions/edge-tag-query-request"
51243 $ref: "#/definitions/search-results"
51246 $ref: "#/definitions/sdn-zone-response"
51252 $ref: "#/definitions/result-data"
51255 SecondaryFilt for performing a named-query or model query
51266 SecondaryFilts for performing a named-query or model query
51271 $ref: "#/definitions/secondary-filt"
51272 segmentation-assignment:
51274 Openstack segmentation assignment.
51275 ###### Related Nodes
51276 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
51278 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
51284 description: Route Table Reference id, UUID assigned to this instance.
51287 description: Concurrency value
51291 $ref: "#/definitions/relationship"
51292 segmentation-assignments:
51294 Collection of openstack segmentation assignments
51296 segmentation-assignment:
51299 $ref: "#/definitions/segmentation-assignment"
51302 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
51305 - service-description
51309 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51310 service-description:
51312 description: Description of the service
51315 description: URL to endpoint where AAI can get more details
51318 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51321 description: service version
51325 $ref: "#/definitions/relationship"
51326 service-capabilities:
51328 Collection of service capabilities.
51330 service-capability:
51333 $ref: "#/definitions/service-capability"
51334 service-capability:
51336 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
51337 ###### Related Nodes
51338 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
51339 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
51341 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
51349 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51352 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.
51355 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51359 $ref: "#/definitions/relationship"
51360 service-design-and-creation:
51362 Namespace for objects managed by ASDC
51367 $ref: "#/definitions/vnf-image"
51371 $ref: "#/definitions/service"
51372 service-capabilities:
51375 $ref: "#/definitions/service-capability"
51379 $ref: "#/definitions/model"
51383 $ref: "#/definitions/named-query"
51386 Instance of a service
51387 ###### Related Nodes
51388 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
51389 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
51390 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
51391 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
51392 - TO configuration( service-instance Uses configuration, ONE2MANY)
51393 - TO connector( service-instance Uses connector, MANY2MANY)
51394 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
51395 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
51396 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
51397 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
51398 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
51399 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51400 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
51401 - TO zone( service-instance LocatedIn zone, MANY2ONE)
51402 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
51403 - TO vce( service-instance ComposedOf vce, ONE2MANY)
51404 - TO model-ver( service-instance IsA model-ver, Many2One)
51405 - FROM project( project Uses service-instance, ONE2MANY)
51406 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
51407 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
51408 - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
51409 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51411 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
51412 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
51413 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
51415 - service-instance-id
51417 service-instance-id:
51419 description: Uniquely identifies this instance of a service
51420 service-instance-name:
51422 description: This field will store a name assigned to the service-instance.
51425 description: String capturing type of service.
51428 description: String capturing the service role.
51429 environment-context:
51431 description: This field will store the environment context assigned to the service-instance.
51434 description: This field will store the workload context assigned to the service-instance.
51437 description: create time of Network Service.
51440 description: last update of Network Service.
51443 description: short description for service-instance.
51444 model-invariant-id:
51446 description: the ASDC model id for this resource or service model.
51449 description: the ASDC model version for this resource or service model.
51450 persona-model-version:
51452 description: the ASDC model version for this resource or service model.
51455 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51456 widget-model-version:
51458 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51461 description: Indicates the total bandwidth to be used for this service.
51464 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51465 bandwidth-down-wan1:
51467 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51470 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51471 bandwidth-down-wan2:
51473 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51476 description: URL customers will use to access the vHN Portal.
51477 service-instance-location-id:
51479 description: An identifier that customers assign to the location where this service is being used.
51482 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51485 description: Path to the controller object.
51486 orchestration-status:
51488 description: Orchestration status of this service.
51492 $ref: "#/definitions/relationship"
51496 $ref: "#/definitions/metadatum"
51497 allotted-resources:
51500 $ref: "#/definitions/allotted-resource"
51503 Collection of service instances
51508 $ref: "#/definitions/service-instance"
51509 service-subscription:
51511 Object that group service instances.
51512 ###### Related Nodes
51513 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
51514 - TO tenant( service-subscription Uses tenant, MANY2MANY)
51515 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
51517 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
51518 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
51524 description: Value defined by orchestration to identify this service across ECOMP.
51525 temp-ub-sub-account-id:
51527 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51530 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51534 $ref: "#/definitions/service-instance"
51538 $ref: "#/definitions/relationship"
51539 service-subscriptions:
51541 Collection of objects that group service instances.
51543 service-subscription:
51546 $ref: "#/definitions/service-subscription"
51549 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
51554 $ref: "#/definitions/service"
51557 ###### Related Nodes
51558 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
51559 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
51561 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
51562 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
51568 description: unique identifier of probe
51571 description: Prefix address
51574 description: Prefix address
51577 description: ip version, v4, v6
51578 destination-hostname:
51580 description: Hostname of the destination equipment to which SLAs are measured against.
51581 destination-equip-type:
51583 description: The type of destinatination equipment. Could be Router, UCPE, etc.
51586 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51587 classes-of-service:
51590 $ref: "#/definitions/class-of-service"
51594 $ref: "#/definitions/relationship"
51597 Set of instances for probes used to measure service level agreements
51598 ###### Related Nodes
51599 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51600 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
51602 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
51608 description: Unique id of site pair set.
51611 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51615 $ref: "#/definitions/routing-instance"
51619 $ref: "#/definitions/relationship"
51622 Collection of sets of instances for probes related to generic-vnf
51627 $ref: "#/definitions/site-pair-set"
51635 $ref: "#/definitions/site-pair"
51639 ###### Related Nodes
51640 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
51641 - FROM vserver( vserver Uses snapshot, ONE2ONE)
51648 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51651 description: Snapshot name
51652 snapshot-architecture:
51654 description: Operating system architecture
51655 snapshot-os-distro:
51657 description: The common name of the operating system distribution in lowercase
51658 snapshot-os-version:
51660 description: The operating system version as specified by the distributor.
51663 description: The application that the image instantiates.
51664 application-vendor:
51666 description: The vendor of the application.
51667 application-version:
51669 description: The version of the application.
51672 description: URL to endpoint where AAI can get more details
51675 description: This field contains the UUID of the previous snapshot (if any).
51678 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51682 $ref: "#/definitions/relationship"
51685 Collection of openstack snapshots
51690 $ref: "#/definitions/snapshot"
51693 SR-IOV Physical Function
51694 ###### Related Nodes
51695 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
51696 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
51698 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
51704 description: Identifier for the sriov-pf
51707 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51711 $ref: "#/definitions/relationship"
51714 Collection of SR-IOV Physical Functions.
51719 $ref: "#/definitions/sriov-pf"
51722 SR-IOV Virtual Function (not to be confused with virtual network function)
51723 ###### Related Nodes
51724 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
51725 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
51727 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
51733 description: PCI ID used to identify the sriov-vf
51736 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51739 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51742 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51743 vf-vlan-anti-spoof-check:
51745 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.
51746 vf-mac-anti-spoof-check:
51748 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.
51751 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51752 vf-broadcast-allow:
51754 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51755 vf-unknown-multicast-allow:
51757 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51758 vf-unknown-unicast-allow:
51760 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51763 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51766 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
51769 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51770 neutron-network-id:
51772 description: Neutron network id of the interface
51776 $ref: "#/definitions/relationship"
51779 Collection of SR-IOV Virtual Functions.
51784 $ref: "#/definitions/sriov-vf"
51793 ###### Related Nodes
51794 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
51795 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
51796 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
51797 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
51798 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
51799 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
51801 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
51802 -(4) IF this TO node is deleted, this SUBNET is DELETED also
51803 -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
51811 description: Subnet ID, should be UUID.
51814 description: Name associated with the subnet.
51817 description: Neutron id of this subnet
51820 description: gateway ip address
51821 network-start-address:
51823 description: network start address
51826 description: cidr mask
51829 description: ip version
51830 orchestration-status:
51832 description: Orchestration status of this VNF, mastered by MSO
51835 description: dhcp enabled
51838 description: the start address reserved for use by dhcp
51841 description: the last address reserved for use by dhcp
51844 description: role of the subnet, referenced when assigning IPs
51845 ip-assignment-direction:
51847 description: ip address assignment direction of the subnet
51850 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51854 description: sequence of the subnet
51858 $ref: "#/definitions/host-route"
51862 $ref: "#/definitions/relationship"
51868 $ref: "#/definitions/subnet"
51869 tagged-inventory-item-list:
51874 $ref: "#/definitions/inventory-item"
51878 ###### Related Nodes
51879 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
51880 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
51881 - TO l3-network( tenant Uses l3-network, MANY2MANY)
51882 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
51883 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
51884 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
51886 -TENANT cannot be deleted if related to VSERVER
51894 description: Unique id relative to the cloud-region.
51897 description: Readable name of tenant
51900 description: This field will store the tenant context.
51903 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51907 $ref: "#/definitions/vserver"
51911 $ref: "#/definitions/relationship"
51914 Collection of openstack tenants.
51919 $ref: "#/definitions/tenant"
51922 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51923 ###### Related Nodes
51924 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
51926 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
51932 description: Allotted Resource id UUID assigned to this instance.
51935 description: The WAN uplink bandwidth for WAN1
51936 bandwidth-down-wan1:
51938 description: The WAN downlink bandwidth for WAN1
51941 description: The WAN uplink bandwidth for WAN2
51942 bandwidth-down-wan2:
51944 description: The WAN downlink bandwidth for WAN2
51947 description: Concurrency value
51951 $ref: "#/definitions/relationship"
51954 This object is used to store the specific tunnel cross connect aspects of an allotted resource
51959 $ref: "#/definitions/tunnel-xconnect"
51962 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
51971 $ref: "#/definitions/update-node-key"
51977 $ref: "#/definitions/action"
51986 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
51987 ###### Related Nodes
51988 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
51989 - TO complex( vce LocatedIn complex, MANY2MANY)
51990 - TO vserver( vce HostedOn vserver, ONE2MANY)
51991 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
51992 - FROM license( license BelongsTo vce, MANY2ONE)(1)
51993 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
51994 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
51996 -(1) IF this VCE node is deleted, this FROM node is DELETED also
52004 description: Unique id of VNF. This is unique across the graph.
52007 description: Name of VNF.
52010 description: Alternate name of VNF.
52013 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.
52016 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
52017 regional-resource-zone:
52019 description: Regional way of organizing pservers, source of truth should define values
52022 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52023 operational-status:
52025 description: Indicator for whether the resource is considered operational
52028 description: OBSOLETE - do not use
52031 description: Network role being played by this VNF
52032 orchestration-status:
52034 description: Orchestration status of this VNF, mastered by MSO
52037 description: Heat stack id corresponding to this instance, managed by MSO
52040 description: Corresponds to the SDN-C catalog id used to configure this VCE
52043 description: Unique ID of VPE connected to this VCE.
52044 v6-vce-wan-address:
52046 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
52049 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
52052 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52053 ipv4-loopback0-address:
52055 description: Loopback0 address
52056 entitlement-resource-uuid:
52058 description: OBSOLETE - see child relationships
52062 $ref: "#/definitions/port-group"
52066 $ref: "#/definitions/license"
52070 $ref: "#/definitions/entitlement"
52074 $ref: "#/definitions/relationship"
52077 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
52082 $ref: "#/definitions/vce"
52085 a deployment unit of VNFCs
52086 ###### Related Nodes
52087 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
52088 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
52089 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
52090 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
52091 - TO vserver( vf-module Uses vserver, ONE2MANY)
52092 - TO model-ver( vf-module IsA model-ver, Many2One)
52094 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
52095 -VF-MODULE cannot be deleted if related to VNFC
52099 - is-base-vf-module
52103 description: Unique ID of vf-module.
52106 description: Name of vf-module
52109 description: Heat stack id corresponding to this instance.
52110 orchestration-status:
52112 description: orchestration status of this vf-module, mastered by MSO
52115 description: used to indicate whether or not this object is base vf module
52118 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52119 model-invariant-id:
52121 description: the ASDC model id for this resource or service model.
52124 description: the ASDC model version for this resource or service model.
52125 persona-model-version:
52127 description: the ASDC model version for this resource or service model.
52128 model-customization-id:
52130 description: captures the id of all the configuration used to customize the resource for the service.
52133 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52134 widget-model-version:
52136 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52137 contrail-service-instance-fqdn:
52139 description: the Contrail unique ID for a service-instance
52143 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
52146 description: Path to the controller object.
52150 $ref: "#/definitions/relationship"
52153 Collection of vf-modules, a deployment unit of VNFCs
52158 $ref: "#/definitions/vf-module"
52161 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
52162 ###### Related Nodes
52163 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
52165 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
52171 description: indicates whether the VIG is for AVPN or INTERNET
52174 description: v4 IP of the vig server
52177 description: v6 IP of the vig server
52180 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52184 $ref: "#/definitions/relationship"
52190 $ref: "#/definitions/vig-server"
52191 vip-ipv4-address-list:
52194 ###### Related Nodes
52195 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
52196 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
52197 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
52198 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
52205 description: IP address
52206 vip-ipv4-prefix-length:
52209 description: Prefix length, 32 for single address
52213 description: Inner VLAN tag
52217 description: Outer VLAN tag
52220 description: Indicator of fixed or floating address
52223 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52224 neutron-network-id:
52226 description: Neutron network id of the interface that address belongs to
52229 description: Neutron id of subnet that address belongs to
52233 $ref: "#/definitions/relationship"
52234 vip-ipv6-address-list:
52237 ###### Related Nodes
52238 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
52239 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
52240 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
52241 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
52248 description: IP address
52249 vip-ipv6-prefix-length:
52252 description: Prefix length, 128 for single address
52256 description: Inner VLAN tag
52260 description: Outer VLAN tag
52263 description: Indicator of fixed or floating address
52266 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52267 neutron-network-id:
52269 description: Neutron network id of the interface that address belongs to
52272 description: Neutron id of subnet that address belongs to
52276 $ref: "#/definitions/relationship"
52277 virtual-data-center:
52279 Virtual organization of cloud infrastructure elements in a data center context
52280 ###### Related Nodes
52281 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
52282 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
52283 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
52291 description: Unique ID of the vdc
52294 description: Name of the virtual data center
52297 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52301 $ref: "#/definitions/relationship"
52302 virtual-data-centers:
52304 Virtual organization of cloud infrastructure elements in a data center context
52306 virtual-data-center:
52309 $ref: "#/definitions/virtual-data-center"
52313 ###### Related Nodes
52314 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
52315 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
52316 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
52317 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
52318 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
52319 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
52320 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
52322 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
52323 -(2) IF this VLAN node is deleted, this TO node is DELETED also
52324 -(4) IF this TO node is deleted, this VLAN is DELETED also
52332 description: String that identifies the interface
52336 description: Inner VLAN tag
52340 description: Outer VLAN tag
52343 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52346 description: Captures the numeric part of the speed
52349 description: Captures the units corresponding to the speed
52352 description: Used to describe (the service associated with) the vlan
52353 backdoor-connection:
52355 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
52358 description: This indicates the customers VPN ID associated with this vlan
52359 orchestration-status:
52361 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
52364 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52367 description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
52370 description: Flag indicating the interface uses the IP Unnumbered configuration.
52374 $ref: "#/definitions/relationship"
52375 l3-interface-ipv4-address-list:
52378 $ref: "#/definitions/l3-interface-ipv4-address-list"
52379 l3-interface-ipv6-address-list:
52382 $ref: "#/definitions/l3-interface-ipv6-address-list"
52388 $ref: "#/definitions/vlan"
52397 description: Unique id of VNF. This is unique across the graph.
52400 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52401 ###### Related Nodes
52402 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
52404 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
52409 - application-vendor
52413 description: Unique ID of this asset
52416 description: The application that the image instantiates.
52417 application-vendor:
52419 description: The vendor of the application.
52420 application-version:
52422 description: The version of the application.
52425 description: URL to endpoint where AAI can get more details
52428 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52432 $ref: "#/definitions/relationship"
52435 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52440 $ref: "#/definitions/vnf-image"
52443 ###### Related Nodes
52444 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
52445 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
52446 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
52447 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
52448 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
52449 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
52450 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
52451 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
52453 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
52454 -(4) IF this TO node is deleted, this VNFC is DELETED also
52460 - is-closed-loop-disabled
52464 description: Unique ID of vnfc.
52467 description: Short code that is used in naming instances of the item being modeled
52470 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
52473 description: prov status of this vnfc
52474 orchestration-status:
52476 description: Orchestration status of this VNF, mastered by APP-C
52477 ipaddress-v4-oam-vip:
52479 description: Oam V4 vip address of this vnfc
52482 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52483 is-closed-loop-disabled:
52485 description: used to indicate whether closed loop function is enabled on this node
52488 description: Group notation of VNFC
52489 model-invariant-id:
52491 description: the ASDC model id for this resource or service model.
52494 description: the ASDC model version for this resource or service model.
52497 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52501 $ref: "#/definitions/relationship"
52502 l3-interface-ipv4-address-list:
52505 $ref: "#/definitions/l3-interface-ipv4-address-list"
52506 l3-interface-ipv6-address-list:
52509 $ref: "#/definitions/l3-interface-ipv6-address-list"
52512 virtual network components associated with a vserver from application controller.
52517 $ref: "#/definitions/vnfc"
52520 Ephemeral Block storage volume.
52521 ###### Related Nodes
52522 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
52524 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
52531 description: Unique ID of block storage volume relative to the vserver.
52534 description: URL to endpoint where AAI can get more details
52537 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52541 $ref: "#/definitions/relationship"
52544 Persistent block-level storage.
52545 ###### Related Nodes
52546 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
52547 - TO complex( volume-group LocatedIn complex, MANY2ONE)
52548 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
52549 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
52550 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
52554 - volume-group-name
52559 description: Unique ID of volume-group.
52562 description: Name of the volume group.
52565 description: Heat stack id corresponding to this volume-group
52568 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.
52569 orchestration-status:
52571 description: Orchestration status of this volume-group
52572 model-customization-id:
52574 description: captures the id of all the configuration used to customize the resource for the service.
52575 vf-module-model-customization-id:
52577 description: helps relate the volume group to the vf-module whose components will require the volume group
52580 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52584 $ref: "#/definitions/relationship"
52587 Collection of persistent block-level storage.
52592 $ref: "#/definitions/volume-group"
52595 Collection of ephemeral Block storage volumes.
52600 $ref: "#/definitions/volume"
52603 VPLS Provider Edge routers.
52604 ###### Related Nodes
52605 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
52606 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
52607 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
52608 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
52610 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
52618 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52621 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).
52624 description: Client should send valid enumerated value, e.g., VPLS-PE.
52628 description: Temporary location for stag to get to VCE
52631 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52635 $ref: "#/definitions/relationship"
52639 $ref: "#/definitions/p-interface"
52643 $ref: "#/definitions/lag-interface"
52646 Collection of VPLS Provider Edge routers
52651 $ref: "#/definitions/vpls-pe"
52655 ###### Related Nodes
52656 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
52657 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
52658 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
52659 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
52661 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
52662 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
52670 description: VPN ID, globally unique within A&AI
52673 description: VPN Name
52676 description: the platform associated with the VPN example AVPN, Mobility
52679 description: Type of the vpn, should be taken from enumerated/valid values
52682 description: region of customer vpn
52685 description: id for this customer vpn
52686 route-distinguisher:
52688 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
52691 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52695 $ref: "#/definitions/route-target"
52699 $ref: "#/definitions/relationship"
52700 description: l3-networks relate to vpn-bindings
52706 $ref: "#/definitions/vpn-binding"
52709 Virtual Servers, aka virtual machine or VM.
52710 ###### Related Nodes
52711 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
52712 - TO flavor( vserver Uses flavor, MANY2ONE)
52713 - TO image( vserver Uses image, MANY2ONE)
52714 - TO pserver( vserver HostedOn pserver, MANY2ONE)
52715 - TO snapshot( vserver Uses snapshot, ONE2ONE)
52716 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
52717 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
52718 - FROM vce( vce HostedOn vserver, ONE2MANY)
52719 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
52720 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
52721 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
52723 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
52724 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
52730 - is-closed-loop-disabled
52734 description: Unique identifier for this vserver relative to its tenant
52737 description: Name of vserver
52740 description: Alternative name of vserver
52743 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52746 description: URL to endpoint where AAI can get more details
52749 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.
52750 is-closed-loop-disabled:
52752 description: Used to indicate whether closed loop function is enabled on this node
52755 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52759 $ref: "#/definitions/volume"
52763 $ref: "#/definitions/relationship"
52767 $ref: "#/definitions/l-interface"
52770 Collection of virtual Servers, aka virtual machines or VMs.
52775 $ref: "#/definitions/vserver"
52778 A zone is a grouping of assets in a location homing to the same connections into the CBB
52779 ###### Related Nodes
52780 - TO complex( zone LocatedIn complex, MANY2ONE)
52781 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
52782 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
52783 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
52784 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
52794 description: Code assigned by AIC to the zone
52797 description: English name associated with the zone
52800 description: Design of zone [Medium/Largeā¦]
52803 description: Context of zone [production/test]
52806 description: Status of a zone.
52809 description: Concurrency value
52813 $ref: "#/definitions/relationship"
52816 Collection of zones
52821 $ref: "#/definitions/zone"
52830 $ref: "#/patchDefinitions/action-data"
52839 APIs that are more action related than REST (e.g., notify, update).
52843 $ref: "#/patchDefinitions/update"
52846 $ref: "#/patchDefinitions/notify"
52849 Represents a slice or partial piece of a resource that gets separately allotted
52850 ###### Related Nodes
52851 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
52852 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
52853 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
52854 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
52855 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
52856 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
52857 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
52858 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
52859 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
52860 - TO model-ver( allotted-resource IsA model-ver, Many2One)
52861 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
52862 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
52863 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
52864 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
52866 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
52867 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
52868 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
52874 description: Allotted Resource id UUID assigned to this instance.
52877 description: The descriptive information assigned to this allotted resource instance
52880 description: Link back to more information in the controller
52881 model-invariant-id:
52883 description: the ASDC model id for this resource or service model.
52886 description: the ASDC model version for this resource or service model.
52887 persona-model-version:
52889 description: the ASDC model version for this resource or service model.
52890 allotted-resources:
52892 This object is used to store slices of services being offered
52897 $ref: "#/patchDefinitions/allotted-resource"
52900 Availability zone, a collection of compute hosts/pservers
52901 ###### Related Nodes
52902 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
52903 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
52904 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
52905 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
52906 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
52907 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
52908 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
52909 - FROM vce( vce Uses availability-zone, MANY2MANY)
52911 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
52912 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52915 - availability-zone-name
52918 availability-zone-name:
52920 description: Name of the availability zone. Unique across a cloud region
52923 description: Type of hypervisor. Source of truth should define valid values.
52924 operational-status:
52926 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
52927 availability-zones:
52929 Collection of availability zones
52934 $ref: "#/patchDefinitions/availability-zone"
52935 az-and-dvs-switches:
52939 $ref: "#/patchDefinitions/dvs-switches"
52942 $ref: "#/patchDefinitions/availability-zone"
52945 Namespace for business related constructs
52950 $ref: "#/patchDefinitions/connector"
52954 $ref: "#/patchDefinitions/customer"
52958 $ref: "#/patchDefinitions/line-of-business"
52962 $ref: "#/patchDefinitions/owning-entity"
52966 $ref: "#/patchDefinitions/platform"
52970 $ref: "#/patchDefinitions/project"
52973 ###### Related Nodes
52974 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
52976 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
52982 description: unique identifier of probe
52985 description: identifier of probe
52988 description: type of probe
52989 classes-of-service:
52991 class-of-service of probe
52996 $ref: "#/patchDefinitions/class-of-service"
52997 cloud-infrastructure:
52999 Namespace for cloud infrastructure.
53004 $ref: "#/patchDefinitions/complex"
53008 $ref: "#/patchDefinitions/cloud-region"
53012 $ref: "#/patchDefinitions/network-profile"
53016 $ref: "#/patchDefinitions/pserver"
53017 virtual-data-centers:
53020 $ref: "#/patchDefinitions/virtual-data-center"
53021 operational-environments:
53024 $ref: "#/patchDefinitions/operational-environment"
53027 cloud-region designates an installation of a cloud cluster or region or instantiation.
53028 ###### Related Nodes
53029 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
53030 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
53031 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
53032 - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
53033 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
53034 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
53035 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
53036 - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
53037 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
53038 - FROM image( image BelongsTo cloud-region, MANY2ONE)
53039 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
53040 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
53041 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
53042 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
53043 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
53044 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
53045 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
53046 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
53048 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
53049 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
53058 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
53061 description: Identifier used by the vendor for the region. Second part of composite key
53064 description: Type of the cloud (e.g., openstack)
53065 owner-defined-type:
53067 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
53068 cloud-region-version:
53070 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
53073 description: URL of the keystone identity service
53076 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53079 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53082 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
53085 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
53088 description: MultiVIM will discover and expose EPA capabilities.
53094 $ref: "#/patchDefinitions/cloud-region"
53097 Collection of physical locations that can house cloud-regions.
53098 ###### Related Nodes
53099 - TO l3-network( complex Uses l3-network, MANY2MANY)
53100 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
53101 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
53102 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
53103 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
53104 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
53105 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
53106 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
53107 - FROM vce( vce LocatedIn complex, MANY2MANY)
53108 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
53109 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
53110 - FROM zone( zone LocatedIn complex, MANY2ONE)
53112 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
53113 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
53116 - physical-location-id
53117 - physical-location-type
53124 physical-location-id:
53126 description: Unique identifier for physical location, e.g., CLLI
53129 description: Data center code which can be an alternate way to identify a complex
53132 description: Gamma complex name for LCP instance.
53135 description: URL of the keystone identity service
53138 Collection of physical locations that can house cloud-regions.
53143 $ref: "#/patchDefinitions/complex"
53146 Port Mirror Configuration.
53147 ###### Related Nodes
53148 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
53149 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
53150 - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
53151 - TO pnf( configuration AppliesTo pnf, ONE2MANY)
53152 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
53153 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
53154 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
53155 - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
53156 - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
53157 - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
53158 - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
53160 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
53161 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
53162 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
53165 - configuration-type
53166 - configuration-sub-type
53167 - orchestration-status
53168 - operational-status
53169 - configuration-selflink
53170 - model-customization-id
53174 description: UUID assigned to configuration.
53177 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
53178 configuration-name:
53180 description: Name of the configuration.
53181 configuration-type:
53183 description: port-mirroring-configuration.
53184 configuration-sub-type:
53186 description: vprobe, pprobe.
53187 model-invariant-id:
53189 description: the ASDC model id for this resource or service model.
53192 description: the ASDC model version for this resource or service model.
53193 orchestration-status:
53195 description: Orchestration status of the configuration.
53196 operational-status:
53198 description: Indicator for whether the resource is considered operational.
53199 configuration-selflink:
53201 description: URL to endpoint where AAI can get more details from SDN-GC.
53202 model-customization-id:
53204 description: id of the configuration used to customize the resource
53207 description: DHV Site Effective Bandwidth
53208 vendor-allowed-max-bandwidth:
53210 description: Velocloud Nominal Throughput - VNT
53213 Collection of configurations
53218 $ref: "#/patchDefinitions/configuration"
53221 Collection of resource instances used to connect a variety of disparate inventory widgets
53222 ###### Related Nodes
53223 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
53224 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
53225 - FROM service-instance( service-instance Uses connector, MANY2MANY)
53227 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
53229 - resource-instance-id
53231 resource-instance-id:
53233 description: Unique id of resource instance.
53236 Collection of resource instances used to connect a variety of disparate inventory widgets
53241 $ref: "#/patchDefinitions/connector"
53242 constrained-element-set:
53244 This is how we would capture constraints defining allowed sets of elements.
53245 ###### Related Nodes
53246 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
53247 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
53248 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
53250 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
53251 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
53253 - constrained-element-set-uuid
53257 constrained-element-set-uuid:
53263 constrained-element-sets:
53265 constrained-element-set:
53268 $ref: "#/patchDefinitions/constrained-element-set"
53271 ###### Related Nodes
53272 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
53273 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
53275 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
53288 $ref: "#/patchDefinitions/ctag-assignment"
53291 A collection of C tags (vlan tags) grouped for a specific purpose.
53292 ###### Related Nodes
53293 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
53294 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
53295 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
53296 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
53298 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
53301 - availability-zone-name
53302 - ctag-pool-purpose
53306 description: The Target provider edge router
53307 availability-zone-name:
53309 description: Name of the availability zone
53312 description: Describes what the intended purpose of this pool is.
53315 description: Comma separated list of ctags
53321 $ref: "#/patchDefinitions/ctag-pool"
53324 customer identifiers to provide linkage back to BSS information.
53325 ###### Related Nodes
53326 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
53328 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
53330 - global-customer-id
53334 global-customer-id:
53336 description: Global customer id used across ECOMP to uniquely identify customer.
53339 description: Subscriber name, an alternate way to retrieve a customer.
53342 description: Subscriber type, a way to provide VID with only the INFRA customers.
53345 Collection of customer identifiers to provide linkage back to BSS information.
53350 $ref: "#/patchDefinitions/customer"
53358 description: See mis-na-virtualization-platform.yang
53364 $ref: "#/patchDefinitions/cvlan-tag-entry"
53367 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.
53368 ###### Related Nodes
53369 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
53370 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
53378 description: DVS switch name
53381 description: URL used to reach the vcenter
53384 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53389 $ref: "#/patchDefinitions/dvs-switch"
53392 Internal map to define the properties of an edge and interpret the map EdgeRules
53410 edge-tag-query-request:
53421 $ref: "#/patchDefinitions/start-node-filter"
53422 include-node-filter:
53425 $ref: "#/patchDefinitions/include-node-filter"
53429 $ref: "#/patchDefinitions/secondary-filter"
53430 edge-tag-query-result:
53432 tagged-inventory-item-list:
53435 $ref: "#/patchDefinitions/tagged-inventory-item-list"
53436 element-choice-set:
53438 This is how we would capture constraints defining allowed sets of elements.
53439 ###### Related Nodes
53440 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
53441 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
53443 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
53444 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
53446 - element-choice-set-uuid
53447 - element-choice-set-name
53449 element-choice-set-uuid:
53451 element-choice-set-name:
53455 element-choice-sets:
53457 element-choice-set:
53460 $ref: "#/patchDefinitions/element-choice-set"
53463 Metadata for entitlement group.
53464 ###### Related Nodes
53465 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
53466 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
53468 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
53475 description: Unique ID for the entitlement group the resource comes from, should be uuid.
53478 description: Unique ID of an entitlement resource.
53481 Entitlements, keyed by group-uuid and resource-uuid, related to license management
53486 $ref: "#/patchDefinitions/entitlement"
53489 Persist EMS address information used by EMS driver.
53490 ###### Related Nodes
53491 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
53493 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
53499 description: Unique ID of EMS.
53505 $ref: "#/patchDefinitions/esr-ems"
53508 Persist common address information of external systems.
53509 ###### Related Nodes
53510 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
53511 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
53512 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
53513 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
53515 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
53517 - esr-system-info-id
53522 esr-system-info-id:
53524 description: Unique ID of esr system info.
53527 description: name of external system.
53530 description: type of external systems.
53533 description: vendor of external systems.
53536 description: version of external systems.
53539 description: url used to access external systems.
53542 description: username used to access external systems.
53545 description: password used to access external systems.
53548 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53551 description: protocol of third party SDNC, for example netconf/snmp.
53554 description: ca file content if enabled ssl on auth-url.
53557 description: Whether to verify VIM's certificate.
53560 description: service IP of ftp server.
53563 description: service port of ftp server.
53566 description: domain info for authentication.
53569 description: default tenant of VIM.
53572 description: ftp passive mode or not.
53575 description: resource or performance data file path.
53578 description: the status of external system.
53579 esr-system-info-list:
53581 Collection of persistent block-level external system auth info.
53586 $ref: "#/patchDefinitions/esr-system-info"
53587 esr-thirdparty-sdnc:
53589 Persist SDNC address information used by ONAP SDNC.
53590 ###### Related Nodes
53591 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
53592 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
53594 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
53596 - thirdparty-sdnc-id
53598 thirdparty-sdnc-id:
53600 description: Unique ID of SDNC.
53603 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53606 description: password used to access SDNC server.
53607 esr-thirdparty-sdnc-list:
53609 esr-thirdparty-sdnc:
53612 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
53615 Persist VNFM address information used by VF-C.
53616 ###### Related Nodes
53617 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
53619 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
53625 description: Unique ID of VNFM.
53628 description: indecate the VIM to deploy VNF.
53631 description: certificate url of VNFM.
53637 $ref: "#/patchDefinitions/esr-vnfm"
53640 evc object is an optional child object of the Configuration object.
53641 ###### Related Nodes
53642 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
53644 -(4) IF this TO node is deleted, this EVC is DELETED also
53650 description: Unique/key field for the evc object
53651 forwarding-path-topology:
53653 description: Point-to-Point, Multi-Point
53656 description: Commited Information Rate
53659 description: CIR units
53660 connection-diversity-group-id:
53662 description: Diversity Group ID
53665 description: formerly Performance Group
53666 esp-evc-circuit-id:
53668 description: EVC Circuit ID of ESP EVC
53671 description: Committed Information Rate (For ESP)
53674 description: CIR units (For ESP)
53677 description: Identifies ESP
53678 collector-pop-clli:
53680 description: Collector POP CLLI (from the hostname of the access pnf)
53681 inter-connect-type-ingress:
53683 description: Interconnect type on ingress side of EVC.
53684 tagmode-access-ingress:
53686 description: tagode for collector side of EVC
53687 tagmode-access-egress:
53689 description: tagMode for network side of EVC
53695 $ref: "#/patchDefinitions/evc"
53698 Namespace for external system.
53702 $ref: "#/patchDefinitions/esr-ems-list"
53705 $ref: "#/patchDefinitions/esr-vnfm-list"
53706 esr-thirdparty-sdnc-list:
53708 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
53711 Extra properties for inventory item for response list
53716 $ref: "#/patchDefinitions/extra-property"
53726 ###### Related Nodes
53727 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
53728 - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
53729 - FROM vserver( vserver Uses flavor, MANY2ONE)
53731 -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
53740 description: Flavor id, expected to be unique across cloud-region.
53743 description: Cloud region Flavor name
53747 description: Number of CPUs
53751 description: Amount of memory
53755 description: Disk space
53759 description: Amount of ephemeral disk space
53762 description: amount of swap space allocation
53765 description: whether flavor is available to all users or private to the tenant it was created in.
53768 description: URL to endpoint where AAI can get more details
53771 description: Boolean as to whether this flavor is no longer enabled
53775 $ref: "#/patchDefinitions/hpa-capability"
53776 description: List of flavor specific HPA Capabilities
53779 Collection of openstack flavors.
53784 $ref: "#/patchDefinitions/flavor"
53787 Entity describing a sequenced segment of forwarding path
53788 ###### Related Nodes
53789 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
53790 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
53791 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
53792 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
53793 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
53795 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
53796 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
53803 description: Unique ID of this segmentation
53806 description: ingress, intermediate, egress
53809 forwarder object is an optional child object of the Configuration object.
53810 ###### Related Nodes
53811 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
53813 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
53819 description: Key for forwarder-evc object
53822 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53825 description: Internal VLAN.
53828 description: SVLAN value for ingress of egress forwarder.
53831 description: CVLAN value for ingress of egress forwarder.
53837 $ref: "#/patchDefinitions/forwarder-evc"
53843 $ref: "#/patchDefinitions/forwarder"
53846 Entity that describes the sequenced forwarding path between interfaces of services or resources
53847 ###### Related Nodes
53848 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
53849 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
53850 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
53852 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
53853 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
53854 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
53856 - forwarding-path-id
53857 - forwarding-path-name
53859 forwarding-path-id:
53861 description: Unique ID of this FP
53862 forwarding-path-name:
53864 description: Name of the FP
53870 $ref: "#/patchDefinitions/forwarding-path"
53873 General purpose VNF
53874 ###### Related Nodes
53875 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
53876 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
53877 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
53878 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
53879 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
53880 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
53881 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
53882 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
53883 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
53884 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
53885 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
53886 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
53887 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
53888 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
53889 - TO model-ver( generic-vnf IsA model-ver, Many2One)
53890 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
53891 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
53892 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
53893 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
53894 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
53895 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
53896 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
53897 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
53898 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
53899 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
53900 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
53901 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
53902 - FROM platform( platform Uses generic-vnf, MANY2MANY)
53904 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
53905 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
53911 - is-closed-loop-disabled
53915 description: Unique id of VNF. This is unique across the graph.
53918 description: vnf instance id.
53921 description: Name of VNF.
53924 description: Alternate name of VNF.
53927 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.
53930 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
53931 regional-resource-zone:
53933 description: Regional way of organizing pservers, source of truth should define values
53936 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53937 operational-status:
53939 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
53942 description: OBSOLETE - do not use
53945 description: Client should send valid enumerated value
53946 orchestration-status:
53948 description: Orchestration status of this VNF, used by MSO.
53951 vnf-discriptor-name:
53953 description: vnf discriptor name
53956 description: job id corresponding to vnf
53959 description: Heat stack id corresponding to this instance, managed by MSO
53962 description: Corresponds to the SDN-C catalog id used to configure this VCE
53965 description: identifier of managed by ATT or customer
53968 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53969 ipv4-loopback0-address:
53971 description: v4 Loopback0 address
53974 description: v6 Loopback address
53975 management-v6-address:
53977 description: v6 management address
53981 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53984 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
53988 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
53991 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
53995 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
53998 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
54002 description: number of associated SHD in vnf.
54006 description: number of vms in vnf.
54010 description: number of network in vnf.
54013 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.
54014 is-closed-loop-disabled:
54016 description: used to indicate whether closed loop function is enabled on this node
54024 $ref: "#/patchDefinitions/generic-vnf"
54027 Openstack group-assignment used to store exclusivity groups (EG).
54028 ###### Related Nodes
54029 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
54030 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
54031 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
54040 description: Group id, expected to be unique across cloud-region.
54043 description: Group type - the type of group this instance refers to
54046 description: Group name - name assigned to the group
54049 description: Group description - description of the group
54052 Collection of openstack group assignments
54057 $ref: "#/patchDefinitions/group-assignment"
54060 ###### Related Nodes
54061 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
54063 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
54071 description: host-route id
54074 description: subnet prefix
54077 description: Could be ip-address, hostname, or service-instance
54080 description: Should be ip-address, hostname, or service-instance to match next-hop
54086 $ref: "#/patchDefinitions/host-route"
54089 Collection of HPA Capabilities
54094 $ref: "#/patchDefinitions/hpa-capability"
54097 Represents a HPA capability
54098 ###### Related Nodes
54099 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
54100 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
54101 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
54103 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
54105 - hpa-capability-id
54110 description: UUID to uniquely identify a HPA capability
54113 description: Name of the HPACapability
54116 description: HPA schema version
54119 description: Hardware architecture
54120 hpa-feature-attributes:
54122 HPA Capability Feature attributes
54123 ###### Related Nodes
54124 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
54126 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
54128 - hpa-attribute-key
54132 description: name of the specific HPA attribute
54133 hpa-attribute-value:
54135 description: JSON string specifying the value, unit and type of the specific HPA attribute
54139 ###### Related Nodes
54140 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
54141 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
54142 - FROM vserver( vserver Uses image, MANY2ONE)
54144 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
54145 -IMAGE cannot be deleted if related to VSERVER
54156 description: Image id, expected to be unique across cloud region
54159 description: Image name
54160 image-architecture:
54162 description: Operating system architecture.
54165 description: The common name of the operating system distribution in lowercase
54168 description: The operating system version as specified by the distributor.
54171 description: The application that the image instantiates.
54172 application-vendor:
54174 description: The vendor of the application.
54175 application-version:
54177 description: The version of the application.
54180 description: URL to endpoint where AAI can get more details
54183 Collectio of Openstack images.
54188 $ref: "#/patchDefinitions/image"
54189 include-node-filter:
54195 InstanceFilter for performing a named-query or model query
54198 InstanceFilters for performing a named-query or model query
54203 $ref: "#/patchDefinitions/instance-filter"
54206 General mechanism for grouping instances
54207 ###### Related Nodes
54208 - TO model( instance-group Targets model, MANY2MANY)
54209 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
54210 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
54211 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
54212 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
54213 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
54214 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
54215 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
54216 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
54217 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
54218 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
54219 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
54226 instance-group-role:
54228 description: role of the instance group.
54229 model-invariant-id:
54231 description: ASDC model id for this resource or service model.
54234 description: ASDC model version uid for this resource model.
54237 description: Instance Group ID, UUID assigned to this instance.
54240 description: Descriptive text to help identify the usage of this instance-group
54243 description: Only valid value today is lower case ha for high availability
54246 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
54249 Collection of openstack route table references
54254 $ref: "#/patchDefinitions/instance-group"
54259 $ref: "#/patchDefinitions/search"
54262 $ref: "#/patchDefinitions/actions"
54263 cloud-infrastructure:
54265 $ref: "#/patchDefinitions/cloud-infrastructure"
54268 $ref: "#/patchDefinitions/external-system"
54271 $ref: "#/patchDefinitions/business"
54272 service-design-and-creation:
54274 $ref: "#/patchDefinitions/service-design-and-creation"
54277 $ref: "#/patchDefinitions/network"
54280 $ref: "#/patchDefinitions/nodes"
54283 inventory-item-type:
54285 inventory-item-link:
54287 inventory-item-data:
54290 $ref: "#/patchDefinitions/inventory-item-data"
54291 tagged-inventory-item-list:
54294 $ref: "#/patchDefinitions/tagged-inventory-item-list"
54295 inventory-item-data:
54301 inventory-response-item:
54303 Inventory item for response list
54309 $ref: "#/patchDefinitions/extra-properties"
54310 inventory-response-items:
54312 $ref: "#/patchDefinitions/inventory-response-items"
54313 inventory-response-items:
54315 Container for inventory items in response list
54317 inventory-response-item:
54320 $ref: "#/patchDefinitions/inventory-response-item"
54321 ipsec-configuration:
54323 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
54324 ###### Related Nodes
54325 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
54326 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
54328 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
54330 - ipsec-configuration-id
54332 ipsec-configuration-id:
54334 description: UUID of this configuration
54335 requested-vig-address-type:
54337 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54338 requested-encryption-strength:
54340 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54341 requested-dmz-type:
54343 description: ATT can offer a shared DMZ or a DMZ specific to a customer
54344 shared-dmz-network-address:
54346 description: Network address of shared DMZ
54347 requested-customer-name:
54349 description: If the DMZ is a custom DMZ, this field will indicate the customer information
54352 description: can be 1 or 2
54353 ikev1-authentication:
54355 description: Contains values like md5, sha1, sha256, sha384
54358 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
54361 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54364 description: Group name defined in VIG for clients using aggressive mode
54367 description: pre-shared key for the above group name
54370 description: Lifetime for IKEv1 SA
54371 ipsec-authentication:
54373 description: md5, sha1, sha256, sha384
54376 description: 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
54379 description: Life time for IPSec SA
54382 description: enable PFS or not
54385 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
54386 xauth-user-password:
54388 description: Encrypted using the Juniper $9$ algorithm
54391 description: The time between DPD probe
54394 description: Maximum number of DPD before claiming the tunnel is down
54395 ipsec-configurations:
54397 ipsec-configuration:
54400 $ref: "#/patchDefinitions/ipsec-configuration"
54409 Logical interfaces, e.g., a vnic.
54410 ###### Related Nodes
54411 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
54412 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
54413 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
54414 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
54415 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
54416 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
54417 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
54418 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
54419 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
54420 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
54421 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
54422 - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
54423 - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
54424 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
54425 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
54426 - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
54427 - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
54428 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
54430 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
54431 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
54432 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
54441 description: Name given to the interface
54444 description: E.g., CUSTOMER, UPLINK, etc.
54447 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54450 description: URL to endpoint where AAI can get more details
54453 description: ID of interface
54456 description: MAC address for the interface
54459 description: Name of the network
54462 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54463 interface-description:
54465 description: Human friendly text regarding this interface.
54468 description: boolean indicatating whether or not port is a mirrored.
54471 Collection of logical interfaces.
54476 $ref: "#/patchDefinitions/l-interface"
54477 l3-interface-ipv4-address-list:
54480 ###### Related Nodes
54481 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
54482 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
54483 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
54484 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
54485 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
54486 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
54488 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
54490 - l3-interface-ipv4-address
54492 l3-interface-ipv4-address:
54494 description: IP address
54495 l3-interface-ipv4-prefix-length:
54498 description: Prefix length, 32 for single address
54502 description: Inner VLAN tag
54506 description: Outer VLAN tag
54509 description: Indicator of fixed or floating address
54510 l3-interface-ipv6-address-list:
54513 ###### Related Nodes
54514 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
54515 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
54516 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
54517 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
54518 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
54519 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
54521 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
54523 - l3-interface-ipv6-address
54525 l3-interface-ipv6-address:
54527 description: IP address
54528 l3-interface-ipv6-prefix-length:
54531 description: Prefix length, 128 for single address
54535 description: Inner VLAN tag
54539 description: Outer VLAN tag
54542 description: Indicator of fixed or floating address
54545 Generic network definition
54546 ###### Related Nodes
54547 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
54548 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
54549 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
54550 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
54551 - TO model-ver( l3-network IsA model-ver, Many2One)
54552 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
54553 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
54554 - FROM complex( complex Uses l3-network, MANY2MANY)
54555 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
54556 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
54557 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
54558 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
54559 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
54560 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
54561 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
54562 - FROM tenant( tenant Uses l3-network, MANY2MANY)
54563 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
54565 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
54570 - is-provider-network
54571 - is-shared-network
54572 - is-external-network
54576 description: Network ID, should be uuid. Unique across A&AI.
54579 description: Name of the network, governed by some naming convention..
54582 description: Type of the network - who defines these values?
54585 description: Role the network plans - who defines these values?
54586 network-technology:
54588 description: Network technology - who defines these values?
54589 neutron-network-id:
54591 description: Neutron network id of this Interface
54594 description: Set to true if bound to VPN
54597 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
54598 network-role-instance:
54601 description: network role instance
54607 $ref: "#/patchDefinitions/l3-network"
54610 Link aggregate interface
54611 ###### Related Nodes
54612 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
54613 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
54614 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
54615 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
54616 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
54617 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
54618 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
54619 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
54620 - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
54622 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
54623 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
54624 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
54631 description: Name that identifies the link aggregate interface
54632 interface-description:
54634 description: Human friendly text regarding this interface.
54637 Collection of link aggregate interfaces.
54642 $ref: "#/patchDefinitions/lag-interface"
54645 LAG links can connect lag-interfaces
54646 ###### Related Nodes
54647 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
54648 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
54650 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
54656 description: Alphabetical concatenation of lag-interface names
54659 Collection of link aggregation connections
54664 $ref: "#/patchDefinitions/lag-link"
54667 Metadata for license group.
54668 ###### Related Nodes
54669 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
54670 - TO vce( license BelongsTo vce, MANY2ONE)(4)
54672 -(4) IF this TO node is deleted, this LICENSE is DELETED also
54679 description: Unique ID for the license group the resource belongs to, should be uuid.
54682 description: Unique ID of a license resource.
54685 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54690 $ref: "#/patchDefinitions/license"
54693 describes a line-of-business
54694 ###### Related Nodes
54695 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
54698 - line-of-business-name
54700 line-of-business-name:
54702 description: Name of the line-of-business (product)
54705 Collection of lines-of-business
54710 $ref: "#/patchDefinitions/line-of-business"
54713 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54714 ###### Related Nodes
54715 - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
54716 - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
54717 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
54718 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
54719 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
54720 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
54721 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
54722 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
54723 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
54724 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
54725 - TO model-ver( logical-link IsA model-ver, Many2One)
54726 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
54727 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
54728 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
54729 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
54730 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
54731 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
54732 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
54734 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
54735 -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
54743 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54746 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.
54749 description: Type of logical link, e.g., evc
54752 description: Captures the numeric part of the speed
54755 description: Captures the units corresponding to the speed
54758 description: v4, v6, or ds for dual stack
54761 description: For example, static or BGP
54764 Collection of logical connections
54769 $ref: "#/patchDefinitions/logical-link"
54772 Collection of metadatum (key/value pairs)
54777 $ref: "#/patchDefinitions/metadatum"
54781 ###### Related Nodes
54782 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
54783 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
54784 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
54785 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
54786 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
54788 -(4) IF this TO node is deleted, this METADATUM is DELETED also
54799 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
54800 ###### Related Nodes
54801 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
54802 - FROM instance-group( instance-group Targets model, MANY2MANY)
54803 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
54804 - FROM named-query( named-query AppliesTo model, ONE2MANY)
54805 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
54807 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
54808 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
54811 - model-invariant-id
54814 model-invariant-id:
54816 description: Unique identifier corresponding to the main definition of a model in ASDC
54819 description: Type of the model, e.g., service, resource, widget, etc.
54820 model-and-named-query-search:
54822 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54826 $ref: "#/patchDefinitions/query-parameters"
54829 $ref: "#/patchDefinitions/instance-filters"
54832 $ref: "#/patchDefinitions/secondary-filts"
54835 secondary-filter-cut-point:
54839 This is how we would capture constraints defining allowed sets of elements.
54840 ###### Related Nodes
54841 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
54842 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
54844 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
54845 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
54847 - model-constraint-uuid
54848 - constrained-element-set-uuid-to-replace
54850 model-constraint-uuid:
54852 constrained-element-set-uuid-to-replace:
54854 constrained-element-sets:
54857 $ref: "#/patchDefinitions/constrained-element-set"
54863 $ref: "#/patchDefinitions/model-constraint"
54866 Defines how other models combine to make up a higher-level model.
54867 ###### Related Nodes
54868 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
54869 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
54870 - TO model-ver( model-element IsA model-ver, MANY2ONE)
54871 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
54872 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
54873 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
54874 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
54876 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
54877 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
54879 - model-element-uuid
54880 - new-data-del-flag
54883 model-element-uuid:
54887 description: Indicates whether this element was created as part of instantiation from this model
54890 description: How many of this type of element are required/allowed
54898 $ref: "#/patchDefinitions/model-element"
54901 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
54902 ###### Related Nodes
54903 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
54904 - FROM model-element( model-element IsA model-ver, MANY2ONE)
54905 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
54906 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
54907 - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
54908 - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
54909 - FROM l3-network( l3-network IsA model-ver, Many2One)
54910 - FROM logical-link( logical-link IsA model-ver, Many2One)
54911 - FROM service-instance( service-instance IsA model-ver, Many2One)
54912 - FROM vf-module( vf-module IsA model-ver, Many2One)
54914 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
54915 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
54916 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
54925 description: Unique identifier corresponding to one version of a model in ASDC
54928 description: Name of the model, which can change from version to version.
54931 description: Version
54932 distribution-status:
54934 description: Distribution Status
54937 description: Description
54943 $ref: "#/patchDefinitions/model-ver"
54946 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
54951 $ref: "#/patchDefinitions/model"
54952 multicast-configuration:
54954 ###### Related Nodes
54955 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
54958 - multicast-configuration-id
54959 - multicast-protocol
54962 multicast-configuration-id:
54964 description: Unique id of multicast configuration.
54965 multicast-protocol:
54967 description: protocol of multicast configuration
54970 description: rp type of multicast configuration
54971 multicast-configurations:
54973 multicast configuration of generic-vnf ip-address
54975 multicast-configuration:
54978 $ref: "#/patchDefinitions/multicast-configuration"
54984 $ref: "#/patchDefinitions/named-query"
54988 ###### Related Nodes
54989 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
54990 - TO model( named-query AppliesTo model, ONE2MANY)
54991 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
54993 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
54997 - named-query-version
55003 named-query-version:
55005 required-input-param:
55009 named-query-element:
55012 ###### Related Nodes
55013 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
55014 - TO model( named-query-element IsA model, MANY2ONE)
55015 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
55016 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
55017 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
55018 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
55020 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
55021 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
55023 - named-query-element-uuid
55025 named-query-element-uuid:
55027 property-collect-list:
55029 named-query-elements:
55031 named-query-element:
55034 $ref: "#/patchDefinitions/named-query-element"
55037 Namespace for network inventory resources.
55042 $ref: "#/patchDefinitions/logical-link"
55046 $ref: "#/patchDefinitions/site-pair-set"
55050 $ref: "#/patchDefinitions/vpn-binding"
55054 $ref: "#/patchDefinitions/vpls-pe"
55055 multicast-configurations:
55058 $ref: "#/patchDefinitions/multicast-configuration"
55062 $ref: "#/patchDefinitions/vce"
55066 $ref: "#/patchDefinitions/vnfc"
55070 $ref: "#/patchDefinitions/l3-network"
55074 $ref: "#/patchDefinitions/network-policy"
55078 $ref: "#/patchDefinitions/generic-vnf"
55082 $ref: "#/patchDefinitions/lag-link"
55086 $ref: "#/patchDefinitions/newvce"
55090 $ref: "#/patchDefinitions/pnf"
55094 $ref: "#/patchDefinitions/physical-link"
55095 ipsec-configurations:
55098 $ref: "#/patchDefinitions/ipsec-configuration"
55099 route-table-references:
55102 $ref: "#/patchDefinitions/route-table-reference"
55106 $ref: "#/patchDefinitions/instance-group"
55110 $ref: "#/patchDefinitions/zone"
55114 $ref: "#/patchDefinitions/configuration"
55118 $ref: "#/patchDefinitions/forwarding-path"
55124 $ref: "#/patchDefinitions/network-policy"
55127 ###### Related Nodes
55128 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
55129 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
55132 - network-policy-id
55136 description: UUID representing unique key to this instance
55137 network-policy-fqdn:
55139 description: Contrail FQDN for the policy
55142 description: ID for the openStack Heat instance
55145 Network profile populated by SDN-GP for SNMP
55146 ###### Related Nodes
55147 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
55154 description: Unique name of network profile.
55157 description: Encrypted SNMP community string
55160 Collection of network profiles
55165 $ref: "#/patchDefinitions/network-profile"
55168 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
55169 ###### Related Nodes
55170 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
55172 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
55180 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
55183 description: Name of VNF.
55186 description: Alternate name of VNF.
55189 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.
55192 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55193 operational-status:
55195 description: Indicator for whether the resource is considered operational
55198 description: OBSOLETE - do not use
55201 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).
55204 description: Client should send valid enumerated value.
55207 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
55212 $ref: "#/patchDefinitions/newvce"
55215 inventory-item-data:
55218 $ref: "#/patchDefinitions/inventory-item-data"
55219 notification-event:
55223 notification-event-header:
55225 $ref: "#/patchDefinitions/notification-event-header"
55226 notification-event-header:
55267 $ref: "#/patchDefinitions/key-data"
55272 OAM network, to be deprecated shortly. Do not use for new purposes.
55273 ###### Related Nodes
55274 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
55275 - TO complex( oam-network AppliesTo complex, MANY2MANY)
55276 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
55285 description: UUID of the network. Unique across a cloud-region
55288 description: Name of the network.
55292 description: cvlan-id
55293 ipv4-oam-gateway-address:
55295 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55296 ipv4-oam-gateway-address-prefix-length:
55299 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55302 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
55307 $ref: "#/patchDefinitions/oam-network"
55308 operational-environment:
55310 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55311 ###### Related Nodes
55312 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
55313 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
55316 - operational-environment-id
55317 - operational-environment-name
55318 - operational-environment-type
55319 - operational-environment-status
55323 operational-environment-id:
55325 description: UUID of an operational environment
55326 operational-environment-name:
55328 description: Operational Environment name
55329 operational-environment-type:
55331 description: Operational Environment Type.
55332 operational-environment-status:
55334 description: Status
55337 description: Tenant Context.
55340 description: Workload Context.
55341 operational-environments:
55343 a logical partition of the cloud which allows to have multiple environments in the production AIC.
55345 operational-environment:
55348 $ref: "#/patchDefinitions/operational-environment"
55351 Allows for legacy POST of old-style and new-style models
55353 - model-invariant-id
55354 - model-name-version-id
55360 model-invariant-id:
55362 description: Unique identifier corresponding to the main definition of a model in ASDC
55363 model-name-version-id:
55365 description: Unique identifier corresponding to one version of a model in ASDC
55368 description: Type of the model, e.g., service, resource, widget, etc.
55371 description: Name of the model, which can change from version to version.
55374 description: Invariant unique ID which does not change from version to version
55377 description: Version
55380 description: Description
55383 Collection of owning-entities
55388 $ref: "#/patchDefinitions/owning-entity"
55391 describes an owning-entity
55392 ###### Related Nodes
55393 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
55397 - owning-entity-name
55401 description: UUID of an owning entity
55402 owning-entity-name:
55404 description: Owning entity name
55407 Physical interface (e.g., nic)
55408 ###### Related Nodes
55409 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
55410 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
55411 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
55412 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
55413 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
55414 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
55415 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
55416 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
55417 - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
55419 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
55420 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
55421 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
55428 description: Name that identifies the physical interface
55431 description: URL to endpoint where AAI can get more details.
55434 description: Captures the numeric part of the speed
55437 description: Captures the units corresponding to the speed
55440 description: Nature of the services and connectivity on this port.
55441 equipment-identifier:
55443 description: CLEI or other specification for p-interface hardware.
55446 description: Role specification for p-interface hardware.
55449 description: Indicates the physical properties of the interface.
55452 description: Trigger for operational monitoring of this resource by Service Assurance systems.
55455 description: MAC Address of the p-interface.
55458 Collection of physical interfaces.
55463 $ref: "#/patchDefinitions/p-interface"
55466 Collection of physical connections, typically between p-interfaces
55467 ###### Related Nodes
55468 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
55470 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
55476 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55479 description: Captures the numeric part of the speed
55482 description: Captures the units corresponding to the speed
55485 description: Circuit it
55488 description: Dual access mode (e.g., primary, secondary
55491 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55492 service-provider-name:
55494 description: Name of the service Provider on this link.
55495 service-provider-bandwidth-up-value:
55498 description: Upstream Bandwidth value agreed with the service provider
55499 service-provider-bandwidth-up-units:
55501 description: Units for the upstream BW value
55502 service-provider-bandwidth-down-value:
55505 description: Downstream Bandwidth value agreed with the service provider
55506 service-provider-bandwidth-down-units:
55508 description: Units for downstream BW value
55511 Collection of physical connections, typically between p-interfaces
55516 $ref: "#/patchDefinitions/physical-link"
55519 describes a platform
55520 ###### Related Nodes
55521 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
55528 description: Name of the platform
55531 Collection of platforms
55536 $ref: "#/patchDefinitions/platform"
55539 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.
55540 ###### Related Nodes
55541 - TO complex( pnf LocatedIn complex, MANY2ONE)
55542 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
55543 - TO zone( pnf LocatedIn zone, MANY2ONE)
55544 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
55545 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
55546 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
55547 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
55548 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
55549 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
55550 - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
55552 -(1) IF this PNF node is deleted, this FROM node is DELETED also
55559 description: unique name of Physical Network Function.
55562 description: name of Physical Network Function.
55565 description: URL to endpoint where AAI can get more details.
55568 description: source of name2
55571 description: id of pnf
55574 description: Equipment type. Source of truth should define valid values.
55577 description: Equipment vendor. Source of truth should define valid values.
55580 description: Equipment model. Source of truth should define valid values.
55583 description: identifier of managed by ATT or customer
55586 description: ipv4-oam-address with new naming convention for IP addresses
55589 description: sw-version is the version of SW for the hosted application on the PNF.
55592 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.
55595 description: ID of the physical frame (relay rack) where pnf is installed.
55598 description: Serial number of the device
55599 ipaddress-v4-loopback-0:
55601 description: IPV4 Loopback 0 address
55602 ipaddress-v6-loopback-0:
55604 description: IPV6 Loopback 0 address
55607 description: IPV4 AIM address
55610 description: IPV6 AIM address
55613 description: IPV6 OAM address
55616 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
55619 Collection of Physical Network Functions.
55624 $ref: "#/patchDefinitions/pnf"
55627 Used to capture the network interfaces of this VCE
55628 ###### Related Nodes
55629 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
55630 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
55632 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
55633 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
55636 - orchestration-status
55640 description: Unique ID of the interface
55641 neutron-network-id:
55643 description: Neutron network id of this Interface
55644 neutron-network-name:
55646 description: Neutron network name of this Interface
55649 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55655 $ref: "#/patchDefinitions/port-group"
55658 describes the project
55659 ###### Related Nodes
55660 - TO service-instance( project Uses service-instance, ONE2MANY)
55667 description: Name of the project deploying a service
55670 Collection of projects
55675 $ref: "#/patchDefinitions/project"
55678 Property holder for query properties or instance properties
55684 property-constraint:
55687 ###### Related Nodes
55688 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
55690 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
55692 - property-constraint-uuid
55697 property-constraint-uuid:
55705 property-constraints:
55707 property-constraint:
55710 $ref: "#/patchDefinitions/property-constraint"
55713 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
55714 ###### Related Nodes
55715 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
55716 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
55717 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
55718 - TO complex( pserver LocatedIn complex, MANY2ONE)
55719 - TO zone( pserver LocatedIn zone, MANY2ONE)
55720 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
55721 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
55722 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
55723 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
55724 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
55726 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
55727 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
55735 description: Value from executing hostname on the compute node.
55738 description: PTNII name
55742 description: Number of cpus
55746 description: Disk size, in GBs
55750 description: RAM size, in MBs
55753 description: Equipment type. Source of truth should define valid values.
55756 description: Equipment vendor. Source of truth should define valid values.
55759 description: Equipment model. Source of truth should define valid values.
55762 description: Fully-qualified domain name
55765 description: URL to endpoint where AAI can get more details
55768 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
55771 description: Serial number, may be queried
55772 ipaddress-v4-loopback-0:
55774 description: IPV4 Loopback 0 address
55775 ipaddress-v6-loopback-0:
55777 description: IPV6 Loopback 0 address
55780 description: IPV4 AIM address
55783 description: IPV6 AIM address
55786 description: IPV6 OAM address
55789 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
55792 description: ID of Pserver
55795 description: internet topology of Pserver
55798 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.
55801 Collection of compute hosts.
55806 $ref: "#/patchDefinitions/pserver"
55809 QueryParameters for performing a named-query or model query
55813 $ref: "#/patchDefinitions/named-query"
55816 $ref: "#/patchDefinitions/overloaded-model"
55820 ###### Related Nodes
55821 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
55823 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
55825 - related-lookup-uuid
55827 - source-node-property
55829 - target-node-property
55831 related-lookup-uuid:
55835 source-node-property:
55839 target-node-property:
55841 property-collect-list:
55848 $ref: "#/patchDefinitions/related-lookup"
55849 related-to-property:
55853 description: Key part of a key/value pair
55856 description: Value part of a key/value pair
55861 description: A keyword provided by A&AI to indicate type of node.
55862 relationship-label:
55864 description: The edge label for this relationship.
55867 description: URL to the object in A&AI.
55871 $ref: "#/patchDefinitions/relationship-data"
55872 related-to-property:
55875 $ref: "#/patchDefinitions/related-to-property"
55879 - relationship-value
55883 description: A keyword provided by A&AI to indicate an attribute.
55884 relationship-value:
55886 description: Value of the attribute.
55887 reserved-prop-names:
55889 Internal map to define some reserved properties of a vertex
55891 last-mod-source-of-truth:
55909 Response container for the results of a named-query or model query
55911 inventory-response-items:
55913 $ref: "#/patchDefinitions/inventory-response-items"
55918 description: The specific type of node in the A&AI graph
55921 description: The URL to the specific resource
55922 route-table-reference:
55924 Openstack route table reference.
55925 ###### Related Nodes
55926 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
55929 - route-table-reference-id
55930 - route-table-reference-fqdn
55932 route-table-reference-id:
55934 description: Route Table Reference id, UUID assigned to this instance.
55935 route-table-reference-fqdn:
55937 description: FQDN entry in the route table.
55938 route-table-references:
55940 Collection of openstack route table references
55942 route-table-reference:
55945 $ref: "#/patchDefinitions/route-table-reference"
55948 Route target information
55949 ###### Related Nodes
55950 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
55952 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
55954 - global-route-target
55955 - route-target-role
55957 global-route-target:
55959 description: Number used to identify an RT, globally unique in the network
55962 description: Role assigned to this route target
55965 Collection of route target information
55970 $ref: "#/patchDefinitions/route-target"
55973 ###### Related Nodes
55974 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
55975 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
55977 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
55978 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
55980 - routing-instance-id
55982 routing-instance-id:
55984 description: Unique id of routing instance
55987 description: rpm owner
55990 set of probes related to generic-vnf routing instance
55995 $ref: "#/patchDefinitions/routing-instance"
56000 $ref: "#/patchDefinitions/oam-networks"
56001 az-and-dvs-switches:
56004 $ref: "#/patchDefinitions/az-and-dvs-switches"
56007 edge-tag-query-result:
56009 $ref: "#/patchDefinitions/edge-tag-query-result"
56010 edge-tag-query-request:
56012 $ref: "#/patchDefinitions/edge-tag-query-request"
56015 $ref: "#/patchDefinitions/search-results"
56018 $ref: "#/patchDefinitions/sdn-zone-response"
56024 $ref: "#/patchDefinitions/result-data"
56027 SecondaryFilt for performing a named-query or model query
56038 SecondaryFilts for performing a named-query or model query
56043 $ref: "#/patchDefinitions/secondary-filt"
56044 segmentation-assignment:
56046 Openstack segmentation assignment.
56047 ###### Related Nodes
56048 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
56050 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
56056 description: Route Table Reference id, UUID assigned to this instance.
56057 segmentation-assignments:
56059 Collection of openstack segmentation assignments
56061 segmentation-assignment:
56064 $ref: "#/patchDefinitions/segmentation-assignment"
56067 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
56070 - service-description
56074 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56075 service-description:
56077 description: Description of the service
56080 description: URL to endpoint where AAI can get more details
56081 service-capabilities:
56083 Collection of service capabilities.
56085 service-capability:
56088 $ref: "#/patchDefinitions/service-capability"
56089 service-capability:
56091 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
56092 ###### Related Nodes
56093 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
56094 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
56096 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
56104 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56107 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.
56108 service-design-and-creation:
56110 Namespace for objects managed by ASDC
56115 $ref: "#/patchDefinitions/vnf-image"
56119 $ref: "#/patchDefinitions/service"
56120 service-capabilities:
56123 $ref: "#/patchDefinitions/service-capability"
56127 $ref: "#/patchDefinitions/model"
56131 $ref: "#/patchDefinitions/named-query"
56134 Instance of a service
56135 ###### Related Nodes
56136 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
56137 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
56138 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
56139 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
56140 - TO configuration( service-instance Uses configuration, ONE2MANY)
56141 - TO connector( service-instance Uses connector, MANY2MANY)
56142 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
56143 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
56144 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
56145 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
56146 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
56147 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
56148 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
56149 - TO zone( service-instance LocatedIn zone, MANY2ONE)
56150 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
56151 - TO vce( service-instance ComposedOf vce, ONE2MANY)
56152 - TO model-ver( service-instance IsA model-ver, Many2One)
56153 - FROM project( project Uses service-instance, ONE2MANY)
56154 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
56155 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
56156 - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
56157 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
56159 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
56160 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
56161 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
56163 - service-instance-id
56165 service-instance-id:
56167 description: Uniquely identifies this instance of a service
56168 service-instance-name:
56170 description: This field will store a name assigned to the service-instance.
56173 description: String capturing type of service.
56176 description: String capturing the service role.
56177 environment-context:
56179 description: This field will store the environment context assigned to the service-instance.
56182 description: This field will store the workload context assigned to the service-instance.
56185 description: create time of Network Service.
56188 description: last update of Network Service.
56191 description: short description for service-instance.
56192 model-invariant-id:
56194 description: the ASDC model id for this resource or service model.
56197 description: the ASDC model version for this resource or service model.
56198 persona-model-version:
56200 description: the ASDC model version for this resource or service model.
56203 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56204 widget-model-version:
56206 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56209 description: Indicates the total bandwidth to be used for this service.
56212 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
56213 bandwidth-down-wan1:
56215 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
56218 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
56219 bandwidth-down-wan2:
56221 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
56224 description: URL customers will use to access the vHN Portal.
56225 service-instance-location-id:
56227 description: An identifier that customers assign to the location where this service is being used.
56230 Collection of service instances
56235 $ref: "#/patchDefinitions/service-instance"
56236 service-subscription:
56238 Object that group service instances.
56239 ###### Related Nodes
56240 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
56241 - TO tenant( service-subscription Uses tenant, MANY2MANY)
56242 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
56244 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
56245 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
56251 description: Value defined by orchestration to identify this service across ECOMP.
56252 temp-ub-sub-account-id:
56254 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
56255 service-subscriptions:
56257 Collection of objects that group service instances.
56259 service-subscription:
56262 $ref: "#/patchDefinitions/service-subscription"
56265 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
56270 $ref: "#/patchDefinitions/service"
56273 ###### Related Nodes
56274 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
56275 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
56277 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
56278 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
56284 description: unique identifier of probe
56287 description: Prefix address
56290 description: Prefix address
56293 description: ip version, v4, v6
56294 destination-hostname:
56296 description: Hostname of the destination equipment to which SLAs are measured against.
56297 destination-equip-type:
56299 description: The type of destinatination equipment. Could be Router, UCPE, etc.
56302 Set of instances for probes used to measure service level agreements
56303 ###### Related Nodes
56304 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
56305 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
56307 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
56313 description: Unique id of site pair set.
56316 Collection of sets of instances for probes related to generic-vnf
56321 $ref: "#/patchDefinitions/site-pair-set"
56329 $ref: "#/patchDefinitions/site-pair"
56333 ###### Related Nodes
56334 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
56335 - FROM vserver( vserver Uses snapshot, ONE2ONE)
56342 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56345 description: Snapshot name
56346 snapshot-architecture:
56348 description: Operating system architecture
56349 snapshot-os-distro:
56351 description: The common name of the operating system distribution in lowercase
56352 snapshot-os-version:
56354 description: The operating system version as specified by the distributor.
56357 description: The application that the image instantiates.
56358 application-vendor:
56360 description: The vendor of the application.
56361 application-version:
56363 description: The version of the application.
56366 description: URL to endpoint where AAI can get more details
56369 description: This field contains the UUID of the previous snapshot (if any).
56372 Collection of openstack snapshots
56377 $ref: "#/patchDefinitions/snapshot"
56380 SR-IOV Physical Function
56381 ###### Related Nodes
56382 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
56383 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
56385 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
56391 description: Identifier for the sriov-pf
56394 Collection of SR-IOV Physical Functions.
56399 $ref: "#/patchDefinitions/sriov-pf"
56402 SR-IOV Virtual Function (not to be confused with virtual network function)
56403 ###### Related Nodes
56404 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
56405 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
56407 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
56413 description: PCI ID used to identify the sriov-vf
56416 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56419 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56422 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56423 vf-vlan-anti-spoof-check:
56425 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.
56426 vf-mac-anti-spoof-check:
56428 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.
56431 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56432 vf-broadcast-allow:
56434 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56435 vf-unknown-multicast-allow:
56437 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56438 vf-unknown-unicast-allow:
56440 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56443 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56446 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
56449 Collection of SR-IOV Virtual Functions.
56454 $ref: "#/patchDefinitions/sriov-vf"
56463 ###### Related Nodes
56464 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
56465 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
56466 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
56467 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
56468 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
56469 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
56471 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
56472 -(4) IF this TO node is deleted, this SUBNET is DELETED also
56473 -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
56481 description: Subnet ID, should be UUID.
56484 description: Name associated with the subnet.
56487 description: Neutron id of this subnet
56490 description: gateway ip address
56491 network-start-address:
56493 description: network start address
56496 description: cidr mask
56499 description: ip version
56500 orchestration-status:
56502 description: Orchestration status of this VNF, mastered by MSO
56505 description: dhcp enabled
56508 description: the start address reserved for use by dhcp
56511 description: the last address reserved for use by dhcp
56514 description: role of the subnet, referenced when assigning IPs
56515 ip-assignment-direction:
56517 description: ip address assignment direction of the subnet
56523 $ref: "#/patchDefinitions/subnet"
56524 tagged-inventory-item-list:
56529 $ref: "#/patchDefinitions/inventory-item"
56533 ###### Related Nodes
56534 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
56535 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
56536 - TO l3-network( tenant Uses l3-network, MANY2MANY)
56537 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
56538 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
56539 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
56541 -TENANT cannot be deleted if related to VSERVER
56549 description: Unique id relative to the cloud-region.
56552 description: Readable name of tenant
56555 description: This field will store the tenant context.
56558 Collection of openstack tenants.
56563 $ref: "#/patchDefinitions/tenant"
56566 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
56567 ###### Related Nodes
56568 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
56570 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
56576 description: Allotted Resource id UUID assigned to this instance.
56579 description: The WAN uplink bandwidth for WAN1
56580 bandwidth-down-wan1:
56582 description: The WAN downlink bandwidth for WAN1
56585 description: The WAN uplink bandwidth for WAN2
56586 bandwidth-down-wan2:
56588 description: The WAN downlink bandwidth for WAN2
56591 This object is used to store the specific tunnel cross connect aspects of an allotted resource
56596 $ref: "#/patchDefinitions/tunnel-xconnect"
56599 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
56608 $ref: "#/patchDefinitions/update-node-key"
56614 $ref: "#/patchDefinitions/action"
56623 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
56624 ###### Related Nodes
56625 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
56626 - TO complex( vce LocatedIn complex, MANY2MANY)
56627 - TO vserver( vce HostedOn vserver, ONE2MANY)
56628 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
56629 - FROM license( license BelongsTo vce, MANY2ONE)(1)
56630 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
56631 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
56633 -(1) IF this VCE node is deleted, this FROM node is DELETED also
56641 description: Unique id of VNF. This is unique across the graph.
56644 description: Name of VNF.
56647 description: Alternate name of VNF.
56650 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.
56653 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
56654 regional-resource-zone:
56656 description: Regional way of organizing pservers, source of truth should define values
56659 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56660 operational-status:
56662 description: Indicator for whether the resource is considered operational
56665 description: OBSOLETE - do not use
56668 description: Network role being played by this VNF
56669 orchestration-status:
56671 description: Orchestration status of this VNF, mastered by MSO
56674 description: Heat stack id corresponding to this instance, managed by MSO
56677 description: Corresponds to the SDN-C catalog id used to configure this VCE
56680 description: Unique ID of VPE connected to this VCE.
56681 v6-vce-wan-address:
56683 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
56686 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
56689 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
56694 $ref: "#/patchDefinitions/vce"
56697 a deployment unit of VNFCs
56698 ###### Related Nodes
56699 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
56700 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
56701 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
56702 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
56703 - TO vserver( vf-module Uses vserver, ONE2MANY)
56704 - TO model-ver( vf-module IsA model-ver, Many2One)
56706 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
56707 -VF-MODULE cannot be deleted if related to VNFC
56711 - is-base-vf-module
56715 description: Unique ID of vf-module.
56718 description: Name of vf-module
56721 description: Heat stack id corresponding to this instance.
56722 orchestration-status:
56724 description: orchestration status of this vf-module, mastered by MSO
56727 description: used to indicate whether or not this object is base vf module
56730 Collection of vf-modules, a deployment unit of VNFCs
56735 $ref: "#/patchDefinitions/vf-module"
56738 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
56739 ###### Related Nodes
56740 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
56742 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
56748 description: indicates whether the VIG is for AVPN or INTERNET
56751 description: v4 IP of the vig server
56754 description: v6 IP of the vig server
56760 $ref: "#/patchDefinitions/vig-server"
56761 vip-ipv4-address-list:
56764 ###### Related Nodes
56765 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
56766 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
56767 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
56768 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
56775 description: IP address
56776 vip-ipv4-prefix-length:
56779 description: Prefix length, 32 for single address
56783 description: Inner VLAN tag
56787 description: Outer VLAN tag
56790 description: Indicator of fixed or floating address
56791 vip-ipv6-address-list:
56794 ###### Related Nodes
56795 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
56796 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
56797 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
56798 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
56805 description: IP address
56806 vip-ipv6-prefix-length:
56809 description: Prefix length, 128 for single address
56813 description: Inner VLAN tag
56817 description: Outer VLAN tag
56820 description: Indicator of fixed or floating address
56821 virtual-data-center:
56823 Virtual organization of cloud infrastructure elements in a data center context
56824 ###### Related Nodes
56825 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
56826 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
56827 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
56835 description: Unique ID of the vdc
56838 description: Name of the virtual data center
56839 virtual-data-centers:
56841 Virtual organization of cloud infrastructure elements in a data center context
56843 virtual-data-center:
56846 $ref: "#/patchDefinitions/virtual-data-center"
56850 ###### Related Nodes
56851 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
56852 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
56853 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
56854 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
56855 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
56856 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
56857 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
56859 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
56860 -(2) IF this VLAN node is deleted, this TO node is DELETED also
56861 -(4) IF this TO node is deleted, this VLAN is DELETED also
56869 description: String that identifies the interface
56873 description: Inner VLAN tag
56877 description: Outer VLAN tag
56883 $ref: "#/patchDefinitions/vlan"
56892 description: Unique id of VNF. This is unique across the graph.
56895 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
56896 ###### Related Nodes
56897 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
56899 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
56904 - application-vendor
56908 description: Unique ID of this asset
56911 description: The application that the image instantiates.
56912 application-vendor:
56914 description: The vendor of the application.
56915 application-version:
56917 description: The version of the application.
56920 description: URL to endpoint where AAI can get more details
56923 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
56928 $ref: "#/patchDefinitions/vnf-image"
56931 ###### Related Nodes
56932 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
56933 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
56934 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
56935 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
56936 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
56937 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
56938 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
56939 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
56941 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
56942 -(4) IF this TO node is deleted, this VNFC is DELETED also
56948 - is-closed-loop-disabled
56952 description: Unique ID of vnfc.
56955 description: Short code that is used in naming instances of the item being modeled
56958 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
56961 description: prov status of this vnfc
56962 orchestration-status:
56964 description: Orchestration status of this VNF, mastered by APP-C
56965 ipaddress-v4-oam-vip:
56967 description: Oam V4 vip address of this vnfc
56970 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
56971 is-closed-loop-disabled:
56973 description: used to indicate whether closed loop function is enabled on this node
56976 description: Group notation of VNFC
56977 model-invariant-id:
56979 description: the ASDC model id for this resource or service model.
56982 description: the ASDC model version for this resource or service model.
56985 virtual network components associated with a vserver from application controller.
56990 $ref: "#/patchDefinitions/vnfc"
56993 Ephemeral Block storage volume.
56994 ###### Related Nodes
56995 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
56997 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
57004 description: Unique ID of block storage volume relative to the vserver.
57007 description: URL to endpoint where AAI can get more details
57010 Persistent block-level storage.
57011 ###### Related Nodes
57012 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
57013 - TO complex( volume-group LocatedIn complex, MANY2ONE)
57014 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
57015 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
57016 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
57020 - volume-group-name
57025 description: Unique ID of volume-group.
57028 description: Name of the volume group.
57031 description: Heat stack id corresponding to this volume-group
57034 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.
57035 orchestration-status:
57037 description: Orchestration status of this volume-group
57038 model-customization-id:
57040 description: captures the id of all the configuration used to customize the resource for the service.
57041 vf-module-model-customization-id:
57043 description: helps relate the volume group to the vf-module whose components will require the volume group
57046 Collection of persistent block-level storage.
57051 $ref: "#/patchDefinitions/volume-group"
57054 Collection of ephemeral Block storage volumes.
57059 $ref: "#/patchDefinitions/volume"
57062 VPLS Provider Edge routers.
57063 ###### Related Nodes
57064 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
57065 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
57066 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
57067 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
57069 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
57077 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57080 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).
57083 description: Client should send valid enumerated value, e.g., VPLS-PE.
57087 description: Temporary location for stag to get to VCE
57090 Collection of VPLS Provider Edge routers
57095 $ref: "#/patchDefinitions/vpls-pe"
57099 ###### Related Nodes
57100 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
57101 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
57102 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
57103 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
57105 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
57106 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
57114 description: VPN ID, globally unique within A&AI
57117 description: VPN Name
57120 description: the platform associated with the VPN example AVPN, Mobility
57123 description: Type of the vpn, should be taken from enumerated/valid values
57126 description: region of customer vpn
57129 description: id for this customer vpn
57130 route-distinguisher:
57132 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
57138 $ref: "#/patchDefinitions/vpn-binding"
57141 Virtual Servers, aka virtual machine or VM.
57142 ###### Related Nodes
57143 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
57144 - TO flavor( vserver Uses flavor, MANY2ONE)
57145 - TO image( vserver Uses image, MANY2ONE)
57146 - TO pserver( vserver HostedOn pserver, MANY2ONE)
57147 - TO snapshot( vserver Uses snapshot, ONE2ONE)
57148 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
57149 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
57150 - FROM vce( vce HostedOn vserver, ONE2MANY)
57151 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
57152 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
57153 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
57155 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
57156 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
57162 - is-closed-loop-disabled
57166 description: Unique identifier for this vserver relative to its tenant
57169 description: Name of vserver
57172 description: Alternative name of vserver
57175 description: Trigger for operational monitoring of this resource by Service Assurance systems.
57178 description: URL to endpoint where AAI can get more details
57181 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.
57182 is-closed-loop-disabled:
57184 description: Used to indicate whether closed loop function is enabled on this node
57187 Collection of virtual Servers, aka virtual machines or VMs.
57192 $ref: "#/patchDefinitions/vserver"
57195 A zone is a grouping of assets in a location homing to the same connections into the CBB
57196 ###### Related Nodes
57197 - TO complex( zone LocatedIn complex, MANY2ONE)
57198 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
57199 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
57200 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
57201 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
57211 description: Code assigned by AIC to the zone
57214 description: English name associated with the zone
57217 description: Design of zone [Medium/Largeā¦]
57220 description: Context of zone [production/test]
57223 description: Status of a zone.
57226 Collection of zones
57231 $ref: "#/patchDefinitions/zone"
57240 $ref: "#/getDefinitions/action-data"
57249 APIs that are more action related than REST (e.g., notify, update).
57253 $ref: "#/getDefinitions/update"
57256 $ref: "#/getDefinitions/notify"
57259 Represents a slice or partial piece of a resource that gets separately allotted
57260 ###### Related Nodes
57261 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
57262 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
57263 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
57264 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
57265 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
57266 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
57267 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
57268 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
57269 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
57270 - TO model-ver( allotted-resource IsA model-ver, Many2One)
57271 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
57272 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
57273 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
57274 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
57276 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
57277 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
57278 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
57284 description: Allotted Resource id UUID assigned to this instance.
57287 description: The descriptive information assigned to this allotted resource instance
57290 description: Link back to more information in the controller
57291 model-invariant-id:
57293 description: the ASDC model id for this resource or service model.
57296 description: the ASDC model version for this resource or service model.
57297 persona-model-version:
57299 description: the ASDC model version for this resource or service model.
57302 description: Concurrency value
57303 orchestration-status:
57305 description: Orchestration status
57306 operational-status:
57308 description: Indicator for whether the resource is considered operational
57311 description: Generic description of the type of allotted resource.
57314 description: role in the network that this resource will be providing.
57318 $ref: "#/getDefinitions/tunnel-xconnect"
57322 $ref: "#/getDefinitions/relationship"
57323 allotted-resources:
57325 This object is used to store slices of services being offered
57330 $ref: "#/getDefinitions/allotted-resource"
57333 Availability zone, a collection of compute hosts/pservers
57334 ###### Related Nodes
57335 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
57336 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
57337 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
57338 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
57339 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
57340 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
57341 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
57342 - FROM vce( vce Uses availability-zone, MANY2MANY)
57344 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
57345 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
57348 - availability-zone-name
57351 availability-zone-name:
57353 description: Name of the availability zone. Unique across a cloud region
57356 description: Type of hypervisor. Source of truth should define valid values.
57357 operational-status:
57359 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
57362 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57366 $ref: "#/getDefinitions/relationship"
57367 availability-zones:
57369 Collection of availability zones
57374 $ref: "#/getDefinitions/availability-zone"
57375 az-and-dvs-switches:
57379 $ref: "#/getDefinitions/dvs-switches"
57382 $ref: "#/getDefinitions/availability-zone"
57385 Namespace for business related constructs
57390 $ref: "#/getDefinitions/connector"
57394 $ref: "#/getDefinitions/customer"
57398 $ref: "#/getDefinitions/line-of-business"
57402 $ref: "#/getDefinitions/owning-entity"
57406 $ref: "#/getDefinitions/platform"
57410 $ref: "#/getDefinitions/project"
57413 ###### Related Nodes
57414 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
57416 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
57422 description: unique identifier of probe
57425 description: identifier of probe
57428 description: type of probe
57431 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57435 $ref: "#/getDefinitions/relationship"
57436 classes-of-service:
57438 class-of-service of probe
57443 $ref: "#/getDefinitions/class-of-service"
57444 cloud-infrastructure:
57446 Namespace for cloud infrastructure.
57451 $ref: "#/getDefinitions/complex"
57455 $ref: "#/getDefinitions/cloud-region"
57459 $ref: "#/getDefinitions/network-profile"
57463 $ref: "#/getDefinitions/pserver"
57464 virtual-data-centers:
57467 $ref: "#/getDefinitions/virtual-data-center"
57468 operational-environments:
57471 $ref: "#/getDefinitions/operational-environment"
57474 cloud-region designates an installation of a cloud cluster or region or instantiation.
57475 ###### Related Nodes
57476 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
57477 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
57478 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
57479 - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
57480 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
57481 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
57482 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
57483 - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
57484 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
57485 - FROM image( image BelongsTo cloud-region, MANY2ONE)
57486 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
57487 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
57488 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
57489 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
57490 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
57491 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
57492 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
57493 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
57495 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
57496 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
57505 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
57508 description: Identifier used by the vendor for the region. Second part of composite key
57511 description: Type of the cloud (e.g., openstack)
57512 owner-defined-type:
57514 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
57515 cloud-region-version:
57517 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
57520 description: URL of the keystone identity service
57523 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57526 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57529 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
57532 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
57535 description: MultiVIM will discover and expose EPA capabilities.
57538 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57542 $ref: "#/getDefinitions/volume-group"
57546 $ref: "#/getDefinitions/tenant"
57550 $ref: "#/getDefinitions/flavor"
57554 $ref: "#/getDefinitions/group-assignment"
57558 $ref: "#/getDefinitions/snapshot"
57562 $ref: "#/getDefinitions/image"
57566 $ref: "#/getDefinitions/dvs-switch"
57570 $ref: "#/getDefinitions/oam-network"
57571 availability-zones:
57574 $ref: "#/getDefinitions/availability-zone"
57578 $ref: "#/getDefinitions/relationship"
57579 vip-ipv4-address-list:
57582 $ref: "#/getDefinitions/vip-ipv4-address-list"
57583 vip-ipv6-address-list:
57586 $ref: "#/getDefinitions/vip-ipv6-address-list"
57590 $ref: "#/getDefinitions/hpa-capability"
57591 description: List of cloud-region specific HPA Capabilities
57592 esr-system-info-list:
57595 $ref: "#/getDefinitions/esr-system-info"
57601 $ref: "#/getDefinitions/cloud-region"
57604 Collection of physical locations that can house cloud-regions.
57605 ###### Related Nodes
57606 - TO l3-network( complex Uses l3-network, MANY2MANY)
57607 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
57608 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
57609 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
57610 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
57611 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
57612 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
57613 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
57614 - FROM vce( vce LocatedIn complex, MANY2MANY)
57615 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
57616 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
57617 - FROM zone( zone LocatedIn complex, MANY2ONE)
57619 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
57620 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
57623 - physical-location-id
57624 - physical-location-type
57631 physical-location-id:
57633 description: Unique identifier for physical location, e.g., CLLI
57636 description: Data center code which can be an alternate way to identify a complex
57639 description: Gamma complex name for LCP instance.
57642 description: URL of the keystone identity service
57645 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57646 physical-location-type:
57648 description: Type, e.g., central office, data center.
57674 $ref: "#/getDefinitions/ctag-pool"
57678 $ref: "#/getDefinitions/relationship"
57681 Collection of physical locations that can house cloud-regions.
57686 $ref: "#/getDefinitions/complex"
57689 Port Mirror Configuration.
57690 ###### Related Nodes
57691 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
57692 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
57693 - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
57694 - TO pnf( configuration AppliesTo pnf, ONE2MANY)
57695 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
57696 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
57697 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
57698 - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
57699 - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
57700 - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
57701 - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
57703 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
57704 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
57705 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
57708 - configuration-type
57709 - configuration-sub-type
57710 - orchestration-status
57711 - operational-status
57712 - configuration-selflink
57713 - model-customization-id
57717 description: UUID assigned to configuration.
57720 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
57721 configuration-name:
57723 description: Name of the configuration.
57724 configuration-type:
57726 description: port-mirroring-configuration.
57727 configuration-sub-type:
57729 description: vprobe, pprobe.
57730 model-invariant-id:
57732 description: the ASDC model id for this resource or service model.
57735 description: the ASDC model version for this resource or service model.
57736 orchestration-status:
57738 description: Orchestration status of the configuration.
57739 operational-status:
57741 description: Indicator for whether the resource is considered operational.
57742 configuration-selflink:
57744 description: URL to endpoint where AAI can get more details from SDN-GC.
57745 model-customization-id:
57747 description: id of the configuration used to customize the resource
57750 description: DHV Site Effective Bandwidth
57751 vendor-allowed-max-bandwidth:
57753 description: Velocloud Nominal Throughput - VNT
57756 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57760 $ref: "#/getDefinitions/relationship"
57764 $ref: "#/getDefinitions/metadatum"
57768 $ref: "#/getDefinitions/forwarder-evc"
57772 $ref: "#/getDefinitions/evc"
57775 Collection of configurations
57780 $ref: "#/getDefinitions/configuration"
57783 Collection of resource instances used to connect a variety of disparate inventory widgets
57784 ###### Related Nodes
57785 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
57786 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
57787 - FROM service-instance( service-instance Uses connector, MANY2MANY)
57789 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
57791 - resource-instance-id
57793 resource-instance-id:
57795 description: Unique id of resource instance.
57798 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57799 model-invariant-id:
57801 description: the ASDC model id for this resource or service model.
57804 description: the ASDC model version for this resource or service model.
57805 persona-model-version:
57807 description: the ASDC model version for this resource or service model.
57810 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57811 widget-model-version:
57813 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57817 $ref: "#/getDefinitions/relationship"
57821 $ref: "#/getDefinitions/metadatum"
57824 Collection of resource instances used to connect a variety of disparate inventory widgets
57829 $ref: "#/getDefinitions/connector"
57830 constrained-element-set:
57832 This is how we would capture constraints defining allowed sets of elements.
57833 ###### Related Nodes
57834 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
57835 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
57836 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
57838 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
57839 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
57841 - constrained-element-set-uuid
57845 constrained-element-set-uuid:
57853 element-choice-sets:
57856 $ref: "#/getDefinitions/element-choice-set"
57860 $ref: "#/getDefinitions/relationship"
57861 constrained-element-sets:
57863 constrained-element-set:
57866 $ref: "#/getDefinitions/constrained-element-set"
57869 ###### Related Nodes
57870 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
57871 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
57873 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
57883 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57887 $ref: "#/getDefinitions/relationship"
57893 $ref: "#/getDefinitions/ctag-assignment"
57896 A collection of C tags (vlan tags) grouped for a specific purpose.
57897 ###### Related Nodes
57898 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
57899 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
57900 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
57901 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
57903 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
57906 - availability-zone-name
57907 - ctag-pool-purpose
57911 description: The Target provider edge router
57912 availability-zone-name:
57914 description: Name of the availability zone
57917 description: Describes what the intended purpose of this pool is.
57920 description: Comma separated list of ctags
57923 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57927 $ref: "#/getDefinitions/relationship"
57933 $ref: "#/getDefinitions/ctag-pool"
57936 customer identifiers to provide linkage back to BSS information.
57937 ###### Related Nodes
57938 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
57940 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
57942 - global-customer-id
57946 global-customer-id:
57948 description: Global customer id used across ECOMP to uniquely identify customer.
57951 description: Subscriber name, an alternate way to retrieve a customer.
57954 description: Subscriber type, a way to provide VID with only the INFRA customers.
57957 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57958 service-subscriptions:
57961 $ref: "#/getDefinitions/service-subscription"
57965 $ref: "#/getDefinitions/relationship"
57968 Collection of customer identifiers to provide linkage back to BSS information.
57973 $ref: "#/getDefinitions/customer"
57981 description: See mis-na-virtualization-platform.yang
57984 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57988 $ref: "#/getDefinitions/relationship"
57994 $ref: "#/getDefinitions/cvlan-tag-entry"
57997 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.
57998 ###### Related Nodes
57999 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
58000 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
58008 description: DVS switch name
58011 description: URL used to reach the vcenter
58014 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58018 $ref: "#/getDefinitions/relationship"
58021 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
58026 $ref: "#/getDefinitions/dvs-switch"
58029 Internal map to define the properties of an edge and interpret the map EdgeRules
58047 edge-tag-query-request:
58058 $ref: "#/getDefinitions/start-node-filter"
58059 include-node-filter:
58062 $ref: "#/getDefinitions/include-node-filter"
58066 $ref: "#/getDefinitions/secondary-filter"
58067 edge-tag-query-result:
58069 tagged-inventory-item-list:
58072 $ref: "#/getDefinitions/tagged-inventory-item-list"
58073 element-choice-set:
58075 This is how we would capture constraints defining allowed sets of elements.
58076 ###### Related Nodes
58077 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
58078 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
58080 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
58081 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
58083 - element-choice-set-uuid
58084 - element-choice-set-name
58086 element-choice-set-uuid:
58088 element-choice-set-name:
58097 $ref: "#/getDefinitions/model-element"
58101 $ref: "#/getDefinitions/relationship"
58102 element-choice-sets:
58104 element-choice-set:
58107 $ref: "#/getDefinitions/element-choice-set"
58110 Metadata for entitlement group.
58111 ###### Related Nodes
58112 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
58113 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
58115 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
58122 description: Unique ID for the entitlement group the resource comes from, should be uuid.
58125 description: Unique ID of an entitlement resource.
58128 description: Concurrency value
58132 $ref: "#/getDefinitions/relationship"
58135 Entitlements, keyed by group-uuid and resource-uuid, related to license management
58140 $ref: "#/getDefinitions/entitlement"
58143 Persist EMS address information used by EMS driver.
58144 ###### Related Nodes
58145 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
58147 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
58153 description: Unique ID of EMS.
58156 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58157 esr-system-info-list:
58159 $ref: "#/getDefinitions/esr-system-info-list"
58162 $ref: "#/getDefinitions/relationship-list"
58168 $ref: "#/getDefinitions/esr-ems"
58171 Persist common address information of external systems.
58172 ###### Related Nodes
58173 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
58174 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
58175 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
58176 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
58178 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
58180 - esr-system-info-id
58185 esr-system-info-id:
58187 description: Unique ID of esr system info.
58190 description: name of external system.
58193 description: type of external systems.
58196 description: vendor of external systems.
58199 description: version of external systems.
58202 description: url used to access external systems.
58205 description: username used to access external systems.
58208 description: password used to access external systems.
58211 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
58214 description: protocol of third party SDNC, for example netconf/snmp.
58217 description: ca file content if enabled ssl on auth-url.
58220 description: Whether to verify VIM's certificate.
58223 description: service IP of ftp server.
58226 description: service port of ftp server.
58229 description: domain info for authentication.
58232 description: default tenant of VIM.
58235 description: ftp passive mode or not.
58238 description: resource or performance data file path.
58241 description: the status of external system.
58244 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58248 $ref: "#/getDefinitions/relationship"
58249 esr-system-info-list:
58251 Collection of persistent block-level external system auth info.
58256 $ref: "#/getDefinitions/esr-system-info"
58257 esr-thirdparty-sdnc:
58259 Persist SDNC address information used by ONAP SDNC.
58260 ###### Related Nodes
58261 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
58262 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
58264 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
58266 - thirdparty-sdnc-id
58268 thirdparty-sdnc-id:
58270 description: Unique ID of SDNC.
58273 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
58276 description: password used to access SDNC server.
58279 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58280 esr-system-info-list:
58282 $ref: "#/getDefinitions/esr-system-info-list"
58285 $ref: "#/getDefinitions/relationship-list"
58286 esr-thirdparty-sdnc-list:
58288 esr-thirdparty-sdnc:
58291 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
58294 Persist VNFM address information used by VF-C.
58295 ###### Related Nodes
58296 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
58298 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
58304 description: Unique ID of VNFM.
58307 description: indecate the VIM to deploy VNF.
58310 description: certificate url of VNFM.
58313 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58314 esr-system-info-list:
58316 $ref: "#/getDefinitions/esr-system-info-list"
58319 $ref: "#/getDefinitions/relationship-list"
58325 $ref: "#/getDefinitions/esr-vnfm"
58328 evc object is an optional child object of the Configuration object.
58329 ###### Related Nodes
58330 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
58332 -(4) IF this TO node is deleted, this EVC is DELETED also
58338 description: Unique/key field for the evc object
58339 forwarding-path-topology:
58341 description: Point-to-Point, Multi-Point
58344 description: Commited Information Rate
58347 description: CIR units
58348 connection-diversity-group-id:
58350 description: Diversity Group ID
58353 description: formerly Performance Group
58354 esp-evc-circuit-id:
58356 description: EVC Circuit ID of ESP EVC
58359 description: Committed Information Rate (For ESP)
58362 description: CIR units (For ESP)
58365 description: Identifies ESP
58366 collector-pop-clli:
58368 description: Collector POP CLLI (from the hostname of the access pnf)
58369 inter-connect-type-ingress:
58371 description: Interconnect type on ingress side of EVC.
58372 tagmode-access-ingress:
58374 description: tagode for collector side of EVC
58375 tagmode-access-egress:
58377 description: tagMode for network side of EVC
58381 $ref: "#/getDefinitions/relationship"
58384 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58390 $ref: "#/getDefinitions/evc"
58393 Namespace for external system.
58397 $ref: "#/getDefinitions/esr-ems-list"
58400 $ref: "#/getDefinitions/esr-vnfm-list"
58401 esr-thirdparty-sdnc-list:
58403 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
58406 Extra properties for inventory item for response list
58411 $ref: "#/getDefinitions/extra-property"
58421 ###### Related Nodes
58422 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
58423 - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
58424 - FROM vserver( vserver Uses flavor, MANY2ONE)
58426 -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
58435 description: Flavor id, expected to be unique across cloud-region.
58438 description: Cloud region Flavor name
58442 description: Number of CPUs
58446 description: Amount of memory
58450 description: Disk space
58454 description: Amount of ephemeral disk space
58457 description: amount of swap space allocation
58460 description: whether flavor is available to all users or private to the tenant it was created in.
58463 description: URL to endpoint where AAI can get more details
58466 description: Boolean as to whether this flavor is no longer enabled
58470 $ref: "#/getDefinitions/hpa-capability"
58471 description: List of flavor specific HPA Capabilities
58474 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58478 $ref: "#/getDefinitions/relationship"
58481 Collection of openstack flavors.
58486 $ref: "#/getDefinitions/flavor"
58489 Entity describing a sequenced segment of forwarding path
58490 ###### Related Nodes
58491 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
58492 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
58493 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
58494 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
58495 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
58497 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
58498 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
58505 description: Unique ID of this segmentation
58508 description: ingress, intermediate, egress
58512 $ref: "#/getDefinitions/relationship"
58515 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58518 forwarder object is an optional child object of the Configuration object.
58519 ###### Related Nodes
58520 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
58522 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
58528 description: Key for forwarder-evc object
58531 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
58534 description: Internal VLAN.
58537 description: SVLAN value for ingress of egress forwarder.
58540 description: CVLAN value for ingress of egress forwarder.
58544 $ref: "#/getDefinitions/relationship"
58547 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58553 $ref: "#/getDefinitions/forwarder-evc"
58559 $ref: "#/getDefinitions/forwarder"
58562 Entity that describes the sequenced forwarding path between interfaces of services or resources
58563 ###### Related Nodes
58564 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
58565 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
58566 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
58568 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
58569 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
58570 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
58572 - forwarding-path-id
58573 - forwarding-path-name
58575 forwarding-path-id:
58577 description: Unique ID of this FP
58578 forwarding-path-name:
58580 description: Name of the FP
58584 $ref: "#/getDefinitions/relationship"
58587 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58590 description: the self link for this FP
58594 $ref: "#/getDefinitions/forwarder"
58600 $ref: "#/getDefinitions/forwarding-path"
58603 General purpose VNF
58604 ###### Related Nodes
58605 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
58606 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
58607 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
58608 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
58609 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
58610 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
58611 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
58612 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
58613 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
58614 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
58615 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
58616 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
58617 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
58618 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
58619 - TO model-ver( generic-vnf IsA model-ver, Many2One)
58620 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
58621 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
58622 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
58623 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
58624 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
58625 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
58626 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
58627 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
58628 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
58629 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
58630 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
58631 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
58632 - FROM platform( platform Uses generic-vnf, MANY2MANY)
58634 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
58635 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
58641 - is-closed-loop-disabled
58645 description: Unique id of VNF. This is unique across the graph.
58648 description: vnf instance id.
58651 description: Name of VNF.
58654 description: Alternate name of VNF.
58657 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.
58660 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
58661 regional-resource-zone:
58663 description: Regional way of organizing pservers, source of truth should define values
58666 description: Trigger for operational monitoring of this resource by Service Assurance systems.
58667 operational-status:
58669 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
58672 description: OBSOLETE - do not use
58675 description: Client should send valid enumerated value
58676 orchestration-status:
58678 description: Orchestration status of this VNF, used by MSO.
58681 vnf-discriptor-name:
58683 description: vnf discriptor name
58686 description: job id corresponding to vnf
58689 description: Heat stack id corresponding to this instance, managed by MSO
58692 description: Corresponds to the SDN-C catalog id used to configure this VCE
58695 description: identifier of managed by ATT or customer
58698 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
58699 ipv4-loopback0-address:
58701 description: v4 Loopback0 address
58704 description: v6 Loopback address
58705 management-v6-address:
58707 description: v6 management address
58711 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
58714 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
58718 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
58721 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
58725 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
58728 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
58732 description: number of associated SHD in vnf.
58736 description: number of vms in vnf.
58740 description: number of network in vnf.
58743 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.
58744 is-closed-loop-disabled:
58746 description: used to indicate whether closed loop function is enabled on this node
58749 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58752 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
58753 encrypted-access-flag:
58755 description: indicates whether generic-vnf access uses SSH
58756 entitlement-assignment-group-uuid:
58758 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
58759 entitlement-resource-uuid:
58761 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
58762 license-assignment-group-uuid:
58764 description: UUID of the license assignment group. OBSOLETE - See child relationships.
58767 description: UUID of the actual license resource. OBSOLETE - See child relationships.
58768 model-invariant-id:
58770 description: the ASDC model id for this resource or service model.
58773 description: the ASDC model version for this resource or service model.
58774 persona-model-version:
58776 description: the ASDC model version for this resource or service model.
58777 model-customization-id:
58779 description: captures the id of all the configuration used to customize the resource for the service.
58782 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58783 widget-model-version:
58785 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58788 description: as-number of the VNF
58789 regional-resource-subzone:
58791 description: represents sub zone of the rr plane
58794 description: Generic description of the type of NF
58797 description: English description of Network function that the specific VNF deployment is providing
58800 description: role in the network that this model will be providing
58803 description: string assigned to this model used for naming purposes
58806 description: Path to the controller object.
58807 ipv4-oam-gateway-address:
58809 description: Gateway address
58810 ipv4-oam-gateway-address-prefix-length:
58813 description: Prefix length for oam-address
58817 description: Temporary location for S-TAG to get to VCE
58820 description: Network Management profile of this VNF
58824 $ref: "#/getDefinitions/relationship"
58828 $ref: "#/getDefinitions/l-interface"
58832 $ref: "#/getDefinitions/lag-interface"
58836 $ref: "#/getDefinitions/vf-module"
58840 $ref: "#/getDefinitions/license"
58844 $ref: "#/getDefinitions/entitlement"
58852 $ref: "#/getDefinitions/generic-vnf"
58855 Openstack group-assignment used to store exclusivity groups (EG).
58856 ###### Related Nodes
58857 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
58858 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
58859 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
58868 description: Group id, expected to be unique across cloud-region.
58871 description: Group type - the type of group this instance refers to
58874 description: Group name - name assigned to the group
58877 description: Group description - description of the group
58880 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58884 $ref: "#/getDefinitions/relationship"
58887 Collection of openstack group assignments
58892 $ref: "#/getDefinitions/group-assignment"
58895 ###### Related Nodes
58896 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
58898 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
58906 description: host-route id
58909 description: subnet prefix
58912 description: Could be ip-address, hostname, or service-instance
58915 description: Should be ip-address, hostname, or service-instance to match next-hop
58918 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58922 $ref: "#/getDefinitions/relationship"
58928 $ref: "#/getDefinitions/host-route"
58931 Collection of HPA Capabilities
58936 $ref: "#/getDefinitions/hpa-capability"
58939 Represents a HPA capability
58940 ###### Related Nodes
58941 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
58942 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
58943 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
58945 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
58947 - hpa-capability-id
58952 description: UUID to uniquely identify a HPA capability
58955 description: Name of the HPACapability
58958 description: HPA schema version
58961 description: Hardware architecture
58964 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58968 $ref: "#/getDefinitions/relationship"
58969 hpa-feature-attributes:
58972 $ref: "#/getDefinitions/hpa-feature-attributes"
58973 hpa-feature-attributes:
58975 HPA Capability Feature attributes
58976 ###### Related Nodes
58977 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
58979 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
58981 - hpa-attribute-key
58985 description: name of the specific HPA attribute
58986 hpa-attribute-value:
58988 description: JSON string specifying the value, unit and type of the specific HPA attribute
58991 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58995 $ref: "#/getDefinitions/relationship"
58999 ###### Related Nodes
59000 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
59001 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
59002 - FROM vserver( vserver Uses image, MANY2ONE)
59004 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
59005 -IMAGE cannot be deleted if related to VSERVER
59016 description: Image id, expected to be unique across cloud region
59019 description: Image name
59020 image-architecture:
59022 description: Operating system architecture.
59025 description: The common name of the operating system distribution in lowercase
59028 description: The operating system version as specified by the distributor.
59031 description: The application that the image instantiates.
59032 application-vendor:
59034 description: The vendor of the application.
59035 application-version:
59037 description: The version of the application.
59040 description: URL to endpoint where AAI can get more details
59043 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59047 $ref: "#/getDefinitions/relationship"
59051 $ref: "#/getDefinitions/metadatum"
59054 Collectio of Openstack images.
59059 $ref: "#/getDefinitions/image"
59060 include-node-filter:
59066 InstanceFilter for performing a named-query or model query
59069 InstanceFilters for performing a named-query or model query
59074 $ref: "#/getDefinitions/instance-filter"
59077 General mechanism for grouping instances
59078 ###### Related Nodes
59079 - TO model( instance-group Targets model, MANY2MANY)
59080 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
59081 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
59082 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
59083 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
59084 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
59085 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
59086 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
59087 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
59088 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
59089 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
59090 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
59097 instance-group-role:
59099 description: role of the instance group.
59100 model-invariant-id:
59102 description: ASDC model id for this resource or service model.
59105 description: ASDC model version uid for this resource model.
59108 description: Instance Group ID, UUID assigned to this instance.
59111 description: Descriptive text to help identify the usage of this instance-group
59114 description: Only valid value today is lower case ha for high availability
59117 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
59120 description: Concurrency value
59124 $ref: "#/getDefinitions/relationship"
59127 Collection of openstack route table references
59132 $ref: "#/getDefinitions/instance-group"
59137 $ref: "#/getDefinitions/search"
59140 $ref: "#/getDefinitions/actions"
59141 cloud-infrastructure:
59143 $ref: "#/getDefinitions/cloud-infrastructure"
59146 $ref: "#/getDefinitions/external-system"
59149 $ref: "#/getDefinitions/business"
59150 service-design-and-creation:
59152 $ref: "#/getDefinitions/service-design-and-creation"
59155 $ref: "#/getDefinitions/network"
59158 $ref: "#/getDefinitions/nodes"
59161 inventory-item-type:
59163 inventory-item-link:
59165 inventory-item-data:
59168 $ref: "#/getDefinitions/inventory-item-data"
59169 tagged-inventory-item-list:
59172 $ref: "#/getDefinitions/tagged-inventory-item-list"
59173 inventory-item-data:
59179 inventory-response-item:
59181 Inventory item for response list
59187 $ref: "#/getDefinitions/extra-properties"
59188 inventory-response-items:
59190 $ref: "#/getDefinitions/inventory-response-items"
59191 inventory-response-items:
59193 Container for inventory items in response list
59195 inventory-response-item:
59198 $ref: "#/getDefinitions/inventory-response-item"
59199 ipsec-configuration:
59201 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
59202 ###### Related Nodes
59203 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
59204 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
59206 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
59208 - ipsec-configuration-id
59210 ipsec-configuration-id:
59212 description: UUID of this configuration
59213 requested-vig-address-type:
59215 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
59216 requested-encryption-strength:
59218 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
59219 requested-dmz-type:
59221 description: ATT can offer a shared DMZ or a DMZ specific to a customer
59222 shared-dmz-network-address:
59224 description: Network address of shared DMZ
59225 requested-customer-name:
59227 description: If the DMZ is a custom DMZ, this field will indicate the customer information
59230 description: can be 1 or 2
59231 ikev1-authentication:
59233 description: Contains values like md5, sha1, sha256, sha384
59236 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
59239 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
59242 description: Group name defined in VIG for clients using aggressive mode
59245 description: pre-shared key for the above group name
59248 description: Lifetime for IKEv1 SA
59249 ipsec-authentication:
59251 description: md5, sha1, sha256, sha384
59254 description: 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
59257 description: Life time for IPSec SA
59260 description: enable PFS or not
59263 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
59264 xauth-user-password:
59266 description: Encrypted using the Juniper $9$ algorithm
59269 description: The time between DPD probe
59272 description: Maximum number of DPD before claiming the tunnel is down
59275 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59279 $ref: "#/getDefinitions/relationship"
59283 $ref: "#/getDefinitions/vig-server"
59284 ipsec-configurations:
59286 ipsec-configuration:
59289 $ref: "#/getDefinitions/ipsec-configuration"
59298 Logical interfaces, e.g., a vnic.
59299 ###### Related Nodes
59300 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
59301 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
59302 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
59303 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
59304 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
59305 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
59306 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
59307 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
59308 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
59309 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
59310 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
59311 - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
59312 - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
59313 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
59314 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
59315 - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
59316 - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
59317 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
59319 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
59320 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
59321 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
59330 description: Name given to the interface
59333 description: E.g., CUSTOMER, UPLINK, etc.
59336 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
59339 description: URL to endpoint where AAI can get more details
59342 description: ID of interface
59345 description: MAC address for the interface
59348 description: Name of the network
59351 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
59352 interface-description:
59354 description: Human friendly text regarding this interface.
59357 description: boolean indicatating whether or not port is a mirrored.
59360 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59363 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
59366 description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
59369 description: Flag indicating the interface uses the IP Unnumbered configuration.
59370 allowed-address-pairs:
59372 description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
59376 $ref: "#/getDefinitions/vlan"
59380 $ref: "#/getDefinitions/sriov-vf"
59384 $ref: "#/getDefinitions/l-interface"
59388 $ref: "#/getDefinitions/relationship"
59389 l3-interface-ipv4-address-list:
59392 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
59393 l3-interface-ipv6-address-list:
59396 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
59399 Collection of logical interfaces.
59404 $ref: "#/getDefinitions/l-interface"
59405 l3-interface-ipv4-address-list:
59408 ###### Related Nodes
59409 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
59410 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
59411 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
59412 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
59413 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
59414 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
59416 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
59418 - l3-interface-ipv4-address
59420 l3-interface-ipv4-address:
59422 description: IP address
59423 l3-interface-ipv4-prefix-length:
59426 description: Prefix length, 32 for single address
59430 description: Inner VLAN tag
59434 description: Outer VLAN tag
59437 description: Indicator of fixed or floating address
59440 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59441 neutron-network-id:
59443 description: Neutron network id of the interface that address belongs to
59446 description: Neutron id of subnet that address belongs to
59450 $ref: "#/getDefinitions/relationship"
59451 l3-interface-ipv6-address-list:
59454 ###### Related Nodes
59455 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
59456 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
59457 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
59458 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
59459 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
59460 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
59462 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
59464 - l3-interface-ipv6-address
59466 l3-interface-ipv6-address:
59468 description: IP address
59469 l3-interface-ipv6-prefix-length:
59472 description: Prefix length, 128 for single address
59476 description: Inner VLAN tag
59480 description: Outer VLAN tag
59483 description: Indicator of fixed or floating address
59486 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59487 neutron-network-id:
59489 description: Neutron network id of the interface that address belongs to
59492 description: Neutron id of subnet that address belongs to
59496 $ref: "#/getDefinitions/relationship"
59499 Generic network definition
59500 ###### Related Nodes
59501 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
59502 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
59503 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
59504 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
59505 - TO model-ver( l3-network IsA model-ver, Many2One)
59506 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
59507 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
59508 - FROM complex( complex Uses l3-network, MANY2MANY)
59509 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
59510 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
59511 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
59512 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
59513 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
59514 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
59515 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
59516 - FROM tenant( tenant Uses l3-network, MANY2MANY)
59517 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
59519 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
59524 - is-provider-network
59525 - is-shared-network
59526 - is-external-network
59530 description: Network ID, should be uuid. Unique across A&AI.
59533 description: Name of the network, governed by some naming convention..
59536 description: Type of the network - who defines these values?
59539 description: Role the network plans - who defines these values?
59540 network-technology:
59542 description: Network technology - who defines these values?
59543 neutron-network-id:
59545 description: Neutron network id of this Interface
59548 description: Set to true if bound to VPN
59551 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
59552 network-role-instance:
59555 description: network role instance
59558 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59559 orchestration-status:
59561 description: Orchestration status of this VNF, mastered by MSO
59564 description: Heat stack id corresponding to this instance, managed by MSO
59567 description: Corresponds to the SDN-C catalog id used to configure this VCE
59568 contrail-network-fqdn:
59570 description: Contrail FQDN for the network
59571 model-invariant-id:
59573 description: the ASDC model id for this resource or service model.
59576 description: the ASDC model version for this resource or service model.
59577 persona-model-version:
59579 description: the ASDC model version for this resource or service model.
59580 model-customization-id:
59582 description: captures the id of all the configuration used to customize the resource for the service.
59585 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59586 widget-model-version:
59588 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59589 physical-network-name:
59591 description: Name associated with the physical network.
59592 is-provider-network:
59594 description: boolean indicatating whether or not network is a provider network.
59597 description: boolean indicatating whether or not network is a shared network.
59598 is-external-network:
59600 description: boolean indicatating whether or not network is an external network.
59603 description: Path to the controller object.
59604 operational-status:
59606 description: Indicator for whether the resource is considered operational.
59610 $ref: "#/getDefinitions/subnet"
59614 $ref: "#/getDefinitions/ctag-assignment"
59615 segmentation-assignments:
59618 $ref: "#/getDefinitions/segmentation-assignment"
59622 $ref: "#/getDefinitions/relationship"
59623 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
59629 $ref: "#/getDefinitions/l3-network"
59632 Link aggregate interface
59633 ###### Related Nodes
59634 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
59635 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
59636 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
59637 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
59638 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
59639 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
59640 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
59641 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
59642 - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
59644 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
59645 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
59646 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
59653 description: Name that identifies the link aggregate interface
59654 interface-description:
59656 description: Human friendly text regarding this interface.
59659 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59662 description: Captures the numeric part of the speed
59665 description: Captures the units corresponding to the speed
59668 description: ID of interface
59671 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
59674 description: Trigger for operational monitoring of this resource by Service Assurance systems.
59677 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
59681 $ref: "#/getDefinitions/relationship"
59685 $ref: "#/getDefinitions/l-interface"
59688 Collection of link aggregate interfaces.
59693 $ref: "#/getDefinitions/lag-interface"
59696 LAG links can connect lag-interfaces
59697 ###### Related Nodes
59698 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
59699 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
59701 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
59707 description: Alphabetical concatenation of lag-interface names
59710 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59714 $ref: "#/getDefinitions/relationship"
59717 Collection of link aggregation connections
59722 $ref: "#/getDefinitions/lag-link"
59725 Metadata for license group.
59726 ###### Related Nodes
59727 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
59728 - TO vce( license BelongsTo vce, MANY2ONE)(4)
59730 -(4) IF this TO node is deleted, this LICENSE is DELETED also
59737 description: Unique ID for the license group the resource belongs to, should be uuid.
59740 description: Unique ID of a license resource.
59743 description: Concurrency value
59747 $ref: "#/getDefinitions/relationship"
59750 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
59755 $ref: "#/getDefinitions/license"
59758 describes a line-of-business
59759 ###### Related Nodes
59760 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
59763 - line-of-business-name
59765 line-of-business-name:
59767 description: Name of the line-of-business (product)
59770 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59774 $ref: "#/getDefinitions/relationship"
59777 Collection of lines-of-business
59782 $ref: "#/getDefinitions/line-of-business"
59785 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
59786 ###### Related Nodes
59787 - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
59788 - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
59789 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
59790 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
59791 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
59792 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
59793 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
59794 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
59795 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
59796 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
59797 - TO model-ver( logical-link IsA model-ver, Many2One)
59798 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
59799 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
59800 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
59801 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
59802 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
59803 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
59804 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
59806 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
59807 -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
59815 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
59818 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.
59821 description: Type of logical link, e.g., evc
59824 description: Captures the numeric part of the speed
59827 description: Captures the units corresponding to the speed
59830 description: v4, v6, or ds for dual stack
59833 description: For example, static or BGP
59836 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59837 model-invariant-id:
59839 description: the ASDC model id for this resource or service model.
59842 description: the ASDC model version for this resource or service model.
59843 persona-model-version:
59845 description: the ASDC model version for this resource or service model.
59848 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59849 widget-model-version:
59851 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59852 operational-status:
59854 description: Indication of operational status of the logical link.
59857 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
59860 description: Indication of the network use of the logical link.
59863 description: Alias or alternate name (CLCI or D1 name).
59866 description: UUID of the logical-link, SDNC generates this.
59869 description: Circuit id
59872 description: Reason for this entity, role it is playing
59876 $ref: "#/getDefinitions/relationship"
59879 Collection of logical connections
59884 $ref: "#/getDefinitions/logical-link"
59887 Collection of metadatum (key/value pairs)
59892 $ref: "#/getDefinitions/metadatum"
59896 ###### Related Nodes
59897 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
59898 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
59899 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
59900 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
59901 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
59903 -(4) IF this TO node is deleted, this METADATUM is DELETED also
59914 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59917 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
59918 ###### Related Nodes
59919 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
59920 - FROM instance-group( instance-group Targets model, MANY2MANY)
59921 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
59922 - FROM named-query( named-query AppliesTo model, ONE2MANY)
59923 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
59925 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
59926 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
59929 - model-invariant-id
59932 model-invariant-id:
59934 description: Unique identifier corresponding to the main definition of a model in ASDC
59937 description: Type of the model, e.g., service, resource, widget, etc.
59940 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59944 $ref: "#/getDefinitions/model-ver"
59948 $ref: "#/getDefinitions/relationship"
59949 model-and-named-query-search:
59951 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
59955 $ref: "#/getDefinitions/query-parameters"
59958 $ref: "#/getDefinitions/instance-filters"
59961 $ref: "#/getDefinitions/secondary-filts"
59964 secondary-filter-cut-point:
59968 This is how we would capture constraints defining allowed sets of elements.
59969 ###### Related Nodes
59970 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
59971 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
59973 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
59974 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
59976 - model-constraint-uuid
59977 - constrained-element-set-uuid-to-replace
59979 model-constraint-uuid:
59981 constrained-element-set-uuid-to-replace:
59983 constrained-element-sets:
59986 $ref: "#/getDefinitions/constrained-element-set"
59989 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59995 $ref: "#/getDefinitions/model-constraint"
59998 Defines how other models combine to make up a higher-level model.
59999 ###### Related Nodes
60000 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
60001 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
60002 - TO model-ver( model-element IsA model-ver, MANY2ONE)
60003 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
60004 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
60005 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
60006 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
60008 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
60009 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
60011 - model-element-uuid
60012 - new-data-del-flag
60015 model-element-uuid:
60019 description: Indicates whether this element was created as part of instantiation from this model
60022 description: How many of this type of element are required/allowed
60027 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60031 $ref: "#/getDefinitions/model-element"
60032 description: Defines how other models combine to make up a higher-level model
60036 $ref: "#/getDefinitions/model-constraint"
60037 description: Describes new constraints on this model element that are not part of that model's definition
60041 $ref: "#/getDefinitions/relationship"
60047 $ref: "#/getDefinitions/model-element"
60050 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
60051 ###### Related Nodes
60052 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
60053 - FROM model-element( model-element IsA model-ver, MANY2ONE)
60054 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
60055 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
60056 - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
60057 - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
60058 - FROM l3-network( l3-network IsA model-ver, Many2One)
60059 - FROM logical-link( logical-link IsA model-ver, Many2One)
60060 - FROM service-instance( service-instance IsA model-ver, Many2One)
60061 - FROM vf-module( vf-module IsA model-ver, Many2One)
60063 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
60064 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
60065 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
60074 description: Unique identifier corresponding to one version of a model in ASDC
60077 description: Name of the model, which can change from version to version.
60080 description: Version
60081 distribution-status:
60083 description: Distribution Status
60086 description: Description
60089 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60093 $ref: "#/getDefinitions/model-element"
60097 $ref: "#/getDefinitions/metadatum"
60101 $ref: "#/getDefinitions/relationship"
60107 $ref: "#/getDefinitions/model-ver"
60110 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
60115 $ref: "#/getDefinitions/model"
60116 multicast-configuration:
60118 ###### Related Nodes
60119 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
60122 - multicast-configuration-id
60123 - multicast-protocol
60126 multicast-configuration-id:
60128 description: Unique id of multicast configuration.
60129 multicast-protocol:
60131 description: protocol of multicast configuration
60134 description: rp type of multicast configuration
60137 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60141 $ref: "#/getDefinitions/relationship"
60142 multicast-configurations:
60144 multicast configuration of generic-vnf ip-address
60146 multicast-configuration:
60149 $ref: "#/getDefinitions/multicast-configuration"
60155 $ref: "#/getDefinitions/named-query"
60159 ###### Related Nodes
60160 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
60161 - TO model( named-query AppliesTo model, ONE2MANY)
60162 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
60164 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
60168 - named-query-version
60174 named-query-version:
60176 required-input-param:
60182 named-query-elements:
60185 $ref: "#/getDefinitions/named-query-element"
60189 $ref: "#/getDefinitions/relationship"
60190 named-query-element:
60193 ###### Related Nodes
60194 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
60195 - TO model( named-query-element IsA model, MANY2ONE)
60196 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
60197 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
60198 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
60199 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
60201 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
60202 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
60204 - named-query-element-uuid
60206 named-query-element-uuid:
60208 property-collect-list:
60212 property-limit-desc:
60216 named-query-elements:
60219 $ref: "#/getDefinitions/named-query-element"
60223 $ref: "#/getDefinitions/related-lookup"
60224 property-constraints:
60227 $ref: "#/getDefinitions/property-constraint"
60231 $ref: "#/getDefinitions/relationship"
60232 named-query-elements:
60234 named-query-element:
60237 $ref: "#/getDefinitions/named-query-element"
60240 Namespace for network inventory resources.
60245 $ref: "#/getDefinitions/logical-link"
60249 $ref: "#/getDefinitions/site-pair-set"
60253 $ref: "#/getDefinitions/vpn-binding"
60257 $ref: "#/getDefinitions/vpls-pe"
60258 multicast-configurations:
60261 $ref: "#/getDefinitions/multicast-configuration"
60265 $ref: "#/getDefinitions/vce"
60269 $ref: "#/getDefinitions/vnfc"
60273 $ref: "#/getDefinitions/l3-network"
60277 $ref: "#/getDefinitions/network-policy"
60281 $ref: "#/getDefinitions/generic-vnf"
60285 $ref: "#/getDefinitions/lag-link"
60289 $ref: "#/getDefinitions/newvce"
60293 $ref: "#/getDefinitions/pnf"
60297 $ref: "#/getDefinitions/physical-link"
60298 ipsec-configurations:
60301 $ref: "#/getDefinitions/ipsec-configuration"
60302 route-table-references:
60305 $ref: "#/getDefinitions/route-table-reference"
60309 $ref: "#/getDefinitions/instance-group"
60313 $ref: "#/getDefinitions/zone"
60317 $ref: "#/getDefinitions/configuration"
60321 $ref: "#/getDefinitions/forwarding-path"
60327 $ref: "#/getDefinitions/network-policy"
60330 ###### Related Nodes
60331 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
60332 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
60335 - network-policy-id
60339 description: UUID representing unique key to this instance
60340 network-policy-fqdn:
60342 description: Contrail FQDN for the policy
60345 description: ID for the openStack Heat instance
60348 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60352 $ref: "#/getDefinitions/relationship"
60355 Network profile populated by SDN-GP for SNMP
60356 ###### Related Nodes
60357 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
60364 description: Unique name of network profile.
60367 description: Encrypted SNMP community string
60370 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60374 $ref: "#/getDefinitions/relationship"
60377 Collection of network profiles
60382 $ref: "#/getDefinitions/network-profile"
60385 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
60386 ###### Related Nodes
60387 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
60389 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
60397 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
60400 description: Name of VNF.
60403 description: Alternate name of VNF.
60406 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.
60409 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60410 operational-status:
60412 description: Indicator for whether the resource is considered operational
60415 description: OBSOLETE - do not use
60418 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).
60421 description: Client should send valid enumerated value.
60424 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60425 ipv4-loopback0-address:
60427 description: v4 Loopback0 address
60428 orchestration-status:
60430 description: Orchestration status of this VNF, mastered by MSO.
60433 description: Heat stack id corresponding to this instance, managed by MSO
60436 description: Corresponds to the SDN-C catalog id used to configure this VCE
60440 $ref: "#/getDefinitions/relationship"
60444 $ref: "#/getDefinitions/l-interface"
60447 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
60452 $ref: "#/getDefinitions/newvce"
60455 inventory-item-data:
60458 $ref: "#/getDefinitions/inventory-item-data"
60459 notification-event:
60463 notification-event-header:
60465 $ref: "#/getDefinitions/notification-event-header"
60466 notification-event-header:
60507 $ref: "#/getDefinitions/key-data"
60512 OAM network, to be deprecated shortly. Do not use for new purposes.
60513 ###### Related Nodes
60514 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
60515 - TO complex( oam-network AppliesTo complex, MANY2MANY)
60516 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
60525 description: UUID of the network. Unique across a cloud-region
60528 description: Name of the network.
60532 description: cvlan-id
60533 ipv4-oam-gateway-address:
60535 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60536 ipv4-oam-gateway-address-prefix-length:
60539 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60542 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60546 $ref: "#/getDefinitions/relationship"
60549 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
60554 $ref: "#/getDefinitions/oam-network"
60555 operational-environment:
60557 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
60558 ###### Related Nodes
60559 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
60560 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
60563 - operational-environment-id
60564 - operational-environment-name
60565 - operational-environment-type
60566 - operational-environment-status
60570 operational-environment-id:
60572 description: UUID of an operational environment
60573 operational-environment-name:
60575 description: Operational Environment name
60576 operational-environment-type:
60578 description: Operational Environment Type.
60579 operational-environment-status:
60581 description: Status
60584 description: Tenant Context.
60587 description: Workload Context.
60590 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60594 $ref: "#/getDefinitions/relationship"
60595 operational-environments:
60597 a logical partition of the cloud which allows to have multiple environments in the production AIC.
60599 operational-environment:
60602 $ref: "#/getDefinitions/operational-environment"
60605 Allows for legacy POST of old-style and new-style models
60607 - model-invariant-id
60608 - model-name-version-id
60614 model-invariant-id:
60616 description: Unique identifier corresponding to the main definition of a model in ASDC
60617 model-name-version-id:
60619 description: Unique identifier corresponding to one version of a model in ASDC
60622 description: Type of the model, e.g., service, resource, widget, etc.
60625 description: Name of the model, which can change from version to version.
60628 description: Invariant unique ID which does not change from version to version
60631 description: Version
60634 description: Description
60637 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60640 $ref: "#/getDefinitions/model-vers"
60643 $ref: "#/getDefinitions/relationship-list"
60646 Collection of owning-entities
60651 $ref: "#/getDefinitions/owning-entity"
60654 describes an owning-entity
60655 ###### Related Nodes
60656 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
60660 - owning-entity-name
60664 description: UUID of an owning entity
60665 owning-entity-name:
60667 description: Owning entity name
60670 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60674 $ref: "#/getDefinitions/relationship"
60677 Physical interface (e.g., nic)
60678 ###### Related Nodes
60679 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
60680 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
60681 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
60682 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
60683 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
60684 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
60685 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
60686 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
60687 - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
60689 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
60690 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
60691 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
60698 description: Name that identifies the physical interface
60701 description: URL to endpoint where AAI can get more details.
60704 description: Captures the numeric part of the speed
60707 description: Captures the units corresponding to the speed
60710 description: Nature of the services and connectivity on this port.
60711 equipment-identifier:
60713 description: CLEI or other specification for p-interface hardware.
60716 description: Role specification for p-interface hardware.
60719 description: Indicates the physical properties of the interface.
60722 description: Trigger for operational monitoring of this resource by Service Assurance systems.
60725 description: MAC Address of the p-interface.
60728 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60731 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
60734 description: inventory status
60738 $ref: "#/getDefinitions/relationship"
60742 $ref: "#/getDefinitions/sriov-pf"
60746 $ref: "#/getDefinitions/l-interface"
60749 Collection of physical interfaces.
60754 $ref: "#/getDefinitions/p-interface"
60757 Collection of physical connections, typically between p-interfaces
60758 ###### Related Nodes
60759 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
60761 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
60767 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
60770 description: Captures the numeric part of the speed
60773 description: Captures the units corresponding to the speed
60776 description: Circuit it
60779 description: Dual access mode (e.g., primary, secondary
60782 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
60783 service-provider-name:
60785 description: Name of the service Provider on this link.
60786 service-provider-bandwidth-up-value:
60789 description: Upstream Bandwidth value agreed with the service provider
60790 service-provider-bandwidth-up-units:
60792 description: Units for the upstream BW value
60793 service-provider-bandwidth-down-value:
60796 description: Downstream Bandwidth value agreed with the service provider
60797 service-provider-bandwidth-down-units:
60799 description: Units for downstream BW value
60802 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60806 $ref: "#/getDefinitions/relationship"
60809 Collection of physical connections, typically between p-interfaces
60814 $ref: "#/getDefinitions/physical-link"
60817 describes a platform
60818 ###### Related Nodes
60819 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
60826 description: Name of the platform
60829 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60833 $ref: "#/getDefinitions/relationship"
60836 Collection of platforms
60841 $ref: "#/getDefinitions/platform"
60844 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.
60845 ###### Related Nodes
60846 - TO complex( pnf LocatedIn complex, MANY2ONE)
60847 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
60848 - TO zone( pnf LocatedIn zone, MANY2ONE)
60849 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
60850 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
60851 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
60852 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
60853 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
60854 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
60855 - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
60857 -(1) IF this PNF node is deleted, this FROM node is DELETED also
60864 description: unique name of Physical Network Function.
60867 description: name of Physical Network Function.
60870 description: URL to endpoint where AAI can get more details.
60873 description: source of name2
60876 description: id of pnf
60879 description: Equipment type. Source of truth should define valid values.
60882 description: Equipment vendor. Source of truth should define valid values.
60885 description: Equipment model. Source of truth should define valid values.
60888 description: identifier of managed by ATT or customer
60891 description: ipv4-oam-address with new naming convention for IP addresses
60894 description: sw-version is the version of SW for the hosted application on the PNF.
60897 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.
60900 description: ID of the physical frame (relay rack) where pnf is installed.
60903 description: Serial number of the device
60904 ipaddress-v4-loopback-0:
60906 description: IPV4 Loopback 0 address
60907 ipaddress-v6-loopback-0:
60909 description: IPV6 Loopback 0 address
60912 description: IPV4 AIM address
60915 description: IPV6 AIM address
60918 description: IPV6 OAM address
60921 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
60924 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60927 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60930 description: Nf Role is the role performed by this instance in the network.
60934 $ref: "#/getDefinitions/relationship"
60938 $ref: "#/getDefinitions/p-interface"
60942 $ref: "#/getDefinitions/lag-interface"
60945 Collection of Physical Network Functions.
60950 $ref: "#/getDefinitions/pnf"
60953 Used to capture the network interfaces of this VCE
60954 ###### Related Nodes
60955 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
60956 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
60958 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
60959 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
60962 - orchestration-status
60966 description: Unique ID of the interface
60967 neutron-network-id:
60969 description: Neutron network id of this Interface
60970 neutron-network-name:
60972 description: Neutron network name of this Interface
60975 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
60978 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60981 description: Unique ID for port group in vmware
60984 description: Likely to duplicate value of neutron network name
60987 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
60988 orchestration-status:
60990 description: Orchestration status of this VNF, mastered by MSO
60993 description: Heat stack id corresponding to this instance, managed by MSO
60996 description: Corresponds to the SDN-C catalog id used to configure this VCE
61000 $ref: "#/getDefinitions/cvlan-tag-entry"
61004 $ref: "#/getDefinitions/relationship"
61010 $ref: "#/getDefinitions/port-group"
61013 describes the project
61014 ###### Related Nodes
61015 - TO service-instance( project Uses service-instance, ONE2MANY)
61022 description: Name of the project deploying a service
61025 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61029 $ref: "#/getDefinitions/relationship"
61032 Collection of projects
61037 $ref: "#/getDefinitions/project"
61040 Property holder for query properties or instance properties
61046 property-constraint:
61049 ###### Related Nodes
61050 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
61052 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
61054 - property-constraint-uuid
61059 property-constraint-uuid:
61069 property-constraints:
61071 property-constraint:
61074 $ref: "#/getDefinitions/property-constraint"
61077 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
61078 ###### Related Nodes
61079 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
61080 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
61081 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
61082 - TO complex( pserver LocatedIn complex, MANY2ONE)
61083 - TO zone( pserver LocatedIn zone, MANY2ONE)
61084 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
61085 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
61086 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
61087 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
61088 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
61090 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
61091 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
61099 description: Value from executing hostname on the compute node.
61102 description: PTNII name
61106 description: Number of cpus
61110 description: Disk size, in GBs
61114 description: RAM size, in MBs
61117 description: Equipment type. Source of truth should define valid values.
61120 description: Equipment vendor. Source of truth should define valid values.
61123 description: Equipment model. Source of truth should define valid values.
61126 description: Fully-qualified domain name
61129 description: URL to endpoint where AAI can get more details
61132 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
61135 description: Serial number, may be queried
61136 ipaddress-v4-loopback-0:
61138 description: IPV4 Loopback 0 address
61139 ipaddress-v6-loopback-0:
61141 description: IPV6 Loopback 0 address
61144 description: IPV4 AIM address
61147 description: IPV6 AIM address
61150 description: IPV6 OAM address
61153 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
61156 description: ID of Pserver
61159 description: internet topology of Pserver
61162 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.
61165 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61168 description: alternative pserver name
61171 description: purpose of pserver
61174 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
61177 description: Indicates who owns and or manages the device.
61180 description: The host profile that defines the configuration of the pserver.
61184 $ref: "#/getDefinitions/relationship"
61188 $ref: "#/getDefinitions/p-interface"
61192 $ref: "#/getDefinitions/lag-interface"
61195 Collection of compute hosts.
61200 $ref: "#/getDefinitions/pserver"
61203 QueryParameters for performing a named-query or model query
61207 $ref: "#/getDefinitions/named-query"
61210 $ref: "#/getDefinitions/overloaded-model"
61214 ###### Related Nodes
61215 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
61217 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
61219 - related-lookup-uuid
61221 - source-node-property
61223 - target-node-property
61225 related-lookup-uuid:
61229 source-node-property:
61233 target-node-property:
61235 property-collect-list:
61242 $ref: "#/getDefinitions/relationship"
61248 $ref: "#/getDefinitions/related-lookup"
61249 related-to-property:
61253 description: Key part of a key/value pair
61256 description: Value part of a key/value pair
61261 description: A keyword provided by A&AI to indicate type of node.
61262 relationship-label:
61264 description: The edge label for this relationship.
61267 description: URL to the object in A&AI.
61271 $ref: "#/getDefinitions/relationship-data"
61272 related-to-property:
61275 $ref: "#/getDefinitions/related-to-property"
61279 - relationship-value
61283 description: A keyword provided by A&AI to indicate an attribute.
61284 relationship-value:
61286 description: Value of the attribute.
61292 $ref: "#/getDefinitions/relationship"
61293 reserved-prop-names:
61295 Internal map to define some reserved properties of a vertex
61297 last-mod-source-of-truth:
61315 Response container for the results of a named-query or model query
61317 inventory-response-items:
61319 $ref: "#/getDefinitions/inventory-response-items"
61324 description: The specific type of node in the A&AI graph
61327 description: The URL to the specific resource
61328 route-table-reference:
61330 Openstack route table reference.
61331 ###### Related Nodes
61332 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
61335 - route-table-reference-id
61336 - route-table-reference-fqdn
61338 route-table-reference-id:
61340 description: Route Table Reference id, UUID assigned to this instance.
61341 route-table-reference-fqdn:
61343 description: FQDN entry in the route table.
61346 description: Concurrency value
61350 $ref: "#/getDefinitions/relationship"
61351 route-table-references:
61353 Collection of openstack route table references
61355 route-table-reference:
61358 $ref: "#/getDefinitions/route-table-reference"
61361 Route target information
61362 ###### Related Nodes
61363 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
61365 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
61367 - global-route-target
61368 - route-target-role
61370 global-route-target:
61372 description: Number used to identify an RT, globally unique in the network
61375 description: Role assigned to this route target
61378 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61382 $ref: "#/getDefinitions/relationship"
61385 Collection of route target information
61390 $ref: "#/getDefinitions/route-target"
61393 ###### Related Nodes
61394 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
61395 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
61397 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
61398 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
61400 - routing-instance-id
61402 routing-instance-id:
61404 description: Unique id of routing instance
61407 description: rpm owner
61410 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61414 $ref: "#/getDefinitions/site-pair"
61418 $ref: "#/getDefinitions/relationship"
61421 set of probes related to generic-vnf routing instance
61426 $ref: "#/getDefinitions/routing-instance"
61431 $ref: "#/getDefinitions/oam-networks"
61432 az-and-dvs-switches:
61435 $ref: "#/getDefinitions/az-and-dvs-switches"
61438 edge-tag-query-result:
61440 $ref: "#/getDefinitions/edge-tag-query-result"
61441 edge-tag-query-request:
61443 $ref: "#/getDefinitions/edge-tag-query-request"
61446 $ref: "#/getDefinitions/search-results"
61449 $ref: "#/getDefinitions/sdn-zone-response"
61455 $ref: "#/getDefinitions/result-data"
61458 SecondaryFilt for performing a named-query or model query
61469 SecondaryFilts for performing a named-query or model query
61474 $ref: "#/getDefinitions/secondary-filt"
61475 segmentation-assignment:
61477 Openstack segmentation assignment.
61478 ###### Related Nodes
61479 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
61481 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
61487 description: Route Table Reference id, UUID assigned to this instance.
61490 description: Concurrency value
61494 $ref: "#/getDefinitions/relationship"
61495 segmentation-assignments:
61497 Collection of openstack segmentation assignments
61499 segmentation-assignment:
61502 $ref: "#/getDefinitions/segmentation-assignment"
61505 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
61508 - service-description
61512 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61513 service-description:
61515 description: Description of the service
61518 description: URL to endpoint where AAI can get more details
61521 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61524 description: service version
61528 $ref: "#/getDefinitions/relationship"
61529 service-capabilities:
61531 Collection of service capabilities.
61533 service-capability:
61536 $ref: "#/getDefinitions/service-capability"
61537 service-capability:
61539 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
61540 ###### Related Nodes
61541 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
61542 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
61544 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
61552 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61555 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.
61558 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61562 $ref: "#/getDefinitions/relationship"
61563 service-design-and-creation:
61565 Namespace for objects managed by ASDC
61570 $ref: "#/getDefinitions/vnf-image"
61574 $ref: "#/getDefinitions/service"
61575 service-capabilities:
61578 $ref: "#/getDefinitions/service-capability"
61582 $ref: "#/getDefinitions/model"
61586 $ref: "#/getDefinitions/named-query"
61589 Instance of a service
61590 ###### Related Nodes
61591 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
61592 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
61593 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
61594 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
61595 - TO configuration( service-instance Uses configuration, ONE2MANY)
61596 - TO connector( service-instance Uses connector, MANY2MANY)
61597 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
61598 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
61599 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
61600 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
61601 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
61602 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
61603 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
61604 - TO zone( service-instance LocatedIn zone, MANY2ONE)
61605 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
61606 - TO vce( service-instance ComposedOf vce, ONE2MANY)
61607 - TO model-ver( service-instance IsA model-ver, Many2One)
61608 - FROM project( project Uses service-instance, ONE2MANY)
61609 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
61610 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
61611 - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
61612 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
61614 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
61615 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
61616 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
61618 - service-instance-id
61620 service-instance-id:
61622 description: Uniquely identifies this instance of a service
61623 service-instance-name:
61625 description: This field will store a name assigned to the service-instance.
61628 description: String capturing type of service.
61631 description: String capturing the service role.
61632 environment-context:
61634 description: This field will store the environment context assigned to the service-instance.
61637 description: This field will store the workload context assigned to the service-instance.
61640 description: create time of Network Service.
61643 description: last update of Network Service.
61646 description: short description for service-instance.
61647 model-invariant-id:
61649 description: the ASDC model id for this resource or service model.
61652 description: the ASDC model version for this resource or service model.
61653 persona-model-version:
61655 description: the ASDC model version for this resource or service model.
61658 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61659 widget-model-version:
61661 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61664 description: Indicates the total bandwidth to be used for this service.
61667 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
61668 bandwidth-down-wan1:
61670 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
61673 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
61674 bandwidth-down-wan2:
61676 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
61679 description: URL customers will use to access the vHN Portal.
61680 service-instance-location-id:
61682 description: An identifier that customers assign to the location where this service is being used.
61685 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61688 description: Path to the controller object.
61689 orchestration-status:
61691 description: Orchestration status of this service.
61695 $ref: "#/getDefinitions/relationship"
61699 $ref: "#/getDefinitions/metadatum"
61700 allotted-resources:
61703 $ref: "#/getDefinitions/allotted-resource"
61706 Collection of service instances
61711 $ref: "#/getDefinitions/service-instance"
61712 service-subscription:
61714 Object that group service instances.
61715 ###### Related Nodes
61716 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
61717 - TO tenant( service-subscription Uses tenant, MANY2MANY)
61718 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
61720 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
61721 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
61727 description: Value defined by orchestration to identify this service across ECOMP.
61728 temp-ub-sub-account-id:
61730 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
61733 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61737 $ref: "#/getDefinitions/service-instance"
61741 $ref: "#/getDefinitions/relationship"
61742 service-subscriptions:
61744 Collection of objects that group service instances.
61746 service-subscription:
61749 $ref: "#/getDefinitions/service-subscription"
61752 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
61757 $ref: "#/getDefinitions/service"
61760 ###### Related Nodes
61761 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
61762 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
61764 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
61765 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
61771 description: unique identifier of probe
61774 description: Prefix address
61777 description: Prefix address
61780 description: ip version, v4, v6
61781 destination-hostname:
61783 description: Hostname of the destination equipment to which SLAs are measured against.
61784 destination-equip-type:
61786 description: The type of destinatination equipment. Could be Router, UCPE, etc.
61789 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61790 classes-of-service:
61793 $ref: "#/getDefinitions/class-of-service"
61797 $ref: "#/getDefinitions/relationship"
61800 Set of instances for probes used to measure service level agreements
61801 ###### Related Nodes
61802 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
61803 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
61805 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
61811 description: Unique id of site pair set.
61814 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61818 $ref: "#/getDefinitions/routing-instance"
61822 $ref: "#/getDefinitions/relationship"
61825 Collection of sets of instances for probes related to generic-vnf
61830 $ref: "#/getDefinitions/site-pair-set"
61838 $ref: "#/getDefinitions/site-pair"
61842 ###### Related Nodes
61843 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
61844 - FROM vserver( vserver Uses snapshot, ONE2ONE)
61851 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
61854 description: Snapshot name
61855 snapshot-architecture:
61857 description: Operating system architecture
61858 snapshot-os-distro:
61860 description: The common name of the operating system distribution in lowercase
61861 snapshot-os-version:
61863 description: The operating system version as specified by the distributor.
61866 description: The application that the image instantiates.
61867 application-vendor:
61869 description: The vendor of the application.
61870 application-version:
61872 description: The version of the application.
61875 description: URL to endpoint where AAI can get more details
61878 description: This field contains the UUID of the previous snapshot (if any).
61881 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61885 $ref: "#/getDefinitions/relationship"
61888 Collection of openstack snapshots
61893 $ref: "#/getDefinitions/snapshot"
61896 SR-IOV Physical Function
61897 ###### Related Nodes
61898 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
61899 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
61901 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
61907 description: Identifier for the sriov-pf
61910 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61914 $ref: "#/getDefinitions/relationship"
61917 Collection of SR-IOV Physical Functions.
61922 $ref: "#/getDefinitions/sriov-pf"
61925 SR-IOV Virtual Function (not to be confused with virtual network function)
61926 ###### Related Nodes
61927 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
61928 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
61930 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
61936 description: PCI ID used to identify the sriov-vf
61939 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
61942 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
61945 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
61946 vf-vlan-anti-spoof-check:
61948 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.
61949 vf-mac-anti-spoof-check:
61951 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.
61954 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
61955 vf-broadcast-allow:
61957 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
61958 vf-unknown-multicast-allow:
61960 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
61961 vf-unknown-unicast-allow:
61963 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
61966 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
61969 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
61972 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61973 neutron-network-id:
61975 description: Neutron network id of the interface
61979 $ref: "#/getDefinitions/relationship"
61982 Collection of SR-IOV Virtual Functions.
61987 $ref: "#/getDefinitions/sriov-vf"
61996 ###### Related Nodes
61997 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
61998 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
61999 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
62000 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
62001 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
62002 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
62004 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
62005 -(4) IF this TO node is deleted, this SUBNET is DELETED also
62006 -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
62014 description: Subnet ID, should be UUID.
62017 description: Name associated with the subnet.
62020 description: Neutron id of this subnet
62023 description: gateway ip address
62024 network-start-address:
62026 description: network start address
62029 description: cidr mask
62032 description: ip version
62033 orchestration-status:
62035 description: Orchestration status of this VNF, mastered by MSO
62038 description: dhcp enabled
62041 description: the start address reserved for use by dhcp
62044 description: the last address reserved for use by dhcp
62047 description: role of the subnet, referenced when assigning IPs
62048 ip-assignment-direction:
62050 description: ip address assignment direction of the subnet
62053 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62057 description: sequence of the subnet
62061 $ref: "#/getDefinitions/host-route"
62065 $ref: "#/getDefinitions/relationship"
62071 $ref: "#/getDefinitions/subnet"
62072 tagged-inventory-item-list:
62077 $ref: "#/getDefinitions/inventory-item"
62081 ###### Related Nodes
62082 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
62083 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
62084 - TO l3-network( tenant Uses l3-network, MANY2MANY)
62085 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
62086 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
62087 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
62089 -TENANT cannot be deleted if related to VSERVER
62097 description: Unique id relative to the cloud-region.
62100 description: Readable name of tenant
62103 description: This field will store the tenant context.
62106 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62110 $ref: "#/getDefinitions/vserver"
62114 $ref: "#/getDefinitions/relationship"
62117 Collection of openstack tenants.
62122 $ref: "#/getDefinitions/tenant"
62125 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
62126 ###### Related Nodes
62127 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
62129 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
62135 description: Allotted Resource id UUID assigned to this instance.
62138 description: The WAN uplink bandwidth for WAN1
62139 bandwidth-down-wan1:
62141 description: The WAN downlink bandwidth for WAN1
62144 description: The WAN uplink bandwidth for WAN2
62145 bandwidth-down-wan2:
62147 description: The WAN downlink bandwidth for WAN2
62150 description: Concurrency value
62154 $ref: "#/getDefinitions/relationship"
62157 This object is used to store the specific tunnel cross connect aspects of an allotted resource
62162 $ref: "#/getDefinitions/tunnel-xconnect"
62165 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
62174 $ref: "#/getDefinitions/update-node-key"
62180 $ref: "#/getDefinitions/action"
62189 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
62190 ###### Related Nodes
62191 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
62192 - TO complex( vce LocatedIn complex, MANY2MANY)
62193 - TO vserver( vce HostedOn vserver, ONE2MANY)
62194 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
62195 - FROM license( license BelongsTo vce, MANY2ONE)(1)
62196 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
62197 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
62199 -(1) IF this VCE node is deleted, this FROM node is DELETED also
62207 description: Unique id of VNF. This is unique across the graph.
62210 description: Name of VNF.
62213 description: Alternate name of VNF.
62216 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.
62219 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
62220 regional-resource-zone:
62222 description: Regional way of organizing pservers, source of truth should define values
62225 description: Trigger for operational monitoring of this resource by Service Assurance systems.
62226 operational-status:
62228 description: Indicator for whether the resource is considered operational
62231 description: OBSOLETE - do not use
62234 description: Network role being played by this VNF
62235 orchestration-status:
62237 description: Orchestration status of this VNF, mastered by MSO
62240 description: Heat stack id corresponding to this instance, managed by MSO
62243 description: Corresponds to the SDN-C catalog id used to configure this VCE
62246 description: Unique ID of VPE connected to this VCE.
62247 v6-vce-wan-address:
62249 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
62252 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
62255 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62256 ipv4-loopback0-address:
62258 description: Loopback0 address
62259 entitlement-resource-uuid:
62261 description: OBSOLETE - see child relationships
62265 $ref: "#/getDefinitions/port-group"
62269 $ref: "#/getDefinitions/license"
62273 $ref: "#/getDefinitions/entitlement"
62277 $ref: "#/getDefinitions/relationship"
62280 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
62285 $ref: "#/getDefinitions/vce"
62288 a deployment unit of VNFCs
62289 ###### Related Nodes
62290 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
62291 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
62292 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
62293 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
62294 - TO vserver( vf-module Uses vserver, ONE2MANY)
62295 - TO model-ver( vf-module IsA model-ver, Many2One)
62297 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
62298 -VF-MODULE cannot be deleted if related to VNFC
62302 - is-base-vf-module
62306 description: Unique ID of vf-module.
62309 description: Name of vf-module
62312 description: Heat stack id corresponding to this instance.
62313 orchestration-status:
62315 description: orchestration status of this vf-module, mastered by MSO
62318 description: used to indicate whether or not this object is base vf module
62321 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62322 model-invariant-id:
62324 description: the ASDC model id for this resource or service model.
62327 description: the ASDC model version for this resource or service model.
62328 persona-model-version:
62330 description: the ASDC model version for this resource or service model.
62331 model-customization-id:
62333 description: captures the id of all the configuration used to customize the resource for the service.
62336 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62337 widget-model-version:
62339 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62340 contrail-service-instance-fqdn:
62342 description: the Contrail unique ID for a service-instance
62346 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
62349 description: Path to the controller object.
62353 $ref: "#/getDefinitions/relationship"
62356 Collection of vf-modules, a deployment unit of VNFCs
62361 $ref: "#/getDefinitions/vf-module"
62364 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
62365 ###### Related Nodes
62366 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
62368 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
62374 description: indicates whether the VIG is for AVPN or INTERNET
62377 description: v4 IP of the vig server
62380 description: v6 IP of the vig server
62383 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62387 $ref: "#/getDefinitions/relationship"
62393 $ref: "#/getDefinitions/vig-server"
62394 vip-ipv4-address-list:
62397 ###### Related Nodes
62398 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
62399 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
62400 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
62401 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
62408 description: IP address
62409 vip-ipv4-prefix-length:
62412 description: Prefix length, 32 for single address
62416 description: Inner VLAN tag
62420 description: Outer VLAN tag
62423 description: Indicator of fixed or floating address
62426 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62427 neutron-network-id:
62429 description: Neutron network id of the interface that address belongs to
62432 description: Neutron id of subnet that address belongs to
62436 $ref: "#/getDefinitions/relationship"
62437 vip-ipv6-address-list:
62440 ###### Related Nodes
62441 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
62442 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
62443 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
62444 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
62451 description: IP address
62452 vip-ipv6-prefix-length:
62455 description: Prefix length, 128 for single address
62459 description: Inner VLAN tag
62463 description: Outer VLAN tag
62466 description: Indicator of fixed or floating address
62469 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62470 neutron-network-id:
62472 description: Neutron network id of the interface that address belongs to
62475 description: Neutron id of subnet that address belongs to
62479 $ref: "#/getDefinitions/relationship"
62480 virtual-data-center:
62482 Virtual organization of cloud infrastructure elements in a data center context
62483 ###### Related Nodes
62484 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
62485 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
62486 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
62494 description: Unique ID of the vdc
62497 description: Name of the virtual data center
62500 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62504 $ref: "#/getDefinitions/relationship"
62505 virtual-data-centers:
62507 Virtual organization of cloud infrastructure elements in a data center context
62509 virtual-data-center:
62512 $ref: "#/getDefinitions/virtual-data-center"
62516 ###### Related Nodes
62517 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
62518 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
62519 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
62520 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
62521 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
62522 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
62523 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
62525 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
62526 -(2) IF this VLAN node is deleted, this TO node is DELETED also
62527 -(4) IF this TO node is deleted, this VLAN is DELETED also
62535 description: String that identifies the interface
62539 description: Inner VLAN tag
62543 description: Outer VLAN tag
62546 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62549 description: Captures the numeric part of the speed
62552 description: Captures the units corresponding to the speed
62555 description: Used to describe (the service associated with) the vlan
62556 backdoor-connection:
62558 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
62561 description: This indicates the customers VPN ID associated with this vlan
62562 orchestration-status:
62564 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
62567 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
62570 description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
62573 description: Flag indicating the interface uses the IP Unnumbered configuration.
62577 $ref: "#/getDefinitions/relationship"
62578 l3-interface-ipv4-address-list:
62581 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62582 l3-interface-ipv6-address-list:
62585 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62591 $ref: "#/getDefinitions/vlan"
62600 description: Unique id of VNF. This is unique across the graph.
62603 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
62604 ###### Related Nodes
62605 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
62607 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
62612 - application-vendor
62616 description: Unique ID of this asset
62619 description: The application that the image instantiates.
62620 application-vendor:
62622 description: The vendor of the application.
62623 application-version:
62625 description: The version of the application.
62628 description: URL to endpoint where AAI can get more details
62631 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62635 $ref: "#/getDefinitions/relationship"
62638 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
62643 $ref: "#/getDefinitions/vnf-image"
62646 ###### Related Nodes
62647 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
62648 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
62649 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
62650 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
62651 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
62652 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
62653 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
62654 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
62656 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
62657 -(4) IF this TO node is deleted, this VNFC is DELETED also
62663 - is-closed-loop-disabled
62667 description: Unique ID of vnfc.
62670 description: Short code that is used in naming instances of the item being modeled
62673 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
62676 description: prov status of this vnfc
62677 orchestration-status:
62679 description: Orchestration status of this VNF, mastered by APP-C
62680 ipaddress-v4-oam-vip:
62682 description: Oam V4 vip address of this vnfc
62685 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
62686 is-closed-loop-disabled:
62688 description: used to indicate whether closed loop function is enabled on this node
62691 description: Group notation of VNFC
62692 model-invariant-id:
62694 description: the ASDC model id for this resource or service model.
62697 description: the ASDC model version for this resource or service model.
62700 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62704 $ref: "#/getDefinitions/relationship"
62705 l3-interface-ipv4-address-list:
62708 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62709 l3-interface-ipv6-address-list:
62712 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62715 virtual network components associated with a vserver from application controller.
62720 $ref: "#/getDefinitions/vnfc"
62723 Ephemeral Block storage volume.
62724 ###### Related Nodes
62725 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
62727 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
62734 description: Unique ID of block storage volume relative to the vserver.
62737 description: URL to endpoint where AAI can get more details
62740 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62744 $ref: "#/getDefinitions/relationship"
62747 Persistent block-level storage.
62748 ###### Related Nodes
62749 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
62750 - TO complex( volume-group LocatedIn complex, MANY2ONE)
62751 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
62752 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
62753 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
62757 - volume-group-name
62762 description: Unique ID of volume-group.
62765 description: Name of the volume group.
62768 description: Heat stack id corresponding to this volume-group
62771 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.
62772 orchestration-status:
62774 description: Orchestration status of this volume-group
62775 model-customization-id:
62777 description: captures the id of all the configuration used to customize the resource for the service.
62778 vf-module-model-customization-id:
62780 description: helps relate the volume group to the vf-module whose components will require the volume group
62783 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62787 $ref: "#/getDefinitions/relationship"
62790 Collection of persistent block-level storage.
62795 $ref: "#/getDefinitions/volume-group"
62798 Collection of ephemeral Block storage volumes.
62803 $ref: "#/getDefinitions/volume"
62806 VPLS Provider Edge routers.
62807 ###### Related Nodes
62808 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
62809 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
62810 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
62811 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
62813 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
62821 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62824 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).
62827 description: Client should send valid enumerated value, e.g., VPLS-PE.
62831 description: Temporary location for stag to get to VCE
62834 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62838 $ref: "#/getDefinitions/relationship"
62842 $ref: "#/getDefinitions/p-interface"
62846 $ref: "#/getDefinitions/lag-interface"
62849 Collection of VPLS Provider Edge routers
62854 $ref: "#/getDefinitions/vpls-pe"
62858 ###### Related Nodes
62859 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
62860 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
62861 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
62862 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
62864 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
62865 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
62873 description: VPN ID, globally unique within A&AI
62876 description: VPN Name
62879 description: the platform associated with the VPN example AVPN, Mobility
62882 description: Type of the vpn, should be taken from enumerated/valid values
62885 description: region of customer vpn
62888 description: id for this customer vpn
62889 route-distinguisher:
62891 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
62894 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62898 $ref: "#/getDefinitions/route-target"
62902 $ref: "#/getDefinitions/relationship"
62903 description: l3-networks relate to vpn-bindings
62909 $ref: "#/getDefinitions/vpn-binding"
62912 Virtual Servers, aka virtual machine or VM.
62913 ###### Related Nodes
62914 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
62915 - TO flavor( vserver Uses flavor, MANY2ONE)
62916 - TO image( vserver Uses image, MANY2ONE)
62917 - TO pserver( vserver HostedOn pserver, MANY2ONE)
62918 - TO snapshot( vserver Uses snapshot, ONE2ONE)
62919 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
62920 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
62921 - FROM vce( vce HostedOn vserver, ONE2MANY)
62922 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
62923 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
62924 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
62926 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
62927 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
62933 - is-closed-loop-disabled
62937 description: Unique identifier for this vserver relative to its tenant
62940 description: Name of vserver
62943 description: Alternative name of vserver
62946 description: Trigger for operational monitoring of this resource by Service Assurance systems.
62949 description: URL to endpoint where AAI can get more details
62952 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.
62953 is-closed-loop-disabled:
62955 description: Used to indicate whether closed loop function is enabled on this node
62958 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62962 $ref: "#/getDefinitions/volume"
62966 $ref: "#/getDefinitions/relationship"
62970 $ref: "#/getDefinitions/l-interface"
62973 Collection of virtual Servers, aka virtual machines or VMs.
62978 $ref: "#/getDefinitions/vserver"
62981 A zone is a grouping of assets in a location homing to the same connections into the CBB
62982 ###### Related Nodes
62983 - TO complex( zone LocatedIn complex, MANY2ONE)
62984 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
62985 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
62986 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
62987 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
62997 description: Code assigned by AIC to the zone
63000 description: English name associated with the zone
63003 description: Design of zone [Medium/Largeā¦]
63006 description: Context of zone [production/test]
63009 description: Status of a zone.
63012 description: Concurrency value
63016 $ref: "#/getDefinitions/relationship"
63019 Collection of zones
63024 $ref: "#/getDefinitions/zone"