5 [Differences versus the previous schema version](apidocs/aai_swagger_v10.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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4359 $ref: "#/definitions/tenant"
4362 - CloudInfrastructure
4363 summary: update an existing tenant
4365 Update an existing tenant
4367 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4368 The PUT operation will entirely replace an existing object.
4369 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4371 Other differences between PUT and PATCH are:
4373 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4374 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4375 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4376 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4385 description: Response codes found in [response codes](https://wiki.onap.org/).
4389 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4392 example: __CLOUD-OWNER__
4393 - name: cloud-region-id
4395 description: Identifier used by the vendor for the region. Second part of composite key
4398 example: __CLOUD-REGION-ID__
4401 description: Unique id relative to the cloud-region.
4404 example: __TENANT-ID__
4407 description: tenant object that needs to be updated.
4410 $ref: "#/patchDefinitions/tenant"
4413 - CloudInfrastructure
4414 summary: delete an existing tenant
4415 description: delete an existing tenant
4416 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4425 description: Response codes found in [response codes](https://wiki.onap.org/).
4429 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4432 example: __CLOUD-OWNER__
4433 - name: cloud-region-id
4435 description: Identifier used by the vendor for the region. Second part of composite key
4438 example: __CLOUD-REGION-ID__
4441 description: Unique id relative to the cloud-region.
4444 example: __TENANT-ID__
4445 - name: resource-version
4447 description: resource-version for concurrency
4450 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
4453 - CloudInfrastructure
4454 summary: returns tenants
4455 description: returns tenants
4456 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
4462 description: successful operation
4464 $ref: "#/getDefinitions/tenants"
4466 description: Response codes found in [response codes](https://wiki.onap.org/).
4470 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4473 example: __CLOUD-OWNER__
4474 - name: cloud-region-id
4476 description: Identifier used by the vendor for the region. Second part of composite key
4479 example: __CLOUD-REGION-ID__
4490 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
4493 - CloudInfrastructure
4494 summary: see node definition for valid relationships
4495 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4504 description: Response codes found in [response codes](https://wiki.onap.org/).
4508 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4511 example: __CLOUD-OWNER__
4512 - name: cloud-region-id
4514 description: Identifier used by the vendor for the region. Second part of composite key
4517 example: __CLOUD-REGION-ID__
4520 description: Flavor id, expected to be unique across cloud-region.
4523 example: __FLAVOR-ID__
4526 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4529 $ref: "#/definitions/relationship"
4532 - CloudInfrastructure
4533 summary: delete an existing relationship
4534 description: delete an existing relationship
4535 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4544 description: Response codes found in [response codes](https://wiki.onap.org/).
4548 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4551 example: __CLOUD-OWNER__
4552 - name: cloud-region-id
4554 description: Identifier used by the vendor for the region. Second part of composite key
4557 example: __CLOUD-REGION-ID__
4560 description: Flavor id, expected to be unique across cloud-region.
4563 example: __FLAVOR-ID__
4564 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
4567 - CloudInfrastructure
4568 summary: returns flavor
4569 description: returns flavor
4570 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4576 description: successful operation
4578 $ref: "#/getDefinitions/flavor"
4580 description: Response codes found in [response codes](https://wiki.onap.org/).
4584 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4587 example: __CLOUD-OWNER__
4588 - name: cloud-region-id
4590 description: Identifier used by the vendor for the region. Second part of composite key
4593 example: __CLOUD-REGION-ID__
4596 description: Flavor id, expected to be unique across cloud-region.
4599 example: __FLAVOR-ID__
4602 - CloudInfrastructure
4603 summary: create or update an existing flavor
4605 Create or update an existing flavor.
4607 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4608 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4617 description: Response codes found in [response codes](https://wiki.onap.org/).
4621 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4624 example: __CLOUD-OWNER__
4625 - name: cloud-region-id
4627 description: Identifier used by the vendor for the region. Second part of composite key
4630 example: __CLOUD-REGION-ID__
4633 description: Flavor id, expected to be unique across cloud-region.
4636 example: __FLAVOR-ID__
4639 description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4642 $ref: "#/definitions/flavor"
4645 - CloudInfrastructure
4646 summary: update an existing flavor
4648 Update an existing flavor
4650 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4651 The PUT operation will entirely replace an existing object.
4652 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4654 Other differences between PUT and PATCH are:
4656 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4657 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4658 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4659 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4668 description: Response codes found in [response codes](https://wiki.onap.org/).
4672 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4675 example: __CLOUD-OWNER__
4676 - name: cloud-region-id
4678 description: Identifier used by the vendor for the region. Second part of composite key
4681 example: __CLOUD-REGION-ID__
4684 description: Flavor id, expected to be unique across cloud-region.
4687 example: __FLAVOR-ID__
4690 description: flavor object that needs to be updated.
4693 $ref: "#/patchDefinitions/flavor"
4696 - CloudInfrastructure
4697 summary: delete an existing flavor
4698 description: delete an existing flavor
4699 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4708 description: Response codes found in [response codes](https://wiki.onap.org/).
4712 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4715 example: __CLOUD-OWNER__
4716 - name: cloud-region-id
4718 description: Identifier used by the vendor for the region. Second part of composite key
4721 example: __CLOUD-REGION-ID__
4724 description: Flavor id, expected to be unique across cloud-region.
4727 example: __FLAVOR-ID__
4728 - name: resource-version
4730 description: resource-version for concurrency
4733 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
4736 - CloudInfrastructure
4737 summary: returns flavors
4738 description: returns flavors
4739 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
4745 description: successful operation
4747 $ref: "#/getDefinitions/flavors"
4749 description: Response codes found in [response codes](https://wiki.onap.org/).
4753 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4756 example: __CLOUD-OWNER__
4757 - name: cloud-region-id
4759 description: Identifier used by the vendor for the region. Second part of composite key
4762 example: __CLOUD-REGION-ID__
4773 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
4776 - CloudInfrastructure
4777 summary: see node definition for valid relationships
4778 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4787 description: Response codes found in [response codes](https://wiki.onap.org/).
4791 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4794 example: __CLOUD-OWNER__
4795 - name: cloud-region-id
4797 description: Identifier used by the vendor for the region. Second part of composite key
4800 example: __CLOUD-REGION-ID__
4803 description: Group id, expected to be unique across cloud-region.
4806 example: __GROUP-ID__
4809 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4812 $ref: "#/definitions/relationship"
4815 - CloudInfrastructure
4816 summary: delete an existing relationship
4817 description: delete an existing relationship
4818 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4827 description: Response codes found in [response codes](https://wiki.onap.org/).
4831 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4834 example: __CLOUD-OWNER__
4835 - name: cloud-region-id
4837 description: Identifier used by the vendor for the region. Second part of composite key
4840 example: __CLOUD-REGION-ID__
4843 description: Group id, expected to be unique across cloud-region.
4846 example: __GROUP-ID__
4847 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
4850 - CloudInfrastructure
4851 summary: returns group-assignment
4852 description: returns group-assignment
4853 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4859 description: successful operation
4861 $ref: "#/getDefinitions/group-assignment"
4863 description: Response codes found in [response codes](https://wiki.onap.org/).
4867 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4870 example: __CLOUD-OWNER__
4871 - name: cloud-region-id
4873 description: Identifier used by the vendor for the region. Second part of composite key
4876 example: __CLOUD-REGION-ID__
4879 description: Group id, expected to be unique across cloud-region.
4882 example: __GROUP-ID__
4885 - CloudInfrastructure
4886 summary: create or update an existing group-assignment
4888 Create or update an existing group-assignment.
4890 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4891 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4900 description: Response codes found in [response codes](https://wiki.onap.org/).
4904 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4907 example: __CLOUD-OWNER__
4908 - name: cloud-region-id
4910 description: Identifier used by the vendor for the region. Second part of composite key
4913 example: __CLOUD-REGION-ID__
4916 description: Group id, expected to be unique across cloud-region.
4919 example: __GROUP-ID__
4922 description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4925 $ref: "#/definitions/group-assignment"
4928 - CloudInfrastructure
4929 summary: update an existing group-assignment
4931 Update an existing group-assignment
4933 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4934 The PUT operation will entirely replace an existing object.
4935 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4937 Other differences between PUT and PATCH are:
4939 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4940 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4941 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4942 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4951 description: Response codes found in [response codes](https://wiki.onap.org/).
4955 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4958 example: __CLOUD-OWNER__
4959 - name: cloud-region-id
4961 description: Identifier used by the vendor for the region. Second part of composite key
4964 example: __CLOUD-REGION-ID__
4967 description: Group id, expected to be unique across cloud-region.
4970 example: __GROUP-ID__
4973 description: group-assignment object that needs to be updated.
4976 $ref: "#/patchDefinitions/group-assignment"
4979 - CloudInfrastructure
4980 summary: delete an existing group-assignment
4981 description: delete an existing group-assignment
4982 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4991 description: Response codes found in [response codes](https://wiki.onap.org/).
4995 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4998 example: __CLOUD-OWNER__
4999 - name: cloud-region-id
5001 description: Identifier used by the vendor for the region. Second part of composite key
5004 example: __CLOUD-REGION-ID__
5007 description: Group id, expected to be unique across cloud-region.
5010 example: __GROUP-ID__
5011 - name: resource-version
5013 description: resource-version for concurrency
5016 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5019 - CloudInfrastructure
5020 summary: returns group-assignments
5021 description: returns group-assignments
5022 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5028 description: successful operation
5030 $ref: "#/getDefinitions/group-assignments"
5032 description: Response codes found in [response codes](https://wiki.onap.org/).
5036 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5039 example: __CLOUD-OWNER__
5040 - name: cloud-region-id
5042 description: Identifier used by the vendor for the region. Second part of composite key
5045 example: __CLOUD-REGION-ID__
5061 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5064 - CloudInfrastructure
5065 summary: see node definition for valid relationships
5066 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5075 description: Response codes found in [response codes](https://wiki.onap.org/).
5079 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5082 example: __CLOUD-OWNER__
5083 - name: cloud-region-id
5085 description: Identifier used by the vendor for the region. Second part of composite key
5088 example: __CLOUD-REGION-ID__
5091 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5094 example: __SNAPSHOT-ID__
5097 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5100 $ref: "#/definitions/relationship"
5103 - CloudInfrastructure
5104 summary: delete an existing relationship
5105 description: delete an existing relationship
5106 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5115 description: Response codes found in [response codes](https://wiki.onap.org/).
5119 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5122 example: __CLOUD-OWNER__
5123 - name: cloud-region-id
5125 description: Identifier used by the vendor for the region. Second part of composite key
5128 example: __CLOUD-REGION-ID__
5131 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5134 example: __SNAPSHOT-ID__
5135 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5138 - CloudInfrastructure
5139 summary: returns snapshot
5140 description: returns snapshot
5141 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5147 description: successful operation
5149 $ref: "#/getDefinitions/snapshot"
5151 description: Response codes found in [response codes](https://wiki.onap.org/).
5155 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5158 example: __CLOUD-OWNER__
5159 - name: cloud-region-id
5161 description: Identifier used by the vendor for the region. Second part of composite key
5164 example: __CLOUD-REGION-ID__
5167 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5170 example: __SNAPSHOT-ID__
5173 - CloudInfrastructure
5174 summary: create or update an existing snapshot
5176 Create or update an existing snapshot.
5178 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5179 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5188 description: Response codes found in [response codes](https://wiki.onap.org/).
5192 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5195 example: __CLOUD-OWNER__
5196 - name: cloud-region-id
5198 description: Identifier used by the vendor for the region. Second part of composite key
5201 example: __CLOUD-REGION-ID__
5204 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5207 example: __SNAPSHOT-ID__
5210 description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5213 $ref: "#/definitions/snapshot"
5216 - CloudInfrastructure
5217 summary: update an existing snapshot
5219 Update an existing snapshot
5221 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5222 The PUT operation will entirely replace an existing object.
5223 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5225 Other differences between PUT and PATCH are:
5227 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5228 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5229 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5230 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5239 description: Response codes found in [response codes](https://wiki.onap.org/).
5243 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5246 example: __CLOUD-OWNER__
5247 - name: cloud-region-id
5249 description: Identifier used by the vendor for the region. Second part of composite key
5252 example: __CLOUD-REGION-ID__
5255 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5258 example: __SNAPSHOT-ID__
5261 description: snapshot object that needs to be updated.
5264 $ref: "#/patchDefinitions/snapshot"
5267 - CloudInfrastructure
5268 summary: delete an existing snapshot
5269 description: delete an existing snapshot
5270 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5279 description: Response codes found in [response codes](https://wiki.onap.org/).
5283 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5286 example: __CLOUD-OWNER__
5287 - name: cloud-region-id
5289 description: Identifier used by the vendor for the region. Second part of composite key
5292 example: __CLOUD-REGION-ID__
5295 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5298 example: __SNAPSHOT-ID__
5299 - name: resource-version
5301 description: resource-version for concurrency
5304 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5307 - CloudInfrastructure
5308 summary: returns snapshots
5309 description: returns snapshots
5310 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5316 description: successful operation
5318 $ref: "#/getDefinitions/snapshots"
5320 description: Response codes found in [response codes](https://wiki.onap.org/).
5324 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5327 example: __CLOUD-OWNER__
5328 - name: cloud-region-id
5330 description: Identifier used by the vendor for the region. Second part of composite key
5333 example: __CLOUD-REGION-ID__
5339 - name: snapshot-name
5349 - name: application-vendor
5354 - name: application-version
5359 - name: prev-snapshot-id
5364 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
5367 - CloudInfrastructure
5368 summary: see node definition for valid relationships
5369 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5378 description: Response codes found in [response codes](https://wiki.onap.org/).
5382 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5385 example: __CLOUD-OWNER__
5386 - name: cloud-region-id
5388 description: Identifier used by the vendor for the region. Second part of composite key
5391 example: __CLOUD-REGION-ID__
5394 description: Image id, expected to be unique across cloud region
5397 example: __IMAGE-ID__
5400 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5403 $ref: "#/definitions/relationship"
5406 - CloudInfrastructure
5407 summary: delete an existing relationship
5408 description: delete an existing relationship
5409 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5418 description: Response codes found in [response codes](https://wiki.onap.org/).
5422 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5425 example: __CLOUD-OWNER__
5426 - name: cloud-region-id
5428 description: Identifier used by the vendor for the region. Second part of composite key
5431 example: __CLOUD-REGION-ID__
5434 description: Image id, expected to be unique across cloud region
5437 example: __IMAGE-ID__
5438 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
5441 - CloudInfrastructure
5442 summary: returns metadatum
5443 description: returns metadatum
5444 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5450 description: successful operation
5452 $ref: "#/getDefinitions/metadatum"
5454 description: Response codes found in [response codes](https://wiki.onap.org/).
5458 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5461 example: __CLOUD-OWNER__
5462 - name: cloud-region-id
5464 description: Identifier used by the vendor for the region. Second part of composite key
5467 example: __CLOUD-REGION-ID__
5470 description: Image id, expected to be unique across cloud region
5473 example: __IMAGE-ID__
5478 example: __METANAME__
5481 - CloudInfrastructure
5482 summary: create or update an existing metadatum
5484 Create or update an existing metadatum.
5486 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5487 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5496 description: Response codes found in [response codes](https://wiki.onap.org/).
5500 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5503 example: __CLOUD-OWNER__
5504 - name: cloud-region-id
5506 description: Identifier used by the vendor for the region. Second part of composite key
5509 example: __CLOUD-REGION-ID__
5512 description: Image id, expected to be unique across cloud region
5515 example: __IMAGE-ID__
5520 example: __METANAME__
5523 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
5526 $ref: "#/definitions/metadatum"
5529 - CloudInfrastructure
5530 summary: update an existing metadatum
5532 Update an existing metadatum
5534 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5535 The PUT operation will entirely replace an existing object.
5536 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5538 Other differences between PUT and PATCH are:
5540 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5541 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5542 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5543 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5552 description: Response codes found in [response codes](https://wiki.onap.org/).
5556 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5559 example: __CLOUD-OWNER__
5560 - name: cloud-region-id
5562 description: Identifier used by the vendor for the region. Second part of composite key
5565 example: __CLOUD-REGION-ID__
5568 description: Image id, expected to be unique across cloud region
5571 example: __IMAGE-ID__
5576 example: __METANAME__
5579 description: metadatum object that needs to be updated.
5582 $ref: "#/patchDefinitions/metadatum"
5585 - CloudInfrastructure
5586 summary: delete an existing metadatum
5587 description: delete an existing metadatum
5588 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5597 description: Response codes found in [response codes](https://wiki.onap.org/).
5601 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5604 example: __CLOUD-OWNER__
5605 - name: cloud-region-id
5607 description: Identifier used by the vendor for the region. Second part of composite key
5610 example: __CLOUD-REGION-ID__
5613 description: Image id, expected to be unique across cloud region
5616 example: __IMAGE-ID__
5621 example: __METANAME__
5622 - name: resource-version
5624 description: resource-version for concurrency
5627 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
5630 - CloudInfrastructure
5631 summary: returns metadata
5632 description: returns metadata
5633 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
5639 description: successful operation
5641 $ref: "#/getDefinitions/metadata"
5643 description: Response codes found in [response codes](https://wiki.onap.org/).
5647 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5650 example: __CLOUD-OWNER__
5651 - name: cloud-region-id
5653 description: Identifier used by the vendor for the region. Second part of composite key
5656 example: __CLOUD-REGION-ID__
5659 description: Image id, expected to be unique across cloud region
5662 example: __IMAGE-ID__
5668 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
5671 - CloudInfrastructure
5672 summary: returns image
5673 description: returns image
5674 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
5680 description: successful operation
5682 $ref: "#/getDefinitions/image"
5684 description: Response codes found in [response codes](https://wiki.onap.org/).
5688 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5691 example: __CLOUD-OWNER__
5692 - name: cloud-region-id
5694 description: Identifier used by the vendor for the region. Second part of composite key
5697 example: __CLOUD-REGION-ID__
5700 description: Image id, expected to be unique across cloud region
5703 example: __IMAGE-ID__
5706 - CloudInfrastructure
5707 summary: create or update an existing image
5709 Create or update an existing image.
5711 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5712 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5721 description: Response codes found in [response codes](https://wiki.onap.org/).
5725 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5728 example: __CLOUD-OWNER__
5729 - name: cloud-region-id
5731 description: Identifier used by the vendor for the region. Second part of composite key
5734 example: __CLOUD-REGION-ID__
5737 description: Image id, expected to be unique across cloud region
5740 example: __IMAGE-ID__
5743 description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5746 $ref: "#/definitions/image"
5749 - CloudInfrastructure
5750 summary: update an existing image
5752 Update an existing image
5754 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5755 The PUT operation will entirely replace an existing object.
5756 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5758 Other differences between PUT and PATCH are:
5760 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5761 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5762 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5763 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5772 description: Response codes found in [response codes](https://wiki.onap.org/).
5776 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5779 example: __CLOUD-OWNER__
5780 - name: cloud-region-id
5782 description: Identifier used by the vendor for the region. Second part of composite key
5785 example: __CLOUD-REGION-ID__
5788 description: Image id, expected to be unique across cloud region
5791 example: __IMAGE-ID__
5794 description: image object that needs to be updated.
5797 $ref: "#/patchDefinitions/image"
5800 - CloudInfrastructure
5801 summary: delete an existing image
5802 description: delete an existing image
5803 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
5812 description: Response codes found in [response codes](https://wiki.onap.org/).
5816 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5819 example: __CLOUD-OWNER__
5820 - name: cloud-region-id
5822 description: Identifier used by the vendor for the region. Second part of composite key
5825 example: __CLOUD-REGION-ID__
5828 description: Image id, expected to be unique across cloud region
5831 example: __IMAGE-ID__
5832 - name: resource-version
5834 description: resource-version for concurrency
5837 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
5840 - CloudInfrastructure
5841 summary: returns images
5842 description: returns images
5843 operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
5849 description: successful operation
5851 $ref: "#/getDefinitions/images"
5853 description: Response codes found in [response codes](https://wiki.onap.org/).
5857 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5860 example: __CLOUD-OWNER__
5861 - name: cloud-region-id
5863 description: Identifier used by the vendor for the region. Second part of composite key
5866 example: __CLOUD-REGION-ID__
5882 - name: application-vendor
5887 - name: application-version
5892 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
5895 - CloudInfrastructure
5896 summary: see node definition for valid relationships
5897 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5906 description: Response codes found in [response codes](https://wiki.onap.org/).
5910 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5913 example: __CLOUD-OWNER__
5914 - name: cloud-region-id
5916 description: Identifier used by the vendor for the region. Second part of composite key
5919 example: __CLOUD-REGION-ID__
5922 description: DVS switch name
5925 example: __SWITCH-NAME__
5928 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
5931 $ref: "#/definitions/relationship"
5934 - CloudInfrastructure
5935 summary: delete an existing relationship
5936 description: delete an existing relationship
5937 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5946 description: Response codes found in [response codes](https://wiki.onap.org/).
5950 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5953 example: __CLOUD-OWNER__
5954 - name: cloud-region-id
5956 description: Identifier used by the vendor for the region. Second part of composite key
5959 example: __CLOUD-REGION-ID__
5962 description: DVS switch name
5965 example: __SWITCH-NAME__
5966 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
5969 - CloudInfrastructure
5970 summary: returns dvs-switch
5971 description: returns dvs-switch
5972 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
5978 description: successful operation
5980 $ref: "#/getDefinitions/dvs-switch"
5982 description: Response codes found in [response codes](https://wiki.onap.org/).
5986 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5989 example: __CLOUD-OWNER__
5990 - name: cloud-region-id
5992 description: Identifier used by the vendor for the region. Second part of composite key
5995 example: __CLOUD-REGION-ID__
5998 description: DVS switch name
6001 example: __SWITCH-NAME__
6004 - CloudInfrastructure
6005 summary: create or update an existing dvs-switch
6007 Create or update an existing dvs-switch.
6009 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6010 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6019 description: Response codes found in [response codes](https://wiki.onap.org/).
6023 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6026 example: __CLOUD-OWNER__
6027 - name: cloud-region-id
6029 description: Identifier used by the vendor for the region. Second part of composite key
6032 example: __CLOUD-REGION-ID__
6035 description: DVS switch name
6038 example: __SWITCH-NAME__
6041 description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6044 $ref: "#/definitions/dvs-switch"
6047 - CloudInfrastructure
6048 summary: update an existing dvs-switch
6050 Update an existing dvs-switch
6052 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6053 The PUT operation will entirely replace an existing object.
6054 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6056 Other differences between PUT and PATCH are:
6058 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6059 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6060 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6061 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6070 description: Response codes found in [response codes](https://wiki.onap.org/).
6074 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6077 example: __CLOUD-OWNER__
6078 - name: cloud-region-id
6080 description: Identifier used by the vendor for the region. Second part of composite key
6083 example: __CLOUD-REGION-ID__
6086 description: DVS switch name
6089 example: __SWITCH-NAME__
6092 description: dvs-switch object that needs to be updated.
6095 $ref: "#/patchDefinitions/dvs-switch"
6098 - CloudInfrastructure
6099 summary: delete an existing dvs-switch
6100 description: delete an existing dvs-switch
6101 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6110 description: Response codes found in [response codes](https://wiki.onap.org/).
6114 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6117 example: __CLOUD-OWNER__
6118 - name: cloud-region-id
6120 description: Identifier used by the vendor for the region. Second part of composite key
6123 example: __CLOUD-REGION-ID__
6126 description: DVS switch name
6129 example: __SWITCH-NAME__
6130 - name: resource-version
6132 description: resource-version for concurrency
6135 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6138 - CloudInfrastructure
6139 summary: returns dvs-switches
6140 description: returns dvs-switches
6141 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6147 description: successful operation
6149 $ref: "#/getDefinitions/dvs-switches"
6151 description: Response codes found in [response codes](https://wiki.onap.org/).
6155 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6158 example: __CLOUD-OWNER__
6159 - name: cloud-region-id
6161 description: Identifier used by the vendor for the region. Second part of composite key
6164 example: __CLOUD-REGION-ID__
6175 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6178 - CloudInfrastructure
6179 summary: see node definition for valid relationships
6180 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6189 description: Response codes found in [response codes](https://wiki.onap.org/).
6193 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6196 example: __CLOUD-OWNER__
6197 - name: cloud-region-id
6199 description: Identifier used by the vendor for the region. Second part of composite key
6202 example: __CLOUD-REGION-ID__
6203 - name: network-uuid
6205 description: UUID of the network. Unique across a cloud-region
6208 example: __NETWORK-UUID__
6211 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6214 $ref: "#/definitions/relationship"
6217 - CloudInfrastructure
6218 summary: delete an existing relationship
6219 description: delete an existing relationship
6220 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6229 description: Response codes found in [response codes](https://wiki.onap.org/).
6233 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6236 example: __CLOUD-OWNER__
6237 - name: cloud-region-id
6239 description: Identifier used by the vendor for the region. Second part of composite key
6242 example: __CLOUD-REGION-ID__
6243 - name: network-uuid
6245 description: UUID of the network. Unique across a cloud-region
6248 example: __NETWORK-UUID__
6249 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6252 - CloudInfrastructure
6253 summary: returns oam-network
6254 description: returns oam-network
6255 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6261 description: successful operation
6263 $ref: "#/getDefinitions/oam-network"
6265 description: Response codes found in [response codes](https://wiki.onap.org/).
6269 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6272 example: __CLOUD-OWNER__
6273 - name: cloud-region-id
6275 description: Identifier used by the vendor for the region. Second part of composite key
6278 example: __CLOUD-REGION-ID__
6279 - name: network-uuid
6281 description: UUID of the network. Unique across a cloud-region
6284 example: __NETWORK-UUID__
6287 - CloudInfrastructure
6288 summary: create or update an existing oam-network
6290 Create or update an existing oam-network.
6292 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6293 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6302 description: Response codes found in [response codes](https://wiki.onap.org/).
6306 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6309 example: __CLOUD-OWNER__
6310 - name: cloud-region-id
6312 description: Identifier used by the vendor for the region. Second part of composite key
6315 example: __CLOUD-REGION-ID__
6316 - name: network-uuid
6318 description: UUID of the network. Unique across a cloud-region
6321 example: __NETWORK-UUID__
6324 description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6327 $ref: "#/definitions/oam-network"
6330 - CloudInfrastructure
6331 summary: update an existing oam-network
6333 Update an existing oam-network
6335 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6336 The PUT operation will entirely replace an existing object.
6337 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6339 Other differences between PUT and PATCH are:
6341 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6342 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6343 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6344 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6353 description: Response codes found in [response codes](https://wiki.onap.org/).
6357 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6360 example: __CLOUD-OWNER__
6361 - name: cloud-region-id
6363 description: Identifier used by the vendor for the region. Second part of composite key
6366 example: __CLOUD-REGION-ID__
6367 - name: network-uuid
6369 description: UUID of the network. Unique across a cloud-region
6372 example: __NETWORK-UUID__
6375 description: oam-network object that needs to be updated.
6378 $ref: "#/patchDefinitions/oam-network"
6381 - CloudInfrastructure
6382 summary: delete an existing oam-network
6383 description: delete an existing oam-network
6384 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6393 description: Response codes found in [response codes](https://wiki.onap.org/).
6397 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6400 example: __CLOUD-OWNER__
6401 - name: cloud-region-id
6403 description: Identifier used by the vendor for the region. Second part of composite key
6406 example: __CLOUD-REGION-ID__
6407 - name: network-uuid
6409 description: UUID of the network. Unique across a cloud-region
6412 example: __NETWORK-UUID__
6413 - name: resource-version
6415 description: resource-version for concurrency
6418 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
6421 - CloudInfrastructure
6422 summary: returns oam-networks
6423 description: returns oam-networks
6424 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
6430 description: successful operation
6432 $ref: "#/getDefinitions/oam-networks"
6434 description: Response codes found in [response codes](https://wiki.onap.org/).
6438 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6441 example: __CLOUD-OWNER__
6442 - name: cloud-region-id
6444 description: Identifier used by the vendor for the region. Second part of composite key
6447 example: __CLOUD-REGION-ID__
6448 - name: network-uuid
6453 - name: network-name
6464 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
6467 - CloudInfrastructure
6468 summary: see node definition for valid relationships
6469 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6478 description: Response codes found in [response codes](https://wiki.onap.org/).
6482 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6485 example: __CLOUD-OWNER__
6486 - name: cloud-region-id
6488 description: Identifier used by the vendor for the region. Second part of composite key
6491 example: __CLOUD-REGION-ID__
6492 - name: availability-zone-name
6494 description: Name of the availability zone. Unique across a cloud region
6497 example: __AVAILABILITY-ZONE-NAME__
6500 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6503 $ref: "#/definitions/relationship"
6506 - CloudInfrastructure
6507 summary: delete an existing relationship
6508 description: delete an existing relationship
6509 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6518 description: Response codes found in [response codes](https://wiki.onap.org/).
6522 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6525 example: __CLOUD-OWNER__
6526 - name: cloud-region-id
6528 description: Identifier used by the vendor for the region. Second part of composite key
6531 example: __CLOUD-REGION-ID__
6532 - name: availability-zone-name
6534 description: Name of the availability zone. Unique across a cloud region
6537 example: __AVAILABILITY-ZONE-NAME__
6538 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
6541 - CloudInfrastructure
6542 summary: returns availability-zone
6543 description: returns availability-zone
6544 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6550 description: successful operation
6552 $ref: "#/getDefinitions/availability-zone"
6554 description: Response codes found in [response codes](https://wiki.onap.org/).
6558 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6561 example: __CLOUD-OWNER__
6562 - name: cloud-region-id
6564 description: Identifier used by the vendor for the region. Second part of composite key
6567 example: __CLOUD-REGION-ID__
6568 - name: availability-zone-name
6570 description: Name of the availability zone. Unique across a cloud region
6573 example: __AVAILABILITY-ZONE-NAME__
6576 - CloudInfrastructure
6577 summary: create or update an existing availability-zone
6579 Create or update an existing availability-zone.
6581 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6582 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6591 description: Response codes found in [response codes](https://wiki.onap.org/).
6595 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6598 example: __CLOUD-OWNER__
6599 - name: cloud-region-id
6601 description: Identifier used by the vendor for the region. Second part of composite key
6604 example: __CLOUD-REGION-ID__
6605 - name: availability-zone-name
6607 description: Name of the availability zone. Unique across a cloud region
6610 example: __AVAILABILITY-ZONE-NAME__
6613 description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6616 $ref: "#/definitions/availability-zone"
6619 - CloudInfrastructure
6620 summary: update an existing availability-zone
6622 Update an existing availability-zone
6624 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6625 The PUT operation will entirely replace an existing object.
6626 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6628 Other differences between PUT and PATCH are:
6630 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6631 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6632 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6633 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6642 description: Response codes found in [response codes](https://wiki.onap.org/).
6646 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6649 example: __CLOUD-OWNER__
6650 - name: cloud-region-id
6652 description: Identifier used by the vendor for the region. Second part of composite key
6655 example: __CLOUD-REGION-ID__
6656 - name: availability-zone-name
6658 description: Name of the availability zone. Unique across a cloud region
6661 example: __AVAILABILITY-ZONE-NAME__
6664 description: availability-zone object that needs to be updated.
6667 $ref: "#/patchDefinitions/availability-zone"
6670 - CloudInfrastructure
6671 summary: delete an existing availability-zone
6672 description: delete an existing availability-zone
6673 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6682 description: Response codes found in [response codes](https://wiki.onap.org/).
6686 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6689 example: __CLOUD-OWNER__
6690 - name: cloud-region-id
6692 description: Identifier used by the vendor for the region. Second part of composite key
6695 example: __CLOUD-REGION-ID__
6696 - name: availability-zone-name
6698 description: Name of the availability zone. Unique across a cloud region
6701 example: __AVAILABILITY-ZONE-NAME__
6702 - name: resource-version
6704 description: resource-version for concurrency
6707 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
6710 - CloudInfrastructure
6711 summary: returns availability-zones
6712 description: returns availability-zones
6713 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
6719 description: successful operation
6721 $ref: "#/getDefinitions/availability-zones"
6723 description: Response codes found in [response codes](https://wiki.onap.org/).
6727 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6730 example: __CLOUD-OWNER__
6731 - name: cloud-region-id
6733 description: Identifier used by the vendor for the region. Second part of composite key
6736 example: __CLOUD-REGION-ID__
6737 - name: availability-zone-name
6742 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
6745 - CloudInfrastructure
6746 summary: see node definition for valid relationships
6747 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6756 description: Response codes found in [response codes](https://wiki.onap.org/).
6760 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6763 example: __CLOUD-OWNER__
6764 - name: cloud-region-id
6766 description: Identifier used by the vendor for the region. Second part of composite key
6769 example: __CLOUD-REGION-ID__
6772 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegion.json)
6775 $ref: "#/definitions/relationship"
6778 - CloudInfrastructure
6779 summary: delete an existing relationship
6780 description: delete an existing relationship
6781 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6790 description: Response codes found in [response codes](https://wiki.onap.org/).
6794 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6797 example: __CLOUD-OWNER__
6798 - name: cloud-region-id
6800 description: Identifier used by the vendor for the region. Second part of composite key
6803 example: __CLOUD-REGION-ID__
6804 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
6807 - CloudInfrastructure
6808 summary: returns cloud-region
6809 description: returns cloud-region
6810 operationId: getCloudInfrastructureCloudRegionsCloudRegion
6816 description: successful operation
6818 $ref: "#/getDefinitions/cloud-region"
6820 description: Response codes found in [response codes](https://wiki.onap.org/).
6824 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6827 example: __CLOUD-OWNER__
6828 - name: cloud-region-id
6830 description: Identifier used by the vendor for the region. Second part of composite key
6833 example: __CLOUD-REGION-ID__
6836 - CloudInfrastructure
6837 summary: create or update an existing cloud-region
6839 Create or update an existing cloud-region.
6841 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6842 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
6851 description: Response codes found in [response codes](https://wiki.onap.org/).
6855 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6858 example: __CLOUD-OWNER__
6859 - name: cloud-region-id
6861 description: Identifier used by the vendor for the region. Second part of composite key
6864 example: __CLOUD-REGION-ID__
6867 description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegion.json)
6870 $ref: "#/definitions/cloud-region"
6873 - CloudInfrastructure
6874 summary: update an existing cloud-region
6876 Update an existing cloud-region
6878 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6879 The PUT operation will entirely replace an existing object.
6880 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6882 Other differences between PUT and PATCH are:
6884 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6885 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6886 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6887 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
6896 description: Response codes found in [response codes](https://wiki.onap.org/).
6900 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6903 example: __CLOUD-OWNER__
6904 - name: cloud-region-id
6906 description: Identifier used by the vendor for the region. Second part of composite key
6909 example: __CLOUD-REGION-ID__
6912 description: cloud-region object that needs to be updated.
6915 $ref: "#/patchDefinitions/cloud-region"
6918 - CloudInfrastructure
6919 summary: delete an existing cloud-region
6920 description: delete an existing cloud-region
6921 operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
6930 description: Response codes found in [response codes](https://wiki.onap.org/).
6934 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6937 example: __CLOUD-OWNER__
6938 - name: cloud-region-id
6940 description: Identifier used by the vendor for the region. Second part of composite key
6943 example: __CLOUD-REGION-ID__
6944 - name: resource-version
6946 description: resource-version for concurrency
6949 /cloud-infrastructure/cloud-regions:
6952 - CloudInfrastructure
6953 summary: returns cloud-regions
6954 description: returns cloud-regions
6955 operationId: getCloudInfrastructureCloudRegions
6961 description: successful operation
6963 $ref: "#/getDefinitions/cloud-regions"
6965 description: Response codes found in [response codes](https://wiki.onap.org/).
6972 - name: cloud-region-id
6982 - name: owner-defined-type
6987 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
6990 - CloudInfrastructure
6991 summary: see node definition for valid relationships
6992 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7001 description: Response codes found in [response codes](https://wiki.onap.org/).
7003 - name: nm-profile-name
7005 description: Unique name of network profile.
7008 example: __NM-PROFILE-NAME__
7011 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7014 $ref: "#/definitions/relationship"
7017 - CloudInfrastructure
7018 summary: delete an existing relationship
7019 description: delete an existing relationship
7020 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7029 description: Response codes found in [response codes](https://wiki.onap.org/).
7031 - name: nm-profile-name
7033 description: Unique name of network profile.
7036 example: __NM-PROFILE-NAME__
7037 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7040 - CloudInfrastructure
7041 summary: returns network-profile
7042 description: returns network-profile
7043 operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7049 description: successful operation
7051 $ref: "#/getDefinitions/network-profile"
7053 description: Response codes found in [response codes](https://wiki.onap.org/).
7055 - name: nm-profile-name
7057 description: Unique name of network profile.
7060 example: __NM-PROFILE-NAME__
7063 - CloudInfrastructure
7064 summary: create or update an existing network-profile
7066 Create or update an existing network-profile.
7068 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7069 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
7078 description: Response codes found in [response codes](https://wiki.onap.org/).
7080 - name: nm-profile-name
7082 description: Unique name of network profile.
7085 example: __NM-PROFILE-NAME__
7088 description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7091 $ref: "#/definitions/network-profile"
7094 - CloudInfrastructure
7095 summary: update an existing network-profile
7097 Update an existing network-profile
7099 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7100 The PUT operation will entirely replace an existing object.
7101 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7103 Other differences between PUT and PATCH are:
7105 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7106 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7107 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7108 operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7117 description: Response codes found in [response codes](https://wiki.onap.org/).
7119 - name: nm-profile-name
7121 description: Unique name of network profile.
7124 example: __NM-PROFILE-NAME__
7127 description: network-profile object that needs to be updated.
7130 $ref: "#/patchDefinitions/network-profile"
7133 - CloudInfrastructure
7134 summary: delete an existing network-profile
7135 description: delete an existing network-profile
7136 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
7145 description: Response codes found in [response codes](https://wiki.onap.org/).
7147 - name: nm-profile-name
7149 description: Unique name of network profile.
7152 example: __NM-PROFILE-NAME__
7153 - name: resource-version
7155 description: resource-version for concurrency
7158 /cloud-infrastructure/network-profiles:
7161 - CloudInfrastructure
7162 summary: returns network-profiles
7163 description: returns network-profiles
7164 operationId: getCloudInfrastructureNetworkProfiles
7170 description: successful operation
7172 $ref: "#/getDefinitions/network-profiles"
7174 description: Response codes found in [response codes](https://wiki.onap.org/).
7176 - name: nm-profile-name
7181 /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
7184 - CloudInfrastructure
7185 summary: see node definition for valid relationships
7186 operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
7195 description: Response codes found in [response codes](https://wiki.onap.org/).
7199 description: Value from executing hostname on the compute node.
7202 example: __HOSTNAME__
7205 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)
7208 $ref: "#/definitions/relationship"
7211 - CloudInfrastructure
7212 summary: delete an existing relationship
7213 description: delete an existing relationship
7214 operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
7223 description: Response codes found in [response codes](https://wiki.onap.org/).
7227 description: Value from executing hostname on the compute node.
7230 example: __HOSTNAME__
7231 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
7234 - CloudInfrastructure
7235 summary: see node definition for valid relationships
7236 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7245 description: Response codes found in [response codes](https://wiki.onap.org/).
7249 description: Value from executing hostname on the compute node.
7252 example: __HOSTNAME__
7253 - name: interface-name
7255 description: Name that identifies the physical interface
7258 example: __INTERFACE-NAME__
7261 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
7264 $ref: "#/definitions/relationship"
7267 - CloudInfrastructure
7268 summary: delete an existing relationship
7269 description: delete an existing relationship
7270 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7279 description: Response codes found in [response codes](https://wiki.onap.org/).
7283 description: Value from executing hostname on the compute node.
7286 example: __HOSTNAME__
7287 - name: interface-name
7289 description: Name that identifies the physical interface
7292 example: __INTERFACE-NAME__
7293 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
7296 - CloudInfrastructure
7297 summary: see node definition for valid relationships
7298 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7307 description: Response codes found in [response codes](https://wiki.onap.org/).
7311 description: Value from executing hostname on the compute node.
7314 example: __HOSTNAME__
7315 - name: interface-name
7317 description: Name that identifies the physical interface
7320 example: __INTERFACE-NAME__
7321 - name: interface-name
7323 description: Name given to the interface
7326 example: __INTERFACE-NAME__
7327 - name: vlan-interface
7329 description: String that identifies the interface
7332 example: __VLAN-INTERFACE__
7335 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
7338 $ref: "#/definitions/relationship"
7341 - CloudInfrastructure
7342 summary: delete an existing relationship
7343 description: delete an existing relationship
7344 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7353 description: Response codes found in [response codes](https://wiki.onap.org/).
7357 description: Value from executing hostname on the compute node.
7360 example: __HOSTNAME__
7361 - name: interface-name
7363 description: Name that identifies the physical interface
7366 example: __INTERFACE-NAME__
7367 - name: interface-name
7369 description: Name given to the interface
7372 example: __INTERFACE-NAME__
7373 - name: vlan-interface
7375 description: String that identifies the interface
7378 example: __VLAN-INTERFACE__
7379 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
7382 - CloudInfrastructure
7383 summary: see node definition for valid relationships
7384 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7393 description: Response codes found in [response codes](https://wiki.onap.org/).
7397 description: Value from executing hostname on the compute node.
7400 example: __HOSTNAME__
7401 - name: interface-name
7403 description: Name that identifies the physical interface
7406 example: __INTERFACE-NAME__
7407 - name: interface-name
7409 description: Name given to the interface
7412 example: __INTERFACE-NAME__
7413 - name: vlan-interface
7415 description: String that identifies the interface
7418 example: __VLAN-INTERFACE__
7419 - name: l3-interface-ipv4-address
7421 description: IP address
7424 example: __L3-INTERFACE-IPV4-ADDRESS__
7427 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7430 $ref: "#/definitions/relationship"
7433 - CloudInfrastructure
7434 summary: delete an existing relationship
7435 description: delete an existing relationship
7436 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7445 description: Response codes found in [response codes](https://wiki.onap.org/).
7449 description: Value from executing hostname on the compute node.
7452 example: __HOSTNAME__
7453 - name: interface-name
7455 description: Name that identifies the physical interface
7458 example: __INTERFACE-NAME__
7459 - name: interface-name
7461 description: Name given to the interface
7464 example: __INTERFACE-NAME__
7465 - name: vlan-interface
7467 description: String that identifies the interface
7470 example: __VLAN-INTERFACE__
7471 - name: l3-interface-ipv4-address
7473 description: IP address
7476 example: __L3-INTERFACE-IPV4-ADDRESS__
7477 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
7480 - CloudInfrastructure
7481 summary: returns l3-interface-ipv4-address-list
7482 description: returns l3-interface-ipv4-address-list
7483 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7489 description: successful operation
7491 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
7493 description: Response codes found in [response codes](https://wiki.onap.org/).
7497 description: Value from executing hostname on the compute node.
7500 example: __HOSTNAME__
7501 - name: interface-name
7503 description: Name that identifies the physical interface
7506 example: __INTERFACE-NAME__
7507 - name: interface-name
7509 description: Name given to the interface
7512 example: __INTERFACE-NAME__
7513 - name: vlan-interface
7515 description: String that identifies the interface
7518 example: __VLAN-INTERFACE__
7519 - name: l3-interface-ipv4-address
7521 description: IP address
7524 example: __L3-INTERFACE-IPV4-ADDRESS__
7527 - CloudInfrastructure
7528 summary: create or update an existing l3-interface-ipv4-address-list
7530 Create or update an existing l3-interface-ipv4-address-list.
7532 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7533 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7542 description: Response codes found in [response codes](https://wiki.onap.org/).
7546 description: Value from executing hostname on the compute node.
7549 example: __HOSTNAME__
7550 - name: interface-name
7552 description: Name that identifies the physical interface
7555 example: __INTERFACE-NAME__
7556 - name: interface-name
7558 description: Name given to the interface
7561 example: __INTERFACE-NAME__
7562 - name: vlan-interface
7564 description: String that identifies the interface
7567 example: __VLAN-INTERFACE__
7568 - name: l3-interface-ipv4-address
7570 description: IP address
7573 example: __L3-INTERFACE-IPV4-ADDRESS__
7576 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7579 $ref: "#/definitions/l3-interface-ipv4-address-list"
7582 - CloudInfrastructure
7583 summary: update an existing l3-interface-ipv4-address-list
7585 Update an existing l3-interface-ipv4-address-list
7587 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7588 The PUT operation will entirely replace an existing object.
7589 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7591 Other differences between PUT and PATCH are:
7593 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7594 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7595 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7596 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7605 description: Response codes found in [response codes](https://wiki.onap.org/).
7609 description: Value from executing hostname on the compute node.
7612 example: __HOSTNAME__
7613 - name: interface-name
7615 description: Name that identifies the physical interface
7618 example: __INTERFACE-NAME__
7619 - name: interface-name
7621 description: Name given to the interface
7624 example: __INTERFACE-NAME__
7625 - name: vlan-interface
7627 description: String that identifies the interface
7630 example: __VLAN-INTERFACE__
7631 - name: l3-interface-ipv4-address
7633 description: IP address
7636 example: __L3-INTERFACE-IPV4-ADDRESS__
7639 description: l3-interface-ipv4-address-list object that needs to be updated.
7642 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
7645 - CloudInfrastructure
7646 summary: delete an existing l3-interface-ipv4-address-list
7647 description: delete an existing l3-interface-ipv4-address-list
7648 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7657 description: Response codes found in [response codes](https://wiki.onap.org/).
7661 description: Value from executing hostname on the compute node.
7664 example: __HOSTNAME__
7665 - name: interface-name
7667 description: Name that identifies the physical interface
7670 example: __INTERFACE-NAME__
7671 - name: interface-name
7673 description: Name given to the interface
7676 example: __INTERFACE-NAME__
7677 - name: vlan-interface
7679 description: String that identifies the interface
7682 example: __VLAN-INTERFACE__
7683 - name: l3-interface-ipv4-address
7685 description: IP address
7688 example: __L3-INTERFACE-IPV4-ADDRESS__
7689 - name: resource-version
7691 description: resource-version for concurrency
7694 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
7697 - CloudInfrastructure
7698 summary: see node definition for valid relationships
7699 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7708 description: Response codes found in [response codes](https://wiki.onap.org/).
7712 description: Value from executing hostname on the compute node.
7715 example: __HOSTNAME__
7716 - name: interface-name
7718 description: Name that identifies the physical interface
7721 example: __INTERFACE-NAME__
7722 - name: interface-name
7724 description: Name given to the interface
7727 example: __INTERFACE-NAME__
7728 - name: vlan-interface
7730 description: String that identifies the interface
7733 example: __VLAN-INTERFACE__
7734 - name: l3-interface-ipv6-address
7736 description: IP address
7739 example: __L3-INTERFACE-IPV6-ADDRESS__
7742 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7745 $ref: "#/definitions/relationship"
7748 - CloudInfrastructure
7749 summary: delete an existing relationship
7750 description: delete an existing relationship
7751 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7760 description: Response codes found in [response codes](https://wiki.onap.org/).
7764 description: Value from executing hostname on the compute node.
7767 example: __HOSTNAME__
7768 - name: interface-name
7770 description: Name that identifies the physical interface
7773 example: __INTERFACE-NAME__
7774 - name: interface-name
7776 description: Name given to the interface
7779 example: __INTERFACE-NAME__
7780 - name: vlan-interface
7782 description: String that identifies the interface
7785 example: __VLAN-INTERFACE__
7786 - name: l3-interface-ipv6-address
7788 description: IP address
7791 example: __L3-INTERFACE-IPV6-ADDRESS__
7792 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
7795 - CloudInfrastructure
7796 summary: returns l3-interface-ipv6-address-list
7797 description: returns l3-interface-ipv6-address-list
7798 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7804 description: successful operation
7806 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
7808 description: Response codes found in [response codes](https://wiki.onap.org/).
7812 description: Value from executing hostname on the compute node.
7815 example: __HOSTNAME__
7816 - name: interface-name
7818 description: Name that identifies the physical interface
7821 example: __INTERFACE-NAME__
7822 - name: interface-name
7824 description: Name given to the interface
7827 example: __INTERFACE-NAME__
7828 - name: vlan-interface
7830 description: String that identifies the interface
7833 example: __VLAN-INTERFACE__
7834 - name: l3-interface-ipv6-address
7836 description: IP address
7839 example: __L3-INTERFACE-IPV6-ADDRESS__
7842 - CloudInfrastructure
7843 summary: create or update an existing l3-interface-ipv6-address-list
7845 Create or update an existing l3-interface-ipv6-address-list.
7847 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7848 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7857 description: Response codes found in [response codes](https://wiki.onap.org/).
7861 description: Value from executing hostname on the compute node.
7864 example: __HOSTNAME__
7865 - name: interface-name
7867 description: Name that identifies the physical interface
7870 example: __INTERFACE-NAME__
7871 - name: interface-name
7873 description: Name given to the interface
7876 example: __INTERFACE-NAME__
7877 - name: vlan-interface
7879 description: String that identifies the interface
7882 example: __VLAN-INTERFACE__
7883 - name: l3-interface-ipv6-address
7885 description: IP address
7888 example: __L3-INTERFACE-IPV6-ADDRESS__
7891 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7894 $ref: "#/definitions/l3-interface-ipv6-address-list"
7897 - CloudInfrastructure
7898 summary: update an existing l3-interface-ipv6-address-list
7900 Update an existing l3-interface-ipv6-address-list
7902 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7903 The PUT operation will entirely replace an existing object.
7904 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7906 Other differences between PUT and PATCH are:
7908 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7909 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7910 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7911 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7920 description: Response codes found in [response codes](https://wiki.onap.org/).
7924 description: Value from executing hostname on the compute node.
7927 example: __HOSTNAME__
7928 - name: interface-name
7930 description: Name that identifies the physical interface
7933 example: __INTERFACE-NAME__
7934 - name: interface-name
7936 description: Name given to the interface
7939 example: __INTERFACE-NAME__
7940 - name: vlan-interface
7942 description: String that identifies the interface
7945 example: __VLAN-INTERFACE__
7946 - name: l3-interface-ipv6-address
7948 description: IP address
7951 example: __L3-INTERFACE-IPV6-ADDRESS__
7954 description: l3-interface-ipv6-address-list object that needs to be updated.
7957 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
7960 - CloudInfrastructure
7961 summary: delete an existing l3-interface-ipv6-address-list
7962 description: delete an existing l3-interface-ipv6-address-list
7963 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7972 description: Response codes found in [response codes](https://wiki.onap.org/).
7976 description: Value from executing hostname on the compute node.
7979 example: __HOSTNAME__
7980 - name: interface-name
7982 description: Name that identifies the physical interface
7985 example: __INTERFACE-NAME__
7986 - name: interface-name
7988 description: Name given to the interface
7991 example: __INTERFACE-NAME__
7992 - name: vlan-interface
7994 description: String that identifies the interface
7997 example: __VLAN-INTERFACE__
7998 - name: l3-interface-ipv6-address
8000 description: IP address
8003 example: __L3-INTERFACE-IPV6-ADDRESS__
8004 - name: resource-version
8006 description: resource-version for concurrency
8009 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8012 - CloudInfrastructure
8013 summary: returns vlan
8014 description: returns vlan
8015 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8021 description: successful operation
8023 $ref: "#/getDefinitions/vlan"
8025 description: Response codes found in [response codes](https://wiki.onap.org/).
8029 description: Value from executing hostname on the compute node.
8032 example: __HOSTNAME__
8033 - name: interface-name
8035 description: Name that identifies the physical interface
8038 example: __INTERFACE-NAME__
8039 - name: interface-name
8041 description: Name given to the interface
8044 example: __INTERFACE-NAME__
8045 - name: vlan-interface
8047 description: String that identifies the interface
8050 example: __VLAN-INTERFACE__
8053 - CloudInfrastructure
8054 summary: create or update an existing vlan
8056 Create or update an existing vlan.
8058 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8059 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8068 description: Response codes found in [response codes](https://wiki.onap.org/).
8072 description: Value from executing hostname on the compute node.
8075 example: __HOSTNAME__
8076 - name: interface-name
8078 description: Name that identifies the physical interface
8081 example: __INTERFACE-NAME__
8082 - name: interface-name
8084 description: Name given to the interface
8087 example: __INTERFACE-NAME__
8088 - name: vlan-interface
8090 description: String that identifies the interface
8093 example: __VLAN-INTERFACE__
8096 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8099 $ref: "#/definitions/vlan"
8102 - CloudInfrastructure
8103 summary: update an existing vlan
8105 Update an existing vlan
8107 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8108 The PUT operation will entirely replace an existing object.
8109 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8111 Other differences between PUT and PATCH are:
8113 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8114 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8115 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8116 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8125 description: Response codes found in [response codes](https://wiki.onap.org/).
8129 description: Value from executing hostname on the compute node.
8132 example: __HOSTNAME__
8133 - name: interface-name
8135 description: Name that identifies the physical interface
8138 example: __INTERFACE-NAME__
8139 - name: interface-name
8141 description: Name given to the interface
8144 example: __INTERFACE-NAME__
8145 - name: vlan-interface
8147 description: String that identifies the interface
8150 example: __VLAN-INTERFACE__
8153 description: vlan object that needs to be updated.
8156 $ref: "#/patchDefinitions/vlan"
8159 - CloudInfrastructure
8160 summary: delete an existing vlan
8161 description: delete an existing vlan
8162 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8171 description: Response codes found in [response codes](https://wiki.onap.org/).
8175 description: Value from executing hostname on the compute node.
8178 example: __HOSTNAME__
8179 - name: interface-name
8181 description: Name that identifies the physical interface
8184 example: __INTERFACE-NAME__
8185 - name: interface-name
8187 description: Name given to the interface
8190 example: __INTERFACE-NAME__
8191 - name: vlan-interface
8193 description: String that identifies the interface
8196 example: __VLAN-INTERFACE__
8197 - name: resource-version
8199 description: resource-version for concurrency
8202 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
8205 - CloudInfrastructure
8206 summary: returns vlans
8207 description: returns vlans
8208 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
8214 description: successful operation
8216 $ref: "#/getDefinitions/vlans"
8218 description: Response codes found in [response codes](https://wiki.onap.org/).
8222 description: Value from executing hostname on the compute node.
8225 example: __HOSTNAME__
8226 - name: interface-name
8228 description: Name that identifies the physical interface
8231 example: __INTERFACE-NAME__
8232 - name: interface-name
8234 description: Name given to the interface
8237 example: __INTERFACE-NAME__
8238 - name: vlan-interface
8243 - name: vlan-id-inner
8254 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
8257 - CloudInfrastructure
8258 summary: see node definition for valid relationships
8259 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8268 description: Response codes found in [response codes](https://wiki.onap.org/).
8272 description: Value from executing hostname on the compute node.
8275 example: __HOSTNAME__
8276 - name: interface-name
8278 description: Name that identifies the physical interface
8281 example: __INTERFACE-NAME__
8282 - name: interface-name
8284 description: Name given to the interface
8287 example: __INTERFACE-NAME__
8290 description: PCI ID used to identify the sriov-vf
8296 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8299 $ref: "#/definitions/relationship"
8302 - CloudInfrastructure
8303 summary: delete an existing relationship
8304 description: delete an existing relationship
8305 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8314 description: Response codes found in [response codes](https://wiki.onap.org/).
8318 description: Value from executing hostname on the compute node.
8321 example: __HOSTNAME__
8322 - name: interface-name
8324 description: Name that identifies the physical interface
8327 example: __INTERFACE-NAME__
8328 - name: interface-name
8330 description: Name given to the interface
8333 example: __INTERFACE-NAME__
8336 description: PCI ID used to identify the sriov-vf
8340 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
8343 - CloudInfrastructure
8344 summary: returns sriov-vf
8345 description: returns sriov-vf
8346 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8352 description: successful operation
8354 $ref: "#/getDefinitions/sriov-vf"
8356 description: Response codes found in [response codes](https://wiki.onap.org/).
8360 description: Value from executing hostname on the compute node.
8363 example: __HOSTNAME__
8364 - name: interface-name
8366 description: Name that identifies the physical interface
8369 example: __INTERFACE-NAME__
8370 - name: interface-name
8372 description: Name given to the interface
8375 example: __INTERFACE-NAME__
8378 description: PCI ID used to identify the sriov-vf
8384 - CloudInfrastructure
8385 summary: create or update an existing sriov-vf
8387 Create or update an existing sriov-vf.
8389 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8390 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8399 description: Response codes found in [response codes](https://wiki.onap.org/).
8403 description: Value from executing hostname on the compute node.
8406 example: __HOSTNAME__
8407 - name: interface-name
8409 description: Name that identifies the physical interface
8412 example: __INTERFACE-NAME__
8413 - name: interface-name
8415 description: Name given to the interface
8418 example: __INTERFACE-NAME__
8421 description: PCI ID used to identify the sriov-vf
8427 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8430 $ref: "#/definitions/sriov-vf"
8433 - CloudInfrastructure
8434 summary: update an existing sriov-vf
8436 Update an existing sriov-vf
8438 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8439 The PUT operation will entirely replace an existing object.
8440 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8442 Other differences between PUT and PATCH are:
8444 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8445 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8446 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8447 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8456 description: Response codes found in [response codes](https://wiki.onap.org/).
8460 description: Value from executing hostname on the compute node.
8463 example: __HOSTNAME__
8464 - name: interface-name
8466 description: Name that identifies the physical interface
8469 example: __INTERFACE-NAME__
8470 - name: interface-name
8472 description: Name given to the interface
8475 example: __INTERFACE-NAME__
8478 description: PCI ID used to identify the sriov-vf
8484 description: sriov-vf object that needs to be updated.
8487 $ref: "#/patchDefinitions/sriov-vf"
8490 - CloudInfrastructure
8491 summary: delete an existing sriov-vf
8492 description: delete an existing sriov-vf
8493 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8502 description: Response codes found in [response codes](https://wiki.onap.org/).
8506 description: Value from executing hostname on the compute node.
8509 example: __HOSTNAME__
8510 - name: interface-name
8512 description: Name that identifies the physical interface
8515 example: __INTERFACE-NAME__
8516 - name: interface-name
8518 description: Name given to the interface
8521 example: __INTERFACE-NAME__
8524 description: PCI ID used to identify the sriov-vf
8528 - name: resource-version
8530 description: resource-version for concurrency
8533 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
8536 - CloudInfrastructure
8537 summary: returns sriov-vfs
8538 description: returns sriov-vfs
8539 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
8545 description: successful operation
8547 $ref: "#/getDefinitions/sriov-vfs"
8549 description: Response codes found in [response codes](https://wiki.onap.org/).
8553 description: Value from executing hostname on the compute node.
8556 example: __HOSTNAME__
8557 - name: interface-name
8559 description: Name that identifies the physical interface
8562 example: __INTERFACE-NAME__
8563 - name: interface-name
8565 description: Name given to the interface
8568 example: __INTERFACE-NAME__
8574 - name: vf-vlan-filter
8579 - name: vf-mac-filter
8584 - name: vf-vlan-strip
8589 - name: neutron-network-id
8594 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
8597 - CloudInfrastructure
8598 summary: see node definition for valid relationships
8599 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8608 description: Response codes found in [response codes](https://wiki.onap.org/).
8612 description: Value from executing hostname on the compute node.
8615 example: __HOSTNAME__
8616 - name: interface-name
8618 description: Name that identifies the physical interface
8621 example: __INTERFACE-NAME__
8622 - name: interface-name
8624 description: Name given to the interface
8627 example: __INTERFACE-NAME__
8630 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
8633 $ref: "#/definitions/relationship"
8636 - CloudInfrastructure
8637 summary: delete an existing relationship
8638 description: delete an existing relationship
8639 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8648 description: Response codes found in [response codes](https://wiki.onap.org/).
8652 description: Value from executing hostname on the compute node.
8655 example: __HOSTNAME__
8656 - name: interface-name
8658 description: Name that identifies the physical interface
8661 example: __INTERFACE-NAME__
8662 - name: interface-name
8664 description: Name given to the interface
8667 example: __INTERFACE-NAME__
8668 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
8671 - CloudInfrastructure
8672 summary: see node definition for valid relationships
8673 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8682 description: Response codes found in [response codes](https://wiki.onap.org/).
8686 description: Value from executing hostname on the compute node.
8689 example: __HOSTNAME__
8690 - name: interface-name
8692 description: Name that identifies the physical interface
8695 example: __INTERFACE-NAME__
8696 - name: interface-name
8698 description: Name given to the interface
8701 example: __INTERFACE-NAME__
8702 - name: l3-interface-ipv4-address
8704 description: IP address
8707 example: __L3-INTERFACE-IPV4-ADDRESS__
8710 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8713 $ref: "#/definitions/relationship"
8716 - CloudInfrastructure
8717 summary: delete an existing relationship
8718 description: delete an existing relationship
8719 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8728 description: Response codes found in [response codes](https://wiki.onap.org/).
8732 description: Value from executing hostname on the compute node.
8735 example: __HOSTNAME__
8736 - name: interface-name
8738 description: Name that identifies the physical interface
8741 example: __INTERFACE-NAME__
8742 - name: interface-name
8744 description: Name given to the interface
8747 example: __INTERFACE-NAME__
8748 - name: l3-interface-ipv4-address
8750 description: IP address
8753 example: __L3-INTERFACE-IPV4-ADDRESS__
8754 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
8757 - CloudInfrastructure
8758 summary: returns l3-interface-ipv4-address-list
8759 description: returns l3-interface-ipv4-address-list
8760 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8766 description: successful operation
8768 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8770 description: Response codes found in [response codes](https://wiki.onap.org/).
8774 description: Value from executing hostname on the compute node.
8777 example: __HOSTNAME__
8778 - name: interface-name
8780 description: Name that identifies the physical interface
8783 example: __INTERFACE-NAME__
8784 - name: interface-name
8786 description: Name given to the interface
8789 example: __INTERFACE-NAME__
8790 - name: l3-interface-ipv4-address
8792 description: IP address
8795 example: __L3-INTERFACE-IPV4-ADDRESS__
8798 - CloudInfrastructure
8799 summary: create or update an existing l3-interface-ipv4-address-list
8801 Create or update an existing l3-interface-ipv4-address-list.
8803 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8804 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8813 description: Response codes found in [response codes](https://wiki.onap.org/).
8817 description: Value from executing hostname on the compute node.
8820 example: __HOSTNAME__
8821 - name: interface-name
8823 description: Name that identifies the physical interface
8826 example: __INTERFACE-NAME__
8827 - name: interface-name
8829 description: Name given to the interface
8832 example: __INTERFACE-NAME__
8833 - name: l3-interface-ipv4-address
8835 description: IP address
8838 example: __L3-INTERFACE-IPV4-ADDRESS__
8841 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8844 $ref: "#/definitions/l3-interface-ipv4-address-list"
8847 - CloudInfrastructure
8848 summary: update an existing l3-interface-ipv4-address-list
8850 Update an existing l3-interface-ipv4-address-list
8852 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8853 The PUT operation will entirely replace an existing object.
8854 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8856 Other differences between PUT and PATCH are:
8858 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8859 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8860 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8861 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8870 description: Response codes found in [response codes](https://wiki.onap.org/).
8874 description: Value from executing hostname on the compute node.
8877 example: __HOSTNAME__
8878 - name: interface-name
8880 description: Name that identifies the physical interface
8883 example: __INTERFACE-NAME__
8884 - name: interface-name
8886 description: Name given to the interface
8889 example: __INTERFACE-NAME__
8890 - name: l3-interface-ipv4-address
8892 description: IP address
8895 example: __L3-INTERFACE-IPV4-ADDRESS__
8898 description: l3-interface-ipv4-address-list object that needs to be updated.
8901 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8904 - CloudInfrastructure
8905 summary: delete an existing l3-interface-ipv4-address-list
8906 description: delete an existing l3-interface-ipv4-address-list
8907 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8916 description: Response codes found in [response codes](https://wiki.onap.org/).
8920 description: Value from executing hostname on the compute node.
8923 example: __HOSTNAME__
8924 - name: interface-name
8926 description: Name that identifies the physical interface
8929 example: __INTERFACE-NAME__
8930 - name: interface-name
8932 description: Name given to the interface
8935 example: __INTERFACE-NAME__
8936 - name: l3-interface-ipv4-address
8938 description: IP address
8941 example: __L3-INTERFACE-IPV4-ADDRESS__
8942 - name: resource-version
8944 description: resource-version for concurrency
8947 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
8950 - CloudInfrastructure
8951 summary: see node definition for valid relationships
8952 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
8961 description: Response codes found in [response codes](https://wiki.onap.org/).
8965 description: Value from executing hostname on the compute node.
8968 example: __HOSTNAME__
8969 - name: interface-name
8971 description: Name that identifies the physical interface
8974 example: __INTERFACE-NAME__
8975 - name: interface-name
8977 description: Name given to the interface
8980 example: __INTERFACE-NAME__
8981 - name: l3-interface-ipv6-address
8983 description: IP address
8986 example: __L3-INTERFACE-IPV6-ADDRESS__
8989 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
8992 $ref: "#/definitions/relationship"
8995 - CloudInfrastructure
8996 summary: delete an existing relationship
8997 description: delete an existing relationship
8998 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
9007 description: Response codes found in [response codes](https://wiki.onap.org/).
9011 description: Value from executing hostname on the compute node.
9014 example: __HOSTNAME__
9015 - name: interface-name
9017 description: Name that identifies the physical interface
9020 example: __INTERFACE-NAME__
9021 - name: interface-name
9023 description: Name given to the interface
9026 example: __INTERFACE-NAME__
9027 - name: l3-interface-ipv6-address
9029 description: IP address
9032 example: __L3-INTERFACE-IPV6-ADDRESS__
9033 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
9036 - CloudInfrastructure
9037 summary: returns l3-interface-ipv6-address-list
9038 description: returns l3-interface-ipv6-address-list
9039 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9045 description: successful operation
9047 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9049 description: Response codes found in [response codes](https://wiki.onap.org/).
9053 description: Value from executing hostname on the compute node.
9056 example: __HOSTNAME__
9057 - name: interface-name
9059 description: Name that identifies the physical interface
9062 example: __INTERFACE-NAME__
9063 - name: interface-name
9065 description: Name given to the interface
9068 example: __INTERFACE-NAME__
9069 - name: l3-interface-ipv6-address
9071 description: IP address
9074 example: __L3-INTERFACE-IPV6-ADDRESS__
9077 - CloudInfrastructure
9078 summary: create or update an existing l3-interface-ipv6-address-list
9080 Create or update an existing l3-interface-ipv6-address-list.
9082 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9083 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9092 description: Response codes found in [response codes](https://wiki.onap.org/).
9096 description: Value from executing hostname on the compute node.
9099 example: __HOSTNAME__
9100 - name: interface-name
9102 description: Name that identifies the physical interface
9105 example: __INTERFACE-NAME__
9106 - name: interface-name
9108 description: Name given to the interface
9111 example: __INTERFACE-NAME__
9112 - name: l3-interface-ipv6-address
9114 description: IP address
9117 example: __L3-INTERFACE-IPV6-ADDRESS__
9120 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
9123 $ref: "#/definitions/l3-interface-ipv6-address-list"
9126 - CloudInfrastructure
9127 summary: update an existing l3-interface-ipv6-address-list
9129 Update an existing l3-interface-ipv6-address-list
9131 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9132 The PUT operation will entirely replace an existing object.
9133 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9135 Other differences between PUT and PATCH are:
9137 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9138 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9139 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9140 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9149 description: Response codes found in [response codes](https://wiki.onap.org/).
9153 description: Value from executing hostname on the compute node.
9156 example: __HOSTNAME__
9157 - name: interface-name
9159 description: Name that identifies the physical interface
9162 example: __INTERFACE-NAME__
9163 - name: interface-name
9165 description: Name given to the interface
9168 example: __INTERFACE-NAME__
9169 - name: l3-interface-ipv6-address
9171 description: IP address
9174 example: __L3-INTERFACE-IPV6-ADDRESS__
9177 description: l3-interface-ipv6-address-list object that needs to be updated.
9180 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9183 - CloudInfrastructure
9184 summary: delete an existing l3-interface-ipv6-address-list
9185 description: delete an existing l3-interface-ipv6-address-list
9186 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9195 description: Response codes found in [response codes](https://wiki.onap.org/).
9199 description: Value from executing hostname on the compute node.
9202 example: __HOSTNAME__
9203 - name: interface-name
9205 description: Name that identifies the physical interface
9208 example: __INTERFACE-NAME__
9209 - name: interface-name
9211 description: Name given to the interface
9214 example: __INTERFACE-NAME__
9215 - name: l3-interface-ipv6-address
9217 description: IP address
9220 example: __L3-INTERFACE-IPV6-ADDRESS__
9221 - name: resource-version
9223 description: resource-version for concurrency
9226 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
9229 - CloudInfrastructure
9230 summary: returns l-interface
9231 description: returns l-interface
9232 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9238 description: successful operation
9240 $ref: "#/getDefinitions/l-interface"
9242 description: Response codes found in [response codes](https://wiki.onap.org/).
9246 description: Value from executing hostname on the compute node.
9249 example: __HOSTNAME__
9250 - name: interface-name
9252 description: Name that identifies the physical interface
9255 example: __INTERFACE-NAME__
9256 - name: interface-name
9258 description: Name given to the interface
9261 example: __INTERFACE-NAME__
9264 - CloudInfrastructure
9265 summary: create or update an existing l-interface
9267 Create or update an existing l-interface.
9269 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9270 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9279 description: Response codes found in [response codes](https://wiki.onap.org/).
9283 description: Value from executing hostname on the compute node.
9286 example: __HOSTNAME__
9287 - name: interface-name
9289 description: Name that identifies the physical interface
9292 example: __INTERFACE-NAME__
9293 - name: interface-name
9295 description: Name given to the interface
9298 example: __INTERFACE-NAME__
9301 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9304 $ref: "#/definitions/l-interface"
9307 - CloudInfrastructure
9308 summary: update an existing l-interface
9310 Update an existing l-interface
9312 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9313 The PUT operation will entirely replace an existing object.
9314 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9316 Other differences between PUT and PATCH are:
9318 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9319 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9320 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9321 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9330 description: Response codes found in [response codes](https://wiki.onap.org/).
9334 description: Value from executing hostname on the compute node.
9337 example: __HOSTNAME__
9338 - name: interface-name
9340 description: Name that identifies the physical interface
9343 example: __INTERFACE-NAME__
9344 - name: interface-name
9346 description: Name given to the interface
9349 example: __INTERFACE-NAME__
9352 description: l-interface object that needs to be updated.
9355 $ref: "#/patchDefinitions/l-interface"
9358 - CloudInfrastructure
9359 summary: delete an existing l-interface
9360 description: delete an existing l-interface
9361 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9370 description: Response codes found in [response codes](https://wiki.onap.org/).
9374 description: Value from executing hostname on the compute node.
9377 example: __HOSTNAME__
9378 - name: interface-name
9380 description: Name that identifies the physical interface
9383 example: __INTERFACE-NAME__
9384 - name: interface-name
9386 description: Name given to the interface
9389 example: __INTERFACE-NAME__
9390 - name: resource-version
9392 description: resource-version for concurrency
9395 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
9398 - CloudInfrastructure
9399 summary: returns l-interfaces
9400 description: returns l-interfaces
9401 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
9407 description: successful operation
9409 $ref: "#/getDefinitions/l-interfaces"
9411 description: Response codes found in [response codes](https://wiki.onap.org/).
9415 description: Value from executing hostname on the compute node.
9418 example: __HOSTNAME__
9419 - name: interface-name
9421 description: Name that identifies the physical interface
9424 example: __INTERFACE-NAME__
9425 - name: interface-name
9430 - name: interface-id
9440 - name: network-name
9445 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
9448 - CloudInfrastructure
9449 summary: returns p-interface
9450 description: returns p-interface
9451 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
9457 description: successful operation
9459 $ref: "#/getDefinitions/p-interface"
9461 description: Response codes found in [response codes](https://wiki.onap.org/).
9465 description: Value from executing hostname on the compute node.
9468 example: __HOSTNAME__
9469 - name: interface-name
9471 description: Name that identifies the physical interface
9474 example: __INTERFACE-NAME__
9477 - CloudInfrastructure
9478 summary: create or update an existing p-interface
9480 Create or update an existing p-interface.
9482 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9483 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9492 description: Response codes found in [response codes](https://wiki.onap.org/).
9496 description: Value from executing hostname on the compute node.
9499 example: __HOSTNAME__
9500 - name: interface-name
9502 description: Name that identifies the physical interface
9505 example: __INTERFACE-NAME__
9508 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9511 $ref: "#/definitions/p-interface"
9514 - CloudInfrastructure
9515 summary: update an existing p-interface
9517 Update an existing p-interface
9519 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9520 The PUT operation will entirely replace an existing object.
9521 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9523 Other differences between PUT and PATCH are:
9525 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9526 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9527 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9528 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9537 description: Response codes found in [response codes](https://wiki.onap.org/).
9541 description: Value from executing hostname on the compute node.
9544 example: __HOSTNAME__
9545 - name: interface-name
9547 description: Name that identifies the physical interface
9550 example: __INTERFACE-NAME__
9553 description: p-interface object that needs to be updated.
9556 $ref: "#/patchDefinitions/p-interface"
9559 - CloudInfrastructure
9560 summary: delete an existing p-interface
9561 description: delete an existing p-interface
9562 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
9571 description: Response codes found in [response codes](https://wiki.onap.org/).
9575 description: Value from executing hostname on the compute node.
9578 example: __HOSTNAME__
9579 - name: interface-name
9581 description: Name that identifies the physical interface
9584 example: __INTERFACE-NAME__
9585 - name: resource-version
9587 description: resource-version for concurrency
9590 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
9593 - CloudInfrastructure
9594 summary: returns p-interfaces
9595 description: returns p-interfaces
9596 operationId: getCloudInfrastructurePserversPserverPInterfaces
9602 description: successful operation
9604 $ref: "#/getDefinitions/p-interfaces"
9606 description: Response codes found in [response codes](https://wiki.onap.org/).
9610 description: Value from executing hostname on the compute node.
9613 example: __HOSTNAME__
9614 - name: interface-name
9624 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
9627 - CloudInfrastructure
9628 summary: see node definition for valid relationships
9629 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9638 description: Response codes found in [response codes](https://wiki.onap.org/).
9642 description: Value from executing hostname on the compute node.
9645 example: __HOSTNAME__
9646 - name: interface-name
9648 description: Name that identifies the link aggregate interface
9651 example: __INTERFACE-NAME__
9654 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
9657 $ref: "#/definitions/relationship"
9660 - CloudInfrastructure
9661 summary: delete an existing relationship
9662 description: delete an existing relationship
9663 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9672 description: Response codes found in [response codes](https://wiki.onap.org/).
9676 description: Value from executing hostname on the compute node.
9679 example: __HOSTNAME__
9680 - name: interface-name
9682 description: Name that identifies the link aggregate interface
9685 example: __INTERFACE-NAME__
9686 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9689 - CloudInfrastructure
9690 summary: see node definition for valid relationships
9691 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9700 description: Response codes found in [response codes](https://wiki.onap.org/).
9704 description: Value from executing hostname on the compute node.
9707 example: __HOSTNAME__
9708 - name: interface-name
9710 description: Name that identifies the link aggregate interface
9713 example: __INTERFACE-NAME__
9714 - name: interface-name
9716 description: Name given to the interface
9719 example: __INTERFACE-NAME__
9720 - name: vlan-interface
9722 description: String that identifies the interface
9725 example: __VLAN-INTERFACE__
9728 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
9731 $ref: "#/definitions/relationship"
9734 - CloudInfrastructure
9735 summary: delete an existing relationship
9736 description: delete an existing relationship
9737 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9746 description: Response codes found in [response codes](https://wiki.onap.org/).
9750 description: Value from executing hostname on the compute node.
9753 example: __HOSTNAME__
9754 - name: interface-name
9756 description: Name that identifies the link aggregate interface
9759 example: __INTERFACE-NAME__
9760 - name: interface-name
9762 description: Name given to the interface
9765 example: __INTERFACE-NAME__
9766 - name: vlan-interface
9768 description: String that identifies the interface
9771 example: __VLAN-INTERFACE__
9772 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9775 - CloudInfrastructure
9776 summary: see node definition for valid relationships
9777 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9786 description: Response codes found in [response codes](https://wiki.onap.org/).
9790 description: Value from executing hostname on the compute node.
9793 example: __HOSTNAME__
9794 - name: interface-name
9796 description: Name that identifies the link aggregate interface
9799 example: __INTERFACE-NAME__
9800 - name: interface-name
9802 description: Name given to the interface
9805 example: __INTERFACE-NAME__
9806 - name: vlan-interface
9808 description: String that identifies the interface
9811 example: __VLAN-INTERFACE__
9812 - name: l3-interface-ipv4-address
9814 description: IP address
9817 example: __L3-INTERFACE-IPV4-ADDRESS__
9820 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9823 $ref: "#/definitions/relationship"
9826 - CloudInfrastructure
9827 summary: delete an existing relationship
9828 description: delete an existing relationship
9829 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9838 description: Response codes found in [response codes](https://wiki.onap.org/).
9842 description: Value from executing hostname on the compute node.
9845 example: __HOSTNAME__
9846 - name: interface-name
9848 description: Name that identifies the link aggregate interface
9851 example: __INTERFACE-NAME__
9852 - name: interface-name
9854 description: Name given to the interface
9857 example: __INTERFACE-NAME__
9858 - name: vlan-interface
9860 description: String that identifies the interface
9863 example: __VLAN-INTERFACE__
9864 - name: l3-interface-ipv4-address
9866 description: IP address
9869 example: __L3-INTERFACE-IPV4-ADDRESS__
9870 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9873 - CloudInfrastructure
9874 summary: returns l3-interface-ipv4-address-list
9875 description: returns l3-interface-ipv4-address-list
9876 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9882 description: successful operation
9884 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9886 description: Response codes found in [response codes](https://wiki.onap.org/).
9890 description: Value from executing hostname on the compute node.
9893 example: __HOSTNAME__
9894 - name: interface-name
9896 description: Name that identifies the link aggregate interface
9899 example: __INTERFACE-NAME__
9900 - name: interface-name
9902 description: Name given to the interface
9905 example: __INTERFACE-NAME__
9906 - name: vlan-interface
9908 description: String that identifies the interface
9911 example: __VLAN-INTERFACE__
9912 - name: l3-interface-ipv4-address
9914 description: IP address
9917 example: __L3-INTERFACE-IPV4-ADDRESS__
9920 - CloudInfrastructure
9921 summary: create or update an existing l3-interface-ipv4-address-list
9923 Create or update an existing l3-interface-ipv4-address-list.
9925 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9926 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9935 description: Response codes found in [response codes](https://wiki.onap.org/).
9939 description: Value from executing hostname on the compute node.
9942 example: __HOSTNAME__
9943 - name: interface-name
9945 description: Name that identifies the link aggregate interface
9948 example: __INTERFACE-NAME__
9949 - name: interface-name
9951 description: Name given to the interface
9954 example: __INTERFACE-NAME__
9955 - name: vlan-interface
9957 description: String that identifies the interface
9960 example: __VLAN-INTERFACE__
9961 - name: l3-interface-ipv4-address
9963 description: IP address
9966 example: __L3-INTERFACE-IPV4-ADDRESS__
9969 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9972 $ref: "#/definitions/l3-interface-ipv4-address-list"
9975 - CloudInfrastructure
9976 summary: update an existing l3-interface-ipv4-address-list
9978 Update an existing l3-interface-ipv4-address-list
9980 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9981 The PUT operation will entirely replace an existing object.
9982 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9984 Other differences between PUT and PATCH are:
9986 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9987 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9988 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9989 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9998 description: Response codes found in [response codes](https://wiki.onap.org/).
10002 description: Value from executing hostname on the compute node.
10005 example: __HOSTNAME__
10006 - name: interface-name
10008 description: Name that identifies the link aggregate interface
10011 example: __INTERFACE-NAME__
10012 - name: interface-name
10014 description: Name given to the interface
10017 example: __INTERFACE-NAME__
10018 - name: vlan-interface
10020 description: String that identifies the interface
10023 example: __VLAN-INTERFACE__
10024 - name: l3-interface-ipv4-address
10026 description: IP address
10029 example: __L3-INTERFACE-IPV4-ADDRESS__
10032 description: l3-interface-ipv4-address-list object that needs to be updated.
10035 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10038 - CloudInfrastructure
10039 summary: delete an existing l3-interface-ipv4-address-list
10040 description: delete an existing l3-interface-ipv4-address-list
10041 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10050 description: Response codes found in [response codes](https://wiki.onap.org/).
10054 description: Value from executing hostname on the compute node.
10057 example: __HOSTNAME__
10058 - name: interface-name
10060 description: Name that identifies the link aggregate interface
10063 example: __INTERFACE-NAME__
10064 - name: interface-name
10066 description: Name given to the interface
10069 example: __INTERFACE-NAME__
10070 - name: vlan-interface
10072 description: String that identifies the interface
10075 example: __VLAN-INTERFACE__
10076 - name: l3-interface-ipv4-address
10078 description: IP address
10081 example: __L3-INTERFACE-IPV4-ADDRESS__
10082 - name: resource-version
10084 description: resource-version for concurrency
10087 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10090 - CloudInfrastructure
10091 summary: see node definition for valid relationships
10092 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10101 description: Response codes found in [response codes](https://wiki.onap.org/).
10105 description: Value from executing hostname on the compute node.
10108 example: __HOSTNAME__
10109 - name: interface-name
10111 description: Name that identifies the link aggregate interface
10114 example: __INTERFACE-NAME__
10115 - name: interface-name
10117 description: Name given to the interface
10120 example: __INTERFACE-NAME__
10121 - name: vlan-interface
10123 description: String that identifies the interface
10126 example: __VLAN-INTERFACE__
10127 - name: l3-interface-ipv6-address
10129 description: IP address
10132 example: __L3-INTERFACE-IPV6-ADDRESS__
10135 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10138 $ref: "#/definitions/relationship"
10141 - CloudInfrastructure
10142 summary: delete an existing relationship
10143 description: delete an existing relationship
10144 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10153 description: Response codes found in [response codes](https://wiki.onap.org/).
10157 description: Value from executing hostname on the compute node.
10160 example: __HOSTNAME__
10161 - name: interface-name
10163 description: Name that identifies the link aggregate interface
10166 example: __INTERFACE-NAME__
10167 - name: interface-name
10169 description: Name given to the interface
10172 example: __INTERFACE-NAME__
10173 - name: vlan-interface
10175 description: String that identifies the interface
10178 example: __VLAN-INTERFACE__
10179 - name: l3-interface-ipv6-address
10181 description: IP address
10184 example: __L3-INTERFACE-IPV6-ADDRESS__
10185 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10188 - CloudInfrastructure
10189 summary: returns l3-interface-ipv6-address-list
10190 description: returns l3-interface-ipv6-address-list
10191 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10197 description: successful operation
10199 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10201 description: Response codes found in [response codes](https://wiki.onap.org/).
10205 description: Value from executing hostname on the compute node.
10208 example: __HOSTNAME__
10209 - name: interface-name
10211 description: Name that identifies the link aggregate interface
10214 example: __INTERFACE-NAME__
10215 - name: interface-name
10217 description: Name given to the interface
10220 example: __INTERFACE-NAME__
10221 - name: vlan-interface
10223 description: String that identifies the interface
10226 example: __VLAN-INTERFACE__
10227 - name: l3-interface-ipv6-address
10229 description: IP address
10232 example: __L3-INTERFACE-IPV6-ADDRESS__
10235 - CloudInfrastructure
10236 summary: create or update an existing l3-interface-ipv6-address-list
10238 Create or update an existing l3-interface-ipv6-address-list.
10240 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10241 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10250 description: Response codes found in [response codes](https://wiki.onap.org/).
10254 description: Value from executing hostname on the compute node.
10257 example: __HOSTNAME__
10258 - name: interface-name
10260 description: Name that identifies the link aggregate interface
10263 example: __INTERFACE-NAME__
10264 - name: interface-name
10266 description: Name given to the interface
10269 example: __INTERFACE-NAME__
10270 - name: vlan-interface
10272 description: String that identifies the interface
10275 example: __VLAN-INTERFACE__
10276 - name: l3-interface-ipv6-address
10278 description: IP address
10281 example: __L3-INTERFACE-IPV6-ADDRESS__
10284 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10287 $ref: "#/definitions/l3-interface-ipv6-address-list"
10290 - CloudInfrastructure
10291 summary: update an existing l3-interface-ipv6-address-list
10293 Update an existing l3-interface-ipv6-address-list
10295 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10296 The PUT operation will entirely replace an existing object.
10297 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10299 Other differences between PUT and PATCH are:
10301 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10302 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10303 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10304 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10313 description: Response codes found in [response codes](https://wiki.onap.org/).
10317 description: Value from executing hostname on the compute node.
10320 example: __HOSTNAME__
10321 - name: interface-name
10323 description: Name that identifies the link aggregate interface
10326 example: __INTERFACE-NAME__
10327 - name: interface-name
10329 description: Name given to the interface
10332 example: __INTERFACE-NAME__
10333 - name: vlan-interface
10335 description: String that identifies the interface
10338 example: __VLAN-INTERFACE__
10339 - name: l3-interface-ipv6-address
10341 description: IP address
10344 example: __L3-INTERFACE-IPV6-ADDRESS__
10347 description: l3-interface-ipv6-address-list object that needs to be updated.
10350 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10353 - CloudInfrastructure
10354 summary: delete an existing l3-interface-ipv6-address-list
10355 description: delete an existing l3-interface-ipv6-address-list
10356 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10365 description: Response codes found in [response codes](https://wiki.onap.org/).
10369 description: Value from executing hostname on the compute node.
10372 example: __HOSTNAME__
10373 - name: interface-name
10375 description: Name that identifies the link aggregate interface
10378 example: __INTERFACE-NAME__
10379 - name: interface-name
10381 description: Name given to the interface
10384 example: __INTERFACE-NAME__
10385 - name: vlan-interface
10387 description: String that identifies the interface
10390 example: __VLAN-INTERFACE__
10391 - name: l3-interface-ipv6-address
10393 description: IP address
10396 example: __L3-INTERFACE-IPV6-ADDRESS__
10397 - name: resource-version
10399 description: resource-version for concurrency
10402 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10405 - CloudInfrastructure
10406 summary: returns vlan
10407 description: returns vlan
10408 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10414 description: successful operation
10416 $ref: "#/getDefinitions/vlan"
10418 description: Response codes found in [response codes](https://wiki.onap.org/).
10422 description: Value from executing hostname on the compute node.
10425 example: __HOSTNAME__
10426 - name: interface-name
10428 description: Name that identifies the link aggregate interface
10431 example: __INTERFACE-NAME__
10432 - name: interface-name
10434 description: Name given to the interface
10437 example: __INTERFACE-NAME__
10438 - name: vlan-interface
10440 description: String that identifies the interface
10443 example: __VLAN-INTERFACE__
10446 - CloudInfrastructure
10447 summary: create or update an existing vlan
10449 Create or update an existing vlan.
10451 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10452 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10461 description: Response codes found in [response codes](https://wiki.onap.org/).
10465 description: Value from executing hostname on the compute node.
10468 example: __HOSTNAME__
10469 - name: interface-name
10471 description: Name that identifies the link aggregate interface
10474 example: __INTERFACE-NAME__
10475 - name: interface-name
10477 description: Name given to the interface
10480 example: __INTERFACE-NAME__
10481 - name: vlan-interface
10483 description: String that identifies the interface
10486 example: __VLAN-INTERFACE__
10489 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10492 $ref: "#/definitions/vlan"
10495 - CloudInfrastructure
10496 summary: update an existing vlan
10498 Update an existing vlan
10500 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10501 The PUT operation will entirely replace an existing object.
10502 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10504 Other differences between PUT and PATCH are:
10506 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10507 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10508 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10509 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10518 description: Response codes found in [response codes](https://wiki.onap.org/).
10522 description: Value from executing hostname on the compute node.
10525 example: __HOSTNAME__
10526 - name: interface-name
10528 description: Name that identifies the link aggregate interface
10531 example: __INTERFACE-NAME__
10532 - name: interface-name
10534 description: Name given to the interface
10537 example: __INTERFACE-NAME__
10538 - name: vlan-interface
10540 description: String that identifies the interface
10543 example: __VLAN-INTERFACE__
10546 description: vlan object that needs to be updated.
10549 $ref: "#/patchDefinitions/vlan"
10552 - CloudInfrastructure
10553 summary: delete an existing vlan
10554 description: delete an existing vlan
10555 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10564 description: Response codes found in [response codes](https://wiki.onap.org/).
10568 description: Value from executing hostname on the compute node.
10571 example: __HOSTNAME__
10572 - name: interface-name
10574 description: Name that identifies the link aggregate interface
10577 example: __INTERFACE-NAME__
10578 - name: interface-name
10580 description: Name given to the interface
10583 example: __INTERFACE-NAME__
10584 - name: vlan-interface
10586 description: String that identifies the interface
10589 example: __VLAN-INTERFACE__
10590 - name: resource-version
10592 description: resource-version for concurrency
10595 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10598 - CloudInfrastructure
10599 summary: returns vlans
10600 description: returns vlans
10601 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
10607 description: successful operation
10609 $ref: "#/getDefinitions/vlans"
10611 description: Response codes found in [response codes](https://wiki.onap.org/).
10615 description: Value from executing hostname on the compute node.
10618 example: __HOSTNAME__
10619 - name: interface-name
10621 description: Name that identifies the link aggregate interface
10624 example: __INTERFACE-NAME__
10625 - name: interface-name
10627 description: Name given to the interface
10630 example: __INTERFACE-NAME__
10631 - name: vlan-interface
10636 - name: vlan-id-inner
10647 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
10650 - CloudInfrastructure
10651 summary: see node definition for valid relationships
10652 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10661 description: Response codes found in [response codes](https://wiki.onap.org/).
10665 description: Value from executing hostname on the compute node.
10668 example: __HOSTNAME__
10669 - name: interface-name
10671 description: Name that identifies the link aggregate interface
10674 example: __INTERFACE-NAME__
10675 - name: interface-name
10677 description: Name given to the interface
10680 example: __INTERFACE-NAME__
10683 description: PCI ID used to identify the sriov-vf
10686 example: __PCI-ID__
10689 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10692 $ref: "#/definitions/relationship"
10695 - CloudInfrastructure
10696 summary: delete an existing relationship
10697 description: delete an existing relationship
10698 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10707 description: Response codes found in [response codes](https://wiki.onap.org/).
10711 description: Value from executing hostname on the compute node.
10714 example: __HOSTNAME__
10715 - name: interface-name
10717 description: Name that identifies the link aggregate interface
10720 example: __INTERFACE-NAME__
10721 - name: interface-name
10723 description: Name given to the interface
10726 example: __INTERFACE-NAME__
10729 description: PCI ID used to identify the sriov-vf
10732 example: __PCI-ID__
10733 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10736 - CloudInfrastructure
10737 summary: returns sriov-vf
10738 description: returns sriov-vf
10739 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10745 description: successful operation
10747 $ref: "#/getDefinitions/sriov-vf"
10749 description: Response codes found in [response codes](https://wiki.onap.org/).
10753 description: Value from executing hostname on the compute node.
10756 example: __HOSTNAME__
10757 - name: interface-name
10759 description: Name that identifies the link aggregate interface
10762 example: __INTERFACE-NAME__
10763 - name: interface-name
10765 description: Name given to the interface
10768 example: __INTERFACE-NAME__
10771 description: PCI ID used to identify the sriov-vf
10774 example: __PCI-ID__
10777 - CloudInfrastructure
10778 summary: create or update an existing sriov-vf
10780 Create or update an existing sriov-vf.
10782 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10783 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10792 description: Response codes found in [response codes](https://wiki.onap.org/).
10796 description: Value from executing hostname on the compute node.
10799 example: __HOSTNAME__
10800 - name: interface-name
10802 description: Name that identifies the link aggregate interface
10805 example: __INTERFACE-NAME__
10806 - name: interface-name
10808 description: Name given to the interface
10811 example: __INTERFACE-NAME__
10814 description: PCI ID used to identify the sriov-vf
10817 example: __PCI-ID__
10820 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10823 $ref: "#/definitions/sriov-vf"
10826 - CloudInfrastructure
10827 summary: update an existing sriov-vf
10829 Update an existing sriov-vf
10831 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10832 The PUT operation will entirely replace an existing object.
10833 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10835 Other differences between PUT and PATCH are:
10837 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10838 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10839 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10840 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10849 description: Response codes found in [response codes](https://wiki.onap.org/).
10853 description: Value from executing hostname on the compute node.
10856 example: __HOSTNAME__
10857 - name: interface-name
10859 description: Name that identifies the link aggregate interface
10862 example: __INTERFACE-NAME__
10863 - name: interface-name
10865 description: Name given to the interface
10868 example: __INTERFACE-NAME__
10871 description: PCI ID used to identify the sriov-vf
10874 example: __PCI-ID__
10877 description: sriov-vf object that needs to be updated.
10880 $ref: "#/patchDefinitions/sriov-vf"
10883 - CloudInfrastructure
10884 summary: delete an existing sriov-vf
10885 description: delete an existing sriov-vf
10886 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10895 description: Response codes found in [response codes](https://wiki.onap.org/).
10899 description: Value from executing hostname on the compute node.
10902 example: __HOSTNAME__
10903 - name: interface-name
10905 description: Name that identifies the link aggregate interface
10908 example: __INTERFACE-NAME__
10909 - name: interface-name
10911 description: Name given to the interface
10914 example: __INTERFACE-NAME__
10917 description: PCI ID used to identify the sriov-vf
10920 example: __PCI-ID__
10921 - name: resource-version
10923 description: resource-version for concurrency
10926 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10929 - CloudInfrastructure
10930 summary: returns sriov-vfs
10931 description: returns sriov-vfs
10932 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
10938 description: successful operation
10940 $ref: "#/getDefinitions/sriov-vfs"
10942 description: Response codes found in [response codes](https://wiki.onap.org/).
10946 description: Value from executing hostname on the compute node.
10949 example: __HOSTNAME__
10950 - name: interface-name
10952 description: Name that identifies the link aggregate interface
10955 example: __INTERFACE-NAME__
10956 - name: interface-name
10958 description: Name given to the interface
10961 example: __INTERFACE-NAME__
10967 - name: vf-vlan-filter
10972 - name: vf-mac-filter
10977 - name: vf-vlan-strip
10982 - name: neutron-network-id
10987 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10990 - CloudInfrastructure
10991 summary: see node definition for valid relationships
10992 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
11001 description: Response codes found in [response codes](https://wiki.onap.org/).
11005 description: Value from executing hostname on the compute node.
11008 example: __HOSTNAME__
11009 - name: interface-name
11011 description: Name that identifies the link aggregate interface
11014 example: __INTERFACE-NAME__
11015 - name: interface-name
11017 description: Name given to the interface
11020 example: __INTERFACE-NAME__
11023 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11026 $ref: "#/definitions/relationship"
11029 - CloudInfrastructure
11030 summary: delete an existing relationship
11031 description: delete an existing relationship
11032 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
11041 description: Response codes found in [response codes](https://wiki.onap.org/).
11045 description: Value from executing hostname on the compute node.
11048 example: __HOSTNAME__
11049 - name: interface-name
11051 description: Name that identifies the link aggregate interface
11054 example: __INTERFACE-NAME__
11055 - name: interface-name
11057 description: Name given to the interface
11060 example: __INTERFACE-NAME__
11061 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
11064 - CloudInfrastructure
11065 summary: see node definition for valid relationships
11066 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11075 description: Response codes found in [response codes](https://wiki.onap.org/).
11079 description: Value from executing hostname on the compute node.
11082 example: __HOSTNAME__
11083 - name: interface-name
11085 description: Name that identifies the link aggregate interface
11088 example: __INTERFACE-NAME__
11089 - name: interface-name
11091 description: Name given to the interface
11094 example: __INTERFACE-NAME__
11095 - name: l3-interface-ipv4-address
11097 description: IP address
11100 example: __L3-INTERFACE-IPV4-ADDRESS__
11103 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11106 $ref: "#/definitions/relationship"
11109 - CloudInfrastructure
11110 summary: delete an existing relationship
11111 description: delete an existing relationship
11112 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11121 description: Response codes found in [response codes](https://wiki.onap.org/).
11125 description: Value from executing hostname on the compute node.
11128 example: __HOSTNAME__
11129 - name: interface-name
11131 description: Name that identifies the link aggregate interface
11134 example: __INTERFACE-NAME__
11135 - name: interface-name
11137 description: Name given to the interface
11140 example: __INTERFACE-NAME__
11141 - name: l3-interface-ipv4-address
11143 description: IP address
11146 example: __L3-INTERFACE-IPV4-ADDRESS__
11147 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11150 - CloudInfrastructure
11151 summary: returns l3-interface-ipv4-address-list
11152 description: returns l3-interface-ipv4-address-list
11153 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11159 description: successful operation
11161 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11163 description: Response codes found in [response codes](https://wiki.onap.org/).
11167 description: Value from executing hostname on the compute node.
11170 example: __HOSTNAME__
11171 - name: interface-name
11173 description: Name that identifies the link aggregate interface
11176 example: __INTERFACE-NAME__
11177 - name: interface-name
11179 description: Name given to the interface
11182 example: __INTERFACE-NAME__
11183 - name: l3-interface-ipv4-address
11185 description: IP address
11188 example: __L3-INTERFACE-IPV4-ADDRESS__
11191 - CloudInfrastructure
11192 summary: create or update an existing l3-interface-ipv4-address-list
11194 Create or update an existing l3-interface-ipv4-address-list.
11196 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11197 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11206 description: Response codes found in [response codes](https://wiki.onap.org/).
11210 description: Value from executing hostname on the compute node.
11213 example: __HOSTNAME__
11214 - name: interface-name
11216 description: Name that identifies the link aggregate interface
11219 example: __INTERFACE-NAME__
11220 - name: interface-name
11222 description: Name given to the interface
11225 example: __INTERFACE-NAME__
11226 - name: l3-interface-ipv4-address
11228 description: IP address
11231 example: __L3-INTERFACE-IPV4-ADDRESS__
11234 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11237 $ref: "#/definitions/l3-interface-ipv4-address-list"
11240 - CloudInfrastructure
11241 summary: update an existing l3-interface-ipv4-address-list
11243 Update an existing l3-interface-ipv4-address-list
11245 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11246 The PUT operation will entirely replace an existing object.
11247 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11249 Other differences between PUT and PATCH are:
11251 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11252 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11253 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11254 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11263 description: Response codes found in [response codes](https://wiki.onap.org/).
11267 description: Value from executing hostname on the compute node.
11270 example: __HOSTNAME__
11271 - name: interface-name
11273 description: Name that identifies the link aggregate interface
11276 example: __INTERFACE-NAME__
11277 - name: interface-name
11279 description: Name given to the interface
11282 example: __INTERFACE-NAME__
11283 - name: l3-interface-ipv4-address
11285 description: IP address
11288 example: __L3-INTERFACE-IPV4-ADDRESS__
11291 description: l3-interface-ipv4-address-list object that needs to be updated.
11294 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11297 - CloudInfrastructure
11298 summary: delete an existing l3-interface-ipv4-address-list
11299 description: delete an existing l3-interface-ipv4-address-list
11300 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11309 description: Response codes found in [response codes](https://wiki.onap.org/).
11313 description: Value from executing hostname on the compute node.
11316 example: __HOSTNAME__
11317 - name: interface-name
11319 description: Name that identifies the link aggregate interface
11322 example: __INTERFACE-NAME__
11323 - name: interface-name
11325 description: Name given to the interface
11328 example: __INTERFACE-NAME__
11329 - name: l3-interface-ipv4-address
11331 description: IP address
11334 example: __L3-INTERFACE-IPV4-ADDRESS__
11335 - name: resource-version
11337 description: resource-version for concurrency
11340 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11343 - CloudInfrastructure
11344 summary: see node definition for valid relationships
11345 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11354 description: Response codes found in [response codes](https://wiki.onap.org/).
11358 description: Value from executing hostname on the compute node.
11361 example: __HOSTNAME__
11362 - name: interface-name
11364 description: Name that identifies the link aggregate interface
11367 example: __INTERFACE-NAME__
11368 - name: interface-name
11370 description: Name given to the interface
11373 example: __INTERFACE-NAME__
11374 - name: l3-interface-ipv6-address
11376 description: IP address
11379 example: __L3-INTERFACE-IPV6-ADDRESS__
11382 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11385 $ref: "#/definitions/relationship"
11388 - CloudInfrastructure
11389 summary: delete an existing relationship
11390 description: delete an existing relationship
11391 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11400 description: Response codes found in [response codes](https://wiki.onap.org/).
11404 description: Value from executing hostname on the compute node.
11407 example: __HOSTNAME__
11408 - name: interface-name
11410 description: Name that identifies the link aggregate interface
11413 example: __INTERFACE-NAME__
11414 - name: interface-name
11416 description: Name given to the interface
11419 example: __INTERFACE-NAME__
11420 - name: l3-interface-ipv6-address
11422 description: IP address
11425 example: __L3-INTERFACE-IPV6-ADDRESS__
11426 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11429 - CloudInfrastructure
11430 summary: returns l3-interface-ipv6-address-list
11431 description: returns l3-interface-ipv6-address-list
11432 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11438 description: successful operation
11440 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11442 description: Response codes found in [response codes](https://wiki.onap.org/).
11446 description: Value from executing hostname on the compute node.
11449 example: __HOSTNAME__
11450 - name: interface-name
11452 description: Name that identifies the link aggregate interface
11455 example: __INTERFACE-NAME__
11456 - name: interface-name
11458 description: Name given to the interface
11461 example: __INTERFACE-NAME__
11462 - name: l3-interface-ipv6-address
11464 description: IP address
11467 example: __L3-INTERFACE-IPV6-ADDRESS__
11470 - CloudInfrastructure
11471 summary: create or update an existing l3-interface-ipv6-address-list
11473 Create or update an existing l3-interface-ipv6-address-list.
11475 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11476 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11485 description: Response codes found in [response codes](https://wiki.onap.org/).
11489 description: Value from executing hostname on the compute node.
11492 example: __HOSTNAME__
11493 - name: interface-name
11495 description: Name that identifies the link aggregate interface
11498 example: __INTERFACE-NAME__
11499 - name: interface-name
11501 description: Name given to the interface
11504 example: __INTERFACE-NAME__
11505 - name: l3-interface-ipv6-address
11507 description: IP address
11510 example: __L3-INTERFACE-IPV6-ADDRESS__
11513 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11516 $ref: "#/definitions/l3-interface-ipv6-address-list"
11519 - CloudInfrastructure
11520 summary: update an existing l3-interface-ipv6-address-list
11522 Update an existing l3-interface-ipv6-address-list
11524 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11525 The PUT operation will entirely replace an existing object.
11526 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11528 Other differences between PUT and PATCH are:
11530 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11531 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11532 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11533 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11542 description: Response codes found in [response codes](https://wiki.onap.org/).
11546 description: Value from executing hostname on the compute node.
11549 example: __HOSTNAME__
11550 - name: interface-name
11552 description: Name that identifies the link aggregate interface
11555 example: __INTERFACE-NAME__
11556 - name: interface-name
11558 description: Name given to the interface
11561 example: __INTERFACE-NAME__
11562 - name: l3-interface-ipv6-address
11564 description: IP address
11567 example: __L3-INTERFACE-IPV6-ADDRESS__
11570 description: l3-interface-ipv6-address-list object that needs to be updated.
11573 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11576 - CloudInfrastructure
11577 summary: delete an existing l3-interface-ipv6-address-list
11578 description: delete an existing l3-interface-ipv6-address-list
11579 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11588 description: Response codes found in [response codes](https://wiki.onap.org/).
11592 description: Value from executing hostname on the compute node.
11595 example: __HOSTNAME__
11596 - name: interface-name
11598 description: Name that identifies the link aggregate interface
11601 example: __INTERFACE-NAME__
11602 - name: interface-name
11604 description: Name given to the interface
11607 example: __INTERFACE-NAME__
11608 - name: l3-interface-ipv6-address
11610 description: IP address
11613 example: __L3-INTERFACE-IPV6-ADDRESS__
11614 - name: resource-version
11616 description: resource-version for concurrency
11619 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11622 - CloudInfrastructure
11623 summary: returns l-interface
11624 description: returns l-interface
11625 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11631 description: successful operation
11633 $ref: "#/getDefinitions/l-interface"
11635 description: Response codes found in [response codes](https://wiki.onap.org/).
11639 description: Value from executing hostname on the compute node.
11642 example: __HOSTNAME__
11643 - name: interface-name
11645 description: Name that identifies the link aggregate interface
11648 example: __INTERFACE-NAME__
11649 - name: interface-name
11651 description: Name given to the interface
11654 example: __INTERFACE-NAME__
11657 - CloudInfrastructure
11658 summary: create or update an existing l-interface
11660 Create or update an existing l-interface.
11662 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11663 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11672 description: Response codes found in [response codes](https://wiki.onap.org/).
11676 description: Value from executing hostname on the compute node.
11679 example: __HOSTNAME__
11680 - name: interface-name
11682 description: Name that identifies the link aggregate interface
11685 example: __INTERFACE-NAME__
11686 - name: interface-name
11688 description: Name given to the interface
11691 example: __INTERFACE-NAME__
11694 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11697 $ref: "#/definitions/l-interface"
11700 - CloudInfrastructure
11701 summary: update an existing l-interface
11703 Update an existing l-interface
11705 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11706 The PUT operation will entirely replace an existing object.
11707 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11709 Other differences between PUT and PATCH are:
11711 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11712 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11713 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11714 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11723 description: Response codes found in [response codes](https://wiki.onap.org/).
11727 description: Value from executing hostname on the compute node.
11730 example: __HOSTNAME__
11731 - name: interface-name
11733 description: Name that identifies the link aggregate interface
11736 example: __INTERFACE-NAME__
11737 - name: interface-name
11739 description: Name given to the interface
11742 example: __INTERFACE-NAME__
11745 description: l-interface object that needs to be updated.
11748 $ref: "#/patchDefinitions/l-interface"
11751 - CloudInfrastructure
11752 summary: delete an existing l-interface
11753 description: delete an existing l-interface
11754 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11763 description: Response codes found in [response codes](https://wiki.onap.org/).
11767 description: Value from executing hostname on the compute node.
11770 example: __HOSTNAME__
11771 - name: interface-name
11773 description: Name that identifies the link aggregate interface
11776 example: __INTERFACE-NAME__
11777 - name: interface-name
11779 description: Name given to the interface
11782 example: __INTERFACE-NAME__
11783 - name: resource-version
11785 description: resource-version for concurrency
11788 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
11791 - CloudInfrastructure
11792 summary: returns l-interfaces
11793 description: returns l-interfaces
11794 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
11800 description: successful operation
11802 $ref: "#/getDefinitions/l-interfaces"
11804 description: Response codes found in [response codes](https://wiki.onap.org/).
11808 description: Value from executing hostname on the compute node.
11811 example: __HOSTNAME__
11812 - name: interface-name
11814 description: Name that identifies the link aggregate interface
11817 example: __INTERFACE-NAME__
11818 - name: interface-name
11823 - name: interface-id
11833 - name: network-name
11838 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
11841 - CloudInfrastructure
11842 summary: returns lag-interface
11843 description: returns lag-interface
11844 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
11850 description: successful operation
11852 $ref: "#/getDefinitions/lag-interface"
11854 description: Response codes found in [response codes](https://wiki.onap.org/).
11858 description: Value from executing hostname on the compute node.
11861 example: __HOSTNAME__
11862 - name: interface-name
11864 description: Name that identifies the link aggregate interface
11867 example: __INTERFACE-NAME__
11870 - CloudInfrastructure
11871 summary: create or update an existing lag-interface
11873 Create or update an existing lag-interface.
11875 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11876 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11885 description: Response codes found in [response codes](https://wiki.onap.org/).
11889 description: Value from executing hostname on the compute node.
11892 example: __HOSTNAME__
11893 - name: interface-name
11895 description: Name that identifies the link aggregate interface
11898 example: __INTERFACE-NAME__
11901 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11904 $ref: "#/definitions/lag-interface"
11907 - CloudInfrastructure
11908 summary: update an existing lag-interface
11910 Update an existing lag-interface
11912 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11913 The PUT operation will entirely replace an existing object.
11914 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11916 Other differences between PUT and PATCH are:
11918 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11919 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11920 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11921 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11930 description: Response codes found in [response codes](https://wiki.onap.org/).
11934 description: Value from executing hostname on the compute node.
11937 example: __HOSTNAME__
11938 - name: interface-name
11940 description: Name that identifies the link aggregate interface
11943 example: __INTERFACE-NAME__
11946 description: lag-interface object that needs to be updated.
11949 $ref: "#/patchDefinitions/lag-interface"
11952 - CloudInfrastructure
11953 summary: delete an existing lag-interface
11954 description: delete an existing lag-interface
11955 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
11964 description: Response codes found in [response codes](https://wiki.onap.org/).
11968 description: Value from executing hostname on the compute node.
11971 example: __HOSTNAME__
11972 - name: interface-name
11974 description: Name that identifies the link aggregate interface
11977 example: __INTERFACE-NAME__
11978 - name: resource-version
11980 description: resource-version for concurrency
11983 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
11986 - CloudInfrastructure
11987 summary: returns lag-interfaces
11988 description: returns lag-interfaces
11989 operationId: getCloudInfrastructurePserversPserverLagInterfaces
11995 description: successful operation
11997 $ref: "#/getDefinitions/lag-interfaces"
11999 description: Response codes found in [response codes](https://wiki.onap.org/).
12003 description: Value from executing hostname on the compute node.
12006 example: __HOSTNAME__
12007 - name: interface-name
12012 - name: interface-id
12017 - name: interface-role
12022 /cloud-infrastructure/pservers/pserver/{hostname}:
12025 - CloudInfrastructure
12026 summary: returns pserver
12027 description: returns pserver
12028 operationId: getCloudInfrastructurePserversPserver
12034 description: successful operation
12036 $ref: "#/getDefinitions/pserver"
12038 description: Response codes found in [response codes](https://wiki.onap.org/).
12042 description: Value from executing hostname on the compute node.
12045 example: __HOSTNAME__
12048 - CloudInfrastructure
12049 summary: create or update an existing pserver
12051 Create or update an existing pserver.
12053 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12054 operationId: createOrUpdateCloudInfrastructurePserversPserver
12063 description: Response codes found in [response codes](https://wiki.onap.org/).
12067 description: Value from executing hostname on the compute node.
12070 example: __HOSTNAME__
12073 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)
12076 $ref: "#/definitions/pserver"
12079 - CloudInfrastructure
12080 summary: update an existing pserver
12082 Update an existing pserver
12084 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12085 The PUT operation will entirely replace an existing object.
12086 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12088 Other differences between PUT and PATCH are:
12090 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12091 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12092 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12093 operationId: UpdateCloudInfrastructurePserversPserver
12102 description: Response codes found in [response codes](https://wiki.onap.org/).
12106 description: Value from executing hostname on the compute node.
12109 example: __HOSTNAME__
12112 description: pserver object that needs to be updated.
12115 $ref: "#/patchDefinitions/pserver"
12118 - CloudInfrastructure
12119 summary: delete an existing pserver
12120 description: delete an existing pserver
12121 operationId: deleteCloudInfrastructurePserversPserver
12130 description: Response codes found in [response codes](https://wiki.onap.org/).
12134 description: Value from executing hostname on the compute node.
12137 example: __HOSTNAME__
12138 - name: resource-version
12140 description: resource-version for concurrency
12143 /cloud-infrastructure/pservers:
12146 - CloudInfrastructure
12147 summary: returns pservers
12148 description: returns pservers
12149 operationId: getCloudInfrastructurePservers
12155 description: successful operation
12157 $ref: "#/getDefinitions/pservers"
12159 description: Response codes found in [response codes](https://wiki.onap.org/).
12181 - name: pserver-name2
12186 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
12189 - CloudInfrastructure
12190 summary: see node definition for valid relationships
12191 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12200 description: Response codes found in [response codes](https://wiki.onap.org/).
12204 description: Unique ID of the vdc
12207 example: __VDC-ID__
12210 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12213 $ref: "#/definitions/relationship"
12216 - CloudInfrastructure
12217 summary: delete an existing relationship
12218 description: delete an existing relationship
12219 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12228 description: Response codes found in [response codes](https://wiki.onap.org/).
12232 description: Unique ID of the vdc
12235 example: __VDC-ID__
12236 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
12239 - CloudInfrastructure
12240 summary: returns virtual-data-center
12241 description: returns virtual-data-center
12242 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
12248 description: successful operation
12250 $ref: "#/getDefinitions/virtual-data-center"
12252 description: Response codes found in [response codes](https://wiki.onap.org/).
12256 description: Unique ID of the vdc
12259 example: __VDC-ID__
12262 - CloudInfrastructure
12263 summary: create or update an existing virtual-data-center
12265 Create or update an existing virtual-data-center.
12267 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12268 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12277 description: Response codes found in [response codes](https://wiki.onap.org/).
12281 description: Unique ID of the vdc
12284 example: __VDC-ID__
12287 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12290 $ref: "#/definitions/virtual-data-center"
12293 - CloudInfrastructure
12294 summary: update an existing virtual-data-center
12296 Update an existing virtual-data-center
12298 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12299 The PUT operation will entirely replace an existing object.
12300 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12302 Other differences between PUT and PATCH are:
12304 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12305 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12306 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12307 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12316 description: Response codes found in [response codes](https://wiki.onap.org/).
12320 description: Unique ID of the vdc
12323 example: __VDC-ID__
12326 description: virtual-data-center object that needs to be updated.
12329 $ref: "#/patchDefinitions/virtual-data-center"
12332 - CloudInfrastructure
12333 summary: delete an existing virtual-data-center
12334 description: delete an existing virtual-data-center
12335 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
12344 description: Response codes found in [response codes](https://wiki.onap.org/).
12348 description: Unique ID of the vdc
12351 example: __VDC-ID__
12352 - name: resource-version
12354 description: resource-version for concurrency
12357 /cloud-infrastructure/virtual-data-centers:
12360 - CloudInfrastructure
12361 summary: returns virtual-data-centers
12362 description: returns virtual-data-centers
12363 operationId: getCloudInfrastructureVirtualDataCenters
12369 description: successful operation
12371 $ref: "#/getDefinitions/virtual-data-centers"
12373 description: Response codes found in [response codes](https://wiki.onap.org/).
12385 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
12389 summary: see node definition for valid relationships
12390 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
12399 description: Response codes found in [response codes](https://wiki.onap.org/).
12401 - name: resource-instance-id
12403 description: Unique id of resource instance.
12406 example: __RESOURCE-INSTANCE-ID__
12409 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)
12412 $ref: "#/definitions/relationship"
12416 summary: delete an existing relationship
12417 description: delete an existing relationship
12418 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
12427 description: Response codes found in [response codes](https://wiki.onap.org/).
12429 - name: resource-instance-id
12431 description: Unique id of resource instance.
12434 example: __RESOURCE-INSTANCE-ID__
12435 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
12439 summary: returns metadatum
12440 description: returns metadatum
12441 operationId: getBusinessConnectorsConnectorMetadataMetadatum
12447 description: successful operation
12449 $ref: "#/getDefinitions/metadatum"
12451 description: Response codes found in [response codes](https://wiki.onap.org/).
12453 - name: resource-instance-id
12455 description: Unique id of resource instance.
12458 example: __RESOURCE-INSTANCE-ID__
12463 example: __METANAME__
12467 summary: create or update an existing metadatum
12469 Create or update an existing metadatum.
12471 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12472 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
12481 description: Response codes found in [response codes](https://wiki.onap.org/).
12483 - name: resource-instance-id
12485 description: Unique id of resource instance.
12488 example: __RESOURCE-INSTANCE-ID__
12493 example: __METANAME__
12496 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnectorMetadataMetadatum.json)
12499 $ref: "#/definitions/metadatum"
12503 summary: update an existing metadatum
12505 Update an existing metadatum
12507 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12508 The PUT operation will entirely replace an existing object.
12509 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12511 Other differences between PUT and PATCH are:
12513 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12514 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12515 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12516 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
12525 description: Response codes found in [response codes](https://wiki.onap.org/).
12527 - name: resource-instance-id
12529 description: Unique id of resource instance.
12532 example: __RESOURCE-INSTANCE-ID__
12537 example: __METANAME__
12540 description: metadatum object that needs to be updated.
12543 $ref: "#/patchDefinitions/metadatum"
12547 summary: delete an existing metadatum
12548 description: delete an existing metadatum
12549 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
12558 description: Response codes found in [response codes](https://wiki.onap.org/).
12560 - name: resource-instance-id
12562 description: Unique id of resource instance.
12565 example: __RESOURCE-INSTANCE-ID__
12570 example: __METANAME__
12571 - name: resource-version
12573 description: resource-version for concurrency
12576 /business/connectors/connector/{resource-instance-id}/metadata:
12580 summary: returns metadata
12581 description: returns metadata
12582 operationId: getBusinessConnectorsConnectorMetadata
12588 description: successful operation
12590 $ref: "#/getDefinitions/metadata"
12592 description: Response codes found in [response codes](https://wiki.onap.org/).
12594 - name: resource-instance-id
12596 description: Unique id of resource instance.
12599 example: __RESOURCE-INSTANCE-ID__
12605 /business/connectors/connector/{resource-instance-id}:
12609 summary: returns connector
12610 description: returns connector
12611 operationId: getBusinessConnectorsConnector
12617 description: successful operation
12619 $ref: "#/getDefinitions/connector"
12621 description: Response codes found in [response codes](https://wiki.onap.org/).
12623 - name: resource-instance-id
12625 description: Unique id of resource instance.
12628 example: __RESOURCE-INSTANCE-ID__
12632 summary: create or update an existing connector
12634 Create or update an existing connector.
12636 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12637 operationId: createOrUpdateBusinessConnectorsConnector
12646 description: Response codes found in [response codes](https://wiki.onap.org/).
12648 - name: resource-instance-id
12650 description: Unique id of resource instance.
12653 example: __RESOURCE-INSTANCE-ID__
12656 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)
12659 $ref: "#/definitions/connector"
12663 summary: update an existing connector
12665 Update an existing connector
12667 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12668 The PUT operation will entirely replace an existing object.
12669 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12671 Other differences between PUT and PATCH are:
12673 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12674 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12675 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12676 operationId: UpdateBusinessConnectorsConnector
12685 description: Response codes found in [response codes](https://wiki.onap.org/).
12687 - name: resource-instance-id
12689 description: Unique id of resource instance.
12692 example: __RESOURCE-INSTANCE-ID__
12695 description: connector object that needs to be updated.
12698 $ref: "#/patchDefinitions/connector"
12702 summary: delete an existing connector
12703 description: delete an existing connector
12704 operationId: deleteBusinessConnectorsConnector
12713 description: Response codes found in [response codes](https://wiki.onap.org/).
12715 - name: resource-instance-id
12717 description: Unique id of resource instance.
12720 example: __RESOURCE-INSTANCE-ID__
12721 - name: resource-version
12723 description: resource-version for concurrency
12726 /business/connectors:
12730 summary: returns connectors
12731 description: returns connectors
12732 operationId: getBusinessConnectors
12738 description: successful operation
12740 $ref: "#/getDefinitions/connectors"
12742 description: Response codes found in [response codes](https://wiki.onap.org/).
12744 - name: resource-instance-id
12749 - name: model-invariant-id
12754 - name: model-version-id
12759 - name: widget-model-id
12764 - name: widget-model-version
12769 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
12773 summary: see node definition for valid relationships
12774 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12783 description: Response codes found in [response codes](https://wiki.onap.org/).
12785 - name: global-customer-id
12787 description: Global customer id used across ECOMP to uniquely identify customer.
12790 example: __GLOBAL-CUSTOMER-ID__
12791 - name: service-type
12793 description: Value defined by orchestration to identify this service across ECOMP.
12796 example: __SERVICE-TYPE__
12797 - name: service-instance-id
12799 description: Uniquely identifies this instance of a service
12802 example: __SERVICE-INSTANCE-ID__
12805 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
12808 $ref: "#/definitions/relationship"
12812 summary: delete an existing relationship
12813 description: delete an existing relationship
12814 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12823 description: Response codes found in [response codes](https://wiki.onap.org/).
12825 - name: global-customer-id
12827 description: Global customer id used across ECOMP to uniquely identify customer.
12830 example: __GLOBAL-CUSTOMER-ID__
12831 - name: service-type
12833 description: Value defined by orchestration to identify this service across ECOMP.
12836 example: __SERVICE-TYPE__
12837 - name: service-instance-id
12839 description: Uniquely identifies this instance of a service
12842 example: __SERVICE-INSTANCE-ID__
12843 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
12847 summary: returns metadatum
12848 description: returns metadatum
12849 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12855 description: successful operation
12857 $ref: "#/getDefinitions/metadatum"
12859 description: Response codes found in [response codes](https://wiki.onap.org/).
12861 - name: global-customer-id
12863 description: Global customer id used across ECOMP to uniquely identify customer.
12866 example: __GLOBAL-CUSTOMER-ID__
12867 - name: service-type
12869 description: Value defined by orchestration to identify this service across ECOMP.
12872 example: __SERVICE-TYPE__
12873 - name: service-instance-id
12875 description: Uniquely identifies this instance of a service
12878 example: __SERVICE-INSTANCE-ID__
12883 example: __METANAME__
12887 summary: create or update an existing metadatum
12889 Create or update an existing metadatum.
12891 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12892 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12901 description: Response codes found in [response codes](https://wiki.onap.org/).
12903 - name: global-customer-id
12905 description: Global customer id used across ECOMP to uniquely identify customer.
12908 example: __GLOBAL-CUSTOMER-ID__
12909 - name: service-type
12911 description: Value defined by orchestration to identify this service across ECOMP.
12914 example: __SERVICE-TYPE__
12915 - name: service-instance-id
12917 description: Uniquely identifies this instance of a service
12920 example: __SERVICE-INSTANCE-ID__
12925 example: __METANAME__
12928 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
12931 $ref: "#/definitions/metadatum"
12935 summary: update an existing metadatum
12937 Update an existing metadatum
12939 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12940 The PUT operation will entirely replace an existing object.
12941 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12943 Other differences between PUT and PATCH are:
12945 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12946 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12947 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12948 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12957 description: Response codes found in [response codes](https://wiki.onap.org/).
12959 - name: global-customer-id
12961 description: Global customer id used across ECOMP to uniquely identify customer.
12964 example: __GLOBAL-CUSTOMER-ID__
12965 - name: service-type
12967 description: Value defined by orchestration to identify this service across ECOMP.
12970 example: __SERVICE-TYPE__
12971 - name: service-instance-id
12973 description: Uniquely identifies this instance of a service
12976 example: __SERVICE-INSTANCE-ID__
12981 example: __METANAME__
12984 description: metadatum object that needs to be updated.
12987 $ref: "#/patchDefinitions/metadatum"
12991 summary: delete an existing metadatum
12992 description: delete an existing metadatum
12993 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
13002 description: Response codes found in [response codes](https://wiki.onap.org/).
13004 - name: global-customer-id
13006 description: Global customer id used across ECOMP to uniquely identify customer.
13009 example: __GLOBAL-CUSTOMER-ID__
13010 - name: service-type
13012 description: Value defined by orchestration to identify this service across ECOMP.
13015 example: __SERVICE-TYPE__
13016 - name: service-instance-id
13018 description: Uniquely identifies this instance of a service
13021 example: __SERVICE-INSTANCE-ID__
13026 example: __METANAME__
13027 - name: resource-version
13029 description: resource-version for concurrency
13032 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
13036 summary: returns metadata
13037 description: returns metadata
13038 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
13044 description: successful operation
13046 $ref: "#/getDefinitions/metadata"
13048 description: Response codes found in [response codes](https://wiki.onap.org/).
13050 - name: global-customer-id
13052 description: Global customer id used across ECOMP to uniquely identify customer.
13055 example: __GLOBAL-CUSTOMER-ID__
13056 - name: service-type
13058 description: Value defined by orchestration to identify this service across ECOMP.
13061 example: __SERVICE-TYPE__
13062 - name: service-instance-id
13064 description: Uniquely identifies this instance of a service
13067 example: __SERVICE-INSTANCE-ID__
13073 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
13077 summary: see node definition for valid relationships
13078 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
13087 description: Response codes found in [response codes](https://wiki.onap.org/).
13089 - name: global-customer-id
13091 description: Global customer id used across ECOMP to uniquely identify customer.
13094 example: __GLOBAL-CUSTOMER-ID__
13095 - name: service-type
13097 description: Value defined by orchestration to identify this service across ECOMP.
13100 example: __SERVICE-TYPE__
13101 - name: service-instance-id
13103 description: Uniquely identifies this instance of a service
13106 example: __SERVICE-INSTANCE-ID__
13109 description: Allotted Resource id UUID assigned to this instance.
13115 description: Allotted Resource id UUID assigned to this instance.
13121 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
13124 $ref: "#/definitions/relationship"
13128 summary: delete an existing relationship
13129 description: delete an existing relationship
13130 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
13139 description: Response codes found in [response codes](https://wiki.onap.org/).
13141 - name: global-customer-id
13143 description: Global customer id used across ECOMP to uniquely identify customer.
13146 example: __GLOBAL-CUSTOMER-ID__
13147 - name: service-type
13149 description: Value defined by orchestration to identify this service across ECOMP.
13152 example: __SERVICE-TYPE__
13153 - name: service-instance-id
13155 description: Uniquely identifies this instance of a service
13158 example: __SERVICE-INSTANCE-ID__
13161 description: Allotted Resource id UUID assigned to this instance.
13167 description: Allotted Resource id UUID assigned to this instance.
13171 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
13175 summary: returns tunnel-xconnect
13176 description: returns tunnel-xconnect
13177 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13183 description: successful operation
13185 $ref: "#/getDefinitions/tunnel-xconnect"
13187 description: Response codes found in [response codes](https://wiki.onap.org/).
13189 - name: global-customer-id
13191 description: Global customer id used across ECOMP to uniquely identify customer.
13194 example: __GLOBAL-CUSTOMER-ID__
13195 - name: service-type
13197 description: Value defined by orchestration to identify this service across ECOMP.
13200 example: __SERVICE-TYPE__
13201 - name: service-instance-id
13203 description: Uniquely identifies this instance of a service
13206 example: __SERVICE-INSTANCE-ID__
13209 description: Allotted Resource id UUID assigned to this instance.
13215 description: Allotted Resource id UUID assigned to this instance.
13222 summary: create or update an existing tunnel-xconnect
13224 Create or update an existing tunnel-xconnect.
13226 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13227 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13236 description: Response codes found in [response codes](https://wiki.onap.org/).
13238 - name: global-customer-id
13240 description: Global customer id used across ECOMP to uniquely identify customer.
13243 example: __GLOBAL-CUSTOMER-ID__
13244 - name: service-type
13246 description: Value defined by orchestration to identify this service across ECOMP.
13249 example: __SERVICE-TYPE__
13250 - name: service-instance-id
13252 description: Uniquely identifies this instance of a service
13255 example: __SERVICE-INSTANCE-ID__
13258 description: Allotted Resource id UUID assigned to this instance.
13264 description: Allotted Resource id UUID assigned to this instance.
13270 description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
13273 $ref: "#/definitions/tunnel-xconnect"
13277 summary: update an existing tunnel-xconnect
13279 Update an existing tunnel-xconnect
13281 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13282 The PUT operation will entirely replace an existing object.
13283 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13285 Other differences between PUT and PATCH are:
13287 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13288 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13289 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13290 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13299 description: Response codes found in [response codes](https://wiki.onap.org/).
13301 - name: global-customer-id
13303 description: Global customer id used across ECOMP to uniquely identify customer.
13306 example: __GLOBAL-CUSTOMER-ID__
13307 - name: service-type
13309 description: Value defined by orchestration to identify this service across ECOMP.
13312 example: __SERVICE-TYPE__
13313 - name: service-instance-id
13315 description: Uniquely identifies this instance of a service
13318 example: __SERVICE-INSTANCE-ID__
13321 description: Allotted Resource id UUID assigned to this instance.
13327 description: Allotted Resource id UUID assigned to this instance.
13333 description: tunnel-xconnect object that needs to be updated.
13336 $ref: "#/patchDefinitions/tunnel-xconnect"
13340 summary: delete an existing tunnel-xconnect
13341 description: delete an existing tunnel-xconnect
13342 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13351 description: Response codes found in [response codes](https://wiki.onap.org/).
13353 - name: global-customer-id
13355 description: Global customer id used across ECOMP to uniquely identify customer.
13358 example: __GLOBAL-CUSTOMER-ID__
13359 - name: service-type
13361 description: Value defined by orchestration to identify this service across ECOMP.
13364 example: __SERVICE-TYPE__
13365 - name: service-instance-id
13367 description: Uniquely identifies this instance of a service
13370 example: __SERVICE-INSTANCE-ID__
13373 description: Allotted Resource id UUID assigned to this instance.
13379 description: Allotted Resource id UUID assigned to this instance.
13383 - name: resource-version
13385 description: resource-version for concurrency
13388 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
13392 summary: returns tunnel-xconnects
13393 description: returns tunnel-xconnects
13394 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
13400 description: successful operation
13402 $ref: "#/getDefinitions/tunnel-xconnects"
13404 description: Response codes found in [response codes](https://wiki.onap.org/).
13406 - name: global-customer-id
13408 description: Global customer id used across ECOMP to uniquely identify customer.
13411 example: __GLOBAL-CUSTOMER-ID__
13412 - name: service-type
13414 description: Value defined by orchestration to identify this service across ECOMP.
13417 example: __SERVICE-TYPE__
13418 - name: service-instance-id
13420 description: Uniquely identifies this instance of a service
13423 example: __SERVICE-INSTANCE-ID__
13426 description: Allotted Resource id UUID assigned to this instance.
13435 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
13439 summary: see node definition for valid relationships
13440 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
13449 description: Response codes found in [response codes](https://wiki.onap.org/).
13451 - name: global-customer-id
13453 description: Global customer id used across ECOMP to uniquely identify customer.
13456 example: __GLOBAL-CUSTOMER-ID__
13457 - name: service-type
13459 description: Value defined by orchestration to identify this service across ECOMP.
13462 example: __SERVICE-TYPE__
13463 - name: service-instance-id
13465 description: Uniquely identifies this instance of a service
13468 example: __SERVICE-INSTANCE-ID__
13471 description: Allotted Resource id UUID assigned to this instance.
13477 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
13480 $ref: "#/definitions/relationship"
13484 summary: delete an existing relationship
13485 description: delete an existing relationship
13486 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
13495 description: Response codes found in [response codes](https://wiki.onap.org/).
13497 - name: global-customer-id
13499 description: Global customer id used across ECOMP to uniquely identify customer.
13502 example: __GLOBAL-CUSTOMER-ID__
13503 - name: service-type
13505 description: Value defined by orchestration to identify this service across ECOMP.
13508 example: __SERVICE-TYPE__
13509 - name: service-instance-id
13511 description: Uniquely identifies this instance of a service
13514 example: __SERVICE-INSTANCE-ID__
13517 description: Allotted Resource id UUID assigned to this instance.
13521 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
13525 summary: returns allotted-resource
13526 description: returns allotted-resource
13527 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13533 description: successful operation
13535 $ref: "#/getDefinitions/allotted-resource"
13537 description: Response codes found in [response codes](https://wiki.onap.org/).
13539 - name: global-customer-id
13541 description: Global customer id used across ECOMP to uniquely identify customer.
13544 example: __GLOBAL-CUSTOMER-ID__
13545 - name: service-type
13547 description: Value defined by orchestration to identify this service across ECOMP.
13550 example: __SERVICE-TYPE__
13551 - name: service-instance-id
13553 description: Uniquely identifies this instance of a service
13556 example: __SERVICE-INSTANCE-ID__
13559 description: Allotted Resource id UUID assigned to this instance.
13566 summary: create or update an existing allotted-resource
13568 Create or update an existing allotted-resource.
13570 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13571 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13580 description: Response codes found in [response codes](https://wiki.onap.org/).
13582 - name: global-customer-id
13584 description: Global customer id used across ECOMP to uniquely identify customer.
13587 example: __GLOBAL-CUSTOMER-ID__
13588 - name: service-type
13590 description: Value defined by orchestration to identify this service across ECOMP.
13593 example: __SERVICE-TYPE__
13594 - name: service-instance-id
13596 description: Uniquely identifies this instance of a service
13599 example: __SERVICE-INSTANCE-ID__
13602 description: Allotted Resource id UUID assigned to this instance.
13608 description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
13611 $ref: "#/definitions/allotted-resource"
13615 summary: update an existing allotted-resource
13617 Update an existing allotted-resource
13619 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13620 The PUT operation will entirely replace an existing object.
13621 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13623 Other differences between PUT and PATCH are:
13625 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13626 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13627 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13628 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13637 description: Response codes found in [response codes](https://wiki.onap.org/).
13639 - name: global-customer-id
13641 description: Global customer id used across ECOMP to uniquely identify customer.
13644 example: __GLOBAL-CUSTOMER-ID__
13645 - name: service-type
13647 description: Value defined by orchestration to identify this service across ECOMP.
13650 example: __SERVICE-TYPE__
13651 - name: service-instance-id
13653 description: Uniquely identifies this instance of a service
13656 example: __SERVICE-INSTANCE-ID__
13659 description: Allotted Resource id UUID assigned to this instance.
13665 description: allotted-resource object that needs to be updated.
13668 $ref: "#/patchDefinitions/allotted-resource"
13672 summary: delete an existing allotted-resource
13673 description: delete an existing allotted-resource
13674 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13683 description: Response codes found in [response codes](https://wiki.onap.org/).
13685 - name: global-customer-id
13687 description: Global customer id used across ECOMP to uniquely identify customer.
13690 example: __GLOBAL-CUSTOMER-ID__
13691 - name: service-type
13693 description: Value defined by orchestration to identify this service across ECOMP.
13696 example: __SERVICE-TYPE__
13697 - name: service-instance-id
13699 description: Uniquely identifies this instance of a service
13702 example: __SERVICE-INSTANCE-ID__
13705 description: Allotted Resource id UUID assigned to this instance.
13709 - name: resource-version
13711 description: resource-version for concurrency
13714 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
13718 summary: returns allotted-resources
13719 description: returns allotted-resources
13720 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
13726 description: successful operation
13728 $ref: "#/getDefinitions/allotted-resources"
13730 description: Response codes found in [response codes](https://wiki.onap.org/).
13732 - name: global-customer-id
13734 description: Global customer id used across ECOMP to uniquely identify customer.
13737 example: __GLOBAL-CUSTOMER-ID__
13738 - name: service-type
13740 description: Value defined by orchestration to identify this service across ECOMP.
13743 example: __SERVICE-TYPE__
13744 - name: service-instance-id
13746 description: Uniquely identifies this instance of a service
13749 example: __SERVICE-INSTANCE-ID__
13755 - name: model-invariant-id
13760 - name: model-version-id
13775 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
13779 summary: returns service-instance
13780 description: returns service-instance
13781 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13787 description: successful operation
13789 $ref: "#/getDefinitions/service-instance"
13791 description: Response codes found in [response codes](https://wiki.onap.org/).
13793 - name: global-customer-id
13795 description: Global customer id used across ECOMP to uniquely identify customer.
13798 example: __GLOBAL-CUSTOMER-ID__
13799 - name: service-type
13801 description: Value defined by orchestration to identify this service across ECOMP.
13804 example: __SERVICE-TYPE__
13805 - name: service-instance-id
13807 description: Uniquely identifies this instance of a service
13810 example: __SERVICE-INSTANCE-ID__
13814 summary: create or update an existing service-instance
13816 Create or update an existing service-instance.
13818 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13819 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13828 description: Response codes found in [response codes](https://wiki.onap.org/).
13830 - name: global-customer-id
13832 description: Global customer id used across ECOMP to uniquely identify customer.
13835 example: __GLOBAL-CUSTOMER-ID__
13836 - name: service-type
13838 description: Value defined by orchestration to identify this service across ECOMP.
13841 example: __SERVICE-TYPE__
13842 - name: service-instance-id
13844 description: Uniquely identifies this instance of a service
13847 example: __SERVICE-INSTANCE-ID__
13850 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
13853 $ref: "#/definitions/service-instance"
13857 summary: update an existing service-instance
13859 Update an existing service-instance
13861 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13862 The PUT operation will entirely replace an existing object.
13863 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13865 Other differences between PUT and PATCH are:
13867 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13868 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13869 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13870 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13879 description: Response codes found in [response codes](https://wiki.onap.org/).
13881 - name: global-customer-id
13883 description: Global customer id used across ECOMP to uniquely identify customer.
13886 example: __GLOBAL-CUSTOMER-ID__
13887 - name: service-type
13889 description: Value defined by orchestration to identify this service across ECOMP.
13892 example: __SERVICE-TYPE__
13893 - name: service-instance-id
13895 description: Uniquely identifies this instance of a service
13898 example: __SERVICE-INSTANCE-ID__
13901 description: service-instance object that needs to be updated.
13904 $ref: "#/patchDefinitions/service-instance"
13908 summary: delete an existing service-instance
13909 description: delete an existing service-instance
13910 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13919 description: Response codes found in [response codes](https://wiki.onap.org/).
13921 - name: global-customer-id
13923 description: Global customer id used across ECOMP to uniquely identify customer.
13926 example: __GLOBAL-CUSTOMER-ID__
13927 - name: service-type
13929 description: Value defined by orchestration to identify this service across ECOMP.
13932 example: __SERVICE-TYPE__
13933 - name: service-instance-id
13935 description: Uniquely identifies this instance of a service
13938 example: __SERVICE-INSTANCE-ID__
13939 - name: resource-version
13941 description: resource-version for concurrency
13944 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
13948 summary: returns service-instances
13949 description: returns service-instances
13950 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
13956 description: successful operation
13958 $ref: "#/getDefinitions/service-instances"
13960 description: Response codes found in [response codes](https://wiki.onap.org/).
13962 - name: global-customer-id
13964 description: Global customer id used across ECOMP to uniquely identify customer.
13967 example: __GLOBAL-CUSTOMER-ID__
13968 - name: service-type
13970 description: Value defined by orchestration to identify this service across ECOMP.
13973 example: __SERVICE-TYPE__
13974 - name: service-instance-id
13979 - name: service-instance-name
13984 - name: model-invariant-id
13989 - name: model-version-id
13994 - name: widget-model-id
13999 - name: widget-model-version
14004 - name: service-instance-location-id
14009 - name: orchestration-status
14014 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
14018 summary: see node definition for valid relationships
14019 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14028 description: Response codes found in [response codes](https://wiki.onap.org/).
14030 - name: global-customer-id
14032 description: Global customer id used across ECOMP to uniquely identify customer.
14035 example: __GLOBAL-CUSTOMER-ID__
14036 - name: service-type
14038 description: Value defined by orchestration to identify this service across ECOMP.
14041 example: __SERVICE-TYPE__
14044 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14047 $ref: "#/definitions/relationship"
14051 summary: delete an existing relationship
14052 description: delete an existing relationship
14053 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14062 description: Response codes found in [response codes](https://wiki.onap.org/).
14064 - name: global-customer-id
14066 description: Global customer id used across ECOMP to uniquely identify customer.
14069 example: __GLOBAL-CUSTOMER-ID__
14070 - name: service-type
14072 description: Value defined by orchestration to identify this service across ECOMP.
14075 example: __SERVICE-TYPE__
14076 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
14080 summary: returns service-subscription
14081 description: returns service-subscription
14082 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14088 description: successful operation
14090 $ref: "#/getDefinitions/service-subscription"
14092 description: Response codes found in [response codes](https://wiki.onap.org/).
14094 - name: global-customer-id
14096 description: Global customer id used across ECOMP to uniquely identify customer.
14099 example: __GLOBAL-CUSTOMER-ID__
14100 - name: service-type
14102 description: Value defined by orchestration to identify this service across ECOMP.
14105 example: __SERVICE-TYPE__
14109 summary: create or update an existing service-subscription
14111 Create or update an existing service-subscription.
14113 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14114 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14123 description: Response codes found in [response codes](https://wiki.onap.org/).
14125 - name: global-customer-id
14127 description: Global customer id used across ECOMP to uniquely identify customer.
14130 example: __GLOBAL-CUSTOMER-ID__
14131 - name: service-type
14133 description: Value defined by orchestration to identify this service across ECOMP.
14136 example: __SERVICE-TYPE__
14139 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14142 $ref: "#/definitions/service-subscription"
14146 summary: update an existing service-subscription
14148 Update an existing service-subscription
14150 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14151 The PUT operation will entirely replace an existing object.
14152 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14154 Other differences between PUT and PATCH are:
14156 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14157 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14158 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14159 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14168 description: Response codes found in [response codes](https://wiki.onap.org/).
14170 - name: global-customer-id
14172 description: Global customer id used across ECOMP to uniquely identify customer.
14175 example: __GLOBAL-CUSTOMER-ID__
14176 - name: service-type
14178 description: Value defined by orchestration to identify this service across ECOMP.
14181 example: __SERVICE-TYPE__
14184 description: service-subscription object that needs to be updated.
14187 $ref: "#/patchDefinitions/service-subscription"
14191 summary: delete an existing service-subscription
14192 description: delete an existing service-subscription
14193 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14202 description: Response codes found in [response codes](https://wiki.onap.org/).
14204 - name: global-customer-id
14206 description: Global customer id used across ECOMP to uniquely identify customer.
14209 example: __GLOBAL-CUSTOMER-ID__
14210 - name: service-type
14212 description: Value defined by orchestration to identify this service across ECOMP.
14215 example: __SERVICE-TYPE__
14216 - name: resource-version
14218 description: resource-version for concurrency
14221 /business/customers/customer/{global-customer-id}/service-subscriptions:
14225 summary: returns service-subscriptions
14226 description: returns service-subscriptions
14227 operationId: getBusinessCustomersCustomerServiceSubscriptions
14233 description: successful operation
14235 $ref: "#/getDefinitions/service-subscriptions"
14237 description: Response codes found in [response codes](https://wiki.onap.org/).
14239 - name: global-customer-id
14241 description: Global customer id used across ECOMP to uniquely identify customer.
14244 example: __GLOBAL-CUSTOMER-ID__
14245 - name: service-type
14250 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
14254 summary: see node definition for valid relationships
14255 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
14264 description: Response codes found in [response codes](https://wiki.onap.org/).
14266 - name: global-customer-id
14268 description: Global customer id used across ECOMP to uniquely identify customer.
14271 example: __GLOBAL-CUSTOMER-ID__
14274 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)
14277 $ref: "#/definitions/relationship"
14281 summary: delete an existing relationship
14282 description: delete an existing relationship
14283 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
14292 description: Response codes found in [response codes](https://wiki.onap.org/).
14294 - name: global-customer-id
14296 description: Global customer id used across ECOMP to uniquely identify customer.
14299 example: __GLOBAL-CUSTOMER-ID__
14300 /business/customers/customer/{global-customer-id}:
14304 summary: returns customer
14305 description: returns customer
14306 operationId: getBusinessCustomersCustomer
14312 description: successful operation
14314 $ref: "#/getDefinitions/customer"
14316 description: Response codes found in [response codes](https://wiki.onap.org/).
14318 - name: global-customer-id
14320 description: Global customer id used across ECOMP to uniquely identify customer.
14323 example: __GLOBAL-CUSTOMER-ID__
14327 summary: create or update an existing customer
14329 Create or update an existing customer.
14331 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14332 operationId: createOrUpdateBusinessCustomersCustomer
14341 description: Response codes found in [response codes](https://wiki.onap.org/).
14343 - name: global-customer-id
14345 description: Global customer id used across ECOMP to uniquely identify customer.
14348 example: __GLOBAL-CUSTOMER-ID__
14351 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)
14354 $ref: "#/definitions/customer"
14358 summary: update an existing customer
14360 Update an existing customer
14362 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14363 The PUT operation will entirely replace an existing object.
14364 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14366 Other differences between PUT and PATCH are:
14368 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14369 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14370 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14371 operationId: UpdateBusinessCustomersCustomer
14380 description: Response codes found in [response codes](https://wiki.onap.org/).
14382 - name: global-customer-id
14384 description: Global customer id used across ECOMP to uniquely identify customer.
14387 example: __GLOBAL-CUSTOMER-ID__
14390 description: customer object that needs to be updated.
14393 $ref: "#/patchDefinitions/customer"
14397 summary: delete an existing customer
14398 description: delete an existing customer
14399 operationId: deleteBusinessCustomersCustomer
14408 description: Response codes found in [response codes](https://wiki.onap.org/).
14410 - name: global-customer-id
14412 description: Global customer id used across ECOMP to uniquely identify customer.
14415 example: __GLOBAL-CUSTOMER-ID__
14416 - name: resource-version
14418 description: resource-version for concurrency
14421 /business/customers:
14425 summary: returns customers
14426 description: returns customers
14427 operationId: getBusinessCustomers
14433 description: successful operation
14435 $ref: "#/getDefinitions/customers"
14437 description: Response codes found in [response codes](https://wiki.onap.org/).
14439 - name: global-customer-id
14444 - name: subscriber-name
14449 - name: subscriber-type
14454 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
14457 - ServiceDesignAndCreation
14458 summary: see node definition for valid relationships
14459 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
14468 description: Response codes found in [response codes](https://wiki.onap.org/).
14470 - name: vnf-image-uuid
14472 description: Unique ID of this asset
14475 example: __VNF-IMAGE-UUID__
14478 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationVnfImagesVnfImage.json)
14481 $ref: "#/definitions/relationship"
14484 - ServiceDesignAndCreation
14485 summary: delete an existing relationship
14486 description: delete an existing relationship
14487 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
14496 description: Response codes found in [response codes](https://wiki.onap.org/).
14498 - name: vnf-image-uuid
14500 description: Unique ID of this asset
14503 example: __VNF-IMAGE-UUID__
14504 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
14507 - ServiceDesignAndCreation
14508 summary: returns vnf-image
14509 description: returns vnf-image
14510 operationId: getServiceDesignAndCreationVnfImagesVnfImage
14516 description: successful operation
14518 $ref: "#/getDefinitions/vnf-image"
14520 description: Response codes found in [response codes](https://wiki.onap.org/).
14522 - name: vnf-image-uuid
14524 description: Unique ID of this asset
14527 example: __VNF-IMAGE-UUID__
14530 - ServiceDesignAndCreation
14531 summary: create or update an existing vnf-image
14533 Create or update an existing vnf-image.
14535 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14536 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
14545 description: Response codes found in [response codes](https://wiki.onap.org/).
14547 - name: vnf-image-uuid
14549 description: Unique ID of this asset
14552 example: __VNF-IMAGE-UUID__
14555 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationVnfImagesVnfImage.json)
14558 $ref: "#/definitions/vnf-image"
14561 - ServiceDesignAndCreation
14562 summary: update an existing vnf-image
14564 Update an existing vnf-image
14566 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14567 The PUT operation will entirely replace an existing object.
14568 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14570 Other differences between PUT and PATCH are:
14572 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14573 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14574 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14575 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
14584 description: Response codes found in [response codes](https://wiki.onap.org/).
14586 - name: vnf-image-uuid
14588 description: Unique ID of this asset
14591 example: __VNF-IMAGE-UUID__
14594 description: vnf-image object that needs to be updated.
14597 $ref: "#/patchDefinitions/vnf-image"
14600 - ServiceDesignAndCreation
14601 summary: delete an existing vnf-image
14602 description: delete an existing vnf-image
14603 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
14612 description: Response codes found in [response codes](https://wiki.onap.org/).
14614 - name: vnf-image-uuid
14616 description: Unique ID of this asset
14619 example: __VNF-IMAGE-UUID__
14620 - name: resource-version
14622 description: resource-version for concurrency
14625 /service-design-and-creation/vnf-images:
14628 - ServiceDesignAndCreation
14629 summary: returns vnf-images
14630 description: returns vnf-images
14631 operationId: getServiceDesignAndCreationVnfImages
14637 description: successful operation
14639 $ref: "#/getDefinitions/vnf-images"
14641 description: Response codes found in [response codes](https://wiki.onap.org/).
14643 - name: vnf-image-uuid
14648 - name: application
14653 - name: application-vendor
14658 - name: application-version
14663 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
14666 - ServiceDesignAndCreation
14667 summary: see node definition for valid relationships
14668 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
14677 description: Response codes found in [response codes](https://wiki.onap.org/).
14681 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14684 example: __SERVICE-ID__
14687 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServicesService.json)
14690 $ref: "#/definitions/relationship"
14693 - ServiceDesignAndCreation
14694 summary: delete an existing relationship
14695 description: delete an existing relationship
14696 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
14705 description: Response codes found in [response codes](https://wiki.onap.org/).
14709 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14712 example: __SERVICE-ID__
14713 /service-design-and-creation/services/service/{service-id}:
14716 - ServiceDesignAndCreation
14717 summary: returns service
14718 description: returns service
14719 operationId: getServiceDesignAndCreationServicesService
14725 description: successful operation
14727 $ref: "#/getDefinitions/service"
14729 description: Response codes found in [response codes](https://wiki.onap.org/).
14733 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14736 example: __SERVICE-ID__
14739 - ServiceDesignAndCreation
14740 summary: create or update an existing service
14742 Create or update an existing service.
14744 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14745 operationId: createOrUpdateServiceDesignAndCreationServicesService
14754 description: Response codes found in [response codes](https://wiki.onap.org/).
14758 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14761 example: __SERVICE-ID__
14764 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServicesService.json)
14767 $ref: "#/definitions/service"
14770 - ServiceDesignAndCreation
14771 summary: update an existing service
14773 Update an existing service
14775 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14776 The PUT operation will entirely replace an existing object.
14777 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14779 Other differences between PUT and PATCH are:
14781 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14782 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14783 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14784 operationId: UpdateServiceDesignAndCreationServicesService
14793 description: Response codes found in [response codes](https://wiki.onap.org/).
14797 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14800 example: __SERVICE-ID__
14803 description: service object that needs to be updated.
14806 $ref: "#/patchDefinitions/service"
14809 - ServiceDesignAndCreation
14810 summary: delete an existing service
14811 description: delete an existing service
14812 operationId: deleteServiceDesignAndCreationServicesService
14821 description: Response codes found in [response codes](https://wiki.onap.org/).
14825 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14828 example: __SERVICE-ID__
14829 - name: resource-version
14831 description: resource-version for concurrency
14834 /service-design-and-creation/services:
14837 - ServiceDesignAndCreation
14838 summary: returns services
14839 description: returns services
14840 operationId: getServiceDesignAndCreationServices
14846 description: successful operation
14848 $ref: "#/getDefinitions/services"
14850 description: Response codes found in [response codes](https://wiki.onap.org/).
14857 - name: service-description
14862 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
14865 - ServiceDesignAndCreation
14866 summary: see node definition for valid relationships
14867 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14876 description: Response codes found in [response codes](https://wiki.onap.org/).
14878 - name: service-type
14880 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14883 example: __SERVICE-TYPE__
14886 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.
14889 example: __VNF-TYPE__
14892 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14895 $ref: "#/definitions/relationship"
14898 - ServiceDesignAndCreation
14899 summary: delete an existing relationship
14900 description: delete an existing relationship
14901 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14910 description: Response codes found in [response codes](https://wiki.onap.org/).
14912 - name: service-type
14914 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14917 example: __SERVICE-TYPE__
14920 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.
14923 example: __VNF-TYPE__
14924 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
14927 - ServiceDesignAndCreation
14928 summary: returns service-capability
14929 description: returns service-capability
14930 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
14936 description: successful operation
14938 $ref: "#/getDefinitions/service-capability"
14940 description: Response codes found in [response codes](https://wiki.onap.org/).
14942 - name: service-type
14944 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14947 example: __SERVICE-TYPE__
14950 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.
14953 example: __VNF-TYPE__
14956 - ServiceDesignAndCreation
14957 summary: create or update an existing service-capability
14959 Create or update an existing service-capability.
14961 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14962 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14971 description: Response codes found in [response codes](https://wiki.onap.org/).
14973 - name: service-type
14975 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14978 example: __SERVICE-TYPE__
14981 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.
14984 example: __VNF-TYPE__
14987 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14990 $ref: "#/definitions/service-capability"
14993 - ServiceDesignAndCreation
14994 summary: update an existing service-capability
14996 Update an existing service-capability
14998 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14999 The PUT operation will entirely replace an existing object.
15000 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15002 Other differences between PUT and PATCH are:
15004 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15005 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15006 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15007 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
15016 description: Response codes found in [response codes](https://wiki.onap.org/).
15018 - name: service-type
15020 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15023 example: __SERVICE-TYPE__
15026 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.
15029 example: __VNF-TYPE__
15032 description: service-capability object that needs to be updated.
15035 $ref: "#/patchDefinitions/service-capability"
15038 - ServiceDesignAndCreation
15039 summary: delete an existing service-capability
15040 description: delete an existing service-capability
15041 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
15050 description: Response codes found in [response codes](https://wiki.onap.org/).
15052 - name: service-type
15054 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15057 example: __SERVICE-TYPE__
15060 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.
15063 example: __VNF-TYPE__
15064 - name: resource-version
15066 description: resource-version for concurrency
15069 /service-design-and-creation/service-capabilities:
15072 - ServiceDesignAndCreation
15073 summary: returns service-capabilities
15074 description: returns service-capabilities
15075 operationId: getServiceDesignAndCreationServiceCapabilities
15081 description: successful operation
15083 $ref: "#/getDefinitions/service-capabilities"
15085 description: Response codes found in [response codes](https://wiki.onap.org/).
15087 - name: service-type
15097 /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:
15100 - ServiceDesignAndCreation
15101 summary: see node definition for valid relationships
15102 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
15111 description: Response codes found in [response codes](https://wiki.onap.org/).
15113 - name: model-invariant-id
15115 description: Unique identifier corresponding to the main definition of a model in ASDC
15118 example: __MODEL-INVARIANT-ID__
15119 - name: model-version-id
15121 description: Unique identifier corresponding to one version of a model in ASDC
15124 example: __MODEL-VERSION-ID__
15125 - name: model-element-uuid
15129 example: __MODEL-ELEMENT-UUID__
15130 - name: model-constraint-uuid
15134 example: __MODEL-CONSTRAINT-UUID__
15135 - name: constrained-element-set-uuid
15139 example: __CONSTRAINED-ELEMENT-SET-UUID__
15140 - name: element-choice-set-uuid
15144 example: __ELEMENT-CHOICE-SET-UUID__
15147 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
15150 $ref: "#/definitions/relationship"
15153 - ServiceDesignAndCreation
15154 summary: delete an existing relationship
15155 description: delete an existing relationship
15156 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
15165 description: Response codes found in [response codes](https://wiki.onap.org/).
15167 - name: model-invariant-id
15169 description: Unique identifier corresponding to the main definition of a model in ASDC
15172 example: __MODEL-INVARIANT-ID__
15173 - name: model-version-id
15175 description: Unique identifier corresponding to one version of a model in ASDC
15178 example: __MODEL-VERSION-ID__
15179 - name: model-element-uuid
15183 example: __MODEL-ELEMENT-UUID__
15184 - name: model-constraint-uuid
15188 example: __MODEL-CONSTRAINT-UUID__
15189 - name: constrained-element-set-uuid
15193 example: __CONSTRAINED-ELEMENT-SET-UUID__
15194 - name: element-choice-set-uuid
15198 example: __ELEMENT-CHOICE-SET-UUID__
15199 /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}:
15202 - ServiceDesignAndCreation
15203 summary: returns element-choice-set
15204 description: returns element-choice-set
15205 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15211 description: successful operation
15213 $ref: "#/getDefinitions/element-choice-set"
15215 description: Response codes found in [response codes](https://wiki.onap.org/).
15217 - name: model-invariant-id
15219 description: Unique identifier corresponding to the main definition of a model in ASDC
15222 example: __MODEL-INVARIANT-ID__
15223 - name: model-version-id
15225 description: Unique identifier corresponding to one version of a model in ASDC
15228 example: __MODEL-VERSION-ID__
15229 - name: model-element-uuid
15233 example: __MODEL-ELEMENT-UUID__
15234 - name: model-constraint-uuid
15238 example: __MODEL-CONSTRAINT-UUID__
15239 - name: constrained-element-set-uuid
15243 example: __CONSTRAINED-ELEMENT-SET-UUID__
15244 - name: element-choice-set-uuid
15248 example: __ELEMENT-CHOICE-SET-UUID__
15251 - ServiceDesignAndCreation
15252 summary: create or update an existing element-choice-set
15254 Create or update an existing element-choice-set.
15256 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15257 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15266 description: Response codes found in [response codes](https://wiki.onap.org/).
15268 - name: model-invariant-id
15270 description: Unique identifier corresponding to the main definition of a model in ASDC
15273 example: __MODEL-INVARIANT-ID__
15274 - name: model-version-id
15276 description: Unique identifier corresponding to one version of a model in ASDC
15279 example: __MODEL-VERSION-ID__
15280 - name: model-element-uuid
15284 example: __MODEL-ELEMENT-UUID__
15285 - name: model-constraint-uuid
15289 example: __MODEL-CONSTRAINT-UUID__
15290 - name: constrained-element-set-uuid
15294 example: __CONSTRAINED-ELEMENT-SET-UUID__
15295 - name: element-choice-set-uuid
15299 example: __ELEMENT-CHOICE-SET-UUID__
15302 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
15305 $ref: "#/definitions/element-choice-set"
15308 - ServiceDesignAndCreation
15309 summary: update an existing element-choice-set
15311 Update an existing element-choice-set
15313 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15314 The PUT operation will entirely replace an existing object.
15315 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15317 Other differences between PUT and PATCH are:
15319 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15320 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15321 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15322 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15331 description: Response codes found in [response codes](https://wiki.onap.org/).
15333 - name: model-invariant-id
15335 description: Unique identifier corresponding to the main definition of a model in ASDC
15338 example: __MODEL-INVARIANT-ID__
15339 - name: model-version-id
15341 description: Unique identifier corresponding to one version of a model in ASDC
15344 example: __MODEL-VERSION-ID__
15345 - name: model-element-uuid
15349 example: __MODEL-ELEMENT-UUID__
15350 - name: model-constraint-uuid
15354 example: __MODEL-CONSTRAINT-UUID__
15355 - name: constrained-element-set-uuid
15359 example: __CONSTRAINED-ELEMENT-SET-UUID__
15360 - name: element-choice-set-uuid
15364 example: __ELEMENT-CHOICE-SET-UUID__
15367 description: element-choice-set object that needs to be updated.
15370 $ref: "#/patchDefinitions/element-choice-set"
15373 - ServiceDesignAndCreation
15374 summary: delete an existing element-choice-set
15375 description: delete an existing element-choice-set
15376 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15385 description: Response codes found in [response codes](https://wiki.onap.org/).
15387 - name: model-invariant-id
15389 description: Unique identifier corresponding to the main definition of a model in ASDC
15392 example: __MODEL-INVARIANT-ID__
15393 - name: model-version-id
15395 description: Unique identifier corresponding to one version of a model in ASDC
15398 example: __MODEL-VERSION-ID__
15399 - name: model-element-uuid
15403 example: __MODEL-ELEMENT-UUID__
15404 - name: model-constraint-uuid
15408 example: __MODEL-CONSTRAINT-UUID__
15409 - name: constrained-element-set-uuid
15413 example: __CONSTRAINED-ELEMENT-SET-UUID__
15414 - name: element-choice-set-uuid
15418 example: __ELEMENT-CHOICE-SET-UUID__
15419 - name: resource-version
15421 description: resource-version for concurrency
15424 /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:
15427 - ServiceDesignAndCreation
15428 summary: returns element-choice-sets
15429 description: returns element-choice-sets
15430 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
15436 description: successful operation
15438 $ref: "#/getDefinitions/element-choice-sets"
15440 description: Response codes found in [response codes](https://wiki.onap.org/).
15442 - name: model-invariant-id
15444 description: Unique identifier corresponding to the main definition of a model in ASDC
15447 example: __MODEL-INVARIANT-ID__
15448 - name: model-version-id
15450 description: Unique identifier corresponding to one version of a model in ASDC
15453 example: __MODEL-VERSION-ID__
15454 - name: model-element-uuid
15458 example: __MODEL-ELEMENT-UUID__
15459 - name: model-constraint-uuid
15463 example: __MODEL-CONSTRAINT-UUID__
15464 - name: constrained-element-set-uuid
15468 example: __CONSTRAINED-ELEMENT-SET-UUID__
15469 - name: element-choice-set-uuid
15474 /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:
15477 - ServiceDesignAndCreation
15478 summary: see node definition for valid relationships
15479 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
15488 description: Response codes found in [response codes](https://wiki.onap.org/).
15490 - name: model-invariant-id
15492 description: Unique identifier corresponding to the main definition of a model in ASDC
15495 example: __MODEL-INVARIANT-ID__
15496 - name: model-version-id
15498 description: Unique identifier corresponding to one version of a model in ASDC
15501 example: __MODEL-VERSION-ID__
15502 - name: model-element-uuid
15506 example: __MODEL-ELEMENT-UUID__
15507 - name: model-constraint-uuid
15511 example: __MODEL-CONSTRAINT-UUID__
15512 - name: constrained-element-set-uuid
15516 example: __CONSTRAINED-ELEMENT-SET-UUID__
15519 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
15522 $ref: "#/definitions/relationship"
15525 - ServiceDesignAndCreation
15526 summary: delete an existing relationship
15527 description: delete an existing relationship
15528 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
15537 description: Response codes found in [response codes](https://wiki.onap.org/).
15539 - name: model-invariant-id
15541 description: Unique identifier corresponding to the main definition of a model in ASDC
15544 example: __MODEL-INVARIANT-ID__
15545 - name: model-version-id
15547 description: Unique identifier corresponding to one version of a model in ASDC
15550 example: __MODEL-VERSION-ID__
15551 - name: model-element-uuid
15555 example: __MODEL-ELEMENT-UUID__
15556 - name: model-constraint-uuid
15560 example: __MODEL-CONSTRAINT-UUID__
15561 - name: constrained-element-set-uuid
15565 example: __CONSTRAINED-ELEMENT-SET-UUID__
15566 /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}:
15569 - ServiceDesignAndCreation
15570 summary: returns constrained-element-set
15571 description: returns constrained-element-set
15572 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15578 description: successful operation
15580 $ref: "#/getDefinitions/constrained-element-set"
15582 description: Response codes found in [response codes](https://wiki.onap.org/).
15584 - name: model-invariant-id
15586 description: Unique identifier corresponding to the main definition of a model in ASDC
15589 example: __MODEL-INVARIANT-ID__
15590 - name: model-version-id
15592 description: Unique identifier corresponding to one version of a model in ASDC
15595 example: __MODEL-VERSION-ID__
15596 - name: model-element-uuid
15600 example: __MODEL-ELEMENT-UUID__
15601 - name: model-constraint-uuid
15605 example: __MODEL-CONSTRAINT-UUID__
15606 - name: constrained-element-set-uuid
15610 example: __CONSTRAINED-ELEMENT-SET-UUID__
15613 - ServiceDesignAndCreation
15614 summary: create or update an existing constrained-element-set
15616 Create or update an existing constrained-element-set.
15618 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15619 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15628 description: Response codes found in [response codes](https://wiki.onap.org/).
15630 - name: model-invariant-id
15632 description: Unique identifier corresponding to the main definition of a model in ASDC
15635 example: __MODEL-INVARIANT-ID__
15636 - name: model-version-id
15638 description: Unique identifier corresponding to one version of a model in ASDC
15641 example: __MODEL-VERSION-ID__
15642 - name: model-element-uuid
15646 example: __MODEL-ELEMENT-UUID__
15647 - name: model-constraint-uuid
15651 example: __MODEL-CONSTRAINT-UUID__
15652 - name: constrained-element-set-uuid
15656 example: __CONSTRAINED-ELEMENT-SET-UUID__
15659 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
15662 $ref: "#/definitions/constrained-element-set"
15665 - ServiceDesignAndCreation
15666 summary: update an existing constrained-element-set
15668 Update an existing constrained-element-set
15670 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15671 The PUT operation will entirely replace an existing object.
15672 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15674 Other differences between PUT and PATCH are:
15676 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15677 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15678 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15679 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15688 description: Response codes found in [response codes](https://wiki.onap.org/).
15690 - name: model-invariant-id
15692 description: Unique identifier corresponding to the main definition of a model in ASDC
15695 example: __MODEL-INVARIANT-ID__
15696 - name: model-version-id
15698 description: Unique identifier corresponding to one version of a model in ASDC
15701 example: __MODEL-VERSION-ID__
15702 - name: model-element-uuid
15706 example: __MODEL-ELEMENT-UUID__
15707 - name: model-constraint-uuid
15711 example: __MODEL-CONSTRAINT-UUID__
15712 - name: constrained-element-set-uuid
15716 example: __CONSTRAINED-ELEMENT-SET-UUID__
15719 description: constrained-element-set object that needs to be updated.
15722 $ref: "#/patchDefinitions/constrained-element-set"
15725 - ServiceDesignAndCreation
15726 summary: delete an existing constrained-element-set
15727 description: delete an existing constrained-element-set
15728 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15737 description: Response codes found in [response codes](https://wiki.onap.org/).
15739 - name: model-invariant-id
15741 description: Unique identifier corresponding to the main definition of a model in ASDC
15744 example: __MODEL-INVARIANT-ID__
15745 - name: model-version-id
15747 description: Unique identifier corresponding to one version of a model in ASDC
15750 example: __MODEL-VERSION-ID__
15751 - name: model-element-uuid
15755 example: __MODEL-ELEMENT-UUID__
15756 - name: model-constraint-uuid
15760 example: __MODEL-CONSTRAINT-UUID__
15761 - name: constrained-element-set-uuid
15765 example: __CONSTRAINED-ELEMENT-SET-UUID__
15766 - name: resource-version
15768 description: resource-version for concurrency
15771 /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:
15774 - ServiceDesignAndCreation
15775 summary: returns constrained-element-sets
15776 description: returns constrained-element-sets
15777 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
15783 description: successful operation
15785 $ref: "#/getDefinitions/constrained-element-sets"
15787 description: Response codes found in [response codes](https://wiki.onap.org/).
15789 - name: model-invariant-id
15791 description: Unique identifier corresponding to the main definition of a model in ASDC
15794 example: __MODEL-INVARIANT-ID__
15795 - name: model-version-id
15797 description: Unique identifier corresponding to one version of a model in ASDC
15800 example: __MODEL-VERSION-ID__
15801 - name: model-element-uuid
15805 example: __MODEL-ELEMENT-UUID__
15806 - name: model-constraint-uuid
15810 example: __MODEL-CONSTRAINT-UUID__
15811 - name: constrained-element-set-uuid
15816 /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}:
15819 - ServiceDesignAndCreation
15820 summary: returns model-constraint
15821 description: returns model-constraint
15822 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15828 description: successful operation
15830 $ref: "#/getDefinitions/model-constraint"
15832 description: Response codes found in [response codes](https://wiki.onap.org/).
15834 - name: model-invariant-id
15836 description: Unique identifier corresponding to the main definition of a model in ASDC
15839 example: __MODEL-INVARIANT-ID__
15840 - name: model-version-id
15842 description: Unique identifier corresponding to one version of a model in ASDC
15845 example: __MODEL-VERSION-ID__
15846 - name: model-element-uuid
15850 example: __MODEL-ELEMENT-UUID__
15851 - name: model-constraint-uuid
15855 example: __MODEL-CONSTRAINT-UUID__
15858 - ServiceDesignAndCreation
15859 summary: create or update an existing model-constraint
15861 Create or update an existing model-constraint.
15863 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15864 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15873 description: Response codes found in [response codes](https://wiki.onap.org/).
15875 - name: model-invariant-id
15877 description: Unique identifier corresponding to the main definition of a model in ASDC
15880 example: __MODEL-INVARIANT-ID__
15881 - name: model-version-id
15883 description: Unique identifier corresponding to one version of a model in ASDC
15886 example: __MODEL-VERSION-ID__
15887 - name: model-element-uuid
15891 example: __MODEL-ELEMENT-UUID__
15892 - name: model-constraint-uuid
15896 example: __MODEL-CONSTRAINT-UUID__
15899 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
15902 $ref: "#/definitions/model-constraint"
15905 - ServiceDesignAndCreation
15906 summary: update an existing model-constraint
15908 Update an existing model-constraint
15910 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15911 The PUT operation will entirely replace an existing object.
15912 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15914 Other differences between PUT and PATCH are:
15916 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15917 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15918 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15919 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15928 description: Response codes found in [response codes](https://wiki.onap.org/).
15930 - name: model-invariant-id
15932 description: Unique identifier corresponding to the main definition of a model in ASDC
15935 example: __MODEL-INVARIANT-ID__
15936 - name: model-version-id
15938 description: Unique identifier corresponding to one version of a model in ASDC
15941 example: __MODEL-VERSION-ID__
15942 - name: model-element-uuid
15946 example: __MODEL-ELEMENT-UUID__
15947 - name: model-constraint-uuid
15951 example: __MODEL-CONSTRAINT-UUID__
15954 description: model-constraint object that needs to be updated.
15957 $ref: "#/patchDefinitions/model-constraint"
15960 - ServiceDesignAndCreation
15961 summary: delete an existing model-constraint
15962 description: delete an existing model-constraint
15963 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15972 description: Response codes found in [response codes](https://wiki.onap.org/).
15974 - name: model-invariant-id
15976 description: Unique identifier corresponding to the main definition of a model in ASDC
15979 example: __MODEL-INVARIANT-ID__
15980 - name: model-version-id
15982 description: Unique identifier corresponding to one version of a model in ASDC
15985 example: __MODEL-VERSION-ID__
15986 - name: model-element-uuid
15990 example: __MODEL-ELEMENT-UUID__
15991 - name: model-constraint-uuid
15995 example: __MODEL-CONSTRAINT-UUID__
15996 - name: resource-version
15998 description: resource-version for concurrency
16001 /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:
16004 - ServiceDesignAndCreation
16005 summary: returns model-constraints
16006 description: returns model-constraints
16007 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
16013 description: successful operation
16015 $ref: "#/getDefinitions/model-constraints"
16017 description: Response codes found in [response codes](https://wiki.onap.org/).
16019 - name: model-invariant-id
16021 description: Unique identifier corresponding to the main definition of a model in ASDC
16024 example: __MODEL-INVARIANT-ID__
16025 - name: model-version-id
16027 description: Unique identifier corresponding to one version of a model in ASDC
16030 example: __MODEL-VERSION-ID__
16031 - name: model-element-uuid
16035 example: __MODEL-ELEMENT-UUID__
16036 - name: model-constraint-uuid
16041 /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:
16044 - ServiceDesignAndCreation
16045 summary: see node definition for valid relationships
16046 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
16055 description: Response codes found in [response codes](https://wiki.onap.org/).
16057 - name: model-invariant-id
16059 description: Unique identifier corresponding to the main definition of a model in ASDC
16062 example: __MODEL-INVARIANT-ID__
16063 - name: model-version-id
16065 description: Unique identifier corresponding to one version of a model in ASDC
16068 example: __MODEL-VERSION-ID__
16069 - name: model-element-uuid
16073 example: __MODEL-ELEMENT-UUID__
16076 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
16079 $ref: "#/definitions/relationship"
16082 - ServiceDesignAndCreation
16083 summary: delete an existing relationship
16084 description: delete an existing relationship
16085 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
16094 description: Response codes found in [response codes](https://wiki.onap.org/).
16096 - name: model-invariant-id
16098 description: Unique identifier corresponding to the main definition of a model in ASDC
16101 example: __MODEL-INVARIANT-ID__
16102 - name: model-version-id
16104 description: Unique identifier corresponding to one version of a model in ASDC
16107 example: __MODEL-VERSION-ID__
16108 - name: model-element-uuid
16112 example: __MODEL-ELEMENT-UUID__
16113 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
16116 - ServiceDesignAndCreation
16117 summary: returns model-element
16118 description: returns model-element
16119 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16125 description: successful operation
16127 $ref: "#/getDefinitions/model-element"
16129 description: Response codes found in [response codes](https://wiki.onap.org/).
16131 - name: model-invariant-id
16133 description: Unique identifier corresponding to the main definition of a model in ASDC
16136 example: __MODEL-INVARIANT-ID__
16137 - name: model-version-id
16139 description: Unique identifier corresponding to one version of a model in ASDC
16142 example: __MODEL-VERSION-ID__
16143 - name: model-element-uuid
16147 example: __MODEL-ELEMENT-UUID__
16150 - ServiceDesignAndCreation
16151 summary: create or update an existing model-element
16153 Create or update an existing model-element.
16155 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16156 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16165 description: Response codes found in [response codes](https://wiki.onap.org/).
16167 - name: model-invariant-id
16169 description: Unique identifier corresponding to the main definition of a model in ASDC
16172 example: __MODEL-INVARIANT-ID__
16173 - name: model-version-id
16175 description: Unique identifier corresponding to one version of a model in ASDC
16178 example: __MODEL-VERSION-ID__
16179 - name: model-element-uuid
16183 example: __MODEL-ELEMENT-UUID__
16186 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
16189 $ref: "#/definitions/model-element"
16192 - ServiceDesignAndCreation
16193 summary: update an existing model-element
16195 Update an existing model-element
16197 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16198 The PUT operation will entirely replace an existing object.
16199 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16201 Other differences between PUT and PATCH are:
16203 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16204 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16205 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16206 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16215 description: Response codes found in [response codes](https://wiki.onap.org/).
16217 - name: model-invariant-id
16219 description: Unique identifier corresponding to the main definition of a model in ASDC
16222 example: __MODEL-INVARIANT-ID__
16223 - name: model-version-id
16225 description: Unique identifier corresponding to one version of a model in ASDC
16228 example: __MODEL-VERSION-ID__
16229 - name: model-element-uuid
16233 example: __MODEL-ELEMENT-UUID__
16236 description: model-element object that needs to be updated.
16239 $ref: "#/patchDefinitions/model-element"
16242 - ServiceDesignAndCreation
16243 summary: delete an existing model-element
16244 description: delete an existing model-element
16245 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16254 description: Response codes found in [response codes](https://wiki.onap.org/).
16256 - name: model-invariant-id
16258 description: Unique identifier corresponding to the main definition of a model in ASDC
16261 example: __MODEL-INVARIANT-ID__
16262 - name: model-version-id
16264 description: Unique identifier corresponding to one version of a model in ASDC
16267 example: __MODEL-VERSION-ID__
16268 - name: model-element-uuid
16272 example: __MODEL-ELEMENT-UUID__
16273 - name: resource-version
16275 description: resource-version for concurrency
16278 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
16281 - ServiceDesignAndCreation
16282 summary: returns model-elements
16283 description: returns model-elements
16284 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
16290 description: successful operation
16292 $ref: "#/getDefinitions/model-elements"
16294 description: Response codes found in [response codes](https://wiki.onap.org/).
16296 - name: model-invariant-id
16298 description: Unique identifier corresponding to the main definition of a model in ASDC
16301 example: __MODEL-INVARIANT-ID__
16302 - name: model-version-id
16304 description: Unique identifier corresponding to one version of a model in ASDC
16307 example: __MODEL-VERSION-ID__
16308 - name: model-element-uuid
16313 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
16316 - ServiceDesignAndCreation
16317 summary: returns metadatum
16318 description: returns metadatum
16319 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16325 description: successful operation
16327 $ref: "#/getDefinitions/metadatum"
16329 description: Response codes found in [response codes](https://wiki.onap.org/).
16331 - name: model-invariant-id
16333 description: Unique identifier corresponding to the main definition of a model in ASDC
16336 example: __MODEL-INVARIANT-ID__
16337 - name: model-version-id
16339 description: Unique identifier corresponding to one version of a model in ASDC
16342 example: __MODEL-VERSION-ID__
16347 example: __METANAME__
16350 - ServiceDesignAndCreation
16351 summary: create or update an existing metadatum
16353 Create or update an existing metadatum.
16355 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16356 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16365 description: Response codes found in [response codes](https://wiki.onap.org/).
16367 - name: model-invariant-id
16369 description: Unique identifier corresponding to the main definition of a model in ASDC
16372 example: __MODEL-INVARIANT-ID__
16373 - name: model-version-id
16375 description: Unique identifier corresponding to one version of a model in ASDC
16378 example: __MODEL-VERSION-ID__
16383 example: __METANAME__
16386 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
16389 $ref: "#/definitions/metadatum"
16392 - ServiceDesignAndCreation
16393 summary: update an existing metadatum
16395 Update an existing metadatum
16397 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16398 The PUT operation will entirely replace an existing object.
16399 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16401 Other differences between PUT and PATCH are:
16403 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16404 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16405 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16406 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16415 description: Response codes found in [response codes](https://wiki.onap.org/).
16417 - name: model-invariant-id
16419 description: Unique identifier corresponding to the main definition of a model in ASDC
16422 example: __MODEL-INVARIANT-ID__
16423 - name: model-version-id
16425 description: Unique identifier corresponding to one version of a model in ASDC
16428 example: __MODEL-VERSION-ID__
16433 example: __METANAME__
16436 description: metadatum object that needs to be updated.
16439 $ref: "#/patchDefinitions/metadatum"
16442 - ServiceDesignAndCreation
16443 summary: delete an existing metadatum
16444 description: delete an existing metadatum
16445 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16454 description: Response codes found in [response codes](https://wiki.onap.org/).
16456 - name: model-invariant-id
16458 description: Unique identifier corresponding to the main definition of a model in ASDC
16461 example: __MODEL-INVARIANT-ID__
16462 - name: model-version-id
16464 description: Unique identifier corresponding to one version of a model in ASDC
16467 example: __MODEL-VERSION-ID__
16472 example: __METANAME__
16473 - name: resource-version
16475 description: resource-version for concurrency
16478 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
16481 - ServiceDesignAndCreation
16482 summary: returns metadata
16483 description: returns metadata
16484 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
16490 description: successful operation
16492 $ref: "#/getDefinitions/metadata"
16494 description: Response codes found in [response codes](https://wiki.onap.org/).
16496 - name: model-invariant-id
16498 description: Unique identifier corresponding to the main definition of a model in ASDC
16501 example: __MODEL-INVARIANT-ID__
16502 - name: model-version-id
16504 description: Unique identifier corresponding to one version of a model in ASDC
16507 example: __MODEL-VERSION-ID__
16513 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
16516 - ServiceDesignAndCreation
16517 summary: see node definition for valid relationships
16518 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
16527 description: Response codes found in [response codes](https://wiki.onap.org/).
16529 - name: model-invariant-id
16531 description: Unique identifier corresponding to the main definition of a model in ASDC
16534 example: __MODEL-INVARIANT-ID__
16535 - name: model-version-id
16537 description: Unique identifier corresponding to one version of a model in ASDC
16540 example: __MODEL-VERSION-ID__
16543 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
16546 $ref: "#/definitions/relationship"
16549 - ServiceDesignAndCreation
16550 summary: delete an existing relationship
16551 description: delete an existing relationship
16552 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
16561 description: Response codes found in [response codes](https://wiki.onap.org/).
16563 - name: model-invariant-id
16565 description: Unique identifier corresponding to the main definition of a model in ASDC
16568 example: __MODEL-INVARIANT-ID__
16569 - name: model-version-id
16571 description: Unique identifier corresponding to one version of a model in ASDC
16574 example: __MODEL-VERSION-ID__
16575 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
16578 - ServiceDesignAndCreation
16579 summary: returns model-ver
16580 description: returns model-ver
16581 operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
16587 description: successful operation
16589 $ref: "#/getDefinitions/model-ver"
16591 description: Response codes found in [response codes](https://wiki.onap.org/).
16593 - name: model-invariant-id
16595 description: Unique identifier corresponding to the main definition of a model in ASDC
16598 example: __MODEL-INVARIANT-ID__
16599 - name: model-version-id
16601 description: Unique identifier corresponding to one version of a model in ASDC
16604 example: __MODEL-VERSION-ID__
16607 - ServiceDesignAndCreation
16608 summary: create or update an existing model-ver
16610 Create or update an existing model-ver.
16612 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16613 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
16622 description: Response codes found in [response codes](https://wiki.onap.org/).
16624 - name: model-invariant-id
16626 description: Unique identifier corresponding to the main definition of a model in ASDC
16629 example: __MODEL-INVARIANT-ID__
16630 - name: model-version-id
16632 description: Unique identifier corresponding to one version of a model in ASDC
16635 example: __MODEL-VERSION-ID__
16638 description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
16641 $ref: "#/definitions/model-ver"
16644 - ServiceDesignAndCreation
16645 summary: update an existing model-ver
16647 Update an existing model-ver
16649 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16650 The PUT operation will entirely replace an existing object.
16651 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16653 Other differences between PUT and PATCH are:
16655 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16656 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16657 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16658 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
16667 description: Response codes found in [response codes](https://wiki.onap.org/).
16669 - name: model-invariant-id
16671 description: Unique identifier corresponding to the main definition of a model in ASDC
16674 example: __MODEL-INVARIANT-ID__
16675 - name: model-version-id
16677 description: Unique identifier corresponding to one version of a model in ASDC
16680 example: __MODEL-VERSION-ID__
16683 description: model-ver object that needs to be updated.
16686 $ref: "#/patchDefinitions/model-ver"
16689 - ServiceDesignAndCreation
16690 summary: delete an existing model-ver
16691 description: delete an existing model-ver
16692 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
16701 description: Response codes found in [response codes](https://wiki.onap.org/).
16703 - name: model-invariant-id
16705 description: Unique identifier corresponding to the main definition of a model in ASDC
16708 example: __MODEL-INVARIANT-ID__
16709 - name: model-version-id
16711 description: Unique identifier corresponding to one version of a model in ASDC
16714 example: __MODEL-VERSION-ID__
16715 - name: resource-version
16717 description: resource-version for concurrency
16720 /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
16723 - ServiceDesignAndCreation
16724 summary: returns model-vers
16725 description: returns model-vers
16726 operationId: getServiceDesignAndCreationModelsModelModelVers
16732 description: successful operation
16734 $ref: "#/getDefinitions/model-vers"
16736 description: Response codes found in [response codes](https://wiki.onap.org/).
16738 - name: model-invariant-id
16740 description: Unique identifier corresponding to the main definition of a model in ASDC
16743 example: __MODEL-INVARIANT-ID__
16744 - name: model-version-id
16754 - name: model-version
16759 /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
16762 - ServiceDesignAndCreation
16763 summary: see node definition for valid relationships
16764 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
16773 description: Response codes found in [response codes](https://wiki.onap.org/).
16775 - name: model-invariant-id
16777 description: Unique identifier corresponding to the main definition of a model in ASDC
16780 example: __MODEL-INVARIANT-ID__
16783 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)
16786 $ref: "#/definitions/relationship"
16789 - ServiceDesignAndCreation
16790 summary: delete an existing relationship
16791 description: delete an existing relationship
16792 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
16801 description: Response codes found in [response codes](https://wiki.onap.org/).
16803 - name: model-invariant-id
16805 description: Unique identifier corresponding to the main definition of a model in ASDC
16808 example: __MODEL-INVARIANT-ID__
16809 /service-design-and-creation/models/model/{model-invariant-id}:
16812 - ServiceDesignAndCreation
16813 summary: returns model
16814 description: returns model
16815 operationId: getServiceDesignAndCreationModelsModel
16821 description: successful operation
16823 $ref: "#/getDefinitions/model"
16825 description: Response codes found in [response codes](https://wiki.onap.org/).
16827 - name: model-invariant-id
16829 description: Unique identifier corresponding to the main definition of a model in ASDC
16832 example: __MODEL-INVARIANT-ID__
16835 - ServiceDesignAndCreation
16836 summary: create or update an existing model
16838 Create or update an existing model.
16840 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16841 operationId: createOrUpdateServiceDesignAndCreationModelsModel
16850 description: Response codes found in [response codes](https://wiki.onap.org/).
16852 - name: model-invariant-id
16854 description: Unique identifier corresponding to the main definition of a model in ASDC
16857 example: __MODEL-INVARIANT-ID__
16860 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)
16863 $ref: "#/definitions/model"
16866 - ServiceDesignAndCreation
16867 summary: update an existing model
16869 Update an existing model
16871 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16872 The PUT operation will entirely replace an existing object.
16873 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16875 Other differences between PUT and PATCH are:
16877 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16878 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16879 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16880 operationId: UpdateServiceDesignAndCreationModelsModel
16889 description: Response codes found in [response codes](https://wiki.onap.org/).
16891 - name: model-invariant-id
16893 description: Unique identifier corresponding to the main definition of a model in ASDC
16896 example: __MODEL-INVARIANT-ID__
16899 description: model object that needs to be updated.
16902 $ref: "#/patchDefinitions/model"
16905 - ServiceDesignAndCreation
16906 summary: delete an existing model
16907 description: delete an existing model
16908 operationId: deleteServiceDesignAndCreationModelsModel
16917 description: Response codes found in [response codes](https://wiki.onap.org/).
16919 - name: model-invariant-id
16921 description: Unique identifier corresponding to the main definition of a model in ASDC
16924 example: __MODEL-INVARIANT-ID__
16925 - name: resource-version
16927 description: resource-version for concurrency
16930 /service-design-and-creation/models:
16933 - ServiceDesignAndCreation
16934 summary: returns models
16935 description: returns models
16936 operationId: getServiceDesignAndCreationModels
16942 description: successful operation
16944 $ref: "#/getDefinitions/models"
16946 description: Response codes found in [response codes](https://wiki.onap.org/).
16948 - name: model-invariant-id
16958 /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:
16961 - ServiceDesignAndCreation
16962 summary: see node definition for valid relationships
16963 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
16972 description: Response codes found in [response codes](https://wiki.onap.org/).
16974 - name: named-query-uuid
16978 example: __NAMED-QUERY-UUID__
16979 - name: named-query-element-uuid
16983 example: __NAMED-QUERY-ELEMENT-UUID__
16984 - name: related-lookup-uuid
16988 example: __RELATED-LOOKUP-UUID__
16991 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
16994 $ref: "#/definitions/relationship"
16997 - ServiceDesignAndCreation
16998 summary: delete an existing relationship
16999 description: delete an existing relationship
17000 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
17009 description: Response codes found in [response codes](https://wiki.onap.org/).
17011 - name: named-query-uuid
17015 example: __NAMED-QUERY-UUID__
17016 - name: named-query-element-uuid
17020 example: __NAMED-QUERY-ELEMENT-UUID__
17021 - name: related-lookup-uuid
17025 example: __RELATED-LOOKUP-UUID__
17026 /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}:
17029 - ServiceDesignAndCreation
17030 summary: returns related-lookup
17031 description: returns related-lookup
17032 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17038 description: successful operation
17040 $ref: "#/getDefinitions/related-lookup"
17042 description: Response codes found in [response codes](https://wiki.onap.org/).
17044 - name: named-query-uuid
17048 example: __NAMED-QUERY-UUID__
17049 - name: named-query-element-uuid
17053 example: __NAMED-QUERY-ELEMENT-UUID__
17054 - name: related-lookup-uuid
17058 example: __RELATED-LOOKUP-UUID__
17061 - ServiceDesignAndCreation
17062 summary: create or update an existing related-lookup
17064 Create or update an existing related-lookup.
17066 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17067 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17076 description: Response codes found in [response codes](https://wiki.onap.org/).
17078 - name: named-query-uuid
17082 example: __NAMED-QUERY-UUID__
17083 - name: named-query-element-uuid
17087 example: __NAMED-QUERY-ELEMENT-UUID__
17088 - name: related-lookup-uuid
17092 example: __RELATED-LOOKUP-UUID__
17095 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
17098 $ref: "#/definitions/related-lookup"
17101 - ServiceDesignAndCreation
17102 summary: update an existing related-lookup
17104 Update an existing related-lookup
17106 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17107 The PUT operation will entirely replace an existing object.
17108 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17110 Other differences between PUT and PATCH are:
17112 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17113 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17114 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17115 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17124 description: Response codes found in [response codes](https://wiki.onap.org/).
17126 - name: named-query-uuid
17130 example: __NAMED-QUERY-UUID__
17131 - name: named-query-element-uuid
17135 example: __NAMED-QUERY-ELEMENT-UUID__
17136 - name: related-lookup-uuid
17140 example: __RELATED-LOOKUP-UUID__
17143 description: related-lookup object that needs to be updated.
17146 $ref: "#/patchDefinitions/related-lookup"
17149 - ServiceDesignAndCreation
17150 summary: delete an existing related-lookup
17151 description: delete an existing related-lookup
17152 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17161 description: Response codes found in [response codes](https://wiki.onap.org/).
17163 - name: named-query-uuid
17167 example: __NAMED-QUERY-UUID__
17168 - name: named-query-element-uuid
17172 example: __NAMED-QUERY-ELEMENT-UUID__
17173 - name: related-lookup-uuid
17177 example: __RELATED-LOOKUP-UUID__
17178 - name: resource-version
17180 description: resource-version for concurrency
17183 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
17186 - ServiceDesignAndCreation
17187 summary: returns related-lookups
17188 description: returns related-lookups
17189 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
17195 description: successful operation
17197 $ref: "#/getDefinitions/related-lookups"
17199 description: Response codes found in [response codes](https://wiki.onap.org/).
17201 - name: named-query-uuid
17205 example: __NAMED-QUERY-UUID__
17206 - name: named-query-element-uuid
17210 example: __NAMED-QUERY-ELEMENT-UUID__
17211 - name: related-lookup-uuid
17216 /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}:
17219 - ServiceDesignAndCreation
17220 summary: returns property-constraint
17221 description: returns property-constraint
17222 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17228 description: successful operation
17230 $ref: "#/getDefinitions/property-constraint"
17232 description: Response codes found in [response codes](https://wiki.onap.org/).
17234 - name: named-query-uuid
17238 example: __NAMED-QUERY-UUID__
17239 - name: named-query-element-uuid
17243 example: __NAMED-QUERY-ELEMENT-UUID__
17244 - name: property-constraint-uuid
17248 example: __PROPERTY-CONSTRAINT-UUID__
17251 - ServiceDesignAndCreation
17252 summary: create or update an existing property-constraint
17254 Create or update an existing property-constraint.
17256 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17257 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17266 description: Response codes found in [response codes](https://wiki.onap.org/).
17268 - name: named-query-uuid
17272 example: __NAMED-QUERY-UUID__
17273 - name: named-query-element-uuid
17277 example: __NAMED-QUERY-ELEMENT-UUID__
17278 - name: property-constraint-uuid
17282 example: __PROPERTY-CONSTRAINT-UUID__
17285 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
17288 $ref: "#/definitions/property-constraint"
17291 - ServiceDesignAndCreation
17292 summary: update an existing property-constraint
17294 Update an existing property-constraint
17296 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17297 The PUT operation will entirely replace an existing object.
17298 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17300 Other differences between PUT and PATCH are:
17302 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17303 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17304 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17305 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17314 description: Response codes found in [response codes](https://wiki.onap.org/).
17316 - name: named-query-uuid
17320 example: __NAMED-QUERY-UUID__
17321 - name: named-query-element-uuid
17325 example: __NAMED-QUERY-ELEMENT-UUID__
17326 - name: property-constraint-uuid
17330 example: __PROPERTY-CONSTRAINT-UUID__
17333 description: property-constraint object that needs to be updated.
17336 $ref: "#/patchDefinitions/property-constraint"
17339 - ServiceDesignAndCreation
17340 summary: delete an existing property-constraint
17341 description: delete an existing property-constraint
17342 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17351 description: Response codes found in [response codes](https://wiki.onap.org/).
17353 - name: named-query-uuid
17357 example: __NAMED-QUERY-UUID__
17358 - name: named-query-element-uuid
17362 example: __NAMED-QUERY-ELEMENT-UUID__
17363 - name: property-constraint-uuid
17367 example: __PROPERTY-CONSTRAINT-UUID__
17368 - name: resource-version
17370 description: resource-version for concurrency
17373 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
17376 - ServiceDesignAndCreation
17377 summary: returns property-constraints
17378 description: returns property-constraints
17379 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
17385 description: successful operation
17387 $ref: "#/getDefinitions/property-constraints"
17389 description: Response codes found in [response codes](https://wiki.onap.org/).
17391 - name: named-query-uuid
17395 example: __NAMED-QUERY-UUID__
17396 - name: named-query-element-uuid
17400 example: __NAMED-QUERY-ELEMENT-UUID__
17401 - name: property-constraint-uuid
17406 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
17409 - ServiceDesignAndCreation
17410 summary: see node definition for valid relationships
17411 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
17420 description: Response codes found in [response codes](https://wiki.onap.org/).
17422 - name: named-query-uuid
17426 example: __NAMED-QUERY-UUID__
17427 - name: named-query-element-uuid
17431 example: __NAMED-QUERY-ELEMENT-UUID__
17434 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
17437 $ref: "#/definitions/relationship"
17440 - ServiceDesignAndCreation
17441 summary: delete an existing relationship
17442 description: delete an existing relationship
17443 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
17452 description: Response codes found in [response codes](https://wiki.onap.org/).
17454 - name: named-query-uuid
17458 example: __NAMED-QUERY-UUID__
17459 - name: named-query-element-uuid
17463 example: __NAMED-QUERY-ELEMENT-UUID__
17464 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
17467 - ServiceDesignAndCreation
17468 summary: returns named-query-element
17469 description: returns named-query-element
17470 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17476 description: successful operation
17478 $ref: "#/getDefinitions/named-query-element"
17480 description: Response codes found in [response codes](https://wiki.onap.org/).
17482 - name: named-query-uuid
17486 example: __NAMED-QUERY-UUID__
17487 - name: named-query-element-uuid
17491 example: __NAMED-QUERY-ELEMENT-UUID__
17494 - ServiceDesignAndCreation
17495 summary: create or update an existing named-query-element
17497 Create or update an existing named-query-element.
17499 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17500 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17509 description: Response codes found in [response codes](https://wiki.onap.org/).
17511 - name: named-query-uuid
17515 example: __NAMED-QUERY-UUID__
17516 - name: named-query-element-uuid
17520 example: __NAMED-QUERY-ELEMENT-UUID__
17523 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
17526 $ref: "#/definitions/named-query-element"
17529 - ServiceDesignAndCreation
17530 summary: update an existing named-query-element
17532 Update an existing named-query-element
17534 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17535 The PUT operation will entirely replace an existing object.
17536 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17538 Other differences between PUT and PATCH are:
17540 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17541 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17542 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17543 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17552 description: Response codes found in [response codes](https://wiki.onap.org/).
17554 - name: named-query-uuid
17558 example: __NAMED-QUERY-UUID__
17559 - name: named-query-element-uuid
17563 example: __NAMED-QUERY-ELEMENT-UUID__
17566 description: named-query-element object that needs to be updated.
17569 $ref: "#/patchDefinitions/named-query-element"
17572 - ServiceDesignAndCreation
17573 summary: delete an existing named-query-element
17574 description: delete an existing named-query-element
17575 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17584 description: Response codes found in [response codes](https://wiki.onap.org/).
17586 - name: named-query-uuid
17590 example: __NAMED-QUERY-UUID__
17591 - name: named-query-element-uuid
17595 example: __NAMED-QUERY-ELEMENT-UUID__
17596 - name: resource-version
17598 description: resource-version for concurrency
17601 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
17604 - ServiceDesignAndCreation
17605 summary: returns named-query-elements
17606 description: returns named-query-elements
17607 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
17613 description: successful operation
17615 $ref: "#/getDefinitions/named-query-elements"
17617 description: Response codes found in [response codes](https://wiki.onap.org/).
17619 - name: named-query-uuid
17623 example: __NAMED-QUERY-UUID__
17624 - name: named-query-element-uuid
17629 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
17632 - ServiceDesignAndCreation
17633 summary: see node definition for valid relationships
17634 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
17643 description: Response codes found in [response codes](https://wiki.onap.org/).
17645 - name: named-query-uuid
17649 example: __NAMED-QUERY-UUID__
17652 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
17655 $ref: "#/definitions/relationship"
17658 - ServiceDesignAndCreation
17659 summary: delete an existing relationship
17660 description: delete an existing relationship
17661 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
17670 description: Response codes found in [response codes](https://wiki.onap.org/).
17672 - name: named-query-uuid
17676 example: __NAMED-QUERY-UUID__
17677 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
17680 - ServiceDesignAndCreation
17681 summary: returns named-query
17682 description: returns named-query
17683 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
17689 description: successful operation
17691 $ref: "#/getDefinitions/named-query"
17693 description: Response codes found in [response codes](https://wiki.onap.org/).
17695 - name: named-query-uuid
17699 example: __NAMED-QUERY-UUID__
17702 - ServiceDesignAndCreation
17703 summary: create or update an existing named-query
17705 Create or update an existing named-query.
17707 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17708 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
17717 description: Response codes found in [response codes](https://wiki.onap.org/).
17719 - name: named-query-uuid
17723 example: __NAMED-QUERY-UUID__
17726 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
17729 $ref: "#/definitions/named-query"
17732 - ServiceDesignAndCreation
17733 summary: update an existing named-query
17735 Update an existing named-query
17737 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17738 The PUT operation will entirely replace an existing object.
17739 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17741 Other differences between PUT and PATCH are:
17743 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17744 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17745 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17746 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
17755 description: Response codes found in [response codes](https://wiki.onap.org/).
17757 - name: named-query-uuid
17761 example: __NAMED-QUERY-UUID__
17764 description: named-query object that needs to be updated.
17767 $ref: "#/patchDefinitions/named-query"
17770 - ServiceDesignAndCreation
17771 summary: delete an existing named-query
17772 description: delete an existing named-query
17773 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
17782 description: Response codes found in [response codes](https://wiki.onap.org/).
17784 - name: named-query-uuid
17788 example: __NAMED-QUERY-UUID__
17789 - name: resource-version
17791 description: resource-version for concurrency
17794 /service-design-and-creation/named-queries:
17797 - ServiceDesignAndCreation
17798 summary: returns named-queries
17799 description: returns named-queries
17800 operationId: getServiceDesignAndCreationNamedQueries
17806 description: successful operation
17808 $ref: "#/getDefinitions/named-queries"
17810 description: Response codes found in [response codes](https://wiki.onap.org/).
17812 - name: named-query-uuid
17817 - name: named-query-name
17822 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
17826 summary: see node definition for valid relationships
17827 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
17836 description: Response codes found in [response codes](https://wiki.onap.org/).
17840 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17843 example: __LINK-NAME__
17846 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)
17849 $ref: "#/definitions/relationship"
17853 summary: delete an existing relationship
17854 description: delete an existing relationship
17855 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
17864 description: Response codes found in [response codes](https://wiki.onap.org/).
17868 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17871 example: __LINK-NAME__
17872 /network/logical-links/logical-link/{link-name}:
17876 summary: returns logical-link
17877 description: returns logical-link
17878 operationId: getNetworkLogicalLinksLogicalLink
17884 description: successful operation
17886 $ref: "#/getDefinitions/logical-link"
17888 description: Response codes found in [response codes](https://wiki.onap.org/).
17892 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17895 example: __LINK-NAME__
17899 summary: create or update an existing logical-link
17901 Create or update an existing logical-link.
17903 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17904 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
17913 description: Response codes found in [response codes](https://wiki.onap.org/).
17917 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17920 example: __LINK-NAME__
17923 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)
17926 $ref: "#/definitions/logical-link"
17930 summary: update an existing logical-link
17932 Update an existing logical-link
17934 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17935 The PUT operation will entirely replace an existing object.
17936 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17938 Other differences between PUT and PATCH are:
17940 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17941 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17942 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17943 operationId: UpdateNetworkLogicalLinksLogicalLink
17952 description: Response codes found in [response codes](https://wiki.onap.org/).
17956 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17959 example: __LINK-NAME__
17962 description: logical-link object that needs to be updated.
17965 $ref: "#/patchDefinitions/logical-link"
17969 summary: delete an existing logical-link
17970 description: delete an existing logical-link
17971 operationId: deleteNetworkLogicalLinksLogicalLink
17980 description: Response codes found in [response codes](https://wiki.onap.org/).
17984 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17987 example: __LINK-NAME__
17988 - name: resource-version
17990 description: resource-version for concurrency
17993 /network/logical-links:
17997 summary: returns logical-links
17998 description: returns logical-links
17999 operationId: getNetworkLogicalLinks
18005 description: successful operation
18007 $ref: "#/getDefinitions/logical-links"
18009 description: Response codes found in [response codes](https://wiki.onap.org/).
18016 - name: model-invariant-id
18021 - name: model-version-id
18026 - name: widget-model-id
18031 - name: widget-model-version
18036 - name: prov-status
18056 /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:
18060 summary: see node definition for valid relationships
18061 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18070 description: Response codes found in [response codes](https://wiki.onap.org/).
18072 - name: site-pair-set-id
18074 description: Unique id of site pair set.
18077 example: __SITE-PAIR-SET-ID__
18078 - name: routing-instance-id
18080 description: Unique id of routing instance
18083 example: __ROUTING-INSTANCE-ID__
18084 - name: site-pair-id
18086 description: unique identifier of probe
18089 example: __SITE-PAIR-ID__
18092 description: unique identifier of probe
18098 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18101 $ref: "#/definitions/relationship"
18105 summary: delete an existing relationship
18106 description: delete an existing relationship
18107 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18116 description: Response codes found in [response codes](https://wiki.onap.org/).
18118 - name: site-pair-set-id
18120 description: Unique id of site pair set.
18123 example: __SITE-PAIR-SET-ID__
18124 - name: routing-instance-id
18126 description: Unique id of routing instance
18129 example: __ROUTING-INSTANCE-ID__
18130 - name: site-pair-id
18132 description: unique identifier of probe
18135 example: __SITE-PAIR-ID__
18138 description: unique identifier of probe
18142 /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}:
18146 summary: returns class-of-service
18147 description: returns class-of-service
18148 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18154 description: successful operation
18156 $ref: "#/getDefinitions/class-of-service"
18158 description: Response codes found in [response codes](https://wiki.onap.org/).
18160 - name: site-pair-set-id
18162 description: Unique id of site pair set.
18165 example: __SITE-PAIR-SET-ID__
18166 - name: routing-instance-id
18168 description: Unique id of routing instance
18171 example: __ROUTING-INSTANCE-ID__
18172 - name: site-pair-id
18174 description: unique identifier of probe
18177 example: __SITE-PAIR-ID__
18180 description: unique identifier of probe
18187 summary: create or update an existing class-of-service
18189 Create or update an existing class-of-service.
18191 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18192 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18201 description: Response codes found in [response codes](https://wiki.onap.org/).
18203 - name: site-pair-set-id
18205 description: Unique id of site pair set.
18208 example: __SITE-PAIR-SET-ID__
18209 - name: routing-instance-id
18211 description: Unique id of routing instance
18214 example: __ROUTING-INSTANCE-ID__
18215 - name: site-pair-id
18217 description: unique identifier of probe
18220 example: __SITE-PAIR-ID__
18223 description: unique identifier of probe
18229 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18232 $ref: "#/definitions/class-of-service"
18236 summary: update an existing class-of-service
18238 Update an existing class-of-service
18240 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18241 The PUT operation will entirely replace an existing object.
18242 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18244 Other differences between PUT and PATCH are:
18246 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18247 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18248 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18249 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18258 description: Response codes found in [response codes](https://wiki.onap.org/).
18260 - name: site-pair-set-id
18262 description: Unique id of site pair set.
18265 example: __SITE-PAIR-SET-ID__
18266 - name: routing-instance-id
18268 description: Unique id of routing instance
18271 example: __ROUTING-INSTANCE-ID__
18272 - name: site-pair-id
18274 description: unique identifier of probe
18277 example: __SITE-PAIR-ID__
18280 description: unique identifier of probe
18286 description: class-of-service object that needs to be updated.
18289 $ref: "#/patchDefinitions/class-of-service"
18293 summary: delete an existing class-of-service
18294 description: delete an existing class-of-service
18295 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18304 description: Response codes found in [response codes](https://wiki.onap.org/).
18306 - name: site-pair-set-id
18308 description: Unique id of site pair set.
18311 example: __SITE-PAIR-SET-ID__
18312 - name: routing-instance-id
18314 description: Unique id of routing instance
18317 example: __ROUTING-INSTANCE-ID__
18318 - name: site-pair-id
18320 description: unique identifier of probe
18323 example: __SITE-PAIR-ID__
18326 description: unique identifier of probe
18330 - name: resource-version
18332 description: resource-version for concurrency
18335 /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:
18339 summary: returns classes-of-service
18340 description: returns classes-of-service
18341 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
18347 description: successful operation
18349 $ref: "#/getDefinitions/classes-of-service"
18351 description: Response codes found in [response codes](https://wiki.onap.org/).
18353 - name: site-pair-set-id
18355 description: Unique id of site pair set.
18358 example: __SITE-PAIR-SET-ID__
18359 - name: routing-instance-id
18361 description: Unique id of routing instance
18364 example: __ROUTING-INSTANCE-ID__
18365 - name: site-pair-id
18367 description: unique identifier of probe
18370 example: __SITE-PAIR-ID__
18376 /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:
18380 summary: see node definition for valid relationships
18381 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
18390 description: Response codes found in [response codes](https://wiki.onap.org/).
18392 - name: site-pair-set-id
18394 description: Unique id of site pair set.
18397 example: __SITE-PAIR-SET-ID__
18398 - name: routing-instance-id
18400 description: Unique id of routing instance
18403 example: __ROUTING-INSTANCE-ID__
18404 - name: site-pair-id
18406 description: unique identifier of probe
18409 example: __SITE-PAIR-ID__
18412 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
18415 $ref: "#/definitions/relationship"
18419 summary: delete an existing relationship
18420 description: delete an existing relationship
18421 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
18430 description: Response codes found in [response codes](https://wiki.onap.org/).
18432 - name: site-pair-set-id
18434 description: Unique id of site pair set.
18437 example: __SITE-PAIR-SET-ID__
18438 - name: routing-instance-id
18440 description: Unique id of routing instance
18443 example: __ROUTING-INSTANCE-ID__
18444 - name: site-pair-id
18446 description: unique identifier of probe
18449 example: __SITE-PAIR-ID__
18450 /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}:
18454 summary: returns site-pair
18455 description: returns site-pair
18456 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18462 description: successful operation
18464 $ref: "#/getDefinitions/site-pair"
18466 description: Response codes found in [response codes](https://wiki.onap.org/).
18468 - name: site-pair-set-id
18470 description: Unique id of site pair set.
18473 example: __SITE-PAIR-SET-ID__
18474 - name: routing-instance-id
18476 description: Unique id of routing instance
18479 example: __ROUTING-INSTANCE-ID__
18480 - name: site-pair-id
18482 description: unique identifier of probe
18485 example: __SITE-PAIR-ID__
18489 summary: create or update an existing site-pair
18491 Create or update an existing site-pair.
18493 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18494 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18503 description: Response codes found in [response codes](https://wiki.onap.org/).
18505 - name: site-pair-set-id
18507 description: Unique id of site pair set.
18510 example: __SITE-PAIR-SET-ID__
18511 - name: routing-instance-id
18513 description: Unique id of routing instance
18516 example: __ROUTING-INSTANCE-ID__
18517 - name: site-pair-id
18519 description: unique identifier of probe
18522 example: __SITE-PAIR-ID__
18525 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
18528 $ref: "#/definitions/site-pair"
18532 summary: update an existing site-pair
18534 Update an existing site-pair
18536 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18537 The PUT operation will entirely replace an existing object.
18538 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18540 Other differences between PUT and PATCH are:
18542 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18543 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18544 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18545 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18554 description: Response codes found in [response codes](https://wiki.onap.org/).
18556 - name: site-pair-set-id
18558 description: Unique id of site pair set.
18561 example: __SITE-PAIR-SET-ID__
18562 - name: routing-instance-id
18564 description: Unique id of routing instance
18567 example: __ROUTING-INSTANCE-ID__
18568 - name: site-pair-id
18570 description: unique identifier of probe
18573 example: __SITE-PAIR-ID__
18576 description: site-pair object that needs to be updated.
18579 $ref: "#/patchDefinitions/site-pair"
18583 summary: delete an existing site-pair
18584 description: delete an existing site-pair
18585 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18594 description: Response codes found in [response codes](https://wiki.onap.org/).
18596 - name: site-pair-set-id
18598 description: Unique id of site pair set.
18601 example: __SITE-PAIR-SET-ID__
18602 - name: routing-instance-id
18604 description: Unique id of routing instance
18607 example: __ROUTING-INSTANCE-ID__
18608 - name: site-pair-id
18610 description: unique identifier of probe
18613 example: __SITE-PAIR-ID__
18614 - name: resource-version
18616 description: resource-version for concurrency
18619 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
18623 summary: returns site-pairs
18624 description: returns site-pairs
18625 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
18631 description: successful operation
18633 $ref: "#/getDefinitions/site-pairs"
18635 description: Response codes found in [response codes](https://wiki.onap.org/).
18637 - name: site-pair-set-id
18639 description: Unique id of site pair set.
18642 example: __SITE-PAIR-SET-ID__
18643 - name: routing-instance-id
18645 description: Unique id of routing instance
18648 example: __ROUTING-INSTANCE-ID__
18649 - name: site-pair-id
18654 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
18658 summary: see node definition for valid relationships
18659 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
18668 description: Response codes found in [response codes](https://wiki.onap.org/).
18670 - name: site-pair-set-id
18672 description: Unique id of site pair set.
18675 example: __SITE-PAIR-SET-ID__
18676 - name: routing-instance-id
18678 description: Unique id of routing instance
18681 example: __ROUTING-INSTANCE-ID__
18684 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
18687 $ref: "#/definitions/relationship"
18691 summary: delete an existing relationship
18692 description: delete an existing relationship
18693 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
18702 description: Response codes found in [response codes](https://wiki.onap.org/).
18704 - name: site-pair-set-id
18706 description: Unique id of site pair set.
18709 example: __SITE-PAIR-SET-ID__
18710 - name: routing-instance-id
18712 description: Unique id of routing instance
18715 example: __ROUTING-INSTANCE-ID__
18716 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
18720 summary: returns routing-instance
18721 description: returns routing-instance
18722 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18728 description: successful operation
18730 $ref: "#/getDefinitions/routing-instance"
18732 description: Response codes found in [response codes](https://wiki.onap.org/).
18734 - name: site-pair-set-id
18736 description: Unique id of site pair set.
18739 example: __SITE-PAIR-SET-ID__
18740 - name: routing-instance-id
18742 description: Unique id of routing instance
18745 example: __ROUTING-INSTANCE-ID__
18749 summary: create or update an existing routing-instance
18751 Create or update an existing routing-instance.
18753 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18754 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18763 description: Response codes found in [response codes](https://wiki.onap.org/).
18765 - name: site-pair-set-id
18767 description: Unique id of site pair set.
18770 example: __SITE-PAIR-SET-ID__
18771 - name: routing-instance-id
18773 description: Unique id of routing instance
18776 example: __ROUTING-INSTANCE-ID__
18779 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
18782 $ref: "#/definitions/routing-instance"
18786 summary: update an existing routing-instance
18788 Update an existing routing-instance
18790 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18791 The PUT operation will entirely replace an existing object.
18792 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18794 Other differences between PUT and PATCH are:
18796 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18797 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18798 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18799 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18808 description: Response codes found in [response codes](https://wiki.onap.org/).
18810 - name: site-pair-set-id
18812 description: Unique id of site pair set.
18815 example: __SITE-PAIR-SET-ID__
18816 - name: routing-instance-id
18818 description: Unique id of routing instance
18821 example: __ROUTING-INSTANCE-ID__
18824 description: routing-instance object that needs to be updated.
18827 $ref: "#/patchDefinitions/routing-instance"
18831 summary: delete an existing routing-instance
18832 description: delete an existing routing-instance
18833 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18842 description: Response codes found in [response codes](https://wiki.onap.org/).
18844 - name: site-pair-set-id
18846 description: Unique id of site pair set.
18849 example: __SITE-PAIR-SET-ID__
18850 - name: routing-instance-id
18852 description: Unique id of routing instance
18855 example: __ROUTING-INSTANCE-ID__
18856 - name: resource-version
18858 description: resource-version for concurrency
18861 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
18865 summary: returns routing-instances
18866 description: returns routing-instances
18867 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
18873 description: successful operation
18875 $ref: "#/getDefinitions/routing-instances"
18877 description: Response codes found in [response codes](https://wiki.onap.org/).
18879 - name: site-pair-set-id
18881 description: Unique id of site pair set.
18884 example: __SITE-PAIR-SET-ID__
18885 - name: routing-instance-id
18890 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
18894 summary: see node definition for valid relationships
18895 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
18904 description: Response codes found in [response codes](https://wiki.onap.org/).
18906 - name: site-pair-set-id
18908 description: Unique id of site pair set.
18911 example: __SITE-PAIR-SET-ID__
18914 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)
18917 $ref: "#/definitions/relationship"
18921 summary: delete an existing relationship
18922 description: delete an existing relationship
18923 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
18932 description: Response codes found in [response codes](https://wiki.onap.org/).
18934 - name: site-pair-set-id
18936 description: Unique id of site pair set.
18939 example: __SITE-PAIR-SET-ID__
18940 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
18944 summary: returns site-pair-set
18945 description: returns site-pair-set
18946 operationId: getNetworkSitePairSetsSitePairSet
18952 description: successful operation
18954 $ref: "#/getDefinitions/site-pair-set"
18956 description: Response codes found in [response codes](https://wiki.onap.org/).
18958 - name: site-pair-set-id
18960 description: Unique id of site pair set.
18963 example: __SITE-PAIR-SET-ID__
18967 summary: create or update an existing site-pair-set
18969 Create or update an existing site-pair-set.
18971 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18972 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
18981 description: Response codes found in [response codes](https://wiki.onap.org/).
18983 - name: site-pair-set-id
18985 description: Unique id of site pair set.
18988 example: __SITE-PAIR-SET-ID__
18991 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)
18994 $ref: "#/definitions/site-pair-set"
18998 summary: update an existing site-pair-set
19000 Update an existing site-pair-set
19002 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19003 The PUT operation will entirely replace an existing object.
19004 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19006 Other differences between PUT and PATCH are:
19008 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19009 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19010 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19011 operationId: UpdateNetworkSitePairSetsSitePairSet
19020 description: Response codes found in [response codes](https://wiki.onap.org/).
19022 - name: site-pair-set-id
19024 description: Unique id of site pair set.
19027 example: __SITE-PAIR-SET-ID__
19030 description: site-pair-set object that needs to be updated.
19033 $ref: "#/patchDefinitions/site-pair-set"
19037 summary: delete an existing site-pair-set
19038 description: delete an existing site-pair-set
19039 operationId: deleteNetworkSitePairSetsSitePairSet
19048 description: Response codes found in [response codes](https://wiki.onap.org/).
19050 - name: site-pair-set-id
19052 description: Unique id of site pair set.
19055 example: __SITE-PAIR-SET-ID__
19056 - name: resource-version
19058 description: resource-version for concurrency
19061 /network/site-pair-sets:
19065 summary: returns site-pair-sets
19066 description: returns site-pair-sets
19067 operationId: getNetworkSitePairSets
19073 description: successful operation
19075 $ref: "#/getDefinitions/site-pair-sets"
19077 description: Response codes found in [response codes](https://wiki.onap.org/).
19079 - name: site-pair-set-id
19084 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
19088 summary: see node definition for valid relationships
19089 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
19098 description: Response codes found in [response codes](https://wiki.onap.org/).
19102 description: VPN ID, globally unique within A&AI
19105 example: __VPN-ID__
19106 - name: global-route-target
19108 description: Number used to identify an RT, globally unique in the network
19111 example: __GLOBAL-ROUTE-TARGET__
19112 - name: route-target-role
19114 description: Role assigned to this route target
19117 example: __ROUTE-TARGET-ROLE__
19120 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
19123 $ref: "#/definitions/relationship"
19127 summary: delete an existing relationship
19128 description: delete an existing relationship
19129 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
19138 description: Response codes found in [response codes](https://wiki.onap.org/).
19142 description: VPN ID, globally unique within A&AI
19145 example: __VPN-ID__
19146 - name: global-route-target
19148 description: Number used to identify an RT, globally unique in the network
19151 example: __GLOBAL-ROUTE-TARGET__
19152 - name: route-target-role
19154 description: Role assigned to this route target
19157 example: __ROUTE-TARGET-ROLE__
19158 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
19162 summary: returns route-target
19163 description: returns route-target
19164 operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
19170 description: successful operation
19172 $ref: "#/getDefinitions/route-target"
19174 description: Response codes found in [response codes](https://wiki.onap.org/).
19178 description: VPN ID, globally unique within A&AI
19181 example: __VPN-ID__
19182 - name: global-route-target
19184 description: Number used to identify an RT, globally unique in the network
19187 example: __GLOBAL-ROUTE-TARGET__
19188 - name: route-target-role
19190 description: Role assigned to this route target
19193 example: __ROUTE-TARGET-ROLE__
19197 summary: create or update an existing route-target
19199 Create or update an existing route-target.
19201 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19202 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
19211 description: Response codes found in [response codes](https://wiki.onap.org/).
19215 description: VPN ID, globally unique within A&AI
19218 example: __VPN-ID__
19219 - name: global-route-target
19221 description: Number used to identify an RT, globally unique in the network
19224 example: __GLOBAL-ROUTE-TARGET__
19225 - name: route-target-role
19227 description: Role assigned to this route target
19230 example: __ROUTE-TARGET-ROLE__
19233 description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
19236 $ref: "#/definitions/route-target"
19240 summary: update an existing route-target
19242 Update an existing route-target
19244 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19245 The PUT operation will entirely replace an existing object.
19246 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19248 Other differences between PUT and PATCH are:
19250 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19251 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19252 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19253 operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
19262 description: Response codes found in [response codes](https://wiki.onap.org/).
19266 description: VPN ID, globally unique within A&AI
19269 example: __VPN-ID__
19270 - name: global-route-target
19272 description: Number used to identify an RT, globally unique in the network
19275 example: __GLOBAL-ROUTE-TARGET__
19276 - name: route-target-role
19278 description: Role assigned to this route target
19281 example: __ROUTE-TARGET-ROLE__
19284 description: route-target object that needs to be updated.
19287 $ref: "#/patchDefinitions/route-target"
19291 summary: delete an existing route-target
19292 description: delete an existing route-target
19293 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
19302 description: Response codes found in [response codes](https://wiki.onap.org/).
19306 description: VPN ID, globally unique within A&AI
19309 example: __VPN-ID__
19310 - name: global-route-target
19312 description: Number used to identify an RT, globally unique in the network
19315 example: __GLOBAL-ROUTE-TARGET__
19316 - name: route-target-role
19318 description: Role assigned to this route target
19321 example: __ROUTE-TARGET-ROLE__
19322 - name: resource-version
19324 description: resource-version for concurrency
19327 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
19331 summary: returns route-targets
19332 description: returns route-targets
19333 operationId: getNetworkVpnBindingsVpnBindingRouteTargets
19339 description: successful operation
19341 $ref: "#/getDefinitions/route-targets"
19343 description: Response codes found in [response codes](https://wiki.onap.org/).
19347 description: VPN ID, globally unique within A&AI
19350 example: __VPN-ID__
19351 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
19355 summary: see node definition for valid relationships
19356 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
19365 description: Response codes found in [response codes](https://wiki.onap.org/).
19369 description: VPN ID, globally unique within A&AI
19372 example: __VPN-ID__
19375 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)
19378 $ref: "#/definitions/relationship"
19382 summary: delete an existing relationship
19383 description: delete an existing relationship
19384 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
19393 description: Response codes found in [response codes](https://wiki.onap.org/).
19397 description: VPN ID, globally unique within A&AI
19400 example: __VPN-ID__
19401 /network/vpn-bindings/vpn-binding/{vpn-id}:
19405 summary: returns vpn-binding
19406 description: returns vpn-binding
19407 operationId: getNetworkVpnBindingsVpnBinding
19413 description: successful operation
19415 $ref: "#/getDefinitions/vpn-binding"
19417 description: Response codes found in [response codes](https://wiki.onap.org/).
19421 description: VPN ID, globally unique within A&AI
19424 example: __VPN-ID__
19428 summary: create or update an existing vpn-binding
19430 Create or update an existing vpn-binding.
19432 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19433 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
19442 description: Response codes found in [response codes](https://wiki.onap.org/).
19446 description: VPN ID, globally unique within A&AI
19449 example: __VPN-ID__
19452 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)
19455 $ref: "#/definitions/vpn-binding"
19459 summary: update an existing vpn-binding
19461 Update an existing vpn-binding
19463 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19464 The PUT operation will entirely replace an existing object.
19465 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19467 Other differences between PUT and PATCH are:
19469 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19470 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19471 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19472 operationId: UpdateNetworkVpnBindingsVpnBinding
19481 description: Response codes found in [response codes](https://wiki.onap.org/).
19485 description: VPN ID, globally unique within A&AI
19488 example: __VPN-ID__
19491 description: vpn-binding object that needs to be updated.
19494 $ref: "#/patchDefinitions/vpn-binding"
19498 summary: delete an existing vpn-binding
19499 description: delete an existing vpn-binding
19500 operationId: deleteNetworkVpnBindingsVpnBinding
19509 description: Response codes found in [response codes](https://wiki.onap.org/).
19513 description: VPN ID, globally unique within A&AI
19516 example: __VPN-ID__
19517 - name: resource-version
19519 description: resource-version for concurrency
19522 /network/vpn-bindings:
19526 summary: returns vpn-bindings
19527 description: returns vpn-bindings
19528 operationId: getNetworkVpnBindings
19534 description: successful operation
19536 $ref: "#/getDefinitions/vpn-bindings"
19538 description: Response codes found in [response codes](https://wiki.onap.org/).
19555 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
19559 summary: see node definition for valid relationships
19560 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
19569 description: Response codes found in [response codes](https://wiki.onap.org/).
19571 - name: equipment-name
19575 example: __EQUIPMENT-NAME__
19578 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)
19581 $ref: "#/definitions/relationship"
19585 summary: delete an existing relationship
19586 description: delete an existing relationship
19587 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
19596 description: Response codes found in [response codes](https://wiki.onap.org/).
19598 - name: equipment-name
19602 example: __EQUIPMENT-NAME__
19603 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
19607 summary: see node definition for valid relationships
19608 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19617 description: Response codes found in [response codes](https://wiki.onap.org/).
19619 - name: equipment-name
19623 example: __EQUIPMENT-NAME__
19624 - name: interface-name
19626 description: Name that identifies the physical interface
19629 example: __INTERFACE-NAME__
19632 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)
19635 $ref: "#/definitions/relationship"
19639 summary: delete an existing relationship
19640 description: delete an existing relationship
19641 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19650 description: Response codes found in [response codes](https://wiki.onap.org/).
19652 - name: equipment-name
19656 example: __EQUIPMENT-NAME__
19657 - name: interface-name
19659 description: Name that identifies the physical interface
19662 example: __INTERFACE-NAME__
19663 /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:
19667 summary: see node definition for valid relationships
19668 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
19677 description: Response codes found in [response codes](https://wiki.onap.org/).
19679 - name: equipment-name
19683 example: __EQUIPMENT-NAME__
19684 - name: interface-name
19686 description: Name that identifies the physical interface
19689 example: __INTERFACE-NAME__
19690 - name: interface-name
19692 description: Name given to the interface
19695 example: __INTERFACE-NAME__
19696 - name: vlan-interface
19698 description: String that identifies the interface
19701 example: __VLAN-INTERFACE__
19704 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
19707 $ref: "#/definitions/relationship"
19711 summary: delete an existing relationship
19712 description: delete an existing relationship
19713 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
19722 description: Response codes found in [response codes](https://wiki.onap.org/).
19724 - name: equipment-name
19728 example: __EQUIPMENT-NAME__
19729 - name: interface-name
19731 description: Name that identifies the physical interface
19734 example: __INTERFACE-NAME__
19735 - name: interface-name
19737 description: Name given to the interface
19740 example: __INTERFACE-NAME__
19741 - name: vlan-interface
19743 description: String that identifies the interface
19746 example: __VLAN-INTERFACE__
19747 /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:
19751 summary: see node definition for valid relationships
19752 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
19761 description: Response codes found in [response codes](https://wiki.onap.org/).
19763 - name: equipment-name
19767 example: __EQUIPMENT-NAME__
19768 - name: interface-name
19770 description: Name that identifies the physical interface
19773 example: __INTERFACE-NAME__
19774 - name: interface-name
19776 description: Name given to the interface
19779 example: __INTERFACE-NAME__
19780 - name: vlan-interface
19782 description: String that identifies the interface
19785 example: __VLAN-INTERFACE__
19786 - name: l3-interface-ipv4-address
19788 description: IP address
19791 example: __L3-INTERFACE-IPV4-ADDRESS__
19794 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
19797 $ref: "#/definitions/relationship"
19801 summary: delete an existing relationship
19802 description: delete an existing relationship
19803 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
19812 description: Response codes found in [response codes](https://wiki.onap.org/).
19814 - name: equipment-name
19818 example: __EQUIPMENT-NAME__
19819 - name: interface-name
19821 description: Name that identifies the physical interface
19824 example: __INTERFACE-NAME__
19825 - name: interface-name
19827 description: Name given to the interface
19830 example: __INTERFACE-NAME__
19831 - name: vlan-interface
19833 description: String that identifies the interface
19836 example: __VLAN-INTERFACE__
19837 - name: l3-interface-ipv4-address
19839 description: IP address
19842 example: __L3-INTERFACE-IPV4-ADDRESS__
19843 /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}:
19847 summary: returns l3-interface-ipv4-address-list
19848 description: returns l3-interface-ipv4-address-list
19849 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19855 description: successful operation
19857 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
19859 description: Response codes found in [response codes](https://wiki.onap.org/).
19861 - name: equipment-name
19865 example: __EQUIPMENT-NAME__
19866 - name: interface-name
19868 description: Name that identifies the physical interface
19871 example: __INTERFACE-NAME__
19872 - name: interface-name
19874 description: Name given to the interface
19877 example: __INTERFACE-NAME__
19878 - name: vlan-interface
19880 description: String that identifies the interface
19883 example: __VLAN-INTERFACE__
19884 - name: l3-interface-ipv4-address
19886 description: IP address
19889 example: __L3-INTERFACE-IPV4-ADDRESS__
19893 summary: create or update an existing l3-interface-ipv4-address-list
19895 Create or update an existing l3-interface-ipv4-address-list.
19897 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19898 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19907 description: Response codes found in [response codes](https://wiki.onap.org/).
19909 - name: equipment-name
19913 example: __EQUIPMENT-NAME__
19914 - name: interface-name
19916 description: Name that identifies the physical interface
19919 example: __INTERFACE-NAME__
19920 - name: interface-name
19922 description: Name given to the interface
19925 example: __INTERFACE-NAME__
19926 - name: vlan-interface
19928 description: String that identifies the interface
19931 example: __VLAN-INTERFACE__
19932 - name: l3-interface-ipv4-address
19934 description: IP address
19937 example: __L3-INTERFACE-IPV4-ADDRESS__
19940 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
19943 $ref: "#/definitions/l3-interface-ipv4-address-list"
19947 summary: update an existing l3-interface-ipv4-address-list
19949 Update an existing l3-interface-ipv4-address-list
19951 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19952 The PUT operation will entirely replace an existing object.
19953 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19955 Other differences between PUT and PATCH are:
19957 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19958 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19959 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19960 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19969 description: Response codes found in [response codes](https://wiki.onap.org/).
19971 - name: equipment-name
19975 example: __EQUIPMENT-NAME__
19976 - name: interface-name
19978 description: Name that identifies the physical interface
19981 example: __INTERFACE-NAME__
19982 - name: interface-name
19984 description: Name given to the interface
19987 example: __INTERFACE-NAME__
19988 - name: vlan-interface
19990 description: String that identifies the interface
19993 example: __VLAN-INTERFACE__
19994 - name: l3-interface-ipv4-address
19996 description: IP address
19999 example: __L3-INTERFACE-IPV4-ADDRESS__
20002 description: l3-interface-ipv4-address-list object that needs to be updated.
20005 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
20009 summary: delete an existing l3-interface-ipv4-address-list
20010 description: delete an existing l3-interface-ipv4-address-list
20011 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20020 description: Response codes found in [response codes](https://wiki.onap.org/).
20022 - name: equipment-name
20026 example: __EQUIPMENT-NAME__
20027 - name: interface-name
20029 description: Name that identifies the physical interface
20032 example: __INTERFACE-NAME__
20033 - name: interface-name
20035 description: Name given to the interface
20038 example: __INTERFACE-NAME__
20039 - name: vlan-interface
20041 description: String that identifies the interface
20044 example: __VLAN-INTERFACE__
20045 - name: l3-interface-ipv4-address
20047 description: IP address
20050 example: __L3-INTERFACE-IPV4-ADDRESS__
20051 - name: resource-version
20053 description: resource-version for concurrency
20056 /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:
20060 summary: see node definition for valid relationships
20061 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20070 description: Response codes found in [response codes](https://wiki.onap.org/).
20072 - name: equipment-name
20076 example: __EQUIPMENT-NAME__
20077 - name: interface-name
20079 description: Name that identifies the physical interface
20082 example: __INTERFACE-NAME__
20083 - name: interface-name
20085 description: Name given to the interface
20088 example: __INTERFACE-NAME__
20089 - name: vlan-interface
20091 description: String that identifies the interface
20094 example: __VLAN-INTERFACE__
20095 - name: l3-interface-ipv6-address
20097 description: IP address
20100 example: __L3-INTERFACE-IPV6-ADDRESS__
20103 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
20106 $ref: "#/definitions/relationship"
20110 summary: delete an existing relationship
20111 description: delete an existing relationship
20112 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20121 description: Response codes found in [response codes](https://wiki.onap.org/).
20123 - name: equipment-name
20127 example: __EQUIPMENT-NAME__
20128 - name: interface-name
20130 description: Name that identifies the physical interface
20133 example: __INTERFACE-NAME__
20134 - name: interface-name
20136 description: Name given to the interface
20139 example: __INTERFACE-NAME__
20140 - name: vlan-interface
20142 description: String that identifies the interface
20145 example: __VLAN-INTERFACE__
20146 - name: l3-interface-ipv6-address
20148 description: IP address
20151 example: __L3-INTERFACE-IPV6-ADDRESS__
20152 /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}:
20156 summary: returns l3-interface-ipv6-address-list
20157 description: returns l3-interface-ipv6-address-list
20158 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20164 description: successful operation
20166 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
20168 description: Response codes found in [response codes](https://wiki.onap.org/).
20170 - name: equipment-name
20174 example: __EQUIPMENT-NAME__
20175 - name: interface-name
20177 description: Name that identifies the physical interface
20180 example: __INTERFACE-NAME__
20181 - name: interface-name
20183 description: Name given to the interface
20186 example: __INTERFACE-NAME__
20187 - name: vlan-interface
20189 description: String that identifies the interface
20192 example: __VLAN-INTERFACE__
20193 - name: l3-interface-ipv6-address
20195 description: IP address
20198 example: __L3-INTERFACE-IPV6-ADDRESS__
20202 summary: create or update an existing l3-interface-ipv6-address-list
20204 Create or update an existing l3-interface-ipv6-address-list.
20206 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20207 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20216 description: Response codes found in [response codes](https://wiki.onap.org/).
20218 - name: equipment-name
20222 example: __EQUIPMENT-NAME__
20223 - name: interface-name
20225 description: Name that identifies the physical interface
20228 example: __INTERFACE-NAME__
20229 - name: interface-name
20231 description: Name given to the interface
20234 example: __INTERFACE-NAME__
20235 - name: vlan-interface
20237 description: String that identifies the interface
20240 example: __VLAN-INTERFACE__
20241 - name: l3-interface-ipv6-address
20243 description: IP address
20246 example: __L3-INTERFACE-IPV6-ADDRESS__
20249 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
20252 $ref: "#/definitions/l3-interface-ipv6-address-list"
20256 summary: update an existing l3-interface-ipv6-address-list
20258 Update an existing l3-interface-ipv6-address-list
20260 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20261 The PUT operation will entirely replace an existing object.
20262 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20264 Other differences between PUT and PATCH are:
20266 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20267 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20268 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20269 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20278 description: Response codes found in [response codes](https://wiki.onap.org/).
20280 - name: equipment-name
20284 example: __EQUIPMENT-NAME__
20285 - name: interface-name
20287 description: Name that identifies the physical interface
20290 example: __INTERFACE-NAME__
20291 - name: interface-name
20293 description: Name given to the interface
20296 example: __INTERFACE-NAME__
20297 - name: vlan-interface
20299 description: String that identifies the interface
20302 example: __VLAN-INTERFACE__
20303 - name: l3-interface-ipv6-address
20305 description: IP address
20308 example: __L3-INTERFACE-IPV6-ADDRESS__
20311 description: l3-interface-ipv6-address-list object that needs to be updated.
20314 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
20318 summary: delete an existing l3-interface-ipv6-address-list
20319 description: delete an existing l3-interface-ipv6-address-list
20320 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20329 description: Response codes found in [response codes](https://wiki.onap.org/).
20331 - name: equipment-name
20335 example: __EQUIPMENT-NAME__
20336 - name: interface-name
20338 description: Name that identifies the physical interface
20341 example: __INTERFACE-NAME__
20342 - name: interface-name
20344 description: Name given to the interface
20347 example: __INTERFACE-NAME__
20348 - name: vlan-interface
20350 description: String that identifies the interface
20353 example: __VLAN-INTERFACE__
20354 - name: l3-interface-ipv6-address
20356 description: IP address
20359 example: __L3-INTERFACE-IPV6-ADDRESS__
20360 - name: resource-version
20362 description: resource-version for concurrency
20365 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
20369 summary: returns vlan
20370 description: returns vlan
20371 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20377 description: successful operation
20379 $ref: "#/getDefinitions/vlan"
20381 description: Response codes found in [response codes](https://wiki.onap.org/).
20383 - name: equipment-name
20387 example: __EQUIPMENT-NAME__
20388 - name: interface-name
20390 description: Name that identifies the physical interface
20393 example: __INTERFACE-NAME__
20394 - name: interface-name
20396 description: Name given to the interface
20399 example: __INTERFACE-NAME__
20400 - name: vlan-interface
20402 description: String that identifies the interface
20405 example: __VLAN-INTERFACE__
20409 summary: create or update an existing vlan
20411 Create or update an existing vlan.
20413 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20414 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20423 description: Response codes found in [response codes](https://wiki.onap.org/).
20425 - name: equipment-name
20429 example: __EQUIPMENT-NAME__
20430 - name: interface-name
20432 description: Name that identifies the physical interface
20435 example: __INTERFACE-NAME__
20436 - name: interface-name
20438 description: Name given to the interface
20441 example: __INTERFACE-NAME__
20442 - name: vlan-interface
20444 description: String that identifies the interface
20447 example: __VLAN-INTERFACE__
20450 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
20453 $ref: "#/definitions/vlan"
20457 summary: update an existing vlan
20459 Update an existing vlan
20461 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20462 The PUT operation will entirely replace an existing object.
20463 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20465 Other differences between PUT and PATCH are:
20467 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20468 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20469 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20470 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20479 description: Response codes found in [response codes](https://wiki.onap.org/).
20481 - name: equipment-name
20485 example: __EQUIPMENT-NAME__
20486 - name: interface-name
20488 description: Name that identifies the physical interface
20491 example: __INTERFACE-NAME__
20492 - name: interface-name
20494 description: Name given to the interface
20497 example: __INTERFACE-NAME__
20498 - name: vlan-interface
20500 description: String that identifies the interface
20503 example: __VLAN-INTERFACE__
20506 description: vlan object that needs to be updated.
20509 $ref: "#/patchDefinitions/vlan"
20513 summary: delete an existing vlan
20514 description: delete an existing vlan
20515 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20524 description: Response codes found in [response codes](https://wiki.onap.org/).
20526 - name: equipment-name
20530 example: __EQUIPMENT-NAME__
20531 - name: interface-name
20533 description: Name that identifies the physical interface
20536 example: __INTERFACE-NAME__
20537 - name: interface-name
20539 description: Name given to the interface
20542 example: __INTERFACE-NAME__
20543 - name: vlan-interface
20545 description: String that identifies the interface
20548 example: __VLAN-INTERFACE__
20549 - name: resource-version
20551 description: resource-version for concurrency
20554 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
20558 summary: returns vlans
20559 description: returns vlans
20560 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
20566 description: successful operation
20568 $ref: "#/getDefinitions/vlans"
20570 description: Response codes found in [response codes](https://wiki.onap.org/).
20572 - name: equipment-name
20576 example: __EQUIPMENT-NAME__
20577 - name: interface-name
20579 description: Name that identifies the physical interface
20582 example: __INTERFACE-NAME__
20583 - name: interface-name
20585 description: Name given to the interface
20588 example: __INTERFACE-NAME__
20589 - name: vlan-interface
20594 - name: vlan-id-inner
20605 /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:
20609 summary: see node definition for valid relationships
20610 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
20619 description: Response codes found in [response codes](https://wiki.onap.org/).
20621 - name: equipment-name
20625 example: __EQUIPMENT-NAME__
20626 - name: interface-name
20628 description: Name that identifies the physical interface
20631 example: __INTERFACE-NAME__
20632 - name: interface-name
20634 description: Name given to the interface
20637 example: __INTERFACE-NAME__
20640 description: PCI ID used to identify the sriov-vf
20643 example: __PCI-ID__
20646 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
20649 $ref: "#/definitions/relationship"
20653 summary: delete an existing relationship
20654 description: delete an existing relationship
20655 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
20664 description: Response codes found in [response codes](https://wiki.onap.org/).
20666 - name: equipment-name
20670 example: __EQUIPMENT-NAME__
20671 - name: interface-name
20673 description: Name that identifies the physical interface
20676 example: __INTERFACE-NAME__
20677 - name: interface-name
20679 description: Name given to the interface
20682 example: __INTERFACE-NAME__
20685 description: PCI ID used to identify the sriov-vf
20688 example: __PCI-ID__
20689 /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}:
20693 summary: returns sriov-vf
20694 description: returns sriov-vf
20695 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20701 description: successful operation
20703 $ref: "#/getDefinitions/sriov-vf"
20705 description: Response codes found in [response codes](https://wiki.onap.org/).
20707 - name: equipment-name
20711 example: __EQUIPMENT-NAME__
20712 - name: interface-name
20714 description: Name that identifies the physical interface
20717 example: __INTERFACE-NAME__
20718 - name: interface-name
20720 description: Name given to the interface
20723 example: __INTERFACE-NAME__
20726 description: PCI ID used to identify the sriov-vf
20729 example: __PCI-ID__
20733 summary: create or update an existing sriov-vf
20735 Create or update an existing sriov-vf.
20737 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20738 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20747 description: Response codes found in [response codes](https://wiki.onap.org/).
20749 - name: equipment-name
20753 example: __EQUIPMENT-NAME__
20754 - name: interface-name
20756 description: Name that identifies the physical interface
20759 example: __INTERFACE-NAME__
20760 - name: interface-name
20762 description: Name given to the interface
20765 example: __INTERFACE-NAME__
20768 description: PCI ID used to identify the sriov-vf
20771 example: __PCI-ID__
20774 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
20777 $ref: "#/definitions/sriov-vf"
20781 summary: update an existing sriov-vf
20783 Update an existing sriov-vf
20785 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20786 The PUT operation will entirely replace an existing object.
20787 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20789 Other differences between PUT and PATCH are:
20791 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20792 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20793 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20794 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20803 description: Response codes found in [response codes](https://wiki.onap.org/).
20805 - name: equipment-name
20809 example: __EQUIPMENT-NAME__
20810 - name: interface-name
20812 description: Name that identifies the physical interface
20815 example: __INTERFACE-NAME__
20816 - name: interface-name
20818 description: Name given to the interface
20821 example: __INTERFACE-NAME__
20824 description: PCI ID used to identify the sriov-vf
20827 example: __PCI-ID__
20830 description: sriov-vf object that needs to be updated.
20833 $ref: "#/patchDefinitions/sriov-vf"
20837 summary: delete an existing sriov-vf
20838 description: delete an existing sriov-vf
20839 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20848 description: Response codes found in [response codes](https://wiki.onap.org/).
20850 - name: equipment-name
20854 example: __EQUIPMENT-NAME__
20855 - name: interface-name
20857 description: Name that identifies the physical interface
20860 example: __INTERFACE-NAME__
20861 - name: interface-name
20863 description: Name given to the interface
20866 example: __INTERFACE-NAME__
20869 description: PCI ID used to identify the sriov-vf
20872 example: __PCI-ID__
20873 - name: resource-version
20875 description: resource-version for concurrency
20878 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
20882 summary: returns sriov-vfs
20883 description: returns sriov-vfs
20884 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
20890 description: successful operation
20892 $ref: "#/getDefinitions/sriov-vfs"
20894 description: Response codes found in [response codes](https://wiki.onap.org/).
20896 - name: equipment-name
20900 example: __EQUIPMENT-NAME__
20901 - name: interface-name
20903 description: Name that identifies the physical interface
20906 example: __INTERFACE-NAME__
20907 - name: interface-name
20909 description: Name given to the interface
20912 example: __INTERFACE-NAME__
20918 - name: vf-vlan-filter
20923 - name: vf-mac-filter
20928 - name: vf-vlan-strip
20933 - name: neutron-network-id
20938 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
20942 summary: see node definition for valid relationships
20943 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
20952 description: Response codes found in [response codes](https://wiki.onap.org/).
20954 - name: equipment-name
20958 example: __EQUIPMENT-NAME__
20959 - name: interface-name
20961 description: Name that identifies the physical interface
20964 example: __INTERFACE-NAME__
20965 - name: interface-name
20967 description: Name given to the interface
20970 example: __INTERFACE-NAME__
20973 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
20976 $ref: "#/definitions/relationship"
20980 summary: delete an existing relationship
20981 description: delete an existing relationship
20982 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
20991 description: Response codes found in [response codes](https://wiki.onap.org/).
20993 - name: equipment-name
20997 example: __EQUIPMENT-NAME__
20998 - name: interface-name
21000 description: Name that identifies the physical interface
21003 example: __INTERFACE-NAME__
21004 - name: interface-name
21006 description: Name given to the interface
21009 example: __INTERFACE-NAME__
21010 /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:
21014 summary: see node definition for valid relationships
21015 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21024 description: Response codes found in [response codes](https://wiki.onap.org/).
21026 - name: equipment-name
21030 example: __EQUIPMENT-NAME__
21031 - name: interface-name
21033 description: Name that identifies the physical interface
21036 example: __INTERFACE-NAME__
21037 - name: interface-name
21039 description: Name given to the interface
21042 example: __INTERFACE-NAME__
21043 - name: l3-interface-ipv4-address
21045 description: IP address
21048 example: __L3-INTERFACE-IPV4-ADDRESS__
21051 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21054 $ref: "#/definitions/relationship"
21058 summary: delete an existing relationship
21059 description: delete an existing relationship
21060 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21069 description: Response codes found in [response codes](https://wiki.onap.org/).
21071 - name: equipment-name
21075 example: __EQUIPMENT-NAME__
21076 - name: interface-name
21078 description: Name that identifies the physical interface
21081 example: __INTERFACE-NAME__
21082 - name: interface-name
21084 description: Name given to the interface
21087 example: __INTERFACE-NAME__
21088 - name: l3-interface-ipv4-address
21090 description: IP address
21093 example: __L3-INTERFACE-IPV4-ADDRESS__
21094 /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}:
21098 summary: returns l3-interface-ipv4-address-list
21099 description: returns l3-interface-ipv4-address-list
21100 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21106 description: successful operation
21108 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21110 description: Response codes found in [response codes](https://wiki.onap.org/).
21112 - name: equipment-name
21116 example: __EQUIPMENT-NAME__
21117 - name: interface-name
21119 description: Name that identifies the physical interface
21122 example: __INTERFACE-NAME__
21123 - name: interface-name
21125 description: Name given to the interface
21128 example: __INTERFACE-NAME__
21129 - name: l3-interface-ipv4-address
21131 description: IP address
21134 example: __L3-INTERFACE-IPV4-ADDRESS__
21138 summary: create or update an existing l3-interface-ipv4-address-list
21140 Create or update an existing l3-interface-ipv4-address-list.
21142 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21143 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21152 description: Response codes found in [response codes](https://wiki.onap.org/).
21154 - name: equipment-name
21158 example: __EQUIPMENT-NAME__
21159 - name: interface-name
21161 description: Name that identifies the physical interface
21164 example: __INTERFACE-NAME__
21165 - name: interface-name
21167 description: Name given to the interface
21170 example: __INTERFACE-NAME__
21171 - name: l3-interface-ipv4-address
21173 description: IP address
21176 example: __L3-INTERFACE-IPV4-ADDRESS__
21179 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21182 $ref: "#/definitions/l3-interface-ipv4-address-list"
21186 summary: update an existing l3-interface-ipv4-address-list
21188 Update an existing l3-interface-ipv4-address-list
21190 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21191 The PUT operation will entirely replace an existing object.
21192 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21194 Other differences between PUT and PATCH are:
21196 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21197 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21198 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21199 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21208 description: Response codes found in [response codes](https://wiki.onap.org/).
21210 - name: equipment-name
21214 example: __EQUIPMENT-NAME__
21215 - name: interface-name
21217 description: Name that identifies the physical interface
21220 example: __INTERFACE-NAME__
21221 - name: interface-name
21223 description: Name given to the interface
21226 example: __INTERFACE-NAME__
21227 - name: l3-interface-ipv4-address
21229 description: IP address
21232 example: __L3-INTERFACE-IPV4-ADDRESS__
21235 description: l3-interface-ipv4-address-list object that needs to be updated.
21238 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
21242 summary: delete an existing l3-interface-ipv4-address-list
21243 description: delete an existing l3-interface-ipv4-address-list
21244 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21253 description: Response codes found in [response codes](https://wiki.onap.org/).
21255 - name: equipment-name
21259 example: __EQUIPMENT-NAME__
21260 - name: interface-name
21262 description: Name that identifies the physical interface
21265 example: __INTERFACE-NAME__
21266 - name: interface-name
21268 description: Name given to the interface
21271 example: __INTERFACE-NAME__
21272 - name: l3-interface-ipv4-address
21274 description: IP address
21277 example: __L3-INTERFACE-IPV4-ADDRESS__
21278 - name: resource-version
21280 description: resource-version for concurrency
21283 /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:
21287 summary: see node definition for valid relationships
21288 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21297 description: Response codes found in [response codes](https://wiki.onap.org/).
21299 - name: equipment-name
21303 example: __EQUIPMENT-NAME__
21304 - name: interface-name
21306 description: Name that identifies the physical interface
21309 example: __INTERFACE-NAME__
21310 - name: interface-name
21312 description: Name given to the interface
21315 example: __INTERFACE-NAME__
21316 - name: l3-interface-ipv6-address
21318 description: IP address
21321 example: __L3-INTERFACE-IPV6-ADDRESS__
21324 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21327 $ref: "#/definitions/relationship"
21331 summary: delete an existing relationship
21332 description: delete an existing relationship
21333 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21342 description: Response codes found in [response codes](https://wiki.onap.org/).
21344 - name: equipment-name
21348 example: __EQUIPMENT-NAME__
21349 - name: interface-name
21351 description: Name that identifies the physical interface
21354 example: __INTERFACE-NAME__
21355 - name: interface-name
21357 description: Name given to the interface
21360 example: __INTERFACE-NAME__
21361 - name: l3-interface-ipv6-address
21363 description: IP address
21366 example: __L3-INTERFACE-IPV6-ADDRESS__
21367 /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}:
21371 summary: returns l3-interface-ipv6-address-list
21372 description: returns l3-interface-ipv6-address-list
21373 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21379 description: successful operation
21381 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
21383 description: Response codes found in [response codes](https://wiki.onap.org/).
21385 - name: equipment-name
21389 example: __EQUIPMENT-NAME__
21390 - name: interface-name
21392 description: Name that identifies the physical interface
21395 example: __INTERFACE-NAME__
21396 - name: interface-name
21398 description: Name given to the interface
21401 example: __INTERFACE-NAME__
21402 - name: l3-interface-ipv6-address
21404 description: IP address
21407 example: __L3-INTERFACE-IPV6-ADDRESS__
21411 summary: create or update an existing l3-interface-ipv6-address-list
21413 Create or update an existing l3-interface-ipv6-address-list.
21415 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21416 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21425 description: Response codes found in [response codes](https://wiki.onap.org/).
21427 - name: equipment-name
21431 example: __EQUIPMENT-NAME__
21432 - name: interface-name
21434 description: Name that identifies the physical interface
21437 example: __INTERFACE-NAME__
21438 - name: interface-name
21440 description: Name given to the interface
21443 example: __INTERFACE-NAME__
21444 - name: l3-interface-ipv6-address
21446 description: IP address
21449 example: __L3-INTERFACE-IPV6-ADDRESS__
21452 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21455 $ref: "#/definitions/l3-interface-ipv6-address-list"
21459 summary: update an existing l3-interface-ipv6-address-list
21461 Update an existing l3-interface-ipv6-address-list
21463 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21464 The PUT operation will entirely replace an existing object.
21465 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21467 Other differences between PUT and PATCH are:
21469 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21470 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21471 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21472 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21481 description: Response codes found in [response codes](https://wiki.onap.org/).
21483 - name: equipment-name
21487 example: __EQUIPMENT-NAME__
21488 - name: interface-name
21490 description: Name that identifies the physical interface
21493 example: __INTERFACE-NAME__
21494 - name: interface-name
21496 description: Name given to the interface
21499 example: __INTERFACE-NAME__
21500 - name: l3-interface-ipv6-address
21502 description: IP address
21505 example: __L3-INTERFACE-IPV6-ADDRESS__
21508 description: l3-interface-ipv6-address-list object that needs to be updated.
21511 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
21515 summary: delete an existing l3-interface-ipv6-address-list
21516 description: delete an existing l3-interface-ipv6-address-list
21517 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21526 description: Response codes found in [response codes](https://wiki.onap.org/).
21528 - name: equipment-name
21532 example: __EQUIPMENT-NAME__
21533 - name: interface-name
21535 description: Name that identifies the physical interface
21538 example: __INTERFACE-NAME__
21539 - name: interface-name
21541 description: Name given to the interface
21544 example: __INTERFACE-NAME__
21545 - name: l3-interface-ipv6-address
21547 description: IP address
21550 example: __L3-INTERFACE-IPV6-ADDRESS__
21551 - name: resource-version
21553 description: resource-version for concurrency
21556 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
21560 summary: returns l-interface
21561 description: returns l-interface
21562 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21568 description: successful operation
21570 $ref: "#/getDefinitions/l-interface"
21572 description: Response codes found in [response codes](https://wiki.onap.org/).
21574 - name: equipment-name
21578 example: __EQUIPMENT-NAME__
21579 - name: interface-name
21581 description: Name that identifies the physical interface
21584 example: __INTERFACE-NAME__
21585 - name: interface-name
21587 description: Name given to the interface
21590 example: __INTERFACE-NAME__
21594 summary: create or update an existing l-interface
21596 Create or update an existing l-interface.
21598 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21599 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21608 description: Response codes found in [response codes](https://wiki.onap.org/).
21610 - name: equipment-name
21614 example: __EQUIPMENT-NAME__
21615 - name: interface-name
21617 description: Name that identifies the physical interface
21620 example: __INTERFACE-NAME__
21621 - name: interface-name
21623 description: Name given to the interface
21626 example: __INTERFACE-NAME__
21629 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
21632 $ref: "#/definitions/l-interface"
21636 summary: update an existing l-interface
21638 Update an existing l-interface
21640 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21641 The PUT operation will entirely replace an existing object.
21642 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21644 Other differences between PUT and PATCH are:
21646 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21647 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21648 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21649 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21658 description: Response codes found in [response codes](https://wiki.onap.org/).
21660 - name: equipment-name
21664 example: __EQUIPMENT-NAME__
21665 - name: interface-name
21667 description: Name that identifies the physical interface
21670 example: __INTERFACE-NAME__
21671 - name: interface-name
21673 description: Name given to the interface
21676 example: __INTERFACE-NAME__
21679 description: l-interface object that needs to be updated.
21682 $ref: "#/patchDefinitions/l-interface"
21686 summary: delete an existing l-interface
21687 description: delete an existing l-interface
21688 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21697 description: Response codes found in [response codes](https://wiki.onap.org/).
21699 - name: equipment-name
21703 example: __EQUIPMENT-NAME__
21704 - name: interface-name
21706 description: Name that identifies the physical interface
21709 example: __INTERFACE-NAME__
21710 - name: interface-name
21712 description: Name given to the interface
21715 example: __INTERFACE-NAME__
21716 - name: resource-version
21718 description: resource-version for concurrency
21721 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
21725 summary: returns l-interfaces
21726 description: returns l-interfaces
21727 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
21733 description: successful operation
21735 $ref: "#/getDefinitions/l-interfaces"
21737 description: Response codes found in [response codes](https://wiki.onap.org/).
21739 - name: equipment-name
21743 example: __EQUIPMENT-NAME__
21744 - name: interface-name
21746 description: Name that identifies the physical interface
21749 example: __INTERFACE-NAME__
21750 - name: interface-name
21755 - name: interface-id
21765 - name: network-name
21770 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
21774 summary: returns p-interface
21775 description: returns p-interface
21776 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
21782 description: successful operation
21784 $ref: "#/getDefinitions/p-interface"
21786 description: Response codes found in [response codes](https://wiki.onap.org/).
21788 - name: equipment-name
21792 example: __EQUIPMENT-NAME__
21793 - name: interface-name
21795 description: Name that identifies the physical interface
21798 example: __INTERFACE-NAME__
21802 summary: create or update an existing p-interface
21804 Create or update an existing p-interface.
21806 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21807 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
21816 description: Response codes found in [response codes](https://wiki.onap.org/).
21818 - name: equipment-name
21822 example: __EQUIPMENT-NAME__
21823 - name: interface-name
21825 description: Name that identifies the physical interface
21828 example: __INTERFACE-NAME__
21831 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)
21834 $ref: "#/definitions/p-interface"
21838 summary: update an existing p-interface
21840 Update an existing p-interface
21842 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21843 The PUT operation will entirely replace an existing object.
21844 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21846 Other differences between PUT and PATCH are:
21848 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21849 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21850 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21851 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
21860 description: Response codes found in [response codes](https://wiki.onap.org/).
21862 - name: equipment-name
21866 example: __EQUIPMENT-NAME__
21867 - name: interface-name
21869 description: Name that identifies the physical interface
21872 example: __INTERFACE-NAME__
21875 description: p-interface object that needs to be updated.
21878 $ref: "#/patchDefinitions/p-interface"
21882 summary: delete an existing p-interface
21883 description: delete an existing p-interface
21884 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
21893 description: Response codes found in [response codes](https://wiki.onap.org/).
21895 - name: equipment-name
21899 example: __EQUIPMENT-NAME__
21900 - name: interface-name
21902 description: Name that identifies the physical interface
21905 example: __INTERFACE-NAME__
21906 - name: resource-version
21908 description: resource-version for concurrency
21911 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
21915 summary: returns p-interfaces
21916 description: returns p-interfaces
21917 operationId: getNetworkVplsPesVplsPePInterfaces
21923 description: successful operation
21925 $ref: "#/getDefinitions/p-interfaces"
21927 description: Response codes found in [response codes](https://wiki.onap.org/).
21929 - name: equipment-name
21933 example: __EQUIPMENT-NAME__
21934 - name: interface-name
21939 - name: prov-status
21944 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
21948 summary: see node definition for valid relationships
21949 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
21958 description: Response codes found in [response codes](https://wiki.onap.org/).
21960 - name: equipment-name
21964 example: __EQUIPMENT-NAME__
21965 - name: interface-name
21967 description: Name that identifies the link aggregate interface
21970 example: __INTERFACE-NAME__
21973 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
21976 $ref: "#/definitions/relationship"
21980 summary: delete an existing relationship
21981 description: delete an existing relationship
21982 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
21991 description: Response codes found in [response codes](https://wiki.onap.org/).
21993 - name: equipment-name
21997 example: __EQUIPMENT-NAME__
21998 - name: interface-name
22000 description: Name that identifies the link aggregate interface
22003 example: __INTERFACE-NAME__
22004 /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:
22008 summary: see node definition for valid relationships
22009 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22018 description: Response codes found in [response codes](https://wiki.onap.org/).
22020 - name: equipment-name
22024 example: __EQUIPMENT-NAME__
22025 - name: interface-name
22027 description: Name that identifies the link aggregate interface
22030 example: __INTERFACE-NAME__
22031 - name: interface-name
22033 description: Name given to the interface
22036 example: __INTERFACE-NAME__
22037 - name: vlan-interface
22039 description: String that identifies the interface
22042 example: __VLAN-INTERFACE__
22045 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
22048 $ref: "#/definitions/relationship"
22052 summary: delete an existing relationship
22053 description: delete an existing relationship
22054 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22063 description: Response codes found in [response codes](https://wiki.onap.org/).
22065 - name: equipment-name
22069 example: __EQUIPMENT-NAME__
22070 - name: interface-name
22072 description: Name that identifies the link aggregate interface
22075 example: __INTERFACE-NAME__
22076 - name: interface-name
22078 description: Name given to the interface
22081 example: __INTERFACE-NAME__
22082 - name: vlan-interface
22084 description: String that identifies the interface
22087 example: __VLAN-INTERFACE__
22088 /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:
22092 summary: see node definition for valid relationships
22093 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22102 description: Response codes found in [response codes](https://wiki.onap.org/).
22104 - name: equipment-name
22108 example: __EQUIPMENT-NAME__
22109 - name: interface-name
22111 description: Name that identifies the link aggregate interface
22114 example: __INTERFACE-NAME__
22115 - name: interface-name
22117 description: Name given to the interface
22120 example: __INTERFACE-NAME__
22121 - name: vlan-interface
22123 description: String that identifies the interface
22126 example: __VLAN-INTERFACE__
22127 - name: l3-interface-ipv4-address
22129 description: IP address
22132 example: __L3-INTERFACE-IPV4-ADDRESS__
22135 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22138 $ref: "#/definitions/relationship"
22142 summary: delete an existing relationship
22143 description: delete an existing relationship
22144 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22153 description: Response codes found in [response codes](https://wiki.onap.org/).
22155 - name: equipment-name
22159 example: __EQUIPMENT-NAME__
22160 - name: interface-name
22162 description: Name that identifies the link aggregate interface
22165 example: __INTERFACE-NAME__
22166 - name: interface-name
22168 description: Name given to the interface
22171 example: __INTERFACE-NAME__
22172 - name: vlan-interface
22174 description: String that identifies the interface
22177 example: __VLAN-INTERFACE__
22178 - name: l3-interface-ipv4-address
22180 description: IP address
22183 example: __L3-INTERFACE-IPV4-ADDRESS__
22184 /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}:
22188 summary: returns l3-interface-ipv4-address-list
22189 description: returns l3-interface-ipv4-address-list
22190 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22196 description: successful operation
22198 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
22200 description: Response codes found in [response codes](https://wiki.onap.org/).
22202 - name: equipment-name
22206 example: __EQUIPMENT-NAME__
22207 - name: interface-name
22209 description: Name that identifies the link aggregate interface
22212 example: __INTERFACE-NAME__
22213 - name: interface-name
22215 description: Name given to the interface
22218 example: __INTERFACE-NAME__
22219 - name: vlan-interface
22221 description: String that identifies the interface
22224 example: __VLAN-INTERFACE__
22225 - name: l3-interface-ipv4-address
22227 description: IP address
22230 example: __L3-INTERFACE-IPV4-ADDRESS__
22234 summary: create or update an existing l3-interface-ipv4-address-list
22236 Create or update an existing l3-interface-ipv4-address-list.
22238 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22239 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22248 description: Response codes found in [response codes](https://wiki.onap.org/).
22250 - name: equipment-name
22254 example: __EQUIPMENT-NAME__
22255 - name: interface-name
22257 description: Name that identifies the link aggregate interface
22260 example: __INTERFACE-NAME__
22261 - name: interface-name
22263 description: Name given to the interface
22266 example: __INTERFACE-NAME__
22267 - name: vlan-interface
22269 description: String that identifies the interface
22272 example: __VLAN-INTERFACE__
22273 - name: l3-interface-ipv4-address
22275 description: IP address
22278 example: __L3-INTERFACE-IPV4-ADDRESS__
22281 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22284 $ref: "#/definitions/l3-interface-ipv4-address-list"
22288 summary: update an existing l3-interface-ipv4-address-list
22290 Update an existing l3-interface-ipv4-address-list
22292 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22293 The PUT operation will entirely replace an existing object.
22294 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22296 Other differences between PUT and PATCH are:
22298 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22299 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22300 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22301 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22310 description: Response codes found in [response codes](https://wiki.onap.org/).
22312 - name: equipment-name
22316 example: __EQUIPMENT-NAME__
22317 - name: interface-name
22319 description: Name that identifies the link aggregate interface
22322 example: __INTERFACE-NAME__
22323 - name: interface-name
22325 description: Name given to the interface
22328 example: __INTERFACE-NAME__
22329 - name: vlan-interface
22331 description: String that identifies the interface
22334 example: __VLAN-INTERFACE__
22335 - name: l3-interface-ipv4-address
22337 description: IP address
22340 example: __L3-INTERFACE-IPV4-ADDRESS__
22343 description: l3-interface-ipv4-address-list object that needs to be updated.
22346 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22350 summary: delete an existing l3-interface-ipv4-address-list
22351 description: delete an existing l3-interface-ipv4-address-list
22352 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22361 description: Response codes found in [response codes](https://wiki.onap.org/).
22363 - name: equipment-name
22367 example: __EQUIPMENT-NAME__
22368 - name: interface-name
22370 description: Name that identifies the link aggregate interface
22373 example: __INTERFACE-NAME__
22374 - name: interface-name
22376 description: Name given to the interface
22379 example: __INTERFACE-NAME__
22380 - name: vlan-interface
22382 description: String that identifies the interface
22385 example: __VLAN-INTERFACE__
22386 - name: l3-interface-ipv4-address
22388 description: IP address
22391 example: __L3-INTERFACE-IPV4-ADDRESS__
22392 - name: resource-version
22394 description: resource-version for concurrency
22397 /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:
22401 summary: see node definition for valid relationships
22402 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22411 description: Response codes found in [response codes](https://wiki.onap.org/).
22413 - name: equipment-name
22417 example: __EQUIPMENT-NAME__
22418 - name: interface-name
22420 description: Name that identifies the link aggregate interface
22423 example: __INTERFACE-NAME__
22424 - name: interface-name
22426 description: Name given to the interface
22429 example: __INTERFACE-NAME__
22430 - name: vlan-interface
22432 description: String that identifies the interface
22435 example: __VLAN-INTERFACE__
22436 - name: l3-interface-ipv6-address
22438 description: IP address
22441 example: __L3-INTERFACE-IPV6-ADDRESS__
22444 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22447 $ref: "#/definitions/relationship"
22451 summary: delete an existing relationship
22452 description: delete an existing relationship
22453 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22462 description: Response codes found in [response codes](https://wiki.onap.org/).
22464 - name: equipment-name
22468 example: __EQUIPMENT-NAME__
22469 - name: interface-name
22471 description: Name that identifies the link aggregate interface
22474 example: __INTERFACE-NAME__
22475 - name: interface-name
22477 description: Name given to the interface
22480 example: __INTERFACE-NAME__
22481 - name: vlan-interface
22483 description: String that identifies the interface
22486 example: __VLAN-INTERFACE__
22487 - name: l3-interface-ipv6-address
22489 description: IP address
22492 example: __L3-INTERFACE-IPV6-ADDRESS__
22493 /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}:
22497 summary: returns l3-interface-ipv6-address-list
22498 description: returns l3-interface-ipv6-address-list
22499 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22505 description: successful operation
22507 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22509 description: Response codes found in [response codes](https://wiki.onap.org/).
22511 - name: equipment-name
22515 example: __EQUIPMENT-NAME__
22516 - name: interface-name
22518 description: Name that identifies the link aggregate interface
22521 example: __INTERFACE-NAME__
22522 - name: interface-name
22524 description: Name given to the interface
22527 example: __INTERFACE-NAME__
22528 - name: vlan-interface
22530 description: String that identifies the interface
22533 example: __VLAN-INTERFACE__
22534 - name: l3-interface-ipv6-address
22536 description: IP address
22539 example: __L3-INTERFACE-IPV6-ADDRESS__
22543 summary: create or update an existing l3-interface-ipv6-address-list
22545 Create or update an existing l3-interface-ipv6-address-list.
22547 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22548 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22557 description: Response codes found in [response codes](https://wiki.onap.org/).
22559 - name: equipment-name
22563 example: __EQUIPMENT-NAME__
22564 - name: interface-name
22566 description: Name that identifies the link aggregate interface
22569 example: __INTERFACE-NAME__
22570 - name: interface-name
22572 description: Name given to the interface
22575 example: __INTERFACE-NAME__
22576 - name: vlan-interface
22578 description: String that identifies the interface
22581 example: __VLAN-INTERFACE__
22582 - name: l3-interface-ipv6-address
22584 description: IP address
22587 example: __L3-INTERFACE-IPV6-ADDRESS__
22590 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22593 $ref: "#/definitions/l3-interface-ipv6-address-list"
22597 summary: update an existing l3-interface-ipv6-address-list
22599 Update an existing l3-interface-ipv6-address-list
22601 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22602 The PUT operation will entirely replace an existing object.
22603 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22605 Other differences between PUT and PATCH are:
22607 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22608 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22609 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22610 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22619 description: Response codes found in [response codes](https://wiki.onap.org/).
22621 - name: equipment-name
22625 example: __EQUIPMENT-NAME__
22626 - name: interface-name
22628 description: Name that identifies the link aggregate interface
22631 example: __INTERFACE-NAME__
22632 - name: interface-name
22634 description: Name given to the interface
22637 example: __INTERFACE-NAME__
22638 - name: vlan-interface
22640 description: String that identifies the interface
22643 example: __VLAN-INTERFACE__
22644 - name: l3-interface-ipv6-address
22646 description: IP address
22649 example: __L3-INTERFACE-IPV6-ADDRESS__
22652 description: l3-interface-ipv6-address-list object that needs to be updated.
22655 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22659 summary: delete an existing l3-interface-ipv6-address-list
22660 description: delete an existing l3-interface-ipv6-address-list
22661 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22670 description: Response codes found in [response codes](https://wiki.onap.org/).
22672 - name: equipment-name
22676 example: __EQUIPMENT-NAME__
22677 - name: interface-name
22679 description: Name that identifies the link aggregate interface
22682 example: __INTERFACE-NAME__
22683 - name: interface-name
22685 description: Name given to the interface
22688 example: __INTERFACE-NAME__
22689 - name: vlan-interface
22691 description: String that identifies the interface
22694 example: __VLAN-INTERFACE__
22695 - name: l3-interface-ipv6-address
22697 description: IP address
22700 example: __L3-INTERFACE-IPV6-ADDRESS__
22701 - name: resource-version
22703 description: resource-version for concurrency
22706 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22710 summary: returns vlan
22711 description: returns vlan
22712 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22718 description: successful operation
22720 $ref: "#/getDefinitions/vlan"
22722 description: Response codes found in [response codes](https://wiki.onap.org/).
22724 - name: equipment-name
22728 example: __EQUIPMENT-NAME__
22729 - name: interface-name
22731 description: Name that identifies the link aggregate interface
22734 example: __INTERFACE-NAME__
22735 - name: interface-name
22737 description: Name given to the interface
22740 example: __INTERFACE-NAME__
22741 - name: vlan-interface
22743 description: String that identifies the interface
22746 example: __VLAN-INTERFACE__
22750 summary: create or update an existing vlan
22752 Create or update an existing vlan.
22754 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22755 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22764 description: Response codes found in [response codes](https://wiki.onap.org/).
22766 - name: equipment-name
22770 example: __EQUIPMENT-NAME__
22771 - name: interface-name
22773 description: Name that identifies the link aggregate interface
22776 example: __INTERFACE-NAME__
22777 - name: interface-name
22779 description: Name given to the interface
22782 example: __INTERFACE-NAME__
22783 - name: vlan-interface
22785 description: String that identifies the interface
22788 example: __VLAN-INTERFACE__
22791 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
22794 $ref: "#/definitions/vlan"
22798 summary: update an existing vlan
22800 Update an existing vlan
22802 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22803 The PUT operation will entirely replace an existing object.
22804 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22806 Other differences between PUT and PATCH are:
22808 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22809 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22810 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22811 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22820 description: Response codes found in [response codes](https://wiki.onap.org/).
22822 - name: equipment-name
22826 example: __EQUIPMENT-NAME__
22827 - name: interface-name
22829 description: Name that identifies the link aggregate interface
22832 example: __INTERFACE-NAME__
22833 - name: interface-name
22835 description: Name given to the interface
22838 example: __INTERFACE-NAME__
22839 - name: vlan-interface
22841 description: String that identifies the interface
22844 example: __VLAN-INTERFACE__
22847 description: vlan object that needs to be updated.
22850 $ref: "#/patchDefinitions/vlan"
22854 summary: delete an existing vlan
22855 description: delete an existing vlan
22856 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22865 description: Response codes found in [response codes](https://wiki.onap.org/).
22867 - name: equipment-name
22871 example: __EQUIPMENT-NAME__
22872 - name: interface-name
22874 description: Name that identifies the link aggregate interface
22877 example: __INTERFACE-NAME__
22878 - name: interface-name
22880 description: Name given to the interface
22883 example: __INTERFACE-NAME__
22884 - name: vlan-interface
22886 description: String that identifies the interface
22889 example: __VLAN-INTERFACE__
22890 - name: resource-version
22892 description: resource-version for concurrency
22895 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22899 summary: returns vlans
22900 description: returns vlans
22901 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
22907 description: successful operation
22909 $ref: "#/getDefinitions/vlans"
22911 description: Response codes found in [response codes](https://wiki.onap.org/).
22913 - name: equipment-name
22917 example: __EQUIPMENT-NAME__
22918 - name: interface-name
22920 description: Name that identifies the link aggregate interface
22923 example: __INTERFACE-NAME__
22924 - name: interface-name
22926 description: Name given to the interface
22929 example: __INTERFACE-NAME__
22930 - name: vlan-interface
22935 - name: vlan-id-inner
22946 /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:
22950 summary: see node definition for valid relationships
22951 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22960 description: Response codes found in [response codes](https://wiki.onap.org/).
22962 - name: equipment-name
22966 example: __EQUIPMENT-NAME__
22967 - name: interface-name
22969 description: Name that identifies the link aggregate interface
22972 example: __INTERFACE-NAME__
22973 - name: interface-name
22975 description: Name given to the interface
22978 example: __INTERFACE-NAME__
22981 description: PCI ID used to identify the sriov-vf
22984 example: __PCI-ID__
22987 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22990 $ref: "#/definitions/relationship"
22994 summary: delete an existing relationship
22995 description: delete an existing relationship
22996 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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 link aggregate interface
23017 example: __INTERFACE-NAME__
23018 - name: interface-name
23020 description: Name given to the interface
23023 example: __INTERFACE-NAME__
23026 description: PCI ID used to identify the sriov-vf
23029 example: __PCI-ID__
23030 /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}:
23034 summary: returns sriov-vf
23035 description: returns sriov-vf
23036 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23042 description: successful operation
23044 $ref: "#/getDefinitions/sriov-vf"
23046 description: Response codes found in [response codes](https://wiki.onap.org/).
23048 - name: equipment-name
23052 example: __EQUIPMENT-NAME__
23053 - name: interface-name
23055 description: Name that identifies the link aggregate interface
23058 example: __INTERFACE-NAME__
23059 - name: interface-name
23061 description: Name given to the interface
23064 example: __INTERFACE-NAME__
23067 description: PCI ID used to identify the sriov-vf
23070 example: __PCI-ID__
23074 summary: create or update an existing sriov-vf
23076 Create or update an existing sriov-vf.
23078 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23079 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23088 description: Response codes found in [response codes](https://wiki.onap.org/).
23090 - name: equipment-name
23094 example: __EQUIPMENT-NAME__
23095 - name: interface-name
23097 description: Name that identifies the link aggregate interface
23100 example: __INTERFACE-NAME__
23101 - name: interface-name
23103 description: Name given to the interface
23106 example: __INTERFACE-NAME__
23109 description: PCI ID used to identify the sriov-vf
23112 example: __PCI-ID__
23115 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23118 $ref: "#/definitions/sriov-vf"
23122 summary: update an existing sriov-vf
23124 Update an existing sriov-vf
23126 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23127 The PUT operation will entirely replace an existing object.
23128 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23130 Other differences between PUT and PATCH are:
23132 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23133 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23134 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23135 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23144 description: Response codes found in [response codes](https://wiki.onap.org/).
23146 - name: equipment-name
23150 example: __EQUIPMENT-NAME__
23151 - name: interface-name
23153 description: Name that identifies the link aggregate interface
23156 example: __INTERFACE-NAME__
23157 - name: interface-name
23159 description: Name given to the interface
23162 example: __INTERFACE-NAME__
23165 description: PCI ID used to identify the sriov-vf
23168 example: __PCI-ID__
23171 description: sriov-vf object that needs to be updated.
23174 $ref: "#/patchDefinitions/sriov-vf"
23178 summary: delete an existing sriov-vf
23179 description: delete an existing sriov-vf
23180 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23189 description: Response codes found in [response codes](https://wiki.onap.org/).
23191 - name: equipment-name
23195 example: __EQUIPMENT-NAME__
23196 - name: interface-name
23198 description: Name that identifies the link aggregate interface
23201 example: __INTERFACE-NAME__
23202 - name: interface-name
23204 description: Name given to the interface
23207 example: __INTERFACE-NAME__
23210 description: PCI ID used to identify the sriov-vf
23213 example: __PCI-ID__
23214 - name: resource-version
23216 description: resource-version for concurrency
23219 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
23223 summary: returns sriov-vfs
23224 description: returns sriov-vfs
23225 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
23231 description: successful operation
23233 $ref: "#/getDefinitions/sriov-vfs"
23235 description: Response codes found in [response codes](https://wiki.onap.org/).
23237 - name: equipment-name
23241 example: __EQUIPMENT-NAME__
23242 - name: interface-name
23244 description: Name that identifies the link aggregate interface
23247 example: __INTERFACE-NAME__
23248 - name: interface-name
23250 description: Name given to the interface
23253 example: __INTERFACE-NAME__
23259 - name: vf-vlan-filter
23264 - name: vf-mac-filter
23269 - name: vf-vlan-strip
23274 - name: neutron-network-id
23279 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23283 summary: see node definition for valid relationships
23284 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
23293 description: Response codes found in [response codes](https://wiki.onap.org/).
23295 - name: equipment-name
23299 example: __EQUIPMENT-NAME__
23300 - name: interface-name
23302 description: Name that identifies the link aggregate interface
23305 example: __INTERFACE-NAME__
23306 - name: interface-name
23308 description: Name given to the interface
23311 example: __INTERFACE-NAME__
23314 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
23317 $ref: "#/definitions/relationship"
23321 summary: delete an existing relationship
23322 description: delete an existing relationship
23323 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
23332 description: Response codes found in [response codes](https://wiki.onap.org/).
23334 - name: equipment-name
23338 example: __EQUIPMENT-NAME__
23339 - name: interface-name
23341 description: Name that identifies the link aggregate interface
23344 example: __INTERFACE-NAME__
23345 - name: interface-name
23347 description: Name given to the interface
23350 example: __INTERFACE-NAME__
23351 /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:
23355 summary: see node definition for valid relationships
23356 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23365 description: Response codes found in [response codes](https://wiki.onap.org/).
23367 - name: equipment-name
23371 example: __EQUIPMENT-NAME__
23372 - name: interface-name
23374 description: Name that identifies the link aggregate interface
23377 example: __INTERFACE-NAME__
23378 - name: interface-name
23380 description: Name given to the interface
23383 example: __INTERFACE-NAME__
23384 - name: l3-interface-ipv4-address
23386 description: IP address
23389 example: __L3-INTERFACE-IPV4-ADDRESS__
23392 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23395 $ref: "#/definitions/relationship"
23399 summary: delete an existing relationship
23400 description: delete an existing relationship
23401 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23410 description: Response codes found in [response codes](https://wiki.onap.org/).
23412 - name: equipment-name
23416 example: __EQUIPMENT-NAME__
23417 - name: interface-name
23419 description: Name that identifies the link aggregate interface
23422 example: __INTERFACE-NAME__
23423 - name: interface-name
23425 description: Name given to the interface
23428 example: __INTERFACE-NAME__
23429 - name: l3-interface-ipv4-address
23431 description: IP address
23434 example: __L3-INTERFACE-IPV4-ADDRESS__
23435 /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}:
23439 summary: returns l3-interface-ipv4-address-list
23440 description: returns l3-interface-ipv4-address-list
23441 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23447 description: successful operation
23449 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23451 description: Response codes found in [response codes](https://wiki.onap.org/).
23453 - name: equipment-name
23457 example: __EQUIPMENT-NAME__
23458 - name: interface-name
23460 description: Name that identifies the link aggregate interface
23463 example: __INTERFACE-NAME__
23464 - name: interface-name
23466 description: Name given to the interface
23469 example: __INTERFACE-NAME__
23470 - name: l3-interface-ipv4-address
23472 description: IP address
23475 example: __L3-INTERFACE-IPV4-ADDRESS__
23479 summary: create or update an existing l3-interface-ipv4-address-list
23481 Create or update an existing l3-interface-ipv4-address-list.
23483 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23484 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23493 description: Response codes found in [response codes](https://wiki.onap.org/).
23495 - name: equipment-name
23499 example: __EQUIPMENT-NAME__
23500 - name: interface-name
23502 description: Name that identifies the link aggregate interface
23505 example: __INTERFACE-NAME__
23506 - name: interface-name
23508 description: Name given to the interface
23511 example: __INTERFACE-NAME__
23512 - name: l3-interface-ipv4-address
23514 description: IP address
23517 example: __L3-INTERFACE-IPV4-ADDRESS__
23520 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23523 $ref: "#/definitions/l3-interface-ipv4-address-list"
23527 summary: update an existing l3-interface-ipv4-address-list
23529 Update an existing l3-interface-ipv4-address-list
23531 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23532 The PUT operation will entirely replace an existing object.
23533 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23535 Other differences between PUT and PATCH are:
23537 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23538 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23539 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23540 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23549 description: Response codes found in [response codes](https://wiki.onap.org/).
23551 - name: equipment-name
23555 example: __EQUIPMENT-NAME__
23556 - name: interface-name
23558 description: Name that identifies the link aggregate interface
23561 example: __INTERFACE-NAME__
23562 - name: interface-name
23564 description: Name given to the interface
23567 example: __INTERFACE-NAME__
23568 - name: l3-interface-ipv4-address
23570 description: IP address
23573 example: __L3-INTERFACE-IPV4-ADDRESS__
23576 description: l3-interface-ipv4-address-list object that needs to be updated.
23579 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23583 summary: delete an existing l3-interface-ipv4-address-list
23584 description: delete an existing l3-interface-ipv4-address-list
23585 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23594 description: Response codes found in [response codes](https://wiki.onap.org/).
23596 - name: equipment-name
23600 example: __EQUIPMENT-NAME__
23601 - name: interface-name
23603 description: Name that identifies the link aggregate interface
23606 example: __INTERFACE-NAME__
23607 - name: interface-name
23609 description: Name given to the interface
23612 example: __INTERFACE-NAME__
23613 - name: l3-interface-ipv4-address
23615 description: IP address
23618 example: __L3-INTERFACE-IPV4-ADDRESS__
23619 - name: resource-version
23621 description: resource-version for concurrency
23624 /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:
23628 summary: see node definition for valid relationships
23629 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23638 description: Response codes found in [response codes](https://wiki.onap.org/).
23640 - name: equipment-name
23644 example: __EQUIPMENT-NAME__
23645 - name: interface-name
23647 description: Name that identifies the link aggregate interface
23650 example: __INTERFACE-NAME__
23651 - name: interface-name
23653 description: Name given to the interface
23656 example: __INTERFACE-NAME__
23657 - name: l3-interface-ipv6-address
23659 description: IP address
23662 example: __L3-INTERFACE-IPV6-ADDRESS__
23665 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23668 $ref: "#/definitions/relationship"
23672 summary: delete an existing relationship
23673 description: delete an existing relationship
23674 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23683 description: Response codes found in [response codes](https://wiki.onap.org/).
23685 - name: equipment-name
23689 example: __EQUIPMENT-NAME__
23690 - name: interface-name
23692 description: Name that identifies the link aggregate interface
23695 example: __INTERFACE-NAME__
23696 - name: interface-name
23698 description: Name given to the interface
23701 example: __INTERFACE-NAME__
23702 - name: l3-interface-ipv6-address
23704 description: IP address
23707 example: __L3-INTERFACE-IPV6-ADDRESS__
23708 /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}:
23712 summary: returns l3-interface-ipv6-address-list
23713 description: returns l3-interface-ipv6-address-list
23714 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23720 description: successful operation
23722 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23724 description: Response codes found in [response codes](https://wiki.onap.org/).
23726 - name: equipment-name
23730 example: __EQUIPMENT-NAME__
23731 - name: interface-name
23733 description: Name that identifies the link aggregate interface
23736 example: __INTERFACE-NAME__
23737 - name: interface-name
23739 description: Name given to the interface
23742 example: __INTERFACE-NAME__
23743 - name: l3-interface-ipv6-address
23745 description: IP address
23748 example: __L3-INTERFACE-IPV6-ADDRESS__
23752 summary: create or update an existing l3-interface-ipv6-address-list
23754 Create or update an existing l3-interface-ipv6-address-list.
23756 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23757 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23766 description: Response codes found in [response codes](https://wiki.onap.org/).
23768 - name: equipment-name
23772 example: __EQUIPMENT-NAME__
23773 - name: interface-name
23775 description: Name that identifies the link aggregate interface
23778 example: __INTERFACE-NAME__
23779 - name: interface-name
23781 description: Name given to the interface
23784 example: __INTERFACE-NAME__
23785 - name: l3-interface-ipv6-address
23787 description: IP address
23790 example: __L3-INTERFACE-IPV6-ADDRESS__
23793 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23796 $ref: "#/definitions/l3-interface-ipv6-address-list"
23800 summary: update an existing l3-interface-ipv6-address-list
23802 Update an existing l3-interface-ipv6-address-list
23804 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23805 The PUT operation will entirely replace an existing object.
23806 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23808 Other differences between PUT and PATCH are:
23810 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23811 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23812 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23813 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23822 description: Response codes found in [response codes](https://wiki.onap.org/).
23824 - name: equipment-name
23828 example: __EQUIPMENT-NAME__
23829 - name: interface-name
23831 description: Name that identifies the link aggregate interface
23834 example: __INTERFACE-NAME__
23835 - name: interface-name
23837 description: Name given to the interface
23840 example: __INTERFACE-NAME__
23841 - name: l3-interface-ipv6-address
23843 description: IP address
23846 example: __L3-INTERFACE-IPV6-ADDRESS__
23849 description: l3-interface-ipv6-address-list object that needs to be updated.
23852 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23856 summary: delete an existing l3-interface-ipv6-address-list
23857 description: delete an existing l3-interface-ipv6-address-list
23858 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23867 description: Response codes found in [response codes](https://wiki.onap.org/).
23869 - name: equipment-name
23873 example: __EQUIPMENT-NAME__
23874 - name: interface-name
23876 description: Name that identifies the link aggregate interface
23879 example: __INTERFACE-NAME__
23880 - name: interface-name
23882 description: Name given to the interface
23885 example: __INTERFACE-NAME__
23886 - name: l3-interface-ipv6-address
23888 description: IP address
23891 example: __L3-INTERFACE-IPV6-ADDRESS__
23892 - name: resource-version
23894 description: resource-version for concurrency
23897 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
23901 summary: returns l-interface
23902 description: returns l-interface
23903 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23909 description: successful operation
23911 $ref: "#/getDefinitions/l-interface"
23913 description: Response codes found in [response codes](https://wiki.onap.org/).
23915 - name: equipment-name
23919 example: __EQUIPMENT-NAME__
23920 - name: interface-name
23922 description: Name that identifies the link aggregate interface
23925 example: __INTERFACE-NAME__
23926 - name: interface-name
23928 description: Name given to the interface
23931 example: __INTERFACE-NAME__
23935 summary: create or update an existing l-interface
23937 Create or update an existing l-interface.
23939 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23940 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23949 description: Response codes found in [response codes](https://wiki.onap.org/).
23951 - name: equipment-name
23955 example: __EQUIPMENT-NAME__
23956 - name: interface-name
23958 description: Name that identifies the link aggregate interface
23961 example: __INTERFACE-NAME__
23962 - name: interface-name
23964 description: Name given to the interface
23967 example: __INTERFACE-NAME__
23970 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
23973 $ref: "#/definitions/l-interface"
23977 summary: update an existing l-interface
23979 Update an existing l-interface
23981 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23982 The PUT operation will entirely replace an existing object.
23983 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23985 Other differences between PUT and PATCH are:
23987 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23988 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23989 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23990 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23999 description: Response codes found in [response codes](https://wiki.onap.org/).
24001 - name: equipment-name
24005 example: __EQUIPMENT-NAME__
24006 - name: interface-name
24008 description: Name that identifies the link aggregate interface
24011 example: __INTERFACE-NAME__
24012 - name: interface-name
24014 description: Name given to the interface
24017 example: __INTERFACE-NAME__
24020 description: l-interface object that needs to be updated.
24023 $ref: "#/patchDefinitions/l-interface"
24027 summary: delete an existing l-interface
24028 description: delete an existing l-interface
24029 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24038 description: Response codes found in [response codes](https://wiki.onap.org/).
24040 - name: equipment-name
24044 example: __EQUIPMENT-NAME__
24045 - name: interface-name
24047 description: Name that identifies the link aggregate interface
24050 example: __INTERFACE-NAME__
24051 - name: interface-name
24053 description: Name given to the interface
24056 example: __INTERFACE-NAME__
24057 - name: resource-version
24059 description: resource-version for concurrency
24062 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
24066 summary: returns l-interfaces
24067 description: returns l-interfaces
24068 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
24074 description: successful operation
24076 $ref: "#/getDefinitions/l-interfaces"
24078 description: Response codes found in [response codes](https://wiki.onap.org/).
24080 - name: equipment-name
24084 example: __EQUIPMENT-NAME__
24085 - name: interface-name
24087 description: Name that identifies the link aggregate interface
24090 example: __INTERFACE-NAME__
24091 - name: interface-name
24096 - name: interface-id
24106 - name: network-name
24111 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
24115 summary: returns lag-interface
24116 description: returns lag-interface
24117 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
24123 description: successful operation
24125 $ref: "#/getDefinitions/lag-interface"
24127 description: Response codes found in [response codes](https://wiki.onap.org/).
24129 - name: equipment-name
24133 example: __EQUIPMENT-NAME__
24134 - name: interface-name
24136 description: Name that identifies the link aggregate interface
24139 example: __INTERFACE-NAME__
24143 summary: create or update an existing lag-interface
24145 Create or update an existing lag-interface.
24147 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24148 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
24157 description: Response codes found in [response codes](https://wiki.onap.org/).
24159 - name: equipment-name
24163 example: __EQUIPMENT-NAME__
24164 - name: interface-name
24166 description: Name that identifies the link aggregate interface
24169 example: __INTERFACE-NAME__
24172 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
24175 $ref: "#/definitions/lag-interface"
24179 summary: update an existing lag-interface
24181 Update an existing lag-interface
24183 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24184 The PUT operation will entirely replace an existing object.
24185 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24187 Other differences between PUT and PATCH are:
24189 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24190 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24191 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24192 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
24201 description: Response codes found in [response codes](https://wiki.onap.org/).
24203 - name: equipment-name
24207 example: __EQUIPMENT-NAME__
24208 - name: interface-name
24210 description: Name that identifies the link aggregate interface
24213 example: __INTERFACE-NAME__
24216 description: lag-interface object that needs to be updated.
24219 $ref: "#/patchDefinitions/lag-interface"
24223 summary: delete an existing lag-interface
24224 description: delete an existing lag-interface
24225 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
24234 description: Response codes found in [response codes](https://wiki.onap.org/).
24236 - name: equipment-name
24240 example: __EQUIPMENT-NAME__
24241 - name: interface-name
24243 description: Name that identifies the link aggregate interface
24246 example: __INTERFACE-NAME__
24247 - name: resource-version
24249 description: resource-version for concurrency
24252 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
24256 summary: returns lag-interfaces
24257 description: returns lag-interfaces
24258 operationId: getNetworkVplsPesVplsPeLagInterfaces
24264 description: successful operation
24266 $ref: "#/getDefinitions/lag-interfaces"
24268 description: Response codes found in [response codes](https://wiki.onap.org/).
24270 - name: equipment-name
24274 example: __EQUIPMENT-NAME__
24275 - name: interface-name
24280 - name: interface-id
24285 - name: interface-role
24290 /network/vpls-pes/vpls-pe/{equipment-name}:
24294 summary: returns vpls-pe
24295 description: returns vpls-pe
24296 operationId: getNetworkVplsPesVplsPe
24302 description: successful operation
24304 $ref: "#/getDefinitions/vpls-pe"
24306 description: Response codes found in [response codes](https://wiki.onap.org/).
24308 - name: equipment-name
24312 example: __EQUIPMENT-NAME__
24316 summary: create or update an existing vpls-pe
24318 Create or update an existing vpls-pe.
24320 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24321 operationId: createOrUpdateNetworkVplsPesVplsPe
24330 description: Response codes found in [response codes](https://wiki.onap.org/).
24332 - name: equipment-name
24336 example: __EQUIPMENT-NAME__
24339 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)
24342 $ref: "#/definitions/vpls-pe"
24346 summary: update an existing vpls-pe
24348 Update an existing vpls-pe
24350 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24351 The PUT operation will entirely replace an existing object.
24352 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24354 Other differences between PUT and PATCH are:
24356 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24357 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24358 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24359 operationId: UpdateNetworkVplsPesVplsPe
24368 description: Response codes found in [response codes](https://wiki.onap.org/).
24370 - name: equipment-name
24374 example: __EQUIPMENT-NAME__
24377 description: vpls-pe object that needs to be updated.
24380 $ref: "#/patchDefinitions/vpls-pe"
24384 summary: delete an existing vpls-pe
24385 description: delete an existing vpls-pe
24386 operationId: deleteNetworkVplsPesVplsPe
24395 description: Response codes found in [response codes](https://wiki.onap.org/).
24397 - name: equipment-name
24401 example: __EQUIPMENT-NAME__
24402 - name: resource-version
24404 description: resource-version for concurrency
24411 summary: returns vpls-pes
24412 description: returns vpls-pes
24413 operationId: getNetworkVplsPes
24419 description: successful operation
24421 $ref: "#/getDefinitions/vpls-pes"
24423 description: Response codes found in [response codes](https://wiki.onap.org/).
24425 - name: equipment-name
24430 - name: prov-status
24435 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
24439 summary: see node definition for valid relationships
24440 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
24449 description: Response codes found in [response codes](https://wiki.onap.org/).
24451 - name: multicast-configuration-id
24453 description: Unique id of multicast configuration.
24456 example: __MULTICAST-CONFIGURATION-ID__
24459 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)
24462 $ref: "#/definitions/relationship"
24466 summary: delete an existing relationship
24467 description: delete an existing relationship
24468 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
24477 description: Response codes found in [response codes](https://wiki.onap.org/).
24479 - name: multicast-configuration-id
24481 description: Unique id of multicast configuration.
24484 example: __MULTICAST-CONFIGURATION-ID__
24485 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
24489 summary: returns multicast-configuration
24490 description: returns multicast-configuration
24491 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
24497 description: successful operation
24499 $ref: "#/getDefinitions/multicast-configuration"
24501 description: Response codes found in [response codes](https://wiki.onap.org/).
24503 - name: multicast-configuration-id
24505 description: Unique id of multicast configuration.
24508 example: __MULTICAST-CONFIGURATION-ID__
24512 summary: create or update an existing multicast-configuration
24514 Create or update an existing multicast-configuration.
24516 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24517 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
24526 description: Response codes found in [response codes](https://wiki.onap.org/).
24528 - name: multicast-configuration-id
24530 description: Unique id of multicast configuration.
24533 example: __MULTICAST-CONFIGURATION-ID__
24536 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)
24539 $ref: "#/definitions/multicast-configuration"
24543 summary: update an existing multicast-configuration
24545 Update an existing multicast-configuration
24547 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24548 The PUT operation will entirely replace an existing object.
24549 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24551 Other differences between PUT and PATCH are:
24553 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24554 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24555 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24556 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
24565 description: Response codes found in [response codes](https://wiki.onap.org/).
24567 - name: multicast-configuration-id
24569 description: Unique id of multicast configuration.
24572 example: __MULTICAST-CONFIGURATION-ID__
24575 description: multicast-configuration object that needs to be updated.
24578 $ref: "#/patchDefinitions/multicast-configuration"
24582 summary: delete an existing multicast-configuration
24583 description: delete an existing multicast-configuration
24584 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
24593 description: Response codes found in [response codes](https://wiki.onap.org/).
24595 - name: multicast-configuration-id
24597 description: Unique id of multicast configuration.
24600 example: __MULTICAST-CONFIGURATION-ID__
24601 - name: resource-version
24603 description: resource-version for concurrency
24606 /network/multicast-configurations:
24610 summary: returns multicast-configurations
24611 description: returns multicast-configurations
24612 operationId: getNetworkMulticastConfigurations
24618 description: successful operation
24620 $ref: "#/getDefinitions/multicast-configurations"
24622 description: Response codes found in [response codes](https://wiki.onap.org/).
24624 - name: multicast-configuration-id
24629 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
24633 summary: see node definition for valid relationships
24634 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
24643 description: Response codes found in [response codes](https://wiki.onap.org/).
24647 description: Unique id of VNF. This is unique across the graph.
24650 example: __VNF-ID__
24651 - name: interface-id
24653 description: Unique ID of the interface
24656 example: __INTERFACE-ID__
24659 description: See mis-na-virtualization-platform.yang
24663 example: __CVLAN-TAG__
24666 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
24669 $ref: "#/definitions/relationship"
24673 summary: delete an existing relationship
24674 description: delete an existing relationship
24675 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
24684 description: Response codes found in [response codes](https://wiki.onap.org/).
24688 description: Unique id of VNF. This is unique across the graph.
24691 example: __VNF-ID__
24692 - name: interface-id
24694 description: Unique ID of the interface
24697 example: __INTERFACE-ID__
24700 description: See mis-na-virtualization-platform.yang
24704 example: __CVLAN-TAG__
24705 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
24709 summary: returns cvlan-tag-entry
24710 description: returns cvlan-tag-entry
24711 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24717 description: successful operation
24719 $ref: "#/getDefinitions/cvlan-tag-entry"
24721 description: Response codes found in [response codes](https://wiki.onap.org/).
24725 description: Unique id of VNF. This is unique across the graph.
24728 example: __VNF-ID__
24729 - name: interface-id
24731 description: Unique ID of the interface
24734 example: __INTERFACE-ID__
24737 description: See mis-na-virtualization-platform.yang
24741 example: __CVLAN-TAG__
24745 summary: create or update an existing cvlan-tag-entry
24747 Create or update an existing cvlan-tag-entry.
24749 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24750 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24759 description: Response codes found in [response codes](https://wiki.onap.org/).
24763 description: Unique id of VNF. This is unique across the graph.
24766 example: __VNF-ID__
24767 - name: interface-id
24769 description: Unique ID of the interface
24772 example: __INTERFACE-ID__
24775 description: See mis-na-virtualization-platform.yang
24779 example: __CVLAN-TAG__
24782 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
24785 $ref: "#/definitions/cvlan-tag-entry"
24789 summary: update an existing cvlan-tag-entry
24791 Update an existing cvlan-tag-entry
24793 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24794 The PUT operation will entirely replace an existing object.
24795 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24797 Other differences between PUT and PATCH are:
24799 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24800 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24801 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24802 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24811 description: Response codes found in [response codes](https://wiki.onap.org/).
24815 description: Unique id of VNF. This is unique across the graph.
24818 example: __VNF-ID__
24819 - name: interface-id
24821 description: Unique ID of the interface
24824 example: __INTERFACE-ID__
24827 description: See mis-na-virtualization-platform.yang
24831 example: __CVLAN-TAG__
24834 description: cvlan-tag-entry object that needs to be updated.
24837 $ref: "#/patchDefinitions/cvlan-tag-entry"
24841 summary: delete an existing cvlan-tag-entry
24842 description: delete an existing cvlan-tag-entry
24843 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24852 description: Response codes found in [response codes](https://wiki.onap.org/).
24856 description: Unique id of VNF. This is unique across the graph.
24859 example: __VNF-ID__
24860 - name: interface-id
24862 description: Unique ID of the interface
24865 example: __INTERFACE-ID__
24868 description: See mis-na-virtualization-platform.yang
24872 example: __CVLAN-TAG__
24873 - name: resource-version
24875 description: resource-version for concurrency
24878 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
24882 summary: returns cvlan-tags
24883 description: returns cvlan-tags
24884 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
24890 description: successful operation
24892 $ref: "#/getDefinitions/cvlan-tags"
24894 description: Response codes found in [response codes](https://wiki.onap.org/).
24898 description: Unique id of VNF. This is unique across the graph.
24901 example: __VNF-ID__
24902 - name: interface-id
24904 description: Unique ID of the interface
24907 example: __INTERFACE-ID__
24914 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
24918 summary: see node definition for valid relationships
24919 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
24928 description: Response codes found in [response codes](https://wiki.onap.org/).
24932 description: Unique id of VNF. This is unique across the graph.
24935 example: __VNF-ID__
24936 - name: interface-id
24938 description: Unique ID of the interface
24941 example: __INTERFACE-ID__
24944 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)
24947 $ref: "#/definitions/relationship"
24951 summary: delete an existing relationship
24952 description: delete an existing relationship
24953 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
24962 description: Response codes found in [response codes](https://wiki.onap.org/).
24966 description: Unique id of VNF. This is unique across the graph.
24969 example: __VNF-ID__
24970 - name: interface-id
24972 description: Unique ID of the interface
24975 example: __INTERFACE-ID__
24976 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
24980 summary: returns port-group
24981 description: returns port-group
24982 operationId: getNetworkVcesVcePortGroupsPortGroup
24988 description: successful operation
24990 $ref: "#/getDefinitions/port-group"
24992 description: Response codes found in [response codes](https://wiki.onap.org/).
24996 description: Unique id of VNF. This is unique across the graph.
24999 example: __VNF-ID__
25000 - name: interface-id
25002 description: Unique ID of the interface
25005 example: __INTERFACE-ID__
25009 summary: create or update an existing port-group
25011 Create or update an existing port-group.
25013 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25014 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
25023 description: Response codes found in [response codes](https://wiki.onap.org/).
25027 description: Unique id of VNF. This is unique across the graph.
25030 example: __VNF-ID__
25031 - name: interface-id
25033 description: Unique ID of the interface
25036 example: __INTERFACE-ID__
25039 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)
25042 $ref: "#/definitions/port-group"
25046 summary: update an existing port-group
25048 Update an existing port-group
25050 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25051 The PUT operation will entirely replace an existing object.
25052 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25054 Other differences between PUT and PATCH are:
25056 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25057 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25058 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25059 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
25068 description: Response codes found in [response codes](https://wiki.onap.org/).
25072 description: Unique id of VNF. This is unique across the graph.
25075 example: __VNF-ID__
25076 - name: interface-id
25078 description: Unique ID of the interface
25081 example: __INTERFACE-ID__
25084 description: port-group object that needs to be updated.
25087 $ref: "#/patchDefinitions/port-group"
25091 summary: delete an existing port-group
25092 description: delete an existing port-group
25093 operationId: deleteNetworkVcesVcePortGroupsPortGroup
25102 description: Response codes found in [response codes](https://wiki.onap.org/).
25106 description: Unique id of VNF. This is unique across the graph.
25109 example: __VNF-ID__
25110 - name: interface-id
25112 description: Unique ID of the interface
25115 example: __INTERFACE-ID__
25116 - name: resource-version
25118 description: resource-version for concurrency
25121 /network/vces/vce/{vnf-id}/port-groups:
25125 summary: returns port-groups
25126 description: returns port-groups
25127 operationId: getNetworkVcesVcePortGroups
25133 description: successful operation
25135 $ref: "#/getDefinitions/port-groups"
25137 description: Response codes found in [response codes](https://wiki.onap.org/).
25141 description: Unique id of VNF. This is unique across the graph.
25144 example: __VNF-ID__
25145 - name: interface-id
25150 - name: port-group-id
25155 - name: switch-name
25160 - name: heat-stack-id
25165 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
25169 summary: see node definition for valid relationships
25170 operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
25179 description: Response codes found in [response codes](https://wiki.onap.org/).
25183 description: Unique id of VNF. This is unique across the graph.
25186 example: __VNF-ID__
25189 description: Unique ID for the license group the resource belongs to, should be uuid.
25192 example: __GROUP-UUID__
25193 - name: resource-uuid
25195 description: Unique ID of a license resource.
25198 example: __RESOURCE-UUID__
25201 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)
25204 $ref: "#/definitions/relationship"
25208 summary: delete an existing relationship
25209 description: delete an existing relationship
25210 operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
25219 description: Response codes found in [response codes](https://wiki.onap.org/).
25223 description: Unique id of VNF. This is unique across the graph.
25226 example: __VNF-ID__
25229 description: Unique ID for the license group the resource belongs to, should be uuid.
25232 example: __GROUP-UUID__
25233 - name: resource-uuid
25235 description: Unique ID of a license resource.
25238 example: __RESOURCE-UUID__
25239 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
25243 summary: returns license
25244 description: returns license
25245 operationId: getNetworkVcesVceLicensesLicense
25251 description: successful operation
25253 $ref: "#/getDefinitions/license"
25255 description: Response codes found in [response codes](https://wiki.onap.org/).
25259 description: Unique id of VNF. This is unique across the graph.
25262 example: __VNF-ID__
25265 description: Unique ID for the license group the resource belongs to, should be uuid.
25268 example: __GROUP-UUID__
25269 - name: resource-uuid
25271 description: Unique ID of a license resource.
25274 example: __RESOURCE-UUID__
25278 summary: create or update an existing license
25280 Create or update an existing license.
25282 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25283 operationId: createOrUpdateNetworkVcesVceLicensesLicense
25292 description: Response codes found in [response codes](https://wiki.onap.org/).
25296 description: Unique id of VNF. This is unique across the graph.
25299 example: __VNF-ID__
25302 description: Unique ID for the license group the resource belongs to, should be uuid.
25305 example: __GROUP-UUID__
25306 - name: resource-uuid
25308 description: Unique ID of a license resource.
25311 example: __RESOURCE-UUID__
25314 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)
25317 $ref: "#/definitions/license"
25321 summary: update an existing license
25323 Update an existing license
25325 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25326 The PUT operation will entirely replace an existing object.
25327 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25329 Other differences between PUT and PATCH are:
25331 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25332 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25333 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25334 operationId: UpdateNetworkVcesVceLicensesLicense
25343 description: Response codes found in [response codes](https://wiki.onap.org/).
25347 description: Unique id of VNF. This is unique across the graph.
25350 example: __VNF-ID__
25353 description: Unique ID for the license group the resource belongs to, should be uuid.
25356 example: __GROUP-UUID__
25357 - name: resource-uuid
25359 description: Unique ID of a license resource.
25362 example: __RESOURCE-UUID__
25365 description: license object that needs to be updated.
25368 $ref: "#/patchDefinitions/license"
25372 summary: delete an existing license
25373 description: delete an existing license
25374 operationId: deleteNetworkVcesVceLicensesLicense
25383 description: Response codes found in [response codes](https://wiki.onap.org/).
25387 description: Unique id of VNF. This is unique across the graph.
25390 example: __VNF-ID__
25393 description: Unique ID for the license group the resource belongs to, should be uuid.
25396 example: __GROUP-UUID__
25397 - name: resource-uuid
25399 description: Unique ID of a license resource.
25402 example: __RESOURCE-UUID__
25403 - name: resource-version
25405 description: resource-version for concurrency
25408 /network/vces/vce/{vnf-id}/licenses:
25412 summary: returns licenses
25413 description: returns licenses
25414 operationId: getNetworkVcesVceLicenses
25420 description: successful operation
25422 $ref: "#/getDefinitions/licenses"
25424 description: Response codes found in [response codes](https://wiki.onap.org/).
25428 description: Unique id of VNF. This is unique across the graph.
25431 example: __VNF-ID__
25437 - name: resource-uuid
25442 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
25446 summary: see node definition for valid relationships
25447 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
25456 description: Response codes found in [response codes](https://wiki.onap.org/).
25460 description: Unique id of VNF. This is unique across the graph.
25463 example: __VNF-ID__
25466 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25469 example: __GROUP-UUID__
25470 - name: resource-uuid
25472 description: Unique ID of an entitlement resource.
25475 example: __RESOURCE-UUID__
25478 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)
25481 $ref: "#/definitions/relationship"
25485 summary: delete an existing relationship
25486 description: delete an existing relationship
25487 operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
25496 description: Response codes found in [response codes](https://wiki.onap.org/).
25500 description: Unique id of VNF. This is unique across the graph.
25503 example: __VNF-ID__
25506 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25509 example: __GROUP-UUID__
25510 - name: resource-uuid
25512 description: Unique ID of an entitlement resource.
25515 example: __RESOURCE-UUID__
25516 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
25520 summary: returns entitlement
25521 description: returns entitlement
25522 operationId: getNetworkVcesVceEntitlementsEntitlement
25528 description: successful operation
25530 $ref: "#/getDefinitions/entitlement"
25532 description: Response codes found in [response codes](https://wiki.onap.org/).
25536 description: Unique id of VNF. This is unique across the graph.
25539 example: __VNF-ID__
25542 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25545 example: __GROUP-UUID__
25546 - name: resource-uuid
25548 description: Unique ID of an entitlement resource.
25551 example: __RESOURCE-UUID__
25555 summary: create or update an existing entitlement
25557 Create or update an existing entitlement.
25559 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25560 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
25569 description: Response codes found in [response codes](https://wiki.onap.org/).
25573 description: Unique id of VNF. This is unique across the graph.
25576 example: __VNF-ID__
25579 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25582 example: __GROUP-UUID__
25583 - name: resource-uuid
25585 description: Unique ID of an entitlement resource.
25588 example: __RESOURCE-UUID__
25591 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)
25594 $ref: "#/definitions/entitlement"
25598 summary: update an existing entitlement
25600 Update an existing entitlement
25602 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25603 The PUT operation will entirely replace an existing object.
25604 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25606 Other differences between PUT and PATCH are:
25608 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25609 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25610 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25611 operationId: UpdateNetworkVcesVceEntitlementsEntitlement
25620 description: Response codes found in [response codes](https://wiki.onap.org/).
25624 description: Unique id of VNF. This is unique across the graph.
25627 example: __VNF-ID__
25630 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25633 example: __GROUP-UUID__
25634 - name: resource-uuid
25636 description: Unique ID of an entitlement resource.
25639 example: __RESOURCE-UUID__
25642 description: entitlement object that needs to be updated.
25645 $ref: "#/patchDefinitions/entitlement"
25649 summary: delete an existing entitlement
25650 description: delete an existing entitlement
25651 operationId: deleteNetworkVcesVceEntitlementsEntitlement
25660 description: Response codes found in [response codes](https://wiki.onap.org/).
25664 description: Unique id of VNF. This is unique across the graph.
25667 example: __VNF-ID__
25670 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25673 example: __GROUP-UUID__
25674 - name: resource-uuid
25676 description: Unique ID of an entitlement resource.
25679 example: __RESOURCE-UUID__
25680 - name: resource-version
25682 description: resource-version for concurrency
25685 /network/vces/vce/{vnf-id}/entitlements:
25689 summary: returns entitlements
25690 description: returns entitlements
25691 operationId: getNetworkVcesVceEntitlements
25697 description: successful operation
25699 $ref: "#/getDefinitions/entitlements"
25701 description: Response codes found in [response codes](https://wiki.onap.org/).
25705 description: Unique id of VNF. This is unique across the graph.
25708 example: __VNF-ID__
25714 - name: resource-uuid
25719 /network/vces/vce/{vnf-id}/relationship-list/relationship:
25723 summary: see node definition for valid relationships
25724 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
25733 description: Response codes found in [response codes](https://wiki.onap.org/).
25737 description: Unique id of VNF. This is unique across the graph.
25740 example: __VNF-ID__
25743 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)
25746 $ref: "#/definitions/relationship"
25750 summary: delete an existing relationship
25751 description: delete an existing relationship
25752 operationId: deleteNetworkVcesVceRelationshipListRelationship
25761 description: Response codes found in [response codes](https://wiki.onap.org/).
25765 description: Unique id of VNF. This is unique across the graph.
25768 example: __VNF-ID__
25769 /network/vces/vce/{vnf-id}:
25773 summary: returns vce
25774 description: returns vce
25775 operationId: getNetworkVcesVce
25781 description: successful operation
25783 $ref: "#/getDefinitions/vce"
25785 description: Response codes found in [response codes](https://wiki.onap.org/).
25789 description: Unique id of VNF. This is unique across the graph.
25792 example: __VNF-ID__
25796 summary: create or update an existing vce
25798 Create or update an existing vce.
25800 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25801 operationId: createOrUpdateNetworkVcesVce
25810 description: Response codes found in [response codes](https://wiki.onap.org/).
25814 description: Unique id of VNF. This is unique across the graph.
25817 example: __VNF-ID__
25820 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)
25823 $ref: "#/definitions/vce"
25827 summary: update an existing vce
25829 Update an existing vce
25831 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25832 The PUT operation will entirely replace an existing object.
25833 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25835 Other differences between PUT and PATCH are:
25837 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25838 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25839 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25840 operationId: UpdateNetworkVcesVce
25849 description: Response codes found in [response codes](https://wiki.onap.org/).
25853 description: Unique id of VNF. This is unique across the graph.
25856 example: __VNF-ID__
25859 description: vce object that needs to be updated.
25862 $ref: "#/patchDefinitions/vce"
25866 summary: delete an existing vce
25867 description: delete an existing vce
25868 operationId: deleteNetworkVcesVce
25877 description: Response codes found in [response codes](https://wiki.onap.org/).
25881 description: Unique id of VNF. This is unique across the graph.
25884 example: __VNF-ID__
25885 - name: resource-version
25887 description: resource-version for concurrency
25894 summary: returns vces
25895 description: returns vces
25896 operationId: getNetworkVces
25902 description: successful operation
25904 $ref: "#/getDefinitions/vces"
25906 description: Response codes found in [response codes](https://wiki.onap.org/).
25933 - name: regional-resource-zone
25938 - name: prov-status
25943 - name: heat-stack-id
25953 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
25957 summary: see node definition for valid relationships
25958 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
25967 description: Response codes found in [response codes](https://wiki.onap.org/).
25971 description: Unique ID of vnfc.
25974 example: __VNFC-NAME__
25977 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)
25980 $ref: "#/definitions/relationship"
25984 summary: delete an existing relationship
25985 description: delete an existing relationship
25986 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
25995 description: Response codes found in [response codes](https://wiki.onap.org/).
25999 description: Unique ID of vnfc.
26002 example: __VNFC-NAME__
26003 /network/vnfcs/vnfc/{vnfc-name}:
26007 summary: returns vnfc
26008 description: returns vnfc
26009 operationId: getNetworkVnfcsVnfc
26015 description: successful operation
26017 $ref: "#/getDefinitions/vnfc"
26019 description: Response codes found in [response codes](https://wiki.onap.org/).
26023 description: Unique ID of vnfc.
26026 example: __VNFC-NAME__
26030 summary: create or update an existing vnfc
26032 Create or update an existing vnfc.
26034 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26035 operationId: createOrUpdateNetworkVnfcsVnfc
26044 description: Response codes found in [response codes](https://wiki.onap.org/).
26048 description: Unique ID of vnfc.
26051 example: __VNFC-NAME__
26054 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)
26057 $ref: "#/definitions/vnfc"
26061 summary: update an existing vnfc
26063 Update an existing vnfc
26065 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26066 The PUT operation will entirely replace an existing object.
26067 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26069 Other differences between PUT and PATCH are:
26071 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26072 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26073 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26074 operationId: UpdateNetworkVnfcsVnfc
26083 description: Response codes found in [response codes](https://wiki.onap.org/).
26087 description: Unique ID of vnfc.
26090 example: __VNFC-NAME__
26093 description: vnfc object that needs to be updated.
26096 $ref: "#/patchDefinitions/vnfc"
26100 summary: delete an existing vnfc
26101 description: delete an existing vnfc
26102 operationId: deleteNetworkVnfcsVnfc
26111 description: Response codes found in [response codes](https://wiki.onap.org/).
26115 description: Unique ID of vnfc.
26118 example: __VNFC-NAME__
26119 - name: resource-version
26121 description: resource-version for concurrency
26128 summary: returns vnfcs
26129 description: returns vnfcs
26130 operationId: getNetworkVnfcs
26136 description: successful operation
26138 $ref: "#/getDefinitions/vnfcs"
26140 description: Response codes found in [response codes](https://wiki.onap.org/).
26147 - name: vnfc-function-code
26157 - name: prov-status
26162 - name: ipaddress-v4-oam-vip
26172 - name: is-closed-loop-disabled
26177 - name: group-notation
26182 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
26186 summary: see node definition for valid relationships
26187 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
26196 description: Response codes found in [response codes](https://wiki.onap.org/).
26200 description: Network ID, should be uuid. Unique across A&AI.
26203 example: __NETWORK-ID__
26206 description: Subnet ID, should be UUID.
26209 example: __SUBNET-ID__
26212 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26215 $ref: "#/definitions/relationship"
26219 summary: delete an existing relationship
26220 description: delete an existing relationship
26221 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
26230 description: Response codes found in [response codes](https://wiki.onap.org/).
26234 description: Network ID, should be uuid. Unique across A&AI.
26237 example: __NETWORK-ID__
26240 description: Subnet ID, should be UUID.
26243 example: __SUBNET-ID__
26244 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
26248 summary: returns subnet
26249 description: returns subnet
26250 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
26256 description: successful operation
26258 $ref: "#/getDefinitions/subnet"
26260 description: Response codes found in [response codes](https://wiki.onap.org/).
26264 description: Network ID, should be uuid. Unique across A&AI.
26267 example: __NETWORK-ID__
26270 description: Subnet ID, should be UUID.
26273 example: __SUBNET-ID__
26277 summary: create or update an existing subnet
26279 Create or update an existing subnet.
26281 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26282 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26291 description: Response codes found in [response codes](https://wiki.onap.org/).
26295 description: Network ID, should be uuid. Unique across A&AI.
26298 example: __NETWORK-ID__
26301 description: Subnet ID, should be UUID.
26304 example: __SUBNET-ID__
26307 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26310 $ref: "#/definitions/subnet"
26314 summary: update an existing subnet
26316 Update an existing subnet
26318 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26319 The PUT operation will entirely replace an existing object.
26320 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26322 Other differences between PUT and PATCH are:
26324 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26325 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26326 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26327 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26336 description: Response codes found in [response codes](https://wiki.onap.org/).
26340 description: Network ID, should be uuid. Unique across A&AI.
26343 example: __NETWORK-ID__
26346 description: Subnet ID, should be UUID.
26349 example: __SUBNET-ID__
26352 description: subnet object that needs to be updated.
26355 $ref: "#/patchDefinitions/subnet"
26359 summary: delete an existing subnet
26360 description: delete an existing subnet
26361 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
26370 description: Response codes found in [response codes](https://wiki.onap.org/).
26374 description: Network ID, should be uuid. Unique across A&AI.
26377 example: __NETWORK-ID__
26380 description: Subnet ID, should be UUID.
26383 example: __SUBNET-ID__
26384 - name: resource-version
26386 description: resource-version for concurrency
26389 /network/l3-networks/l3-network/{network-id}/subnets:
26393 summary: returns subnets
26394 description: returns subnets
26395 operationId: getNetworkL3NetworksL3NetworkSubnets
26401 description: successful operation
26403 $ref: "#/getDefinitions/subnets"
26405 description: Response codes found in [response codes](https://wiki.onap.org/).
26409 description: Network ID, should be uuid. Unique across A&AI.
26412 example: __NETWORK-ID__
26418 - name: subnet-name
26423 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
26427 summary: see node definition for valid relationships
26428 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26437 description: Response codes found in [response codes](https://wiki.onap.org/).
26441 description: Network ID, should be uuid. Unique across A&AI.
26444 example: __NETWORK-ID__
26445 - name: vlan-id-inner
26451 example: __VLAN-ID-INNER__
26454 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26457 $ref: "#/definitions/relationship"
26461 summary: delete an existing relationship
26462 description: delete an existing relationship
26463 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26472 description: Response codes found in [response codes](https://wiki.onap.org/).
26476 description: Network ID, should be uuid. Unique across A&AI.
26479 example: __NETWORK-ID__
26480 - name: vlan-id-inner
26486 example: __VLAN-ID-INNER__
26487 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
26491 summary: returns ctag-assignment
26492 description: returns ctag-assignment
26493 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26499 description: successful operation
26501 $ref: "#/getDefinitions/ctag-assignment"
26503 description: Response codes found in [response codes](https://wiki.onap.org/).
26507 description: Network ID, should be uuid. Unique across A&AI.
26510 example: __NETWORK-ID__
26511 - name: vlan-id-inner
26517 example: __VLAN-ID-INNER__
26521 summary: create or update an existing ctag-assignment
26523 Create or update an existing ctag-assignment.
26525 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26526 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26535 description: Response codes found in [response codes](https://wiki.onap.org/).
26539 description: Network ID, should be uuid. Unique across A&AI.
26542 example: __NETWORK-ID__
26543 - name: vlan-id-inner
26549 example: __VLAN-ID-INNER__
26552 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26555 $ref: "#/definitions/ctag-assignment"
26559 summary: update an existing ctag-assignment
26561 Update an existing ctag-assignment
26563 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26564 The PUT operation will entirely replace an existing object.
26565 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26567 Other differences between PUT and PATCH are:
26569 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26570 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26571 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26572 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26581 description: Response codes found in [response codes](https://wiki.onap.org/).
26585 description: Network ID, should be uuid. Unique across A&AI.
26588 example: __NETWORK-ID__
26589 - name: vlan-id-inner
26595 example: __VLAN-ID-INNER__
26598 description: ctag-assignment object that needs to be updated.
26601 $ref: "#/patchDefinitions/ctag-assignment"
26605 summary: delete an existing ctag-assignment
26606 description: delete an existing ctag-assignment
26607 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26616 description: Response codes found in [response codes](https://wiki.onap.org/).
26620 description: Network ID, should be uuid. Unique across A&AI.
26623 example: __NETWORK-ID__
26624 - name: vlan-id-inner
26630 example: __VLAN-ID-INNER__
26631 - name: resource-version
26633 description: resource-version for concurrency
26636 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
26640 summary: returns ctag-assignments
26641 description: returns ctag-assignments
26642 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
26648 description: successful operation
26650 $ref: "#/getDefinitions/ctag-assignments"
26652 description: Response codes found in [response codes](https://wiki.onap.org/).
26656 description: Network ID, should be uuid. Unique across A&AI.
26659 example: __NETWORK-ID__
26660 - name: vlan-id-inner
26666 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
26670 summary: see node definition for valid relationships
26671 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
26680 description: Response codes found in [response codes](https://wiki.onap.org/).
26684 description: Network ID, should be uuid. Unique across A&AI.
26687 example: __NETWORK-ID__
26688 - name: segmentation-id
26690 description: Route Table Reference id, UUID assigned to this instance.
26693 example: __SEGMENTATION-ID__
26696 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
26699 $ref: "#/definitions/relationship"
26703 summary: delete an existing relationship
26704 description: delete an existing relationship
26705 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
26714 description: Response codes found in [response codes](https://wiki.onap.org/).
26718 description: Network ID, should be uuid. Unique across A&AI.
26721 example: __NETWORK-ID__
26722 - name: segmentation-id
26724 description: Route Table Reference id, UUID assigned to this instance.
26727 example: __SEGMENTATION-ID__
26728 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
26732 summary: returns segmentation-assignment
26733 description: returns segmentation-assignment
26734 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26740 description: successful operation
26742 $ref: "#/getDefinitions/segmentation-assignment"
26744 description: Response codes found in [response codes](https://wiki.onap.org/).
26748 description: Network ID, should be uuid. Unique across A&AI.
26751 example: __NETWORK-ID__
26752 - name: segmentation-id
26754 description: Route Table Reference id, UUID assigned to this instance.
26757 example: __SEGMENTATION-ID__
26761 summary: create or update an existing segmentation-assignment
26763 Create or update an existing segmentation-assignment.
26765 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26766 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26775 description: Response codes found in [response codes](https://wiki.onap.org/).
26779 description: Network ID, should be uuid. Unique across A&AI.
26782 example: __NETWORK-ID__
26783 - name: segmentation-id
26785 description: Route Table Reference id, UUID assigned to this instance.
26788 example: __SEGMENTATION-ID__
26791 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
26794 $ref: "#/definitions/segmentation-assignment"
26798 summary: update an existing segmentation-assignment
26800 Update an existing segmentation-assignment
26802 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26803 The PUT operation will entirely replace an existing object.
26804 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26806 Other differences between PUT and PATCH are:
26808 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26809 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26810 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26811 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26820 description: Response codes found in [response codes](https://wiki.onap.org/).
26824 description: Network ID, should be uuid. Unique across A&AI.
26827 example: __NETWORK-ID__
26828 - name: segmentation-id
26830 description: Route Table Reference id, UUID assigned to this instance.
26833 example: __SEGMENTATION-ID__
26836 description: segmentation-assignment object that needs to be updated.
26839 $ref: "#/patchDefinitions/segmentation-assignment"
26843 summary: delete an existing segmentation-assignment
26844 description: delete an existing segmentation-assignment
26845 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26854 description: Response codes found in [response codes](https://wiki.onap.org/).
26858 description: Network ID, should be uuid. Unique across A&AI.
26861 example: __NETWORK-ID__
26862 - name: segmentation-id
26864 description: Route Table Reference id, UUID assigned to this instance.
26867 example: __SEGMENTATION-ID__
26868 - name: resource-version
26870 description: resource-version for concurrency
26873 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
26877 summary: returns segmentation-assignments
26878 description: returns segmentation-assignments
26879 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
26885 description: successful operation
26887 $ref: "#/getDefinitions/segmentation-assignments"
26889 description: Response codes found in [response codes](https://wiki.onap.org/).
26893 description: Network ID, should be uuid. Unique across A&AI.
26896 example: __NETWORK-ID__
26897 - name: segmentation-id
26902 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
26906 summary: see node definition for valid relationships
26907 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
26916 description: Response codes found in [response codes](https://wiki.onap.org/).
26920 description: Network ID, should be uuid. Unique across A&AI.
26923 example: __NETWORK-ID__
26926 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)
26929 $ref: "#/definitions/relationship"
26933 summary: delete an existing relationship
26934 description: delete an existing relationship
26935 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
26944 description: Response codes found in [response codes](https://wiki.onap.org/).
26948 description: Network ID, should be uuid. Unique across A&AI.
26951 example: __NETWORK-ID__
26952 /network/l3-networks/l3-network/{network-id}:
26956 summary: returns l3-network
26957 description: returns l3-network
26958 operationId: getNetworkL3NetworksL3Network
26964 description: successful operation
26966 $ref: "#/getDefinitions/l3-network"
26968 description: Response codes found in [response codes](https://wiki.onap.org/).
26972 description: Network ID, should be uuid. Unique across A&AI.
26975 example: __NETWORK-ID__
26979 summary: create or update an existing l3-network
26981 Create or update an existing l3-network.
26983 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26984 operationId: createOrUpdateNetworkL3NetworksL3Network
26993 description: Response codes found in [response codes](https://wiki.onap.org/).
26997 description: Network ID, should be uuid. Unique across A&AI.
27000 example: __NETWORK-ID__
27003 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)
27006 $ref: "#/definitions/l3-network"
27010 summary: update an existing l3-network
27012 Update an existing l3-network
27014 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27015 The PUT operation will entirely replace an existing object.
27016 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27018 Other differences between PUT and PATCH are:
27020 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27021 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27022 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27023 operationId: UpdateNetworkL3NetworksL3Network
27032 description: Response codes found in [response codes](https://wiki.onap.org/).
27036 description: Network ID, should be uuid. Unique across A&AI.
27039 example: __NETWORK-ID__
27042 description: l3-network object that needs to be updated.
27045 $ref: "#/patchDefinitions/l3-network"
27049 summary: delete an existing l3-network
27050 description: delete an existing l3-network
27051 operationId: deleteNetworkL3NetworksL3Network
27060 description: Response codes found in [response codes](https://wiki.onap.org/).
27064 description: Network ID, should be uuid. Unique across A&AI.
27067 example: __NETWORK-ID__
27068 - name: resource-version
27070 description: resource-version for concurrency
27073 /network/l3-networks:
27077 summary: returns l3-networks
27078 description: returns l3-networks
27079 operationId: getNetworkL3Networks
27085 description: successful operation
27087 $ref: "#/getDefinitions/l3-networks"
27089 description: Response codes found in [response codes](https://wiki.onap.org/).
27096 - name: network-name
27101 - name: network-role
27111 - name: heat-stack-id
27116 - name: contrail-network-fqdn
27121 - name: model-invariant-id
27126 - name: model-version-id
27131 - name: widget-model-id
27136 - name: widget-model-version
27141 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
27145 summary: see node definition for valid relationships
27146 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
27155 description: Response codes found in [response codes](https://wiki.onap.org/).
27157 - name: network-policy-id
27159 description: UUID representing unique key to this instance
27162 example: __NETWORK-POLICY-ID__
27165 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)
27168 $ref: "#/definitions/relationship"
27172 summary: delete an existing relationship
27173 description: delete an existing relationship
27174 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
27183 description: Response codes found in [response codes](https://wiki.onap.org/).
27185 - name: network-policy-id
27187 description: UUID representing unique key to this instance
27190 example: __NETWORK-POLICY-ID__
27191 /network/network-policies/network-policy/{network-policy-id}:
27195 summary: returns network-policy
27196 description: returns network-policy
27197 operationId: getNetworkNetworkPoliciesNetworkPolicy
27203 description: successful operation
27205 $ref: "#/getDefinitions/network-policy"
27207 description: Response codes found in [response codes](https://wiki.onap.org/).
27209 - name: network-policy-id
27211 description: UUID representing unique key to this instance
27214 example: __NETWORK-POLICY-ID__
27218 summary: create or update an existing network-policy
27220 Create or update an existing network-policy.
27222 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27223 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
27232 description: Response codes found in [response codes](https://wiki.onap.org/).
27234 - name: network-policy-id
27236 description: UUID representing unique key to this instance
27239 example: __NETWORK-POLICY-ID__
27242 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)
27245 $ref: "#/definitions/network-policy"
27249 summary: update an existing network-policy
27251 Update an existing network-policy
27253 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27254 The PUT operation will entirely replace an existing object.
27255 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27257 Other differences between PUT and PATCH are:
27259 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27260 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27261 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27262 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
27271 description: Response codes found in [response codes](https://wiki.onap.org/).
27273 - name: network-policy-id
27275 description: UUID representing unique key to this instance
27278 example: __NETWORK-POLICY-ID__
27281 description: network-policy object that needs to be updated.
27284 $ref: "#/patchDefinitions/network-policy"
27288 summary: delete an existing network-policy
27289 description: delete an existing network-policy
27290 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
27299 description: Response codes found in [response codes](https://wiki.onap.org/).
27301 - name: network-policy-id
27303 description: UUID representing unique key to this instance
27306 example: __NETWORK-POLICY-ID__
27307 - name: resource-version
27309 description: resource-version for concurrency
27312 /network/network-policies:
27316 summary: returns network-policies
27317 description: returns network-policies
27318 operationId: getNetworkNetworkPolicies
27324 description: successful operation
27326 $ref: "#/getDefinitions/network-policies"
27328 description: Response codes found in [response codes](https://wiki.onap.org/).
27330 - name: network-policy-id
27335 - name: network-policy-fqdn
27340 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
27344 summary: see node definition for valid relationships
27345 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
27354 description: Response codes found in [response codes](https://wiki.onap.org/).
27358 description: Unique id of VNF. This is unique across the graph.
27361 example: __VNF-ID__
27364 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)
27367 $ref: "#/definitions/relationship"
27371 summary: delete an existing relationship
27372 description: delete an existing relationship
27373 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
27382 description: Response codes found in [response codes](https://wiki.onap.org/).
27386 description: Unique id of VNF. This is unique across the graph.
27389 example: __VNF-ID__
27390 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
27394 summary: see node definition for valid relationships
27395 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27404 description: Response codes found in [response codes](https://wiki.onap.org/).
27408 description: Unique id of VNF. This is unique across the graph.
27411 example: __VNF-ID__
27412 - name: interface-name
27414 description: Name given to the interface
27417 example: __INTERFACE-NAME__
27418 - name: vlan-interface
27420 description: String that identifies the interface
27423 example: __VLAN-INTERFACE__
27426 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
27429 $ref: "#/definitions/relationship"
27433 summary: delete an existing relationship
27434 description: delete an existing relationship
27435 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27444 description: Response codes found in [response codes](https://wiki.onap.org/).
27448 description: Unique id of VNF. This is unique across the graph.
27451 example: __VNF-ID__
27452 - name: interface-name
27454 description: Name given to the interface
27457 example: __INTERFACE-NAME__
27458 - name: vlan-interface
27460 description: String that identifies the interface
27463 example: __VLAN-INTERFACE__
27464 /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:
27468 summary: see node definition for valid relationships
27469 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27478 description: Response codes found in [response codes](https://wiki.onap.org/).
27482 description: Unique id of VNF. This is unique across the graph.
27485 example: __VNF-ID__
27486 - name: interface-name
27488 description: Name given to the interface
27491 example: __INTERFACE-NAME__
27492 - name: vlan-interface
27494 description: String that identifies the interface
27497 example: __VLAN-INTERFACE__
27498 - name: l3-interface-ipv4-address
27500 description: IP address
27503 example: __L3-INTERFACE-IPV4-ADDRESS__
27506 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27509 $ref: "#/definitions/relationship"
27513 summary: delete an existing relationship
27514 description: delete an existing relationship
27515 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27524 description: Response codes found in [response codes](https://wiki.onap.org/).
27528 description: Unique id of VNF. This is unique across the graph.
27531 example: __VNF-ID__
27532 - name: interface-name
27534 description: Name given to the interface
27537 example: __INTERFACE-NAME__
27538 - name: vlan-interface
27540 description: String that identifies the interface
27543 example: __VLAN-INTERFACE__
27544 - name: l3-interface-ipv4-address
27546 description: IP address
27549 example: __L3-INTERFACE-IPV4-ADDRESS__
27550 /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}:
27554 summary: returns l3-interface-ipv4-address-list
27555 description: returns l3-interface-ipv4-address-list
27556 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27562 description: successful operation
27564 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27566 description: Response codes found in [response codes](https://wiki.onap.org/).
27570 description: Unique id of VNF. This is unique across the graph.
27573 example: __VNF-ID__
27574 - name: interface-name
27576 description: Name given to the interface
27579 example: __INTERFACE-NAME__
27580 - name: vlan-interface
27582 description: String that identifies the interface
27585 example: __VLAN-INTERFACE__
27586 - name: l3-interface-ipv4-address
27588 description: IP address
27591 example: __L3-INTERFACE-IPV4-ADDRESS__
27595 summary: create or update an existing l3-interface-ipv4-address-list
27597 Create or update an existing l3-interface-ipv4-address-list.
27599 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27600 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27609 description: Response codes found in [response codes](https://wiki.onap.org/).
27613 description: Unique id of VNF. This is unique across the graph.
27616 example: __VNF-ID__
27617 - name: interface-name
27619 description: Name given to the interface
27622 example: __INTERFACE-NAME__
27623 - name: vlan-interface
27625 description: String that identifies the interface
27628 example: __VLAN-INTERFACE__
27629 - name: l3-interface-ipv4-address
27631 description: IP address
27634 example: __L3-INTERFACE-IPV4-ADDRESS__
27637 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27640 $ref: "#/definitions/l3-interface-ipv4-address-list"
27644 summary: update an existing l3-interface-ipv4-address-list
27646 Update an existing l3-interface-ipv4-address-list
27648 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27649 The PUT operation will entirely replace an existing object.
27650 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27652 Other differences between PUT and PATCH are:
27654 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27655 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27656 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27657 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27666 description: Response codes found in [response codes](https://wiki.onap.org/).
27670 description: Unique id of VNF. This is unique across the graph.
27673 example: __VNF-ID__
27674 - name: interface-name
27676 description: Name given to the interface
27679 example: __INTERFACE-NAME__
27680 - name: vlan-interface
27682 description: String that identifies the interface
27685 example: __VLAN-INTERFACE__
27686 - name: l3-interface-ipv4-address
27688 description: IP address
27691 example: __L3-INTERFACE-IPV4-ADDRESS__
27694 description: l3-interface-ipv4-address-list object that needs to be updated.
27697 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27701 summary: delete an existing l3-interface-ipv4-address-list
27702 description: delete an existing l3-interface-ipv4-address-list
27703 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27712 description: Response codes found in [response codes](https://wiki.onap.org/).
27716 description: Unique id of VNF. This is unique across the graph.
27719 example: __VNF-ID__
27720 - name: interface-name
27722 description: Name given to the interface
27725 example: __INTERFACE-NAME__
27726 - name: vlan-interface
27728 description: String that identifies the interface
27731 example: __VLAN-INTERFACE__
27732 - name: l3-interface-ipv4-address
27734 description: IP address
27737 example: __L3-INTERFACE-IPV4-ADDRESS__
27738 - name: resource-version
27740 description: resource-version for concurrency
27743 /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:
27747 summary: see node definition for valid relationships
27748 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27757 description: Response codes found in [response codes](https://wiki.onap.org/).
27761 description: Unique id of VNF. This is unique across the graph.
27764 example: __VNF-ID__
27765 - name: interface-name
27767 description: Name given to the interface
27770 example: __INTERFACE-NAME__
27771 - name: vlan-interface
27773 description: String that identifies the interface
27776 example: __VLAN-INTERFACE__
27777 - name: l3-interface-ipv6-address
27779 description: IP address
27782 example: __L3-INTERFACE-IPV6-ADDRESS__
27785 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27788 $ref: "#/definitions/relationship"
27792 summary: delete an existing relationship
27793 description: delete an existing relationship
27794 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27803 description: Response codes found in [response codes](https://wiki.onap.org/).
27807 description: Unique id of VNF. This is unique across the graph.
27810 example: __VNF-ID__
27811 - name: interface-name
27813 description: Name given to the interface
27816 example: __INTERFACE-NAME__
27817 - name: vlan-interface
27819 description: String that identifies the interface
27822 example: __VLAN-INTERFACE__
27823 - name: l3-interface-ipv6-address
27825 description: IP address
27828 example: __L3-INTERFACE-IPV6-ADDRESS__
27829 /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}:
27833 summary: returns l3-interface-ipv6-address-list
27834 description: returns l3-interface-ipv6-address-list
27835 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27841 description: successful operation
27843 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27845 description: Response codes found in [response codes](https://wiki.onap.org/).
27849 description: Unique id of VNF. This is unique across the graph.
27852 example: __VNF-ID__
27853 - name: interface-name
27855 description: Name given to the interface
27858 example: __INTERFACE-NAME__
27859 - name: vlan-interface
27861 description: String that identifies the interface
27864 example: __VLAN-INTERFACE__
27865 - name: l3-interface-ipv6-address
27867 description: IP address
27870 example: __L3-INTERFACE-IPV6-ADDRESS__
27874 summary: create or update an existing l3-interface-ipv6-address-list
27876 Create or update an existing l3-interface-ipv6-address-list.
27878 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27879 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27888 description: Response codes found in [response codes](https://wiki.onap.org/).
27892 description: Unique id of VNF. This is unique across the graph.
27895 example: __VNF-ID__
27896 - name: interface-name
27898 description: Name given to the interface
27901 example: __INTERFACE-NAME__
27902 - name: vlan-interface
27904 description: String that identifies the interface
27907 example: __VLAN-INTERFACE__
27908 - name: l3-interface-ipv6-address
27910 description: IP address
27913 example: __L3-INTERFACE-IPV6-ADDRESS__
27916 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27919 $ref: "#/definitions/l3-interface-ipv6-address-list"
27923 summary: update an existing l3-interface-ipv6-address-list
27925 Update an existing l3-interface-ipv6-address-list
27927 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27928 The PUT operation will entirely replace an existing object.
27929 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27931 Other differences between PUT and PATCH are:
27933 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27934 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27935 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27936 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27945 description: Response codes found in [response codes](https://wiki.onap.org/).
27949 description: Unique id of VNF. This is unique across the graph.
27952 example: __VNF-ID__
27953 - name: interface-name
27955 description: Name given to the interface
27958 example: __INTERFACE-NAME__
27959 - name: vlan-interface
27961 description: String that identifies the interface
27964 example: __VLAN-INTERFACE__
27965 - name: l3-interface-ipv6-address
27967 description: IP address
27970 example: __L3-INTERFACE-IPV6-ADDRESS__
27973 description: l3-interface-ipv6-address-list object that needs to be updated.
27976 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27980 summary: delete an existing l3-interface-ipv6-address-list
27981 description: delete an existing l3-interface-ipv6-address-list
27982 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27991 description: Response codes found in [response codes](https://wiki.onap.org/).
27995 description: Unique id of VNF. This is unique across the graph.
27998 example: __VNF-ID__
27999 - name: interface-name
28001 description: Name given to the interface
28004 example: __INTERFACE-NAME__
28005 - name: vlan-interface
28007 description: String that identifies the interface
28010 example: __VLAN-INTERFACE__
28011 - name: l3-interface-ipv6-address
28013 description: IP address
28016 example: __L3-INTERFACE-IPV6-ADDRESS__
28017 - name: resource-version
28019 description: resource-version for concurrency
28022 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
28026 summary: returns vlan
28027 description: returns vlan
28028 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28034 description: successful operation
28036 $ref: "#/getDefinitions/vlan"
28038 description: Response codes found in [response codes](https://wiki.onap.org/).
28042 description: Unique id of VNF. This is unique across the graph.
28045 example: __VNF-ID__
28046 - name: interface-name
28048 description: Name given to the interface
28051 example: __INTERFACE-NAME__
28052 - name: vlan-interface
28054 description: String that identifies the interface
28057 example: __VLAN-INTERFACE__
28061 summary: create or update an existing vlan
28063 Create or update an existing vlan.
28065 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28066 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28075 description: Response codes found in [response codes](https://wiki.onap.org/).
28079 description: Unique id of VNF. This is unique across the graph.
28082 example: __VNF-ID__
28083 - name: interface-name
28085 description: Name given to the interface
28088 example: __INTERFACE-NAME__
28089 - name: vlan-interface
28091 description: String that identifies the interface
28094 example: __VLAN-INTERFACE__
28097 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
28100 $ref: "#/definitions/vlan"
28104 summary: update an existing vlan
28106 Update an existing vlan
28108 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28109 The PUT operation will entirely replace an existing object.
28110 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28112 Other differences between PUT and PATCH are:
28114 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28115 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28116 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28117 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28126 description: Response codes found in [response codes](https://wiki.onap.org/).
28130 description: Unique id of VNF. This is unique across the graph.
28133 example: __VNF-ID__
28134 - name: interface-name
28136 description: Name given to the interface
28139 example: __INTERFACE-NAME__
28140 - name: vlan-interface
28142 description: String that identifies the interface
28145 example: __VLAN-INTERFACE__
28148 description: vlan object that needs to be updated.
28151 $ref: "#/patchDefinitions/vlan"
28155 summary: delete an existing vlan
28156 description: delete an existing vlan
28157 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28166 description: Response codes found in [response codes](https://wiki.onap.org/).
28170 description: Unique id of VNF. This is unique across the graph.
28173 example: __VNF-ID__
28174 - name: interface-name
28176 description: Name given to the interface
28179 example: __INTERFACE-NAME__
28180 - name: vlan-interface
28182 description: String that identifies the interface
28185 example: __VLAN-INTERFACE__
28186 - name: resource-version
28188 description: resource-version for concurrency
28191 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
28195 summary: returns vlans
28196 description: returns vlans
28197 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
28203 description: successful operation
28205 $ref: "#/getDefinitions/vlans"
28207 description: Response codes found in [response codes](https://wiki.onap.org/).
28211 description: Unique id of VNF. This is unique across the graph.
28214 example: __VNF-ID__
28215 - name: interface-name
28217 description: Name given to the interface
28220 example: __INTERFACE-NAME__
28221 - name: vlan-interface
28226 - name: vlan-id-inner
28237 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
28241 summary: see node definition for valid relationships
28242 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28251 description: Response codes found in [response codes](https://wiki.onap.org/).
28255 description: Unique id of VNF. This is unique across the graph.
28258 example: __VNF-ID__
28259 - name: interface-name
28261 description: Name given to the interface
28264 example: __INTERFACE-NAME__
28267 description: PCI ID used to identify the sriov-vf
28270 example: __PCI-ID__
28273 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
28276 $ref: "#/definitions/relationship"
28280 summary: delete an existing relationship
28281 description: delete an existing relationship
28282 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28291 description: Response codes found in [response codes](https://wiki.onap.org/).
28295 description: Unique id of VNF. This is unique across the graph.
28298 example: __VNF-ID__
28299 - name: interface-name
28301 description: Name given to the interface
28304 example: __INTERFACE-NAME__
28307 description: PCI ID used to identify the sriov-vf
28310 example: __PCI-ID__
28311 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
28315 summary: returns sriov-vf
28316 description: returns sriov-vf
28317 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28323 description: successful operation
28325 $ref: "#/getDefinitions/sriov-vf"
28327 description: Response codes found in [response codes](https://wiki.onap.org/).
28331 description: Unique id of VNF. This is unique across the graph.
28334 example: __VNF-ID__
28335 - name: interface-name
28337 description: Name given to the interface
28340 example: __INTERFACE-NAME__
28343 description: PCI ID used to identify the sriov-vf
28346 example: __PCI-ID__
28350 summary: create or update an existing sriov-vf
28352 Create or update an existing sriov-vf.
28354 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28355 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28364 description: Response codes found in [response codes](https://wiki.onap.org/).
28368 description: Unique id of VNF. This is unique across the graph.
28371 example: __VNF-ID__
28372 - name: interface-name
28374 description: Name given to the interface
28377 example: __INTERFACE-NAME__
28380 description: PCI ID used to identify the sriov-vf
28383 example: __PCI-ID__
28386 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
28389 $ref: "#/definitions/sriov-vf"
28393 summary: update an existing sriov-vf
28395 Update an existing sriov-vf
28397 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28398 The PUT operation will entirely replace an existing object.
28399 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28401 Other differences between PUT and PATCH are:
28403 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28404 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28405 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28406 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28415 description: Response codes found in [response codes](https://wiki.onap.org/).
28419 description: Unique id of VNF. This is unique across the graph.
28422 example: __VNF-ID__
28423 - name: interface-name
28425 description: Name given to the interface
28428 example: __INTERFACE-NAME__
28431 description: PCI ID used to identify the sriov-vf
28434 example: __PCI-ID__
28437 description: sriov-vf object that needs to be updated.
28440 $ref: "#/patchDefinitions/sriov-vf"
28444 summary: delete an existing sriov-vf
28445 description: delete an existing sriov-vf
28446 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28455 description: Response codes found in [response codes](https://wiki.onap.org/).
28459 description: Unique id of VNF. This is unique across the graph.
28462 example: __VNF-ID__
28463 - name: interface-name
28465 description: Name given to the interface
28468 example: __INTERFACE-NAME__
28471 description: PCI ID used to identify the sriov-vf
28474 example: __PCI-ID__
28475 - name: resource-version
28477 description: resource-version for concurrency
28480 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28484 summary: returns sriov-vfs
28485 description: returns sriov-vfs
28486 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
28492 description: successful operation
28494 $ref: "#/getDefinitions/sriov-vfs"
28496 description: Response codes found in [response codes](https://wiki.onap.org/).
28500 description: Unique id of VNF. This is unique across the graph.
28503 example: __VNF-ID__
28504 - name: interface-name
28506 description: Name given to the interface
28509 example: __INTERFACE-NAME__
28515 - name: vf-vlan-filter
28520 - name: vf-mac-filter
28525 - name: vf-vlan-strip
28530 - name: neutron-network-id
28535 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28539 summary: see node definition for valid relationships
28540 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
28549 description: Response codes found in [response codes](https://wiki.onap.org/).
28553 description: Unique id of VNF. This is unique across the graph.
28556 example: __VNF-ID__
28557 - name: interface-name
28559 description: Name given to the interface
28562 example: __INTERFACE-NAME__
28565 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
28568 $ref: "#/definitions/relationship"
28572 summary: delete an existing relationship
28573 description: delete an existing relationship
28574 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
28583 description: Response codes found in [response codes](https://wiki.onap.org/).
28587 description: Unique id of VNF. This is unique across the graph.
28590 example: __VNF-ID__
28591 - name: interface-name
28593 description: Name given to the interface
28596 example: __INTERFACE-NAME__
28597 /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:
28601 summary: see node definition for valid relationships
28602 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28611 description: Response codes found in [response codes](https://wiki.onap.org/).
28615 description: Unique id of VNF. This is unique across the graph.
28618 example: __VNF-ID__
28619 - name: interface-name
28621 description: Name given to the interface
28624 example: __INTERFACE-NAME__
28625 - name: l3-interface-ipv4-address
28627 description: IP address
28630 example: __L3-INTERFACE-IPV4-ADDRESS__
28633 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28636 $ref: "#/definitions/relationship"
28640 summary: delete an existing relationship
28641 description: delete an existing relationship
28642 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28651 description: Response codes found in [response codes](https://wiki.onap.org/).
28655 description: Unique id of VNF. This is unique across the graph.
28658 example: __VNF-ID__
28659 - name: interface-name
28661 description: Name given to the interface
28664 example: __INTERFACE-NAME__
28665 - name: l3-interface-ipv4-address
28667 description: IP address
28670 example: __L3-INTERFACE-IPV4-ADDRESS__
28671 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
28675 summary: returns l3-interface-ipv4-address-list
28676 description: returns l3-interface-ipv4-address-list
28677 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28683 description: successful operation
28685 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28687 description: Response codes found in [response codes](https://wiki.onap.org/).
28691 description: Unique id of VNF. This is unique across the graph.
28694 example: __VNF-ID__
28695 - name: interface-name
28697 description: Name given to the interface
28700 example: __INTERFACE-NAME__
28701 - name: l3-interface-ipv4-address
28703 description: IP address
28706 example: __L3-INTERFACE-IPV4-ADDRESS__
28710 summary: create or update an existing l3-interface-ipv4-address-list
28712 Create or update an existing l3-interface-ipv4-address-list.
28714 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28715 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28724 description: Response codes found in [response codes](https://wiki.onap.org/).
28728 description: Unique id of VNF. This is unique across the graph.
28731 example: __VNF-ID__
28732 - name: interface-name
28734 description: Name given to the interface
28737 example: __INTERFACE-NAME__
28738 - name: l3-interface-ipv4-address
28740 description: IP address
28743 example: __L3-INTERFACE-IPV4-ADDRESS__
28746 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28749 $ref: "#/definitions/l3-interface-ipv4-address-list"
28753 summary: update an existing l3-interface-ipv4-address-list
28755 Update an existing l3-interface-ipv4-address-list
28757 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28758 The PUT operation will entirely replace an existing object.
28759 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28761 Other differences between PUT and PATCH are:
28763 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28764 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28765 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28766 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28775 description: Response codes found in [response codes](https://wiki.onap.org/).
28779 description: Unique id of VNF. This is unique across the graph.
28782 example: __VNF-ID__
28783 - name: interface-name
28785 description: Name given to the interface
28788 example: __INTERFACE-NAME__
28789 - name: l3-interface-ipv4-address
28791 description: IP address
28794 example: __L3-INTERFACE-IPV4-ADDRESS__
28797 description: l3-interface-ipv4-address-list object that needs to be updated.
28800 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28804 summary: delete an existing l3-interface-ipv4-address-list
28805 description: delete an existing l3-interface-ipv4-address-list
28806 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28815 description: Response codes found in [response codes](https://wiki.onap.org/).
28819 description: Unique id of VNF. This is unique across the graph.
28822 example: __VNF-ID__
28823 - name: interface-name
28825 description: Name given to the interface
28828 example: __INTERFACE-NAME__
28829 - name: l3-interface-ipv4-address
28831 description: IP address
28834 example: __L3-INTERFACE-IPV4-ADDRESS__
28835 - name: resource-version
28837 description: resource-version for concurrency
28840 /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:
28844 summary: see node definition for valid relationships
28845 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28854 description: Response codes found in [response codes](https://wiki.onap.org/).
28858 description: Unique id of VNF. This is unique across the graph.
28861 example: __VNF-ID__
28862 - name: interface-name
28864 description: Name given to the interface
28867 example: __INTERFACE-NAME__
28868 - name: l3-interface-ipv6-address
28870 description: IP address
28873 example: __L3-INTERFACE-IPV6-ADDRESS__
28876 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28879 $ref: "#/definitions/relationship"
28883 summary: delete an existing relationship
28884 description: delete an existing relationship
28885 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28894 description: Response codes found in [response codes](https://wiki.onap.org/).
28898 description: Unique id of VNF. This is unique across the graph.
28901 example: __VNF-ID__
28902 - name: interface-name
28904 description: Name given to the interface
28907 example: __INTERFACE-NAME__
28908 - name: l3-interface-ipv6-address
28910 description: IP address
28913 example: __L3-INTERFACE-IPV6-ADDRESS__
28914 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
28918 summary: returns l3-interface-ipv6-address-list
28919 description: returns l3-interface-ipv6-address-list
28920 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28926 description: successful operation
28928 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28930 description: Response codes found in [response codes](https://wiki.onap.org/).
28934 description: Unique id of VNF. This is unique across the graph.
28937 example: __VNF-ID__
28938 - name: interface-name
28940 description: Name given to the interface
28943 example: __INTERFACE-NAME__
28944 - name: l3-interface-ipv6-address
28946 description: IP address
28949 example: __L3-INTERFACE-IPV6-ADDRESS__
28953 summary: create or update an existing l3-interface-ipv6-address-list
28955 Create or update an existing l3-interface-ipv6-address-list.
28957 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28958 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28967 description: Response codes found in [response codes](https://wiki.onap.org/).
28971 description: Unique id of VNF. This is unique across the graph.
28974 example: __VNF-ID__
28975 - name: interface-name
28977 description: Name given to the interface
28980 example: __INTERFACE-NAME__
28981 - name: l3-interface-ipv6-address
28983 description: IP address
28986 example: __L3-INTERFACE-IPV6-ADDRESS__
28989 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28992 $ref: "#/definitions/l3-interface-ipv6-address-list"
28996 summary: update an existing l3-interface-ipv6-address-list
28998 Update an existing l3-interface-ipv6-address-list
29000 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29001 The PUT operation will entirely replace an existing object.
29002 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29004 Other differences between PUT and PATCH are:
29006 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29007 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29008 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29009 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
29018 description: Response codes found in [response codes](https://wiki.onap.org/).
29022 description: Unique id of VNF. This is unique across the graph.
29025 example: __VNF-ID__
29026 - name: interface-name
29028 description: Name given to the interface
29031 example: __INTERFACE-NAME__
29032 - name: l3-interface-ipv6-address
29034 description: IP address
29037 example: __L3-INTERFACE-IPV6-ADDRESS__
29040 description: l3-interface-ipv6-address-list object that needs to be updated.
29043 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29047 summary: delete an existing l3-interface-ipv6-address-list
29048 description: delete an existing l3-interface-ipv6-address-list
29049 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
29058 description: Response codes found in [response codes](https://wiki.onap.org/).
29062 description: Unique id of VNF. This is unique across the graph.
29065 example: __VNF-ID__
29066 - name: interface-name
29068 description: Name given to the interface
29071 example: __INTERFACE-NAME__
29072 - name: l3-interface-ipv6-address
29074 description: IP address
29077 example: __L3-INTERFACE-IPV6-ADDRESS__
29078 - name: resource-version
29080 description: resource-version for concurrency
29083 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
29087 summary: returns l-interface
29088 description: returns l-interface
29089 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
29095 description: successful operation
29097 $ref: "#/getDefinitions/l-interface"
29099 description: Response codes found in [response codes](https://wiki.onap.org/).
29103 description: Unique id of VNF. This is unique across the graph.
29106 example: __VNF-ID__
29107 - name: interface-name
29109 description: Name given to the interface
29112 example: __INTERFACE-NAME__
29116 summary: create or update an existing l-interface
29118 Create or update an existing l-interface.
29120 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29121 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
29130 description: Response codes found in [response codes](https://wiki.onap.org/).
29134 description: Unique id of VNF. This is unique across the graph.
29137 example: __VNF-ID__
29138 - name: interface-name
29140 description: Name given to the interface
29143 example: __INTERFACE-NAME__
29146 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
29149 $ref: "#/definitions/l-interface"
29153 summary: update an existing l-interface
29155 Update an existing l-interface
29157 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29158 The PUT operation will entirely replace an existing object.
29159 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29161 Other differences between PUT and PATCH are:
29163 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29164 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29165 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29166 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
29175 description: Response codes found in [response codes](https://wiki.onap.org/).
29179 description: Unique id of VNF. This is unique across the graph.
29182 example: __VNF-ID__
29183 - name: interface-name
29185 description: Name given to the interface
29188 example: __INTERFACE-NAME__
29191 description: l-interface object that needs to be updated.
29194 $ref: "#/patchDefinitions/l-interface"
29198 summary: delete an existing l-interface
29199 description: delete an existing l-interface
29200 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
29209 description: Response codes found in [response codes](https://wiki.onap.org/).
29213 description: Unique id of VNF. This is unique across the graph.
29216 example: __VNF-ID__
29217 - name: interface-name
29219 description: Name given to the interface
29222 example: __INTERFACE-NAME__
29223 - name: resource-version
29225 description: resource-version for concurrency
29228 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
29232 summary: returns l-interfaces
29233 description: returns l-interfaces
29234 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
29240 description: successful operation
29242 $ref: "#/getDefinitions/l-interfaces"
29244 description: Response codes found in [response codes](https://wiki.onap.org/).
29248 description: Unique id of VNF. This is unique across the graph.
29251 example: __VNF-ID__
29252 - name: interface-name
29257 - name: interface-id
29267 - name: network-name
29272 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
29276 summary: see node definition for valid relationships
29277 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
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 - name: interface-name
29296 description: Name that identifies the link aggregate interface
29299 example: __INTERFACE-NAME__
29302 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
29305 $ref: "#/definitions/relationship"
29309 summary: delete an existing relationship
29310 description: delete an existing relationship
29311 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
29320 description: Response codes found in [response codes](https://wiki.onap.org/).
29324 description: Unique id of VNF. This is unique across the graph.
29327 example: __VNF-ID__
29328 - name: interface-name
29330 description: Name that identifies the link aggregate interface
29333 example: __INTERFACE-NAME__
29334 /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:
29338 summary: see node definition for valid relationships
29339 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
29348 description: Response codes found in [response codes](https://wiki.onap.org/).
29352 description: Unique id of VNF. This is unique across the graph.
29355 example: __VNF-ID__
29356 - name: interface-name
29358 description: Name that identifies the link aggregate interface
29361 example: __INTERFACE-NAME__
29362 - name: interface-name
29364 description: Name given to the interface
29367 example: __INTERFACE-NAME__
29368 - name: vlan-interface
29370 description: String that identifies the interface
29373 example: __VLAN-INTERFACE__
29376 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
29379 $ref: "#/definitions/relationship"
29383 summary: delete an existing relationship
29384 description: delete an existing relationship
29385 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
29394 description: Response codes found in [response codes](https://wiki.onap.org/).
29398 description: Unique id of VNF. This is unique across the graph.
29401 example: __VNF-ID__
29402 - name: interface-name
29404 description: Name that identifies the link aggregate interface
29407 example: __INTERFACE-NAME__
29408 - name: interface-name
29410 description: Name given to the interface
29413 example: __INTERFACE-NAME__
29414 - name: vlan-interface
29416 description: String that identifies the interface
29419 example: __VLAN-INTERFACE__
29420 /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:
29424 summary: see node definition for valid relationships
29425 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
29434 description: Response codes found in [response codes](https://wiki.onap.org/).
29438 description: Unique id of VNF. This is unique across the graph.
29441 example: __VNF-ID__
29442 - name: interface-name
29444 description: Name that identifies the link aggregate interface
29447 example: __INTERFACE-NAME__
29448 - name: interface-name
29450 description: Name given to the interface
29453 example: __INTERFACE-NAME__
29454 - name: vlan-interface
29456 description: String that identifies the interface
29459 example: __VLAN-INTERFACE__
29460 - name: l3-interface-ipv4-address
29462 description: IP address
29465 example: __L3-INTERFACE-IPV4-ADDRESS__
29468 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
29471 $ref: "#/definitions/relationship"
29475 summary: delete an existing relationship
29476 description: delete an existing relationship
29477 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
29486 description: Response codes found in [response codes](https://wiki.onap.org/).
29490 description: Unique id of VNF. This is unique across the graph.
29493 example: __VNF-ID__
29494 - name: interface-name
29496 description: Name that identifies the link aggregate interface
29499 example: __INTERFACE-NAME__
29500 - name: interface-name
29502 description: Name given to the interface
29505 example: __INTERFACE-NAME__
29506 - name: vlan-interface
29508 description: String that identifies the interface
29511 example: __VLAN-INTERFACE__
29512 - name: l3-interface-ipv4-address
29514 description: IP address
29517 example: __L3-INTERFACE-IPV4-ADDRESS__
29518 /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}:
29522 summary: returns l3-interface-ipv4-address-list
29523 description: returns l3-interface-ipv4-address-list
29524 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29530 description: successful operation
29532 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29534 description: Response codes found in [response codes](https://wiki.onap.org/).
29538 description: Unique id of VNF. This is unique across the graph.
29541 example: __VNF-ID__
29542 - name: interface-name
29544 description: Name that identifies the link aggregate interface
29547 example: __INTERFACE-NAME__
29548 - name: interface-name
29550 description: Name given to the interface
29553 example: __INTERFACE-NAME__
29554 - name: vlan-interface
29556 description: String that identifies the interface
29559 example: __VLAN-INTERFACE__
29560 - name: l3-interface-ipv4-address
29562 description: IP address
29565 example: __L3-INTERFACE-IPV4-ADDRESS__
29569 summary: create or update an existing l3-interface-ipv4-address-list
29571 Create or update an existing l3-interface-ipv4-address-list.
29573 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29574 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29583 description: Response codes found in [response codes](https://wiki.onap.org/).
29587 description: Unique id of VNF. This is unique across the graph.
29590 example: __VNF-ID__
29591 - name: interface-name
29593 description: Name that identifies the link aggregate interface
29596 example: __INTERFACE-NAME__
29597 - name: interface-name
29599 description: Name given to the interface
29602 example: __INTERFACE-NAME__
29603 - name: vlan-interface
29605 description: String that identifies the interface
29608 example: __VLAN-INTERFACE__
29609 - name: l3-interface-ipv4-address
29611 description: IP address
29614 example: __L3-INTERFACE-IPV4-ADDRESS__
29617 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
29620 $ref: "#/definitions/l3-interface-ipv4-address-list"
29624 summary: update an existing l3-interface-ipv4-address-list
29626 Update an existing l3-interface-ipv4-address-list
29628 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29629 The PUT operation will entirely replace an existing object.
29630 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29632 Other differences between PUT and PATCH are:
29634 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29635 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29636 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29637 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29646 description: Response codes found in [response codes](https://wiki.onap.org/).
29650 description: Unique id of VNF. This is unique across the graph.
29653 example: __VNF-ID__
29654 - name: interface-name
29656 description: Name that identifies the link aggregate interface
29659 example: __INTERFACE-NAME__
29660 - name: interface-name
29662 description: Name given to the interface
29665 example: __INTERFACE-NAME__
29666 - name: vlan-interface
29668 description: String that identifies the interface
29671 example: __VLAN-INTERFACE__
29672 - name: l3-interface-ipv4-address
29674 description: IP address
29677 example: __L3-INTERFACE-IPV4-ADDRESS__
29680 description: l3-interface-ipv4-address-list object that needs to be updated.
29683 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29687 summary: delete an existing l3-interface-ipv4-address-list
29688 description: delete an existing l3-interface-ipv4-address-list
29689 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29698 description: Response codes found in [response codes](https://wiki.onap.org/).
29702 description: Unique id of VNF. This is unique across the graph.
29705 example: __VNF-ID__
29706 - name: interface-name
29708 description: Name that identifies the link aggregate interface
29711 example: __INTERFACE-NAME__
29712 - name: interface-name
29714 description: Name given to the interface
29717 example: __INTERFACE-NAME__
29718 - name: vlan-interface
29720 description: String that identifies the interface
29723 example: __VLAN-INTERFACE__
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/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:
29739 summary: see node definition for valid relationships
29740 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
29749 description: Response codes found in [response codes](https://wiki.onap.org/).
29753 description: Unique id of VNF. This is unique across the graph.
29756 example: __VNF-ID__
29757 - name: interface-name
29759 description: Name that identifies the link aggregate interface
29762 example: __INTERFACE-NAME__
29763 - name: interface-name
29765 description: Name given to the interface
29768 example: __INTERFACE-NAME__
29769 - name: vlan-interface
29771 description: String that identifies the interface
29774 example: __VLAN-INTERFACE__
29775 - name: l3-interface-ipv6-address
29777 description: IP address
29780 example: __L3-INTERFACE-IPV6-ADDRESS__
29783 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
29786 $ref: "#/definitions/relationship"
29790 summary: delete an existing relationship
29791 description: delete an existing relationship
29792 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
29801 description: Response codes found in [response codes](https://wiki.onap.org/).
29805 description: Unique id of VNF. This is unique across the graph.
29808 example: __VNF-ID__
29809 - name: interface-name
29811 description: Name that identifies the link aggregate interface
29814 example: __INTERFACE-NAME__
29815 - name: interface-name
29817 description: Name given to the interface
29820 example: __INTERFACE-NAME__
29821 - name: vlan-interface
29823 description: String that identifies the interface
29826 example: __VLAN-INTERFACE__
29827 - name: l3-interface-ipv6-address
29829 description: IP address
29832 example: __L3-INTERFACE-IPV6-ADDRESS__
29833 /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}:
29837 summary: returns l3-interface-ipv6-address-list
29838 description: returns l3-interface-ipv6-address-list
29839 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29845 description: successful operation
29847 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29849 description: Response codes found in [response codes](https://wiki.onap.org/).
29853 description: Unique id of VNF. This is unique across the graph.
29856 example: __VNF-ID__
29857 - name: interface-name
29859 description: Name that identifies the link aggregate interface
29862 example: __INTERFACE-NAME__
29863 - name: interface-name
29865 description: Name given to the interface
29868 example: __INTERFACE-NAME__
29869 - name: vlan-interface
29871 description: String that identifies the interface
29874 example: __VLAN-INTERFACE__
29875 - name: l3-interface-ipv6-address
29877 description: IP address
29880 example: __L3-INTERFACE-IPV6-ADDRESS__
29884 summary: create or update an existing l3-interface-ipv6-address-list
29886 Create or update an existing l3-interface-ipv6-address-list.
29888 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29889 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29898 description: Response codes found in [response codes](https://wiki.onap.org/).
29902 description: Unique id of VNF. This is unique across the graph.
29905 example: __VNF-ID__
29906 - name: interface-name
29908 description: Name that identifies the link aggregate interface
29911 example: __INTERFACE-NAME__
29912 - name: interface-name
29914 description: Name given to the interface
29917 example: __INTERFACE-NAME__
29918 - name: vlan-interface
29920 description: String that identifies the interface
29923 example: __VLAN-INTERFACE__
29924 - name: l3-interface-ipv6-address
29926 description: IP address
29929 example: __L3-INTERFACE-IPV6-ADDRESS__
29932 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
29935 $ref: "#/definitions/l3-interface-ipv6-address-list"
29939 summary: update an existing l3-interface-ipv6-address-list
29941 Update an existing l3-interface-ipv6-address-list
29943 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29944 The PUT operation will entirely replace an existing object.
29945 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29947 Other differences between PUT and PATCH are:
29949 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29950 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29951 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29952 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29961 description: Response codes found in [response codes](https://wiki.onap.org/).
29965 description: Unique id of VNF. This is unique across the graph.
29968 example: __VNF-ID__
29969 - name: interface-name
29971 description: Name that identifies the link aggregate interface
29974 example: __INTERFACE-NAME__
29975 - name: interface-name
29977 description: Name given to the interface
29980 example: __INTERFACE-NAME__
29981 - name: vlan-interface
29983 description: String that identifies the interface
29986 example: __VLAN-INTERFACE__
29987 - name: l3-interface-ipv6-address
29989 description: IP address
29992 example: __L3-INTERFACE-IPV6-ADDRESS__
29995 description: l3-interface-ipv6-address-list object that needs to be updated.
29998 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30002 summary: delete an existing l3-interface-ipv6-address-list
30003 description: delete an existing l3-interface-ipv6-address-list
30004 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
30013 description: Response codes found in [response codes](https://wiki.onap.org/).
30017 description: Unique id of VNF. This is unique across the graph.
30020 example: __VNF-ID__
30021 - name: interface-name
30023 description: Name that identifies the link aggregate interface
30026 example: __INTERFACE-NAME__
30027 - name: interface-name
30029 description: Name given to the interface
30032 example: __INTERFACE-NAME__
30033 - name: vlan-interface
30035 description: String that identifies the interface
30038 example: __VLAN-INTERFACE__
30039 - name: l3-interface-ipv6-address
30041 description: IP address
30044 example: __L3-INTERFACE-IPV6-ADDRESS__
30045 - name: resource-version
30047 description: resource-version for concurrency
30050 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
30054 summary: returns vlan
30055 description: returns vlan
30056 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
30062 description: successful operation
30064 $ref: "#/getDefinitions/vlan"
30066 description: Response codes found in [response codes](https://wiki.onap.org/).
30070 description: Unique id of VNF. This is unique across the graph.
30073 example: __VNF-ID__
30074 - name: interface-name
30076 description: Name that identifies the link aggregate interface
30079 example: __INTERFACE-NAME__
30080 - name: interface-name
30082 description: Name given to the interface
30085 example: __INTERFACE-NAME__
30086 - name: vlan-interface
30088 description: String that identifies the interface
30091 example: __VLAN-INTERFACE__
30095 summary: create or update an existing vlan
30097 Create or update an existing vlan.
30099 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30100 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
30109 description: Response codes found in [response codes](https://wiki.onap.org/).
30113 description: Unique id of VNF. This is unique across the graph.
30116 example: __VNF-ID__
30117 - name: interface-name
30119 description: Name that identifies the link aggregate interface
30122 example: __INTERFACE-NAME__
30123 - name: interface-name
30125 description: Name given to the interface
30128 example: __INTERFACE-NAME__
30129 - name: vlan-interface
30131 description: String that identifies the interface
30134 example: __VLAN-INTERFACE__
30137 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
30140 $ref: "#/definitions/vlan"
30144 summary: update an existing vlan
30146 Update an existing vlan
30148 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30149 The PUT operation will entirely replace an existing object.
30150 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30152 Other differences between PUT and PATCH are:
30154 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30155 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30156 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30157 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
30166 description: Response codes found in [response codes](https://wiki.onap.org/).
30170 description: Unique id of VNF. This is unique across the graph.
30173 example: __VNF-ID__
30174 - name: interface-name
30176 description: Name that identifies the link aggregate interface
30179 example: __INTERFACE-NAME__
30180 - name: interface-name
30182 description: Name given to the interface
30185 example: __INTERFACE-NAME__
30186 - name: vlan-interface
30188 description: String that identifies the interface
30191 example: __VLAN-INTERFACE__
30194 description: vlan object that needs to be updated.
30197 $ref: "#/patchDefinitions/vlan"
30201 summary: delete an existing vlan
30202 description: delete an existing vlan
30203 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
30212 description: Response codes found in [response codes](https://wiki.onap.org/).
30216 description: Unique id of VNF. This is unique across the graph.
30219 example: __VNF-ID__
30220 - name: interface-name
30222 description: Name that identifies the link aggregate interface
30225 example: __INTERFACE-NAME__
30226 - name: interface-name
30228 description: Name given to the interface
30231 example: __INTERFACE-NAME__
30232 - name: vlan-interface
30234 description: String that identifies the interface
30237 example: __VLAN-INTERFACE__
30238 - name: resource-version
30240 description: resource-version for concurrency
30243 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
30247 summary: returns vlans
30248 description: returns vlans
30249 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
30255 description: successful operation
30257 $ref: "#/getDefinitions/vlans"
30259 description: Response codes found in [response codes](https://wiki.onap.org/).
30263 description: Unique id of VNF. This is unique across the graph.
30266 example: __VNF-ID__
30267 - name: interface-name
30269 description: Name that identifies the link aggregate interface
30272 example: __INTERFACE-NAME__
30273 - name: interface-name
30275 description: Name given to the interface
30278 example: __INTERFACE-NAME__
30279 - name: vlan-interface
30284 - name: vlan-id-inner
30295 /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:
30299 summary: see node definition for valid relationships
30300 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
30309 description: Response codes found in [response codes](https://wiki.onap.org/).
30313 description: Unique id of VNF. This is unique across the graph.
30316 example: __VNF-ID__
30317 - name: interface-name
30319 description: Name that identifies the link aggregate interface
30322 example: __INTERFACE-NAME__
30323 - name: interface-name
30325 description: Name given to the interface
30328 example: __INTERFACE-NAME__
30331 description: PCI ID used to identify the sriov-vf
30334 example: __PCI-ID__
30337 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
30340 $ref: "#/definitions/relationship"
30344 summary: delete an existing relationship
30345 description: delete an existing relationship
30346 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
30355 description: Response codes found in [response codes](https://wiki.onap.org/).
30359 description: Unique id of VNF. This is unique across the graph.
30362 example: __VNF-ID__
30363 - name: interface-name
30365 description: Name that identifies the link aggregate interface
30368 example: __INTERFACE-NAME__
30369 - name: interface-name
30371 description: Name given to the interface
30374 example: __INTERFACE-NAME__
30377 description: PCI ID used to identify the sriov-vf
30380 example: __PCI-ID__
30381 /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}:
30385 summary: returns sriov-vf
30386 description: returns sriov-vf
30387 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30393 description: successful operation
30395 $ref: "#/getDefinitions/sriov-vf"
30397 description: Response codes found in [response codes](https://wiki.onap.org/).
30401 description: Unique id of VNF. This is unique across the graph.
30404 example: __VNF-ID__
30405 - name: interface-name
30407 description: Name that identifies the link aggregate interface
30410 example: __INTERFACE-NAME__
30411 - name: interface-name
30413 description: Name given to the interface
30416 example: __INTERFACE-NAME__
30419 description: PCI ID used to identify the sriov-vf
30422 example: __PCI-ID__
30426 summary: create or update an existing sriov-vf
30428 Create or update an existing sriov-vf.
30430 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30431 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30440 description: Response codes found in [response codes](https://wiki.onap.org/).
30444 description: Unique id of VNF. This is unique across the graph.
30447 example: __VNF-ID__
30448 - name: interface-name
30450 description: Name that identifies the link aggregate interface
30453 example: __INTERFACE-NAME__
30454 - name: interface-name
30456 description: Name given to the interface
30459 example: __INTERFACE-NAME__
30462 description: PCI ID used to identify the sriov-vf
30465 example: __PCI-ID__
30468 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
30471 $ref: "#/definitions/sriov-vf"
30475 summary: update an existing sriov-vf
30477 Update an existing sriov-vf
30479 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30480 The PUT operation will entirely replace an existing object.
30481 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30483 Other differences between PUT and PATCH are:
30485 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30486 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30487 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30488 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30497 description: Response codes found in [response codes](https://wiki.onap.org/).
30501 description: Unique id of VNF. This is unique across the graph.
30504 example: __VNF-ID__
30505 - name: interface-name
30507 description: Name that identifies the link aggregate interface
30510 example: __INTERFACE-NAME__
30511 - name: interface-name
30513 description: Name given to the interface
30516 example: __INTERFACE-NAME__
30519 description: PCI ID used to identify the sriov-vf
30522 example: __PCI-ID__
30525 description: sriov-vf object that needs to be updated.
30528 $ref: "#/patchDefinitions/sriov-vf"
30532 summary: delete an existing sriov-vf
30533 description: delete an existing sriov-vf
30534 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30543 description: Response codes found in [response codes](https://wiki.onap.org/).
30547 description: Unique id of VNF. This is unique across the graph.
30550 example: __VNF-ID__
30551 - name: interface-name
30553 description: Name that identifies the link aggregate interface
30556 example: __INTERFACE-NAME__
30557 - name: interface-name
30559 description: Name given to the interface
30562 example: __INTERFACE-NAME__
30565 description: PCI ID used to identify the sriov-vf
30568 example: __PCI-ID__
30569 - name: resource-version
30571 description: resource-version for concurrency
30574 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
30578 summary: returns sriov-vfs
30579 description: returns sriov-vfs
30580 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
30586 description: successful operation
30588 $ref: "#/getDefinitions/sriov-vfs"
30590 description: Response codes found in [response codes](https://wiki.onap.org/).
30594 description: Unique id of VNF. This is unique across the graph.
30597 example: __VNF-ID__
30598 - name: interface-name
30600 description: Name that identifies the link aggregate interface
30603 example: __INTERFACE-NAME__
30604 - name: interface-name
30606 description: Name given to the interface
30609 example: __INTERFACE-NAME__
30615 - name: vf-vlan-filter
30620 - name: vf-mac-filter
30625 - name: vf-vlan-strip
30630 - name: neutron-network-id
30635 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
30639 summary: see node definition for valid relationships
30640 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
30649 description: Response codes found in [response codes](https://wiki.onap.org/).
30653 description: Unique id of VNF. This is unique across the graph.
30656 example: __VNF-ID__
30657 - name: interface-name
30659 description: Name that identifies the link aggregate interface
30662 example: __INTERFACE-NAME__
30663 - name: interface-name
30665 description: Name given to the interface
30668 example: __INTERFACE-NAME__
30671 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
30674 $ref: "#/definitions/relationship"
30678 summary: delete an existing relationship
30679 description: delete an existing relationship
30680 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
30689 description: Response codes found in [response codes](https://wiki.onap.org/).
30693 description: Unique id of VNF. This is unique across the graph.
30696 example: __VNF-ID__
30697 - name: interface-name
30699 description: Name that identifies the link aggregate interface
30702 example: __INTERFACE-NAME__
30703 - name: interface-name
30705 description: Name given to the interface
30708 example: __INTERFACE-NAME__
30709 /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:
30713 summary: see node definition for valid relationships
30714 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
30723 description: Response codes found in [response codes](https://wiki.onap.org/).
30727 description: Unique id of VNF. This is unique across the graph.
30730 example: __VNF-ID__
30731 - name: interface-name
30733 description: Name that identifies the link aggregate interface
30736 example: __INTERFACE-NAME__
30737 - name: interface-name
30739 description: Name given to the interface
30742 example: __INTERFACE-NAME__
30743 - name: l3-interface-ipv4-address
30745 description: IP address
30748 example: __L3-INTERFACE-IPV4-ADDRESS__
30751 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30754 $ref: "#/definitions/relationship"
30758 summary: delete an existing relationship
30759 description: delete an existing relationship
30760 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
30769 description: Response codes found in [response codes](https://wiki.onap.org/).
30773 description: Unique id of VNF. This is unique across the graph.
30776 example: __VNF-ID__
30777 - name: interface-name
30779 description: Name that identifies the link aggregate interface
30782 example: __INTERFACE-NAME__
30783 - name: interface-name
30785 description: Name given to the interface
30788 example: __INTERFACE-NAME__
30789 - name: l3-interface-ipv4-address
30791 description: IP address
30794 example: __L3-INTERFACE-IPV4-ADDRESS__
30795 /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}:
30799 summary: returns l3-interface-ipv4-address-list
30800 description: returns l3-interface-ipv4-address-list
30801 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30807 description: successful operation
30809 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30811 description: Response codes found in [response codes](https://wiki.onap.org/).
30815 description: Unique id of VNF. This is unique across the graph.
30818 example: __VNF-ID__
30819 - name: interface-name
30821 description: Name that identifies the link aggregate interface
30824 example: __INTERFACE-NAME__
30825 - name: interface-name
30827 description: Name given to the interface
30830 example: __INTERFACE-NAME__
30831 - name: l3-interface-ipv4-address
30833 description: IP address
30836 example: __L3-INTERFACE-IPV4-ADDRESS__
30840 summary: create or update an existing l3-interface-ipv4-address-list
30842 Create or update an existing l3-interface-ipv4-address-list.
30844 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30845 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30854 description: Response codes found in [response codes](https://wiki.onap.org/).
30858 description: Unique id of VNF. This is unique across the graph.
30861 example: __VNF-ID__
30862 - name: interface-name
30864 description: Name that identifies the link aggregate interface
30867 example: __INTERFACE-NAME__
30868 - name: interface-name
30870 description: Name given to the interface
30873 example: __INTERFACE-NAME__
30874 - name: l3-interface-ipv4-address
30876 description: IP address
30879 example: __L3-INTERFACE-IPV4-ADDRESS__
30882 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30885 $ref: "#/definitions/l3-interface-ipv4-address-list"
30889 summary: update an existing l3-interface-ipv4-address-list
30891 Update an existing l3-interface-ipv4-address-list
30893 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30894 The PUT operation will entirely replace an existing object.
30895 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30897 Other differences between PUT and PATCH are:
30899 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30900 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30901 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30902 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30911 description: Response codes found in [response codes](https://wiki.onap.org/).
30915 description: Unique id of VNF. This is unique across the graph.
30918 example: __VNF-ID__
30919 - name: interface-name
30921 description: Name that identifies the link aggregate interface
30924 example: __INTERFACE-NAME__
30925 - name: interface-name
30927 description: Name given to the interface
30930 example: __INTERFACE-NAME__
30931 - name: l3-interface-ipv4-address
30933 description: IP address
30936 example: __L3-INTERFACE-IPV4-ADDRESS__
30939 description: l3-interface-ipv4-address-list object that needs to be updated.
30942 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30946 summary: delete an existing l3-interface-ipv4-address-list
30947 description: delete an existing l3-interface-ipv4-address-list
30948 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30957 description: Response codes found in [response codes](https://wiki.onap.org/).
30961 description: Unique id of VNF. This is unique across the graph.
30964 example: __VNF-ID__
30965 - name: interface-name
30967 description: Name that identifies the link aggregate interface
30970 example: __INTERFACE-NAME__
30971 - name: interface-name
30973 description: Name given to the interface
30976 example: __INTERFACE-NAME__
30977 - name: l3-interface-ipv4-address
30979 description: IP address
30982 example: __L3-INTERFACE-IPV4-ADDRESS__
30983 - name: resource-version
30985 description: resource-version for concurrency
30988 /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:
30992 summary: see node definition for valid relationships
30993 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31002 description: Response codes found in [response codes](https://wiki.onap.org/).
31006 description: Unique id of VNF. This is unique across the graph.
31009 example: __VNF-ID__
31010 - name: interface-name
31012 description: Name that identifies the link aggregate interface
31015 example: __INTERFACE-NAME__
31016 - name: interface-name
31018 description: Name given to the interface
31021 example: __INTERFACE-NAME__
31022 - name: l3-interface-ipv6-address
31024 description: IP address
31027 example: __L3-INTERFACE-IPV6-ADDRESS__
31030 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31033 $ref: "#/definitions/relationship"
31037 summary: delete an existing relationship
31038 description: delete an existing relationship
31039 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
31048 description: Response codes found in [response codes](https://wiki.onap.org/).
31052 description: Unique id of VNF. This is unique across the graph.
31055 example: __VNF-ID__
31056 - name: interface-name
31058 description: Name that identifies the link aggregate interface
31061 example: __INTERFACE-NAME__
31062 - name: interface-name
31064 description: Name given to the interface
31067 example: __INTERFACE-NAME__
31068 - name: l3-interface-ipv6-address
31070 description: IP address
31073 example: __L3-INTERFACE-IPV6-ADDRESS__
31074 /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}:
31078 summary: returns l3-interface-ipv6-address-list
31079 description: returns l3-interface-ipv6-address-list
31080 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31086 description: successful operation
31088 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31090 description: Response codes found in [response codes](https://wiki.onap.org/).
31094 description: Unique id of VNF. This is unique across the graph.
31097 example: __VNF-ID__
31098 - name: interface-name
31100 description: Name that identifies the link aggregate interface
31103 example: __INTERFACE-NAME__
31104 - name: interface-name
31106 description: Name given to the interface
31109 example: __INTERFACE-NAME__
31110 - name: l3-interface-ipv6-address
31112 description: IP address
31115 example: __L3-INTERFACE-IPV6-ADDRESS__
31119 summary: create or update an existing l3-interface-ipv6-address-list
31121 Create or update an existing l3-interface-ipv6-address-list.
31123 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31124 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31133 description: Response codes found in [response codes](https://wiki.onap.org/).
31137 description: Unique id of VNF. This is unique across the graph.
31140 example: __VNF-ID__
31141 - name: interface-name
31143 description: Name that identifies the link aggregate interface
31146 example: __INTERFACE-NAME__
31147 - name: interface-name
31149 description: Name given to the interface
31152 example: __INTERFACE-NAME__
31153 - name: l3-interface-ipv6-address
31155 description: IP address
31158 example: __L3-INTERFACE-IPV6-ADDRESS__
31161 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
31164 $ref: "#/definitions/l3-interface-ipv6-address-list"
31168 summary: update an existing l3-interface-ipv6-address-list
31170 Update an existing l3-interface-ipv6-address-list
31172 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31173 The PUT operation will entirely replace an existing object.
31174 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31176 Other differences between PUT and PATCH are:
31178 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31179 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31180 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31181 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31190 description: Response codes found in [response codes](https://wiki.onap.org/).
31194 description: Unique id of VNF. This is unique across the graph.
31197 example: __VNF-ID__
31198 - name: interface-name
31200 description: Name that identifies the link aggregate interface
31203 example: __INTERFACE-NAME__
31204 - name: interface-name
31206 description: Name given to the interface
31209 example: __INTERFACE-NAME__
31210 - name: l3-interface-ipv6-address
31212 description: IP address
31215 example: __L3-INTERFACE-IPV6-ADDRESS__
31218 description: l3-interface-ipv6-address-list object that needs to be updated.
31221 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31225 summary: delete an existing l3-interface-ipv6-address-list
31226 description: delete an existing l3-interface-ipv6-address-list
31227 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
31236 description: Response codes found in [response codes](https://wiki.onap.org/).
31240 description: Unique id of VNF. This is unique across the graph.
31243 example: __VNF-ID__
31244 - name: interface-name
31246 description: Name that identifies the link aggregate interface
31249 example: __INTERFACE-NAME__
31250 - name: interface-name
31252 description: Name given to the interface
31255 example: __INTERFACE-NAME__
31256 - name: l3-interface-ipv6-address
31258 description: IP address
31261 example: __L3-INTERFACE-IPV6-ADDRESS__
31262 - name: resource-version
31264 description: resource-version for concurrency
31267 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
31271 summary: returns l-interface
31272 description: returns l-interface
31273 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31279 description: successful operation
31281 $ref: "#/getDefinitions/l-interface"
31283 description: Response codes found in [response codes](https://wiki.onap.org/).
31287 description: Unique id of VNF. This is unique across the graph.
31290 example: __VNF-ID__
31291 - name: interface-name
31293 description: Name that identifies the link aggregate interface
31296 example: __INTERFACE-NAME__
31297 - name: interface-name
31299 description: Name given to the interface
31302 example: __INTERFACE-NAME__
31306 summary: create or update an existing l-interface
31308 Create or update an existing l-interface.
31310 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31311 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31320 description: Response codes found in [response codes](https://wiki.onap.org/).
31324 description: Unique id of VNF. This is unique across the graph.
31327 example: __VNF-ID__
31328 - name: interface-name
31330 description: Name that identifies the link aggregate interface
31333 example: __INTERFACE-NAME__
31334 - name: interface-name
31336 description: Name given to the interface
31339 example: __INTERFACE-NAME__
31342 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
31345 $ref: "#/definitions/l-interface"
31349 summary: update an existing l-interface
31351 Update an existing l-interface
31353 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31354 The PUT operation will entirely replace an existing object.
31355 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31357 Other differences between PUT and PATCH are:
31359 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31360 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31361 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31362 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31371 description: Response codes found in [response codes](https://wiki.onap.org/).
31375 description: Unique id of VNF. This is unique across the graph.
31378 example: __VNF-ID__
31379 - name: interface-name
31381 description: Name that identifies the link aggregate interface
31384 example: __INTERFACE-NAME__
31385 - name: interface-name
31387 description: Name given to the interface
31390 example: __INTERFACE-NAME__
31393 description: l-interface object that needs to be updated.
31396 $ref: "#/patchDefinitions/l-interface"
31400 summary: delete an existing l-interface
31401 description: delete an existing l-interface
31402 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31411 description: Response codes found in [response codes](https://wiki.onap.org/).
31415 description: Unique id of VNF. This is unique across the graph.
31418 example: __VNF-ID__
31419 - name: interface-name
31421 description: Name that identifies the link aggregate interface
31424 example: __INTERFACE-NAME__
31425 - name: interface-name
31427 description: Name given to the interface
31430 example: __INTERFACE-NAME__
31431 - name: resource-version
31433 description: resource-version for concurrency
31436 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
31440 summary: returns l-interfaces
31441 description: returns l-interfaces
31442 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
31448 description: successful operation
31450 $ref: "#/getDefinitions/l-interfaces"
31452 description: Response codes found in [response codes](https://wiki.onap.org/).
31456 description: Unique id of VNF. This is unique across the graph.
31459 example: __VNF-ID__
31460 - name: interface-name
31462 description: Name that identifies the link aggregate interface
31465 example: __INTERFACE-NAME__
31466 - name: interface-name
31471 - name: interface-id
31481 - name: network-name
31486 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
31490 summary: returns lag-interface
31491 description: returns lag-interface
31492 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31498 description: successful operation
31500 $ref: "#/getDefinitions/lag-interface"
31502 description: Response codes found in [response codes](https://wiki.onap.org/).
31506 description: Unique id of VNF. This is unique across the graph.
31509 example: __VNF-ID__
31510 - name: interface-name
31512 description: Name that identifies the link aggregate interface
31515 example: __INTERFACE-NAME__
31519 summary: create or update an existing lag-interface
31521 Create or update an existing lag-interface.
31523 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31524 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31533 description: Response codes found in [response codes](https://wiki.onap.org/).
31537 description: Unique id of VNF. This is unique across the graph.
31540 example: __VNF-ID__
31541 - name: interface-name
31543 description: Name that identifies the link aggregate interface
31546 example: __INTERFACE-NAME__
31549 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
31552 $ref: "#/definitions/lag-interface"
31556 summary: update an existing lag-interface
31558 Update an existing lag-interface
31560 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31561 The PUT operation will entirely replace an existing object.
31562 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31564 Other differences between PUT and PATCH are:
31566 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31567 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31568 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31569 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31578 description: Response codes found in [response codes](https://wiki.onap.org/).
31582 description: Unique id of VNF. This is unique across the graph.
31585 example: __VNF-ID__
31586 - name: interface-name
31588 description: Name that identifies the link aggregate interface
31591 example: __INTERFACE-NAME__
31594 description: lag-interface object that needs to be updated.
31597 $ref: "#/patchDefinitions/lag-interface"
31601 summary: delete an existing lag-interface
31602 description: delete an existing lag-interface
31603 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31612 description: Response codes found in [response codes](https://wiki.onap.org/).
31616 description: Unique id of VNF. This is unique across the graph.
31619 example: __VNF-ID__
31620 - name: interface-name
31622 description: Name that identifies the link aggregate interface
31625 example: __INTERFACE-NAME__
31626 - name: resource-version
31628 description: resource-version for concurrency
31631 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
31635 summary: returns lag-interfaces
31636 description: returns lag-interfaces
31637 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
31643 description: successful operation
31645 $ref: "#/getDefinitions/lag-interfaces"
31647 description: Response codes found in [response codes](https://wiki.onap.org/).
31651 description: Unique id of VNF. This is unique across the graph.
31654 example: __VNF-ID__
31655 - name: interface-name
31660 - name: interface-id
31665 - name: interface-role
31670 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
31674 summary: see node definition for valid relationships
31675 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
31684 description: Response codes found in [response codes](https://wiki.onap.org/).
31688 description: Unique id of VNF. This is unique across the graph.
31691 example: __VNF-ID__
31692 - name: vf-module-id
31694 description: Unique ID of vf-module.
31697 example: __VF-MODULE-ID__
31700 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
31703 $ref: "#/definitions/relationship"
31707 summary: delete an existing relationship
31708 description: delete an existing relationship
31709 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
31718 description: Response codes found in [response codes](https://wiki.onap.org/).
31722 description: Unique id of VNF. This is unique across the graph.
31725 example: __VNF-ID__
31726 - name: vf-module-id
31728 description: Unique ID of vf-module.
31731 example: __VF-MODULE-ID__
31732 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
31736 summary: returns vf-module
31737 description: returns vf-module
31738 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
31744 description: successful operation
31746 $ref: "#/getDefinitions/vf-module"
31748 description: Response codes found in [response codes](https://wiki.onap.org/).
31752 description: Unique id of VNF. This is unique across the graph.
31755 example: __VNF-ID__
31756 - name: vf-module-id
31758 description: Unique ID of vf-module.
31761 example: __VF-MODULE-ID__
31765 summary: create or update an existing vf-module
31767 Create or update an existing vf-module.
31769 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31770 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
31779 description: Response codes found in [response codes](https://wiki.onap.org/).
31783 description: Unique id of VNF. This is unique across the graph.
31786 example: __VNF-ID__
31787 - name: vf-module-id
31789 description: Unique ID of vf-module.
31792 example: __VF-MODULE-ID__
31795 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
31798 $ref: "#/definitions/vf-module"
31802 summary: update an existing vf-module
31804 Update an existing vf-module
31806 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31807 The PUT operation will entirely replace an existing object.
31808 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31810 Other differences between PUT and PATCH are:
31812 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31813 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31814 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31815 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
31824 description: Response codes found in [response codes](https://wiki.onap.org/).
31828 description: Unique id of VNF. This is unique across the graph.
31831 example: __VNF-ID__
31832 - name: vf-module-id
31834 description: Unique ID of vf-module.
31837 example: __VF-MODULE-ID__
31840 description: vf-module object that needs to be updated.
31843 $ref: "#/patchDefinitions/vf-module"
31847 summary: delete an existing vf-module
31848 description: delete an existing vf-module
31849 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
31858 description: Response codes found in [response codes](https://wiki.onap.org/).
31862 description: Unique id of VNF. This is unique across the graph.
31865 example: __VNF-ID__
31866 - name: vf-module-id
31868 description: Unique ID of vf-module.
31871 example: __VF-MODULE-ID__
31872 - name: resource-version
31874 description: resource-version for concurrency
31877 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
31881 summary: returns vf-modules
31882 description: returns vf-modules
31883 operationId: getNetworkGenericVnfsGenericVnfVfModules
31889 description: successful operation
31891 $ref: "#/getDefinitions/vf-modules"
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: vf-module-id
31906 - name: vf-module-name
31911 - name: heat-stack-id
31916 - name: model-invariant-id
31921 - name: model-version-id
31926 - name: widget-model-id
31931 - name: widget-model-version
31936 - name: contrail-service-instance-fqdn
31941 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31945 summary: see node definition for valid relationships
31946 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
31955 description: Response codes found in [response codes](https://wiki.onap.org/).
31959 description: Unique id of VNF. This is unique across the graph.
31962 example: __VNF-ID__
31965 description: Unique ID for the license group the resource belongs to, should be uuid.
31968 example: __GROUP-UUID__
31969 - name: resource-uuid
31971 description: Unique ID of a license resource.
31974 example: __RESOURCE-UUID__
31977 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)
31980 $ref: "#/definitions/relationship"
31984 summary: delete an existing relationship
31985 description: delete an existing relationship
31986 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
31995 description: Response codes found in [response codes](https://wiki.onap.org/).
31999 description: Unique id of VNF. This is unique across the graph.
32002 example: __VNF-ID__
32005 description: Unique ID for the license group the resource belongs to, should be uuid.
32008 example: __GROUP-UUID__
32009 - name: resource-uuid
32011 description: Unique ID of a license resource.
32014 example: __RESOURCE-UUID__
32015 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
32019 summary: returns license
32020 description: returns license
32021 operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
32027 description: successful operation
32029 $ref: "#/getDefinitions/license"
32031 description: Response codes found in [response codes](https://wiki.onap.org/).
32035 description: Unique id of VNF. This is unique across the graph.
32038 example: __VNF-ID__
32041 description: Unique ID for the license group the resource belongs to, should be uuid.
32044 example: __GROUP-UUID__
32045 - name: resource-uuid
32047 description: Unique ID of a license resource.
32050 example: __RESOURCE-UUID__
32054 summary: create or update an existing license
32056 Create or update an existing license.
32058 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32059 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
32068 description: Response codes found in [response codes](https://wiki.onap.org/).
32072 description: Unique id of VNF. This is unique across the graph.
32075 example: __VNF-ID__
32078 description: Unique ID for the license group the resource belongs to, should be uuid.
32081 example: __GROUP-UUID__
32082 - name: resource-uuid
32084 description: Unique ID of a license resource.
32087 example: __RESOURCE-UUID__
32090 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)
32093 $ref: "#/definitions/license"
32097 summary: update an existing license
32099 Update an existing license
32101 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32102 The PUT operation will entirely replace an existing object.
32103 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32105 Other differences between PUT and PATCH are:
32107 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32108 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32109 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32110 operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
32119 description: Response codes found in [response codes](https://wiki.onap.org/).
32123 description: Unique id of VNF. This is unique across the graph.
32126 example: __VNF-ID__
32129 description: Unique ID for the license group the resource belongs to, should be uuid.
32132 example: __GROUP-UUID__
32133 - name: resource-uuid
32135 description: Unique ID of a license resource.
32138 example: __RESOURCE-UUID__
32141 description: license object that needs to be updated.
32144 $ref: "#/patchDefinitions/license"
32148 summary: delete an existing license
32149 description: delete an existing license
32150 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
32159 description: Response codes found in [response codes](https://wiki.onap.org/).
32163 description: Unique id of VNF. This is unique across the graph.
32166 example: __VNF-ID__
32169 description: Unique ID for the license group the resource belongs to, should be uuid.
32172 example: __GROUP-UUID__
32173 - name: resource-uuid
32175 description: Unique ID of a license resource.
32178 example: __RESOURCE-UUID__
32179 - name: resource-version
32181 description: resource-version for concurrency
32184 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
32188 summary: returns licenses
32189 description: returns licenses
32190 operationId: getNetworkGenericVnfsGenericVnfLicenses
32196 description: successful operation
32198 $ref: "#/getDefinitions/licenses"
32200 description: Response codes found in [response codes](https://wiki.onap.org/).
32204 description: Unique id of VNF. This is unique across the graph.
32207 example: __VNF-ID__
32213 - name: resource-uuid
32218 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
32222 summary: see node definition for valid relationships
32223 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
32232 description: Response codes found in [response codes](https://wiki.onap.org/).
32236 description: Unique id of VNF. This is unique across the graph.
32239 example: __VNF-ID__
32242 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32245 example: __GROUP-UUID__
32246 - name: resource-uuid
32248 description: Unique ID of an entitlement resource.
32251 example: __RESOURCE-UUID__
32254 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
32257 $ref: "#/definitions/relationship"
32261 summary: delete an existing relationship
32262 description: delete an existing relationship
32263 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
32272 description: Response codes found in [response codes](https://wiki.onap.org/).
32276 description: Unique id of VNF. This is unique across the graph.
32279 example: __VNF-ID__
32282 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32285 example: __GROUP-UUID__
32286 - name: resource-uuid
32288 description: Unique ID of an entitlement resource.
32291 example: __RESOURCE-UUID__
32292 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
32296 summary: returns entitlement
32297 description: returns entitlement
32298 operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32304 description: successful operation
32306 $ref: "#/getDefinitions/entitlement"
32308 description: Response codes found in [response codes](https://wiki.onap.org/).
32312 description: Unique id of VNF. This is unique across the graph.
32315 example: __VNF-ID__
32318 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32321 example: __GROUP-UUID__
32322 - name: resource-uuid
32324 description: Unique ID of an entitlement resource.
32327 example: __RESOURCE-UUID__
32331 summary: create or update an existing entitlement
32333 Create or update an existing entitlement.
32335 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32336 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32345 description: Response codes found in [response codes](https://wiki.onap.org/).
32349 description: Unique id of VNF. This is unique across the graph.
32352 example: __VNF-ID__
32355 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32358 example: __GROUP-UUID__
32359 - name: resource-uuid
32361 description: Unique ID of an entitlement resource.
32364 example: __RESOURCE-UUID__
32367 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
32370 $ref: "#/definitions/entitlement"
32374 summary: update an existing entitlement
32376 Update an existing entitlement
32378 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32379 The PUT operation will entirely replace an existing object.
32380 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32382 Other differences between PUT and PATCH are:
32384 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32385 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32386 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32387 operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32396 description: Response codes found in [response codes](https://wiki.onap.org/).
32400 description: Unique id of VNF. This is unique across the graph.
32403 example: __VNF-ID__
32406 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32409 example: __GROUP-UUID__
32410 - name: resource-uuid
32412 description: Unique ID of an entitlement resource.
32415 example: __RESOURCE-UUID__
32418 description: entitlement object that needs to be updated.
32421 $ref: "#/patchDefinitions/entitlement"
32425 summary: delete an existing entitlement
32426 description: delete an existing entitlement
32427 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32436 description: Response codes found in [response codes](https://wiki.onap.org/).
32440 description: Unique id of VNF. This is unique across the graph.
32443 example: __VNF-ID__
32446 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32449 example: __GROUP-UUID__
32450 - name: resource-uuid
32452 description: Unique ID of an entitlement resource.
32455 example: __RESOURCE-UUID__
32456 - name: resource-version
32458 description: resource-version for concurrency
32461 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
32465 summary: returns entitlements
32466 description: returns entitlements
32467 operationId: getNetworkGenericVnfsGenericVnfEntitlements
32473 description: successful operation
32475 $ref: "#/getDefinitions/entitlements"
32477 description: Response codes found in [response codes](https://wiki.onap.org/).
32481 description: Unique id of VNF. This is unique across the graph.
32484 example: __VNF-ID__
32490 - name: resource-uuid
32495 /network/generic-vnfs/generic-vnf/{vnf-id}:
32499 summary: returns generic-vnf
32500 description: returns generic-vnf
32501 operationId: getNetworkGenericVnfsGenericVnf
32507 description: successful operation
32509 $ref: "#/getDefinitions/generic-vnf"
32511 description: Response codes found in [response codes](https://wiki.onap.org/).
32515 description: Unique id of VNF. This is unique across the graph.
32518 example: __VNF-ID__
32522 summary: create or update an existing generic-vnf
32524 Create or update an existing generic-vnf.
32526 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32527 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
32536 description: Response codes found in [response codes](https://wiki.onap.org/).
32540 description: Unique id of VNF. This is unique across the graph.
32543 example: __VNF-ID__
32546 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)
32549 $ref: "#/definitions/generic-vnf"
32553 summary: update an existing generic-vnf
32555 Update an existing generic-vnf
32557 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32558 The PUT operation will entirely replace an existing object.
32559 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32561 Other differences between PUT and PATCH are:
32563 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32564 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32565 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32566 operationId: UpdateNetworkGenericVnfsGenericVnf
32575 description: Response codes found in [response codes](https://wiki.onap.org/).
32579 description: Unique id of VNF. This is unique across the graph.
32582 example: __VNF-ID__
32585 description: generic-vnf object that needs to be updated.
32588 $ref: "#/patchDefinitions/generic-vnf"
32592 summary: delete an existing generic-vnf
32593 description: delete an existing generic-vnf
32594 operationId: deleteNetworkGenericVnfsGenericVnf
32603 description: Response codes found in [response codes](https://wiki.onap.org/).
32607 description: Unique id of VNF. This is unique across the graph.
32610 example: __VNF-ID__
32611 - name: resource-version
32613 description: resource-version for concurrency
32616 /network/generic-vnfs:
32620 summary: returns generic-vnfs
32621 description: returns generic-vnfs
32622 operationId: getNetworkGenericVnfs
32628 description: successful operation
32630 $ref: "#/getDefinitions/generic-vnfs"
32632 description: Response codes found in [response codes](https://wiki.onap.org/).
32659 - name: regional-resource-zone
32664 - name: prov-status
32669 - name: heat-stack-id
32679 - name: is-closed-loop-disabled
32684 - name: model-invariant-id
32689 - name: model-version-id
32694 - name: widget-model-id
32699 - name: widget-model-version
32709 - name: nf-function
32719 - name: nf-naming-code
32724 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
32728 summary: see node definition for valid relationships
32729 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
32738 description: Response codes found in [response codes](https://wiki.onap.org/).
32742 description: Alphabetical concatenation of lag-interface names
32745 example: __LINK-NAME__
32748 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)
32751 $ref: "#/definitions/relationship"
32755 summary: delete an existing relationship
32756 description: delete an existing relationship
32757 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
32766 description: Response codes found in [response codes](https://wiki.onap.org/).
32770 description: Alphabetical concatenation of lag-interface names
32773 example: __LINK-NAME__
32774 /network/lag-links/lag-link/{link-name}:
32778 summary: returns lag-link
32779 description: returns lag-link
32780 operationId: getNetworkLagLinksLagLink
32786 description: successful operation
32788 $ref: "#/getDefinitions/lag-link"
32790 description: Response codes found in [response codes](https://wiki.onap.org/).
32794 description: Alphabetical concatenation of lag-interface names
32797 example: __LINK-NAME__
32801 summary: create or update an existing lag-link
32803 Create or update an existing lag-link.
32805 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32806 operationId: createOrUpdateNetworkLagLinksLagLink
32815 description: Response codes found in [response codes](https://wiki.onap.org/).
32819 description: Alphabetical concatenation of lag-interface names
32822 example: __LINK-NAME__
32825 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)
32828 $ref: "#/definitions/lag-link"
32832 summary: update an existing lag-link
32834 Update an existing lag-link
32836 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32837 The PUT operation will entirely replace an existing object.
32838 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32840 Other differences between PUT and PATCH are:
32842 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32843 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32844 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32845 operationId: UpdateNetworkLagLinksLagLink
32854 description: Response codes found in [response codes](https://wiki.onap.org/).
32858 description: Alphabetical concatenation of lag-interface names
32861 example: __LINK-NAME__
32864 description: lag-link object that needs to be updated.
32867 $ref: "#/patchDefinitions/lag-link"
32871 summary: delete an existing lag-link
32872 description: delete an existing lag-link
32873 operationId: deleteNetworkLagLinksLagLink
32882 description: Response codes found in [response codes](https://wiki.onap.org/).
32886 description: Alphabetical concatenation of lag-interface names
32889 example: __LINK-NAME__
32890 - name: resource-version
32892 description: resource-version for concurrency
32895 /network/lag-links:
32899 summary: returns lag-links
32900 description: returns lag-links
32901 operationId: getNetworkLagLinks
32907 description: successful operation
32909 $ref: "#/getDefinitions/lag-links"
32911 description: Response codes found in [response codes](https://wiki.onap.org/).
32918 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
32922 summary: see node definition for valid relationships
32923 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
32932 description: Response codes found in [response codes](https://wiki.onap.org/).
32936 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32939 example: __VNF-ID2__
32942 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)
32945 $ref: "#/definitions/relationship"
32949 summary: delete an existing relationship
32950 description: delete an existing relationship
32951 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
32960 description: Response codes found in [response codes](https://wiki.onap.org/).
32964 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32967 example: __VNF-ID2__
32968 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
32972 summary: see node definition for valid relationships
32973 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32982 description: Response codes found in [response codes](https://wiki.onap.org/).
32986 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32989 example: __VNF-ID2__
32990 - name: interface-name
32992 description: Name given to the interface
32995 example: __INTERFACE-NAME__
32996 - name: vlan-interface
32998 description: String that identifies the interface
33001 example: __VLAN-INTERFACE__
33004 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
33007 $ref: "#/definitions/relationship"
33011 summary: delete an existing relationship
33012 description: delete an existing relationship
33013 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33022 description: Response codes found in [response codes](https://wiki.onap.org/).
33026 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33029 example: __VNF-ID2__
33030 - name: interface-name
33032 description: Name given to the interface
33035 example: __INTERFACE-NAME__
33036 - name: vlan-interface
33038 description: String that identifies the interface
33041 example: __VLAN-INTERFACE__
33042 /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:
33046 summary: see node definition for valid relationships
33047 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33056 description: Response codes found in [response codes](https://wiki.onap.org/).
33060 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33063 example: __VNF-ID2__
33064 - name: interface-name
33066 description: Name given to the interface
33069 example: __INTERFACE-NAME__
33070 - name: vlan-interface
33072 description: String that identifies the interface
33075 example: __VLAN-INTERFACE__
33076 - name: l3-interface-ipv4-address
33078 description: IP address
33081 example: __L3-INTERFACE-IPV4-ADDRESS__
33084 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33087 $ref: "#/definitions/relationship"
33091 summary: delete an existing relationship
33092 description: delete an existing relationship
33093 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33102 description: Response codes found in [response codes](https://wiki.onap.org/).
33106 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33109 example: __VNF-ID2__
33110 - name: interface-name
33112 description: Name given to the interface
33115 example: __INTERFACE-NAME__
33116 - name: vlan-interface
33118 description: String that identifies the interface
33121 example: __VLAN-INTERFACE__
33122 - name: l3-interface-ipv4-address
33124 description: IP address
33127 example: __L3-INTERFACE-IPV4-ADDRESS__
33128 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
33132 summary: returns l3-interface-ipv4-address-list
33133 description: returns l3-interface-ipv4-address-list
33134 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33140 description: successful operation
33142 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33144 description: Response codes found in [response codes](https://wiki.onap.org/).
33148 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33151 example: __VNF-ID2__
33152 - name: interface-name
33154 description: Name given to the interface
33157 example: __INTERFACE-NAME__
33158 - name: vlan-interface
33160 description: String that identifies the interface
33163 example: __VLAN-INTERFACE__
33164 - name: l3-interface-ipv4-address
33166 description: IP address
33169 example: __L3-INTERFACE-IPV4-ADDRESS__
33173 summary: create or update an existing l3-interface-ipv4-address-list
33175 Create or update an existing l3-interface-ipv4-address-list.
33177 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33178 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33187 description: Response codes found in [response codes](https://wiki.onap.org/).
33191 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33194 example: __VNF-ID2__
33195 - name: interface-name
33197 description: Name given to the interface
33200 example: __INTERFACE-NAME__
33201 - name: vlan-interface
33203 description: String that identifies the interface
33206 example: __VLAN-INTERFACE__
33207 - name: l3-interface-ipv4-address
33209 description: IP address
33212 example: __L3-INTERFACE-IPV4-ADDRESS__
33215 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33218 $ref: "#/definitions/l3-interface-ipv4-address-list"
33222 summary: update an existing l3-interface-ipv4-address-list
33224 Update an existing l3-interface-ipv4-address-list
33226 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33227 The PUT operation will entirely replace an existing object.
33228 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33230 Other differences between PUT and PATCH are:
33232 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33233 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33234 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33235 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33244 description: Response codes found in [response codes](https://wiki.onap.org/).
33248 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33251 example: __VNF-ID2__
33252 - name: interface-name
33254 description: Name given to the interface
33257 example: __INTERFACE-NAME__
33258 - name: vlan-interface
33260 description: String that identifies the interface
33263 example: __VLAN-INTERFACE__
33264 - name: l3-interface-ipv4-address
33266 description: IP address
33269 example: __L3-INTERFACE-IPV4-ADDRESS__
33272 description: l3-interface-ipv4-address-list object that needs to be updated.
33275 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33279 summary: delete an existing l3-interface-ipv4-address-list
33280 description: delete an existing l3-interface-ipv4-address-list
33281 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33290 description: Response codes found in [response codes](https://wiki.onap.org/).
33294 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33297 example: __VNF-ID2__
33298 - name: interface-name
33300 description: Name given to the interface
33303 example: __INTERFACE-NAME__
33304 - name: vlan-interface
33306 description: String that identifies the interface
33309 example: __VLAN-INTERFACE__
33310 - name: l3-interface-ipv4-address
33312 description: IP address
33315 example: __L3-INTERFACE-IPV4-ADDRESS__
33316 - name: resource-version
33318 description: resource-version for concurrency
33321 /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:
33325 summary: see node definition for valid relationships
33326 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33335 description: Response codes found in [response codes](https://wiki.onap.org/).
33339 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33342 example: __VNF-ID2__
33343 - name: interface-name
33345 description: Name given to the interface
33348 example: __INTERFACE-NAME__
33349 - name: vlan-interface
33351 description: String that identifies the interface
33354 example: __VLAN-INTERFACE__
33355 - name: l3-interface-ipv6-address
33357 description: IP address
33360 example: __L3-INTERFACE-IPV6-ADDRESS__
33363 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33366 $ref: "#/definitions/relationship"
33370 summary: delete an existing relationship
33371 description: delete an existing relationship
33372 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33381 description: Response codes found in [response codes](https://wiki.onap.org/).
33385 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33388 example: __VNF-ID2__
33389 - name: interface-name
33391 description: Name given to the interface
33394 example: __INTERFACE-NAME__
33395 - name: vlan-interface
33397 description: String that identifies the interface
33400 example: __VLAN-INTERFACE__
33401 - name: l3-interface-ipv6-address
33403 description: IP address
33406 example: __L3-INTERFACE-IPV6-ADDRESS__
33407 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33411 summary: returns l3-interface-ipv6-address-list
33412 description: returns l3-interface-ipv6-address-list
33413 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33419 description: successful operation
33421 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33423 description: Response codes found in [response codes](https://wiki.onap.org/).
33427 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33430 example: __VNF-ID2__
33431 - name: interface-name
33433 description: Name given to the interface
33436 example: __INTERFACE-NAME__
33437 - name: vlan-interface
33439 description: String that identifies the interface
33442 example: __VLAN-INTERFACE__
33443 - name: l3-interface-ipv6-address
33445 description: IP address
33448 example: __L3-INTERFACE-IPV6-ADDRESS__
33452 summary: create or update an existing l3-interface-ipv6-address-list
33454 Create or update an existing l3-interface-ipv6-address-list.
33456 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33457 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33466 description: Response codes found in [response codes](https://wiki.onap.org/).
33470 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33473 example: __VNF-ID2__
33474 - name: interface-name
33476 description: Name given to the interface
33479 example: __INTERFACE-NAME__
33480 - name: vlan-interface
33482 description: String that identifies the interface
33485 example: __VLAN-INTERFACE__
33486 - name: l3-interface-ipv6-address
33488 description: IP address
33491 example: __L3-INTERFACE-IPV6-ADDRESS__
33494 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33497 $ref: "#/definitions/l3-interface-ipv6-address-list"
33501 summary: update an existing l3-interface-ipv6-address-list
33503 Update an existing l3-interface-ipv6-address-list
33505 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33506 The PUT operation will entirely replace an existing object.
33507 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33509 Other differences between PUT and PATCH are:
33511 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33512 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33513 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33514 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33523 description: Response codes found in [response codes](https://wiki.onap.org/).
33527 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33530 example: __VNF-ID2__
33531 - name: interface-name
33533 description: Name given to the interface
33536 example: __INTERFACE-NAME__
33537 - name: vlan-interface
33539 description: String that identifies the interface
33542 example: __VLAN-INTERFACE__
33543 - name: l3-interface-ipv6-address
33545 description: IP address
33548 example: __L3-INTERFACE-IPV6-ADDRESS__
33551 description: l3-interface-ipv6-address-list object that needs to be updated.
33554 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33558 summary: delete an existing l3-interface-ipv6-address-list
33559 description: delete an existing l3-interface-ipv6-address-list
33560 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33569 description: Response codes found in [response codes](https://wiki.onap.org/).
33573 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33576 example: __VNF-ID2__
33577 - name: interface-name
33579 description: Name given to the interface
33582 example: __INTERFACE-NAME__
33583 - name: vlan-interface
33585 description: String that identifies the interface
33588 example: __VLAN-INTERFACE__
33589 - name: l3-interface-ipv6-address
33591 description: IP address
33594 example: __L3-INTERFACE-IPV6-ADDRESS__
33595 - name: resource-version
33597 description: resource-version for concurrency
33600 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
33604 summary: returns vlan
33605 description: returns vlan
33606 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33612 description: successful operation
33614 $ref: "#/getDefinitions/vlan"
33616 description: Response codes found in [response codes](https://wiki.onap.org/).
33620 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33623 example: __VNF-ID2__
33624 - name: interface-name
33626 description: Name given to the interface
33629 example: __INTERFACE-NAME__
33630 - name: vlan-interface
33632 description: String that identifies the interface
33635 example: __VLAN-INTERFACE__
33639 summary: create or update an existing vlan
33641 Create or update an existing vlan.
33643 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33644 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33653 description: Response codes found in [response codes](https://wiki.onap.org/).
33657 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33660 example: __VNF-ID2__
33661 - name: interface-name
33663 description: Name given to the interface
33666 example: __INTERFACE-NAME__
33667 - name: vlan-interface
33669 description: String that identifies the interface
33672 example: __VLAN-INTERFACE__
33675 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
33678 $ref: "#/definitions/vlan"
33682 summary: update an existing vlan
33684 Update an existing vlan
33686 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33687 The PUT operation will entirely replace an existing object.
33688 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33690 Other differences between PUT and PATCH are:
33692 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33693 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33694 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33695 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33704 description: Response codes found in [response codes](https://wiki.onap.org/).
33708 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33711 example: __VNF-ID2__
33712 - name: interface-name
33714 description: Name given to the interface
33717 example: __INTERFACE-NAME__
33718 - name: vlan-interface
33720 description: String that identifies the interface
33723 example: __VLAN-INTERFACE__
33726 description: vlan object that needs to be updated.
33729 $ref: "#/patchDefinitions/vlan"
33733 summary: delete an existing vlan
33734 description: delete an existing vlan
33735 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33744 description: Response codes found in [response codes](https://wiki.onap.org/).
33748 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33751 example: __VNF-ID2__
33752 - name: interface-name
33754 description: Name given to the interface
33757 example: __INTERFACE-NAME__
33758 - name: vlan-interface
33760 description: String that identifies the interface
33763 example: __VLAN-INTERFACE__
33764 - name: resource-version
33766 description: resource-version for concurrency
33769 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
33773 summary: returns vlans
33774 description: returns vlans
33775 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
33781 description: successful operation
33783 $ref: "#/getDefinitions/vlans"
33785 description: Response codes found in [response codes](https://wiki.onap.org/).
33789 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33792 example: __VNF-ID2__
33793 - name: interface-name
33795 description: Name given to the interface
33798 example: __INTERFACE-NAME__
33799 - name: vlan-interface
33804 - name: vlan-id-inner
33815 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
33819 summary: see node definition for valid relationships
33820 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33829 description: Response codes found in [response codes](https://wiki.onap.org/).
33833 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33836 example: __VNF-ID2__
33837 - name: interface-name
33839 description: Name given to the interface
33842 example: __INTERFACE-NAME__
33845 description: PCI ID used to identify the sriov-vf
33848 example: __PCI-ID__
33851 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
33854 $ref: "#/definitions/relationship"
33858 summary: delete an existing relationship
33859 description: delete an existing relationship
33860 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33869 description: Response codes found in [response codes](https://wiki.onap.org/).
33873 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33876 example: __VNF-ID2__
33877 - name: interface-name
33879 description: Name given to the interface
33882 example: __INTERFACE-NAME__
33885 description: PCI ID used to identify the sriov-vf
33888 example: __PCI-ID__
33889 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
33893 summary: returns sriov-vf
33894 description: returns sriov-vf
33895 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33901 description: successful operation
33903 $ref: "#/getDefinitions/sriov-vf"
33905 description: Response codes found in [response codes](https://wiki.onap.org/).
33909 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33912 example: __VNF-ID2__
33913 - name: interface-name
33915 description: Name given to the interface
33918 example: __INTERFACE-NAME__
33921 description: PCI ID used to identify the sriov-vf
33924 example: __PCI-ID__
33928 summary: create or update an existing sriov-vf
33930 Create or update an existing sriov-vf.
33932 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33933 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33942 description: Response codes found in [response codes](https://wiki.onap.org/).
33946 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33949 example: __VNF-ID2__
33950 - name: interface-name
33952 description: Name given to the interface
33955 example: __INTERFACE-NAME__
33958 description: PCI ID used to identify the sriov-vf
33961 example: __PCI-ID__
33964 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
33967 $ref: "#/definitions/sriov-vf"
33971 summary: update an existing sriov-vf
33973 Update an existing sriov-vf
33975 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33976 The PUT operation will entirely replace an existing object.
33977 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33979 Other differences between PUT and PATCH are:
33981 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33982 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33983 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33984 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33993 description: Response codes found in [response codes](https://wiki.onap.org/).
33997 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34000 example: __VNF-ID2__
34001 - name: interface-name
34003 description: Name given to the interface
34006 example: __INTERFACE-NAME__
34009 description: PCI ID used to identify the sriov-vf
34012 example: __PCI-ID__
34015 description: sriov-vf object that needs to be updated.
34018 $ref: "#/patchDefinitions/sriov-vf"
34022 summary: delete an existing sriov-vf
34023 description: delete an existing sriov-vf
34024 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
34033 description: Response codes found in [response codes](https://wiki.onap.org/).
34037 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34040 example: __VNF-ID2__
34041 - name: interface-name
34043 description: Name given to the interface
34046 example: __INTERFACE-NAME__
34049 description: PCI ID used to identify the sriov-vf
34052 example: __PCI-ID__
34053 - name: resource-version
34055 description: resource-version for concurrency
34058 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
34062 summary: returns sriov-vfs
34063 description: returns sriov-vfs
34064 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
34070 description: successful operation
34072 $ref: "#/getDefinitions/sriov-vfs"
34074 description: Response codes found in [response codes](https://wiki.onap.org/).
34078 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34081 example: __VNF-ID2__
34082 - name: interface-name
34084 description: Name given to the interface
34087 example: __INTERFACE-NAME__
34093 - name: vf-vlan-filter
34098 - name: vf-mac-filter
34103 - name: vf-vlan-strip
34108 - name: neutron-network-id
34113 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
34117 summary: see node definition for valid relationships
34118 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
34127 description: Response codes found in [response codes](https://wiki.onap.org/).
34131 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34134 example: __VNF-ID2__
34135 - name: interface-name
34137 description: Name given to the interface
34140 example: __INTERFACE-NAME__
34143 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)
34146 $ref: "#/definitions/relationship"
34150 summary: delete an existing relationship
34151 description: delete an existing relationship
34152 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
34161 description: Response codes found in [response codes](https://wiki.onap.org/).
34165 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34168 example: __VNF-ID2__
34169 - name: interface-name
34171 description: Name given to the interface
34174 example: __INTERFACE-NAME__
34175 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
34179 summary: see node definition for valid relationships
34180 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34189 description: Response codes found in [response codes](https://wiki.onap.org/).
34193 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34196 example: __VNF-ID2__
34197 - name: interface-name
34199 description: Name given to the interface
34202 example: __INTERFACE-NAME__
34203 - name: l3-interface-ipv4-address
34205 description: IP address
34208 example: __L3-INTERFACE-IPV4-ADDRESS__
34211 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34214 $ref: "#/definitions/relationship"
34218 summary: delete an existing relationship
34219 description: delete an existing relationship
34220 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34229 description: Response codes found in [response codes](https://wiki.onap.org/).
34233 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34236 example: __VNF-ID2__
34237 - name: interface-name
34239 description: Name given to the interface
34242 example: __INTERFACE-NAME__
34243 - name: l3-interface-ipv4-address
34245 description: IP address
34248 example: __L3-INTERFACE-IPV4-ADDRESS__
34249 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
34253 summary: returns l3-interface-ipv4-address-list
34254 description: returns l3-interface-ipv4-address-list
34255 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34261 description: successful operation
34263 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34265 description: Response codes found in [response codes](https://wiki.onap.org/).
34269 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34272 example: __VNF-ID2__
34273 - name: interface-name
34275 description: Name given to the interface
34278 example: __INTERFACE-NAME__
34279 - name: l3-interface-ipv4-address
34281 description: IP address
34284 example: __L3-INTERFACE-IPV4-ADDRESS__
34288 summary: create or update an existing l3-interface-ipv4-address-list
34290 Create or update an existing l3-interface-ipv4-address-list.
34292 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34293 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34302 description: Response codes found in [response codes](https://wiki.onap.org/).
34306 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34309 example: __VNF-ID2__
34310 - name: interface-name
34312 description: Name given to the interface
34315 example: __INTERFACE-NAME__
34316 - name: l3-interface-ipv4-address
34318 description: IP address
34321 example: __L3-INTERFACE-IPV4-ADDRESS__
34324 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34327 $ref: "#/definitions/l3-interface-ipv4-address-list"
34331 summary: update an existing l3-interface-ipv4-address-list
34333 Update an existing l3-interface-ipv4-address-list
34335 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34336 The PUT operation will entirely replace an existing object.
34337 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34339 Other differences between PUT and PATCH are:
34341 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34342 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34343 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34344 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34353 description: Response codes found in [response codes](https://wiki.onap.org/).
34357 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34360 example: __VNF-ID2__
34361 - name: interface-name
34363 description: Name given to the interface
34366 example: __INTERFACE-NAME__
34367 - name: l3-interface-ipv4-address
34369 description: IP address
34372 example: __L3-INTERFACE-IPV4-ADDRESS__
34375 description: l3-interface-ipv4-address-list object that needs to be updated.
34378 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34382 summary: delete an existing l3-interface-ipv4-address-list
34383 description: delete an existing l3-interface-ipv4-address-list
34384 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34393 description: Response codes found in [response codes](https://wiki.onap.org/).
34397 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34400 example: __VNF-ID2__
34401 - name: interface-name
34403 description: Name given to the interface
34406 example: __INTERFACE-NAME__
34407 - name: l3-interface-ipv4-address
34409 description: IP address
34412 example: __L3-INTERFACE-IPV4-ADDRESS__
34413 - name: resource-version
34415 description: resource-version for concurrency
34418 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
34422 summary: see node definition for valid relationships
34423 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34432 description: Response codes found in [response codes](https://wiki.onap.org/).
34436 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34439 example: __VNF-ID2__
34440 - name: interface-name
34442 description: Name given to the interface
34445 example: __INTERFACE-NAME__
34446 - name: l3-interface-ipv6-address
34448 description: IP address
34451 example: __L3-INTERFACE-IPV6-ADDRESS__
34454 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34457 $ref: "#/definitions/relationship"
34461 summary: delete an existing relationship
34462 description: delete an existing relationship
34463 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34472 description: Response codes found in [response codes](https://wiki.onap.org/).
34476 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34479 example: __VNF-ID2__
34480 - name: interface-name
34482 description: Name given to the interface
34485 example: __INTERFACE-NAME__
34486 - name: l3-interface-ipv6-address
34488 description: IP address
34491 example: __L3-INTERFACE-IPV6-ADDRESS__
34492 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
34496 summary: returns l3-interface-ipv6-address-list
34497 description: returns l3-interface-ipv6-address-list
34498 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34504 description: successful operation
34506 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34508 description: Response codes found in [response codes](https://wiki.onap.org/).
34512 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34515 example: __VNF-ID2__
34516 - name: interface-name
34518 description: Name given to the interface
34521 example: __INTERFACE-NAME__
34522 - name: l3-interface-ipv6-address
34524 description: IP address
34527 example: __L3-INTERFACE-IPV6-ADDRESS__
34531 summary: create or update an existing l3-interface-ipv6-address-list
34533 Create or update an existing l3-interface-ipv6-address-list.
34535 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34536 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34545 description: Response codes found in [response codes](https://wiki.onap.org/).
34549 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34552 example: __VNF-ID2__
34553 - name: interface-name
34555 description: Name given to the interface
34558 example: __INTERFACE-NAME__
34559 - name: l3-interface-ipv6-address
34561 description: IP address
34564 example: __L3-INTERFACE-IPV6-ADDRESS__
34567 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34570 $ref: "#/definitions/l3-interface-ipv6-address-list"
34574 summary: update an existing l3-interface-ipv6-address-list
34576 Update an existing l3-interface-ipv6-address-list
34578 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34579 The PUT operation will entirely replace an existing object.
34580 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34582 Other differences between PUT and PATCH are:
34584 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34585 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34586 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34587 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34596 description: Response codes found in [response codes](https://wiki.onap.org/).
34600 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34603 example: __VNF-ID2__
34604 - name: interface-name
34606 description: Name given to the interface
34609 example: __INTERFACE-NAME__
34610 - name: l3-interface-ipv6-address
34612 description: IP address
34615 example: __L3-INTERFACE-IPV6-ADDRESS__
34618 description: l3-interface-ipv6-address-list object that needs to be updated.
34621 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34625 summary: delete an existing l3-interface-ipv6-address-list
34626 description: delete an existing l3-interface-ipv6-address-list
34627 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34636 description: Response codes found in [response codes](https://wiki.onap.org/).
34640 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34643 example: __VNF-ID2__
34644 - name: interface-name
34646 description: Name given to the interface
34649 example: __INTERFACE-NAME__
34650 - name: l3-interface-ipv6-address
34652 description: IP address
34655 example: __L3-INTERFACE-IPV6-ADDRESS__
34656 - name: resource-version
34658 description: resource-version for concurrency
34661 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
34665 summary: returns l-interface
34666 description: returns l-interface
34667 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
34673 description: successful operation
34675 $ref: "#/getDefinitions/l-interface"
34677 description: Response codes found in [response codes](https://wiki.onap.org/).
34681 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34684 example: __VNF-ID2__
34685 - name: interface-name
34687 description: Name given to the interface
34690 example: __INTERFACE-NAME__
34694 summary: create or update an existing l-interface
34696 Create or update an existing l-interface.
34698 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34699 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
34708 description: Response codes found in [response codes](https://wiki.onap.org/).
34712 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34715 example: __VNF-ID2__
34716 - name: interface-name
34718 description: Name given to the interface
34721 example: __INTERFACE-NAME__
34724 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)
34727 $ref: "#/definitions/l-interface"
34731 summary: update an existing l-interface
34733 Update an existing l-interface
34735 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34736 The PUT operation will entirely replace an existing object.
34737 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34739 Other differences between PUT and PATCH are:
34741 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34742 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34743 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34744 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
34753 description: Response codes found in [response codes](https://wiki.onap.org/).
34757 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34760 example: __VNF-ID2__
34761 - name: interface-name
34763 description: Name given to the interface
34766 example: __INTERFACE-NAME__
34769 description: l-interface object that needs to be updated.
34772 $ref: "#/patchDefinitions/l-interface"
34776 summary: delete an existing l-interface
34777 description: delete an existing l-interface
34778 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
34787 description: Response codes found in [response codes](https://wiki.onap.org/).
34791 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34794 example: __VNF-ID2__
34795 - name: interface-name
34797 description: Name given to the interface
34800 example: __INTERFACE-NAME__
34801 - name: resource-version
34803 description: resource-version for concurrency
34806 /network/newvces/newvce/{vnf-id2}/l-interfaces:
34810 summary: returns l-interfaces
34811 description: returns l-interfaces
34812 operationId: getNetworkNewvcesNewvceLInterfaces
34818 description: successful operation
34820 $ref: "#/getDefinitions/l-interfaces"
34822 description: Response codes found in [response codes](https://wiki.onap.org/).
34826 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34829 example: __VNF-ID2__
34830 - name: interface-name
34835 - name: interface-id
34845 - name: network-name
34850 /network/newvces/newvce/{vnf-id2}:
34854 summary: returns newvce
34855 description: returns newvce
34856 operationId: getNetworkNewvcesNewvce
34862 description: successful operation
34864 $ref: "#/getDefinitions/newvce"
34866 description: Response codes found in [response codes](https://wiki.onap.org/).
34870 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34873 example: __VNF-ID2__
34877 summary: create or update an existing newvce
34879 Create or update an existing newvce.
34881 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34882 operationId: createOrUpdateNetworkNewvcesNewvce
34891 description: Response codes found in [response codes](https://wiki.onap.org/).
34895 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34898 example: __VNF-ID2__
34901 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)
34904 $ref: "#/definitions/newvce"
34908 summary: update an existing newvce
34910 Update an existing newvce
34912 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34913 The PUT operation will entirely replace an existing object.
34914 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34916 Other differences between PUT and PATCH are:
34918 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34919 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34920 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34921 operationId: UpdateNetworkNewvcesNewvce
34930 description: Response codes found in [response codes](https://wiki.onap.org/).
34934 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34937 example: __VNF-ID2__
34940 description: newvce object that needs to be updated.
34943 $ref: "#/patchDefinitions/newvce"
34947 summary: delete an existing newvce
34948 description: delete an existing newvce
34949 operationId: deleteNetworkNewvcesNewvce
34958 description: Response codes found in [response codes](https://wiki.onap.org/).
34962 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34965 example: __VNF-ID2__
34966 - name: resource-version
34968 description: resource-version for concurrency
34975 summary: returns newvces
34976 description: returns newvces
34977 operationId: getNetworkNewvces
34983 description: successful operation
34985 $ref: "#/getDefinitions/newvces"
34987 description: Response codes found in [response codes](https://wiki.onap.org/).
35009 - name: prov-status
35014 - name: heat-stack-id
35019 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
35023 summary: see node definition for valid relationships
35024 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
35033 description: Response codes found in [response codes](https://wiki.onap.org/).
35037 description: unique name of Physical Network Function.
35040 example: __PNF-NAME__
35043 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)
35046 $ref: "#/definitions/relationship"
35050 summary: delete an existing relationship
35051 description: delete an existing relationship
35052 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
35061 description: Response codes found in [response codes](https://wiki.onap.org/).
35065 description: unique name of Physical Network Function.
35068 example: __PNF-NAME__
35069 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
35073 summary: see node definition for valid relationships
35074 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
35083 description: Response codes found in [response codes](https://wiki.onap.org/).
35087 description: unique name of Physical Network Function.
35090 example: __PNF-NAME__
35091 - name: interface-name
35093 description: Name that identifies the physical interface
35096 example: __INTERFACE-NAME__
35099 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)
35102 $ref: "#/definitions/relationship"
35106 summary: delete an existing relationship
35107 description: delete an existing relationship
35108 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
35117 description: Response codes found in [response codes](https://wiki.onap.org/).
35121 description: unique name of Physical Network Function.
35124 example: __PNF-NAME__
35125 - name: interface-name
35127 description: Name that identifies the physical interface
35130 example: __INTERFACE-NAME__
35131 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
35135 summary: see node definition for valid relationships
35136 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35145 description: Response codes found in [response codes](https://wiki.onap.org/).
35149 description: unique name of Physical Network Function.
35152 example: __PNF-NAME__
35153 - name: interface-name
35155 description: Name that identifies the physical interface
35158 example: __INTERFACE-NAME__
35159 - name: interface-name
35161 description: Name given to the interface
35164 example: __INTERFACE-NAME__
35165 - name: vlan-interface
35167 description: String that identifies the interface
35170 example: __VLAN-INTERFACE__
35173 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
35176 $ref: "#/definitions/relationship"
35180 summary: delete an existing relationship
35181 description: delete an existing relationship
35182 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35191 description: Response codes found in [response codes](https://wiki.onap.org/).
35195 description: unique name of Physical Network Function.
35198 example: __PNF-NAME__
35199 - name: interface-name
35201 description: Name that identifies the physical interface
35204 example: __INTERFACE-NAME__
35205 - name: interface-name
35207 description: Name given to the interface
35210 example: __INTERFACE-NAME__
35211 - name: vlan-interface
35213 description: String that identifies the interface
35216 example: __VLAN-INTERFACE__
35217 /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:
35221 summary: see node definition for valid relationships
35222 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35231 description: Response codes found in [response codes](https://wiki.onap.org/).
35235 description: unique name of Physical Network Function.
35238 example: __PNF-NAME__
35239 - name: interface-name
35241 description: Name that identifies the physical interface
35244 example: __INTERFACE-NAME__
35245 - name: interface-name
35247 description: Name given to the interface
35250 example: __INTERFACE-NAME__
35251 - name: vlan-interface
35253 description: String that identifies the interface
35256 example: __VLAN-INTERFACE__
35257 - name: l3-interface-ipv4-address
35259 description: IP address
35262 example: __L3-INTERFACE-IPV4-ADDRESS__
35265 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35268 $ref: "#/definitions/relationship"
35272 summary: delete an existing relationship
35273 description: delete an existing relationship
35274 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35283 description: Response codes found in [response codes](https://wiki.onap.org/).
35287 description: unique name of Physical Network Function.
35290 example: __PNF-NAME__
35291 - name: interface-name
35293 description: Name that identifies the physical interface
35296 example: __INTERFACE-NAME__
35297 - name: interface-name
35299 description: Name given to the interface
35302 example: __INTERFACE-NAME__
35303 - name: vlan-interface
35305 description: String that identifies the interface
35308 example: __VLAN-INTERFACE__
35309 - name: l3-interface-ipv4-address
35311 description: IP address
35314 example: __L3-INTERFACE-IPV4-ADDRESS__
35315 /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}:
35319 summary: returns l3-interface-ipv4-address-list
35320 description: returns l3-interface-ipv4-address-list
35321 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35327 description: successful operation
35329 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35331 description: Response codes found in [response codes](https://wiki.onap.org/).
35335 description: unique name of Physical Network Function.
35338 example: __PNF-NAME__
35339 - name: interface-name
35341 description: Name that identifies the physical interface
35344 example: __INTERFACE-NAME__
35345 - name: interface-name
35347 description: Name given to the interface
35350 example: __INTERFACE-NAME__
35351 - name: vlan-interface
35353 description: String that identifies the interface
35356 example: __VLAN-INTERFACE__
35357 - name: l3-interface-ipv4-address
35359 description: IP address
35362 example: __L3-INTERFACE-IPV4-ADDRESS__
35366 summary: create or update an existing l3-interface-ipv4-address-list
35368 Create or update an existing l3-interface-ipv4-address-list.
35370 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35371 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35380 description: Response codes found in [response codes](https://wiki.onap.org/).
35384 description: unique name of Physical Network Function.
35387 example: __PNF-NAME__
35388 - name: interface-name
35390 description: Name that identifies the physical interface
35393 example: __INTERFACE-NAME__
35394 - name: interface-name
35396 description: Name given to the interface
35399 example: __INTERFACE-NAME__
35400 - name: vlan-interface
35402 description: String that identifies the interface
35405 example: __VLAN-INTERFACE__
35406 - name: l3-interface-ipv4-address
35408 description: IP address
35411 example: __L3-INTERFACE-IPV4-ADDRESS__
35414 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35417 $ref: "#/definitions/l3-interface-ipv4-address-list"
35421 summary: update an existing l3-interface-ipv4-address-list
35423 Update an existing l3-interface-ipv4-address-list
35425 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35426 The PUT operation will entirely replace an existing object.
35427 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35429 Other differences between PUT and PATCH are:
35431 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35432 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35433 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35434 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35443 description: Response codes found in [response codes](https://wiki.onap.org/).
35447 description: unique name of Physical Network Function.
35450 example: __PNF-NAME__
35451 - name: interface-name
35453 description: Name that identifies the physical interface
35456 example: __INTERFACE-NAME__
35457 - name: interface-name
35459 description: Name given to the interface
35462 example: __INTERFACE-NAME__
35463 - name: vlan-interface
35465 description: String that identifies the interface
35468 example: __VLAN-INTERFACE__
35469 - name: l3-interface-ipv4-address
35471 description: IP address
35474 example: __L3-INTERFACE-IPV4-ADDRESS__
35477 description: l3-interface-ipv4-address-list object that needs to be updated.
35480 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35484 summary: delete an existing l3-interface-ipv4-address-list
35485 description: delete an existing l3-interface-ipv4-address-list
35486 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35495 description: Response codes found in [response codes](https://wiki.onap.org/).
35499 description: unique name of Physical Network Function.
35502 example: __PNF-NAME__
35503 - name: interface-name
35505 description: Name that identifies the physical interface
35508 example: __INTERFACE-NAME__
35509 - name: interface-name
35511 description: Name given to the interface
35514 example: __INTERFACE-NAME__
35515 - name: vlan-interface
35517 description: String that identifies the interface
35520 example: __VLAN-INTERFACE__
35521 - name: l3-interface-ipv4-address
35523 description: IP address
35526 example: __L3-INTERFACE-IPV4-ADDRESS__
35527 - name: resource-version
35529 description: resource-version for concurrency
35532 /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:
35536 summary: see node definition for valid relationships
35537 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35546 description: Response codes found in [response codes](https://wiki.onap.org/).
35550 description: unique name of Physical Network Function.
35553 example: __PNF-NAME__
35554 - name: interface-name
35556 description: Name that identifies the physical interface
35559 example: __INTERFACE-NAME__
35560 - name: interface-name
35562 description: Name given to the interface
35565 example: __INTERFACE-NAME__
35566 - name: vlan-interface
35568 description: String that identifies the interface
35571 example: __VLAN-INTERFACE__
35572 - name: l3-interface-ipv6-address
35574 description: IP address
35577 example: __L3-INTERFACE-IPV6-ADDRESS__
35580 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35583 $ref: "#/definitions/relationship"
35587 summary: delete an existing relationship
35588 description: delete an existing relationship
35589 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35598 description: Response codes found in [response codes](https://wiki.onap.org/).
35602 description: unique name of Physical Network Function.
35605 example: __PNF-NAME__
35606 - name: interface-name
35608 description: Name that identifies the physical interface
35611 example: __INTERFACE-NAME__
35612 - name: interface-name
35614 description: Name given to the interface
35617 example: __INTERFACE-NAME__
35618 - name: vlan-interface
35620 description: String that identifies the interface
35623 example: __VLAN-INTERFACE__
35624 - name: l3-interface-ipv6-address
35626 description: IP address
35629 example: __L3-INTERFACE-IPV6-ADDRESS__
35630 /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}:
35634 summary: returns l3-interface-ipv6-address-list
35635 description: returns l3-interface-ipv6-address-list
35636 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35642 description: successful operation
35644 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35646 description: Response codes found in [response codes](https://wiki.onap.org/).
35650 description: unique name of Physical Network Function.
35653 example: __PNF-NAME__
35654 - name: interface-name
35656 description: Name that identifies the physical interface
35659 example: __INTERFACE-NAME__
35660 - name: interface-name
35662 description: Name given to the interface
35665 example: __INTERFACE-NAME__
35666 - name: vlan-interface
35668 description: String that identifies the interface
35671 example: __VLAN-INTERFACE__
35672 - name: l3-interface-ipv6-address
35674 description: IP address
35677 example: __L3-INTERFACE-IPV6-ADDRESS__
35681 summary: create or update an existing l3-interface-ipv6-address-list
35683 Create or update an existing l3-interface-ipv6-address-list.
35685 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35686 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35695 description: Response codes found in [response codes](https://wiki.onap.org/).
35699 description: unique name of Physical Network Function.
35702 example: __PNF-NAME__
35703 - name: interface-name
35705 description: Name that identifies the physical interface
35708 example: __INTERFACE-NAME__
35709 - name: interface-name
35711 description: Name given to the interface
35714 example: __INTERFACE-NAME__
35715 - name: vlan-interface
35717 description: String that identifies the interface
35720 example: __VLAN-INTERFACE__
35721 - name: l3-interface-ipv6-address
35723 description: IP address
35726 example: __L3-INTERFACE-IPV6-ADDRESS__
35729 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35732 $ref: "#/definitions/l3-interface-ipv6-address-list"
35736 summary: update an existing l3-interface-ipv6-address-list
35738 Update an existing l3-interface-ipv6-address-list
35740 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35741 The PUT operation will entirely replace an existing object.
35742 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35744 Other differences between PUT and PATCH are:
35746 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35747 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35748 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35749 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35758 description: Response codes found in [response codes](https://wiki.onap.org/).
35762 description: unique name of Physical Network Function.
35765 example: __PNF-NAME__
35766 - name: interface-name
35768 description: Name that identifies the physical interface
35771 example: __INTERFACE-NAME__
35772 - name: interface-name
35774 description: Name given to the interface
35777 example: __INTERFACE-NAME__
35778 - name: vlan-interface
35780 description: String that identifies the interface
35783 example: __VLAN-INTERFACE__
35784 - name: l3-interface-ipv6-address
35786 description: IP address
35789 example: __L3-INTERFACE-IPV6-ADDRESS__
35792 description: l3-interface-ipv6-address-list object that needs to be updated.
35795 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35799 summary: delete an existing l3-interface-ipv6-address-list
35800 description: delete an existing l3-interface-ipv6-address-list
35801 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35810 description: Response codes found in [response codes](https://wiki.onap.org/).
35814 description: unique name of Physical Network Function.
35817 example: __PNF-NAME__
35818 - name: interface-name
35820 description: Name that identifies the physical interface
35823 example: __INTERFACE-NAME__
35824 - name: interface-name
35826 description: Name given to the interface
35829 example: __INTERFACE-NAME__
35830 - name: vlan-interface
35832 description: String that identifies the interface
35835 example: __VLAN-INTERFACE__
35836 - name: l3-interface-ipv6-address
35838 description: IP address
35841 example: __L3-INTERFACE-IPV6-ADDRESS__
35842 - name: resource-version
35844 description: resource-version for concurrency
35847 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35851 summary: returns vlan
35852 description: returns vlan
35853 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35859 description: successful operation
35861 $ref: "#/getDefinitions/vlan"
35863 description: Response codes found in [response codes](https://wiki.onap.org/).
35867 description: unique name of Physical Network Function.
35870 example: __PNF-NAME__
35871 - name: interface-name
35873 description: Name that identifies the physical interface
35876 example: __INTERFACE-NAME__
35877 - name: interface-name
35879 description: Name given to the interface
35882 example: __INTERFACE-NAME__
35883 - name: vlan-interface
35885 description: String that identifies the interface
35888 example: __VLAN-INTERFACE__
35892 summary: create or update an existing vlan
35894 Create or update an existing vlan.
35896 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35897 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35906 description: Response codes found in [response codes](https://wiki.onap.org/).
35910 description: unique name of Physical Network Function.
35913 example: __PNF-NAME__
35914 - name: interface-name
35916 description: Name that identifies the physical interface
35919 example: __INTERFACE-NAME__
35920 - name: interface-name
35922 description: Name given to the interface
35925 example: __INTERFACE-NAME__
35926 - name: vlan-interface
35928 description: String that identifies the interface
35931 example: __VLAN-INTERFACE__
35934 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
35937 $ref: "#/definitions/vlan"
35941 summary: update an existing vlan
35943 Update an existing vlan
35945 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35946 The PUT operation will entirely replace an existing object.
35947 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35949 Other differences between PUT and PATCH are:
35951 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35952 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35953 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35954 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35963 description: Response codes found in [response codes](https://wiki.onap.org/).
35967 description: unique name of Physical Network Function.
35970 example: __PNF-NAME__
35971 - name: interface-name
35973 description: Name that identifies the physical interface
35976 example: __INTERFACE-NAME__
35977 - name: interface-name
35979 description: Name given to the interface
35982 example: __INTERFACE-NAME__
35983 - name: vlan-interface
35985 description: String that identifies the interface
35988 example: __VLAN-INTERFACE__
35991 description: vlan object that needs to be updated.
35994 $ref: "#/patchDefinitions/vlan"
35998 summary: delete an existing vlan
35999 description: delete an existing vlan
36000 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
36009 description: Response codes found in [response codes](https://wiki.onap.org/).
36013 description: unique name of Physical Network Function.
36016 example: __PNF-NAME__
36017 - name: interface-name
36019 description: Name that identifies the physical interface
36022 example: __INTERFACE-NAME__
36023 - name: interface-name
36025 description: Name given to the interface
36028 example: __INTERFACE-NAME__
36029 - name: vlan-interface
36031 description: String that identifies the interface
36034 example: __VLAN-INTERFACE__
36035 - name: resource-version
36037 description: resource-version for concurrency
36040 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
36044 summary: returns vlans
36045 description: returns vlans
36046 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
36052 description: successful operation
36054 $ref: "#/getDefinitions/vlans"
36056 description: Response codes found in [response codes](https://wiki.onap.org/).
36060 description: unique name of Physical Network Function.
36063 example: __PNF-NAME__
36064 - name: interface-name
36066 description: Name that identifies the physical interface
36069 example: __INTERFACE-NAME__
36070 - name: interface-name
36072 description: Name given to the interface
36075 example: __INTERFACE-NAME__
36076 - name: vlan-interface
36081 - name: vlan-id-inner
36092 /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:
36096 summary: see node definition for valid relationships
36097 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36106 description: Response codes found in [response codes](https://wiki.onap.org/).
36110 description: unique name of Physical Network Function.
36113 example: __PNF-NAME__
36114 - name: interface-name
36116 description: Name that identifies the physical interface
36119 example: __INTERFACE-NAME__
36120 - name: interface-name
36122 description: Name given to the interface
36125 example: __INTERFACE-NAME__
36128 description: PCI ID used to identify the sriov-vf
36131 example: __PCI-ID__
36134 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
36137 $ref: "#/definitions/relationship"
36141 summary: delete an existing relationship
36142 description: delete an existing relationship
36143 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36152 description: Response codes found in [response codes](https://wiki.onap.org/).
36156 description: unique name of Physical Network Function.
36159 example: __PNF-NAME__
36160 - name: interface-name
36162 description: Name that identifies the physical interface
36165 example: __INTERFACE-NAME__
36166 - name: interface-name
36168 description: Name given to the interface
36171 example: __INTERFACE-NAME__
36174 description: PCI ID used to identify the sriov-vf
36177 example: __PCI-ID__
36178 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
36182 summary: returns sriov-vf
36183 description: returns sriov-vf
36184 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36190 description: successful operation
36192 $ref: "#/getDefinitions/sriov-vf"
36194 description: Response codes found in [response codes](https://wiki.onap.org/).
36198 description: unique name of Physical Network Function.
36201 example: __PNF-NAME__
36202 - name: interface-name
36204 description: Name that identifies the physical interface
36207 example: __INTERFACE-NAME__
36208 - name: interface-name
36210 description: Name given to the interface
36213 example: __INTERFACE-NAME__
36216 description: PCI ID used to identify the sriov-vf
36219 example: __PCI-ID__
36223 summary: create or update an existing sriov-vf
36225 Create or update an existing sriov-vf.
36227 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36228 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36237 description: Response codes found in [response codes](https://wiki.onap.org/).
36241 description: unique name of Physical Network Function.
36244 example: __PNF-NAME__
36245 - name: interface-name
36247 description: Name that identifies the physical interface
36250 example: __INTERFACE-NAME__
36251 - name: interface-name
36253 description: Name given to the interface
36256 example: __INTERFACE-NAME__
36259 description: PCI ID used to identify the sriov-vf
36262 example: __PCI-ID__
36265 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
36268 $ref: "#/definitions/sriov-vf"
36272 summary: update an existing sriov-vf
36274 Update an existing sriov-vf
36276 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36277 The PUT operation will entirely replace an existing object.
36278 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36280 Other differences between PUT and PATCH are:
36282 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36283 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36284 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36285 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36294 description: Response codes found in [response codes](https://wiki.onap.org/).
36298 description: unique name of Physical Network Function.
36301 example: __PNF-NAME__
36302 - name: interface-name
36304 description: Name that identifies the physical interface
36307 example: __INTERFACE-NAME__
36308 - name: interface-name
36310 description: Name given to the interface
36313 example: __INTERFACE-NAME__
36316 description: PCI ID used to identify the sriov-vf
36319 example: __PCI-ID__
36322 description: sriov-vf object that needs to be updated.
36325 $ref: "#/patchDefinitions/sriov-vf"
36329 summary: delete an existing sriov-vf
36330 description: delete an existing sriov-vf
36331 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36340 description: Response codes found in [response codes](https://wiki.onap.org/).
36344 description: unique name of Physical Network Function.
36347 example: __PNF-NAME__
36348 - name: interface-name
36350 description: Name that identifies the physical interface
36353 example: __INTERFACE-NAME__
36354 - name: interface-name
36356 description: Name given to the interface
36359 example: __INTERFACE-NAME__
36362 description: PCI ID used to identify the sriov-vf
36365 example: __PCI-ID__
36366 - name: resource-version
36368 description: resource-version for concurrency
36371 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36375 summary: returns sriov-vfs
36376 description: returns sriov-vfs
36377 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
36383 description: successful operation
36385 $ref: "#/getDefinitions/sriov-vfs"
36387 description: Response codes found in [response codes](https://wiki.onap.org/).
36391 description: unique name of Physical Network Function.
36394 example: __PNF-NAME__
36395 - name: interface-name
36397 description: Name that identifies the physical interface
36400 example: __INTERFACE-NAME__
36401 - name: interface-name
36403 description: Name given to the interface
36406 example: __INTERFACE-NAME__
36412 - name: vf-vlan-filter
36417 - name: vf-mac-filter
36422 - name: vf-vlan-strip
36427 - name: neutron-network-id
36432 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36436 summary: see node definition for valid relationships
36437 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
36446 description: Response codes found in [response codes](https://wiki.onap.org/).
36450 description: unique name of Physical Network Function.
36453 example: __PNF-NAME__
36454 - name: interface-name
36456 description: Name that identifies the physical interface
36459 example: __INTERFACE-NAME__
36460 - name: interface-name
36462 description: Name given to the interface
36465 example: __INTERFACE-NAME__
36468 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
36471 $ref: "#/definitions/relationship"
36475 summary: delete an existing relationship
36476 description: delete an existing relationship
36477 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
36486 description: Response codes found in [response codes](https://wiki.onap.org/).
36490 description: unique name of Physical Network Function.
36493 example: __PNF-NAME__
36494 - name: interface-name
36496 description: Name that identifies the physical interface
36499 example: __INTERFACE-NAME__
36500 - name: interface-name
36502 description: Name given to the interface
36505 example: __INTERFACE-NAME__
36506 /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:
36510 summary: see node definition for valid relationships
36511 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36520 description: Response codes found in [response codes](https://wiki.onap.org/).
36524 description: unique name of Physical Network Function.
36527 example: __PNF-NAME__
36528 - name: interface-name
36530 description: Name that identifies the physical interface
36533 example: __INTERFACE-NAME__
36534 - name: interface-name
36536 description: Name given to the interface
36539 example: __INTERFACE-NAME__
36540 - name: l3-interface-ipv4-address
36542 description: IP address
36545 example: __L3-INTERFACE-IPV4-ADDRESS__
36548 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36551 $ref: "#/definitions/relationship"
36555 summary: delete an existing relationship
36556 description: delete an existing relationship
36557 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36566 description: Response codes found in [response codes](https://wiki.onap.org/).
36570 description: unique name of Physical Network Function.
36573 example: __PNF-NAME__
36574 - name: interface-name
36576 description: Name that identifies the physical interface
36579 example: __INTERFACE-NAME__
36580 - name: interface-name
36582 description: Name given to the interface
36585 example: __INTERFACE-NAME__
36586 - name: l3-interface-ipv4-address
36588 description: IP address
36591 example: __L3-INTERFACE-IPV4-ADDRESS__
36592 /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}:
36596 summary: returns l3-interface-ipv4-address-list
36597 description: returns l3-interface-ipv4-address-list
36598 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36604 description: successful operation
36606 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36608 description: Response codes found in [response codes](https://wiki.onap.org/).
36612 description: unique name of Physical Network Function.
36615 example: __PNF-NAME__
36616 - name: interface-name
36618 description: Name that identifies the physical interface
36621 example: __INTERFACE-NAME__
36622 - name: interface-name
36624 description: Name given to the interface
36627 example: __INTERFACE-NAME__
36628 - name: l3-interface-ipv4-address
36630 description: IP address
36633 example: __L3-INTERFACE-IPV4-ADDRESS__
36637 summary: create or update an existing l3-interface-ipv4-address-list
36639 Create or update an existing l3-interface-ipv4-address-list.
36641 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36642 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36651 description: Response codes found in [response codes](https://wiki.onap.org/).
36655 description: unique name of Physical Network Function.
36658 example: __PNF-NAME__
36659 - name: interface-name
36661 description: Name that identifies the physical interface
36664 example: __INTERFACE-NAME__
36665 - name: interface-name
36667 description: Name given to the interface
36670 example: __INTERFACE-NAME__
36671 - name: l3-interface-ipv4-address
36673 description: IP address
36676 example: __L3-INTERFACE-IPV4-ADDRESS__
36679 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36682 $ref: "#/definitions/l3-interface-ipv4-address-list"
36686 summary: update an existing l3-interface-ipv4-address-list
36688 Update an existing l3-interface-ipv4-address-list
36690 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36691 The PUT operation will entirely replace an existing object.
36692 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36694 Other differences between PUT and PATCH are:
36696 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36697 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36698 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36699 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36708 description: Response codes found in [response codes](https://wiki.onap.org/).
36712 description: unique name of Physical Network Function.
36715 example: __PNF-NAME__
36716 - name: interface-name
36718 description: Name that identifies the physical interface
36721 example: __INTERFACE-NAME__
36722 - name: interface-name
36724 description: Name given to the interface
36727 example: __INTERFACE-NAME__
36728 - name: l3-interface-ipv4-address
36730 description: IP address
36733 example: __L3-INTERFACE-IPV4-ADDRESS__
36736 description: l3-interface-ipv4-address-list object that needs to be updated.
36739 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36743 summary: delete an existing l3-interface-ipv4-address-list
36744 description: delete an existing l3-interface-ipv4-address-list
36745 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36754 description: Response codes found in [response codes](https://wiki.onap.org/).
36758 description: unique name of Physical Network Function.
36761 example: __PNF-NAME__
36762 - name: interface-name
36764 description: Name that identifies the physical interface
36767 example: __INTERFACE-NAME__
36768 - name: interface-name
36770 description: Name given to the interface
36773 example: __INTERFACE-NAME__
36774 - name: l3-interface-ipv4-address
36776 description: IP address
36779 example: __L3-INTERFACE-IPV4-ADDRESS__
36780 - name: resource-version
36782 description: resource-version for concurrency
36785 /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:
36789 summary: see node definition for valid relationships
36790 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36799 description: Response codes found in [response codes](https://wiki.onap.org/).
36803 description: unique name of Physical Network Function.
36806 example: __PNF-NAME__
36807 - name: interface-name
36809 description: Name that identifies the physical interface
36812 example: __INTERFACE-NAME__
36813 - name: interface-name
36815 description: Name given to the interface
36818 example: __INTERFACE-NAME__
36819 - name: l3-interface-ipv6-address
36821 description: IP address
36824 example: __L3-INTERFACE-IPV6-ADDRESS__
36827 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36830 $ref: "#/definitions/relationship"
36834 summary: delete an existing relationship
36835 description: delete an existing relationship
36836 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36845 description: Response codes found in [response codes](https://wiki.onap.org/).
36849 description: unique name of Physical Network Function.
36852 example: __PNF-NAME__
36853 - name: interface-name
36855 description: Name that identifies the physical interface
36858 example: __INTERFACE-NAME__
36859 - name: interface-name
36861 description: Name given to the interface
36864 example: __INTERFACE-NAME__
36865 - name: l3-interface-ipv6-address
36867 description: IP address
36870 example: __L3-INTERFACE-IPV6-ADDRESS__
36871 /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}:
36875 summary: returns l3-interface-ipv6-address-list
36876 description: returns l3-interface-ipv6-address-list
36877 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36883 description: successful operation
36885 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36887 description: Response codes found in [response codes](https://wiki.onap.org/).
36891 description: unique name of Physical Network Function.
36894 example: __PNF-NAME__
36895 - name: interface-name
36897 description: Name that identifies the physical interface
36900 example: __INTERFACE-NAME__
36901 - name: interface-name
36903 description: Name given to the interface
36906 example: __INTERFACE-NAME__
36907 - name: l3-interface-ipv6-address
36909 description: IP address
36912 example: __L3-INTERFACE-IPV6-ADDRESS__
36916 summary: create or update an existing l3-interface-ipv6-address-list
36918 Create or update an existing l3-interface-ipv6-address-list.
36920 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36921 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36930 description: Response codes found in [response codes](https://wiki.onap.org/).
36934 description: unique name of Physical Network Function.
36937 example: __PNF-NAME__
36938 - name: interface-name
36940 description: Name that identifies the physical interface
36943 example: __INTERFACE-NAME__
36944 - name: interface-name
36946 description: Name given to the interface
36949 example: __INTERFACE-NAME__
36950 - name: l3-interface-ipv6-address
36952 description: IP address
36955 example: __L3-INTERFACE-IPV6-ADDRESS__
36958 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36961 $ref: "#/definitions/l3-interface-ipv6-address-list"
36965 summary: update an existing l3-interface-ipv6-address-list
36967 Update an existing l3-interface-ipv6-address-list
36969 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36970 The PUT operation will entirely replace an existing object.
36971 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36973 Other differences between PUT and PATCH are:
36975 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36976 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36977 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36978 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36987 description: Response codes found in [response codes](https://wiki.onap.org/).
36991 description: unique name of Physical Network Function.
36994 example: __PNF-NAME__
36995 - name: interface-name
36997 description: Name that identifies the physical interface
37000 example: __INTERFACE-NAME__
37001 - name: interface-name
37003 description: Name given to the interface
37006 example: __INTERFACE-NAME__
37007 - name: l3-interface-ipv6-address
37009 description: IP address
37012 example: __L3-INTERFACE-IPV6-ADDRESS__
37015 description: l3-interface-ipv6-address-list object that needs to be updated.
37018 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37022 summary: delete an existing l3-interface-ipv6-address-list
37023 description: delete an existing l3-interface-ipv6-address-list
37024 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
37033 description: Response codes found in [response codes](https://wiki.onap.org/).
37037 description: unique name of Physical Network Function.
37040 example: __PNF-NAME__
37041 - name: interface-name
37043 description: Name that identifies the physical interface
37046 example: __INTERFACE-NAME__
37047 - name: interface-name
37049 description: Name given to the interface
37052 example: __INTERFACE-NAME__
37053 - name: l3-interface-ipv6-address
37055 description: IP address
37058 example: __L3-INTERFACE-IPV6-ADDRESS__
37059 - name: resource-version
37061 description: resource-version for concurrency
37064 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
37068 summary: returns l-interface
37069 description: returns l-interface
37070 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
37076 description: successful operation
37078 $ref: "#/getDefinitions/l-interface"
37080 description: Response codes found in [response codes](https://wiki.onap.org/).
37084 description: unique name of Physical Network Function.
37087 example: __PNF-NAME__
37088 - name: interface-name
37090 description: Name that identifies the physical interface
37093 example: __INTERFACE-NAME__
37094 - name: interface-name
37096 description: Name given to the interface
37099 example: __INTERFACE-NAME__
37103 summary: create or update an existing l-interface
37105 Create or update an existing l-interface.
37107 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37108 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
37117 description: Response codes found in [response codes](https://wiki.onap.org/).
37121 description: unique name of Physical Network Function.
37124 example: __PNF-NAME__
37125 - name: interface-name
37127 description: Name that identifies the physical interface
37130 example: __INTERFACE-NAME__
37131 - name: interface-name
37133 description: Name given to the interface
37136 example: __INTERFACE-NAME__
37139 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
37142 $ref: "#/definitions/l-interface"
37146 summary: update an existing l-interface
37148 Update an existing l-interface
37150 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37151 The PUT operation will entirely replace an existing object.
37152 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37154 Other differences between PUT and PATCH are:
37156 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37157 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37158 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37159 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
37168 description: Response codes found in [response codes](https://wiki.onap.org/).
37172 description: unique name of Physical Network Function.
37175 example: __PNF-NAME__
37176 - name: interface-name
37178 description: Name that identifies the physical interface
37181 example: __INTERFACE-NAME__
37182 - name: interface-name
37184 description: Name given to the interface
37187 example: __INTERFACE-NAME__
37190 description: l-interface object that needs to be updated.
37193 $ref: "#/patchDefinitions/l-interface"
37197 summary: delete an existing l-interface
37198 description: delete an existing l-interface
37199 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
37208 description: Response codes found in [response codes](https://wiki.onap.org/).
37212 description: unique name of Physical Network Function.
37215 example: __PNF-NAME__
37216 - name: interface-name
37218 description: Name that identifies the physical interface
37221 example: __INTERFACE-NAME__
37222 - name: interface-name
37224 description: Name given to the interface
37227 example: __INTERFACE-NAME__
37228 - name: resource-version
37230 description: resource-version for concurrency
37233 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
37237 summary: returns l-interfaces
37238 description: returns l-interfaces
37239 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
37245 description: successful operation
37247 $ref: "#/getDefinitions/l-interfaces"
37249 description: Response codes found in [response codes](https://wiki.onap.org/).
37253 description: unique name of Physical Network Function.
37256 example: __PNF-NAME__
37257 - name: interface-name
37259 description: Name that identifies the physical interface
37262 example: __INTERFACE-NAME__
37263 - name: interface-name
37268 - name: interface-id
37278 - name: network-name
37283 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
37287 summary: returns p-interface
37288 description: returns p-interface
37289 operationId: getNetworkPnfsPnfPInterfacesPInterface
37295 description: successful operation
37297 $ref: "#/getDefinitions/p-interface"
37299 description: Response codes found in [response codes](https://wiki.onap.org/).
37303 description: unique name of Physical Network Function.
37306 example: __PNF-NAME__
37307 - name: interface-name
37309 description: Name that identifies the physical interface
37312 example: __INTERFACE-NAME__
37316 summary: create or update an existing p-interface
37318 Create or update an existing p-interface.
37320 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37321 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
37330 description: Response codes found in [response codes](https://wiki.onap.org/).
37334 description: unique name of Physical Network Function.
37337 example: __PNF-NAME__
37338 - name: interface-name
37340 description: Name that identifies the physical interface
37343 example: __INTERFACE-NAME__
37346 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)
37349 $ref: "#/definitions/p-interface"
37353 summary: update an existing p-interface
37355 Update an existing p-interface
37357 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37358 The PUT operation will entirely replace an existing object.
37359 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37361 Other differences between PUT and PATCH are:
37363 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37364 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37365 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37366 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
37375 description: Response codes found in [response codes](https://wiki.onap.org/).
37379 description: unique name of Physical Network Function.
37382 example: __PNF-NAME__
37383 - name: interface-name
37385 description: Name that identifies the physical interface
37388 example: __INTERFACE-NAME__
37391 description: p-interface object that needs to be updated.
37394 $ref: "#/patchDefinitions/p-interface"
37398 summary: delete an existing p-interface
37399 description: delete an existing p-interface
37400 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
37409 description: Response codes found in [response codes](https://wiki.onap.org/).
37413 description: unique name of Physical Network Function.
37416 example: __PNF-NAME__
37417 - name: interface-name
37419 description: Name that identifies the physical interface
37422 example: __INTERFACE-NAME__
37423 - name: resource-version
37425 description: resource-version for concurrency
37428 /network/pnfs/pnf/{pnf-name}/p-interfaces:
37432 summary: returns p-interfaces
37433 description: returns p-interfaces
37434 operationId: getNetworkPnfsPnfPInterfaces
37440 description: successful operation
37442 $ref: "#/getDefinitions/p-interfaces"
37444 description: Response codes found in [response codes](https://wiki.onap.org/).
37448 description: unique name of Physical Network Function.
37451 example: __PNF-NAME__
37452 - name: interface-name
37457 - name: prov-status
37462 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
37466 summary: see node definition for valid relationships
37467 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
37476 description: Response codes found in [response codes](https://wiki.onap.org/).
37480 description: unique name of Physical Network Function.
37483 example: __PNF-NAME__
37484 - name: interface-name
37486 description: Name that identifies the link aggregate interface
37489 example: __INTERFACE-NAME__
37492 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)
37495 $ref: "#/definitions/relationship"
37499 summary: delete an existing relationship
37500 description: delete an existing relationship
37501 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
37510 description: Response codes found in [response codes](https://wiki.onap.org/).
37514 description: unique name of Physical Network Function.
37517 example: __PNF-NAME__
37518 - name: interface-name
37520 description: Name that identifies the link aggregate interface
37523 example: __INTERFACE-NAME__
37524 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
37528 summary: see node definition for valid relationships
37529 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37538 description: Response codes found in [response codes](https://wiki.onap.org/).
37542 description: unique name of Physical Network Function.
37545 example: __PNF-NAME__
37546 - name: interface-name
37548 description: Name that identifies the link aggregate interface
37551 example: __INTERFACE-NAME__
37552 - name: interface-name
37554 description: Name given to the interface
37557 example: __INTERFACE-NAME__
37558 - name: vlan-interface
37560 description: String that identifies the interface
37563 example: __VLAN-INTERFACE__
37566 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
37569 $ref: "#/definitions/relationship"
37573 summary: delete an existing relationship
37574 description: delete an existing relationship
37575 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37584 description: Response codes found in [response codes](https://wiki.onap.org/).
37588 description: unique name of Physical Network Function.
37591 example: __PNF-NAME__
37592 - name: interface-name
37594 description: Name that identifies the link aggregate interface
37597 example: __INTERFACE-NAME__
37598 - name: interface-name
37600 description: Name given to the interface
37603 example: __INTERFACE-NAME__
37604 - name: vlan-interface
37606 description: String that identifies the interface
37609 example: __VLAN-INTERFACE__
37610 /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:
37614 summary: see node definition for valid relationships
37615 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37624 description: Response codes found in [response codes](https://wiki.onap.org/).
37628 description: unique name of Physical Network Function.
37631 example: __PNF-NAME__
37632 - name: interface-name
37634 description: Name that identifies the link aggregate interface
37637 example: __INTERFACE-NAME__
37638 - name: interface-name
37640 description: Name given to the interface
37643 example: __INTERFACE-NAME__
37644 - name: vlan-interface
37646 description: String that identifies the interface
37649 example: __VLAN-INTERFACE__
37650 - name: l3-interface-ipv4-address
37652 description: IP address
37655 example: __L3-INTERFACE-IPV4-ADDRESS__
37658 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37661 $ref: "#/definitions/relationship"
37665 summary: delete an existing relationship
37666 description: delete an existing relationship
37667 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37676 description: Response codes found in [response codes](https://wiki.onap.org/).
37680 description: unique name of Physical Network Function.
37683 example: __PNF-NAME__
37684 - name: interface-name
37686 description: Name that identifies the link aggregate interface
37689 example: __INTERFACE-NAME__
37690 - name: interface-name
37692 description: Name given to the interface
37695 example: __INTERFACE-NAME__
37696 - name: vlan-interface
37698 description: String that identifies the interface
37701 example: __VLAN-INTERFACE__
37702 - name: l3-interface-ipv4-address
37704 description: IP address
37707 example: __L3-INTERFACE-IPV4-ADDRESS__
37708 /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}:
37712 summary: returns l3-interface-ipv4-address-list
37713 description: returns l3-interface-ipv4-address-list
37714 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37720 description: successful operation
37722 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37724 description: Response codes found in [response codes](https://wiki.onap.org/).
37728 description: unique name of Physical Network Function.
37731 example: __PNF-NAME__
37732 - name: interface-name
37734 description: Name that identifies the link aggregate interface
37737 example: __INTERFACE-NAME__
37738 - name: interface-name
37740 description: Name given to the interface
37743 example: __INTERFACE-NAME__
37744 - name: vlan-interface
37746 description: String that identifies the interface
37749 example: __VLAN-INTERFACE__
37750 - name: l3-interface-ipv4-address
37752 description: IP address
37755 example: __L3-INTERFACE-IPV4-ADDRESS__
37759 summary: create or update an existing l3-interface-ipv4-address-list
37761 Create or update an existing l3-interface-ipv4-address-list.
37763 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37764 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37773 description: Response codes found in [response codes](https://wiki.onap.org/).
37777 description: unique name of Physical Network Function.
37780 example: __PNF-NAME__
37781 - name: interface-name
37783 description: Name that identifies the link aggregate interface
37786 example: __INTERFACE-NAME__
37787 - name: interface-name
37789 description: Name given to the interface
37792 example: __INTERFACE-NAME__
37793 - name: vlan-interface
37795 description: String that identifies the interface
37798 example: __VLAN-INTERFACE__
37799 - name: l3-interface-ipv4-address
37801 description: IP address
37804 example: __L3-INTERFACE-IPV4-ADDRESS__
37807 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37810 $ref: "#/definitions/l3-interface-ipv4-address-list"
37814 summary: update an existing l3-interface-ipv4-address-list
37816 Update an existing l3-interface-ipv4-address-list
37818 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37819 The PUT operation will entirely replace an existing object.
37820 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37822 Other differences between PUT and PATCH are:
37824 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37825 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37826 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37827 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37836 description: Response codes found in [response codes](https://wiki.onap.org/).
37840 description: unique name of Physical Network Function.
37843 example: __PNF-NAME__
37844 - name: interface-name
37846 description: Name that identifies the link aggregate interface
37849 example: __INTERFACE-NAME__
37850 - name: interface-name
37852 description: Name given to the interface
37855 example: __INTERFACE-NAME__
37856 - name: vlan-interface
37858 description: String that identifies the interface
37861 example: __VLAN-INTERFACE__
37862 - name: l3-interface-ipv4-address
37864 description: IP address
37867 example: __L3-INTERFACE-IPV4-ADDRESS__
37870 description: l3-interface-ipv4-address-list object that needs to be updated.
37873 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37877 summary: delete an existing l3-interface-ipv4-address-list
37878 description: delete an existing l3-interface-ipv4-address-list
37879 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37888 description: Response codes found in [response codes](https://wiki.onap.org/).
37892 description: unique name of Physical Network Function.
37895 example: __PNF-NAME__
37896 - name: interface-name
37898 description: Name that identifies the link aggregate interface
37901 example: __INTERFACE-NAME__
37902 - name: interface-name
37904 description: Name given to the interface
37907 example: __INTERFACE-NAME__
37908 - name: vlan-interface
37910 description: String that identifies the interface
37913 example: __VLAN-INTERFACE__
37914 - name: l3-interface-ipv4-address
37916 description: IP address
37919 example: __L3-INTERFACE-IPV4-ADDRESS__
37920 - name: resource-version
37922 description: resource-version for concurrency
37925 /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:
37929 summary: see node definition for valid relationships
37930 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37939 description: Response codes found in [response codes](https://wiki.onap.org/).
37943 description: unique name of Physical Network Function.
37946 example: __PNF-NAME__
37947 - name: interface-name
37949 description: Name that identifies the link aggregate interface
37952 example: __INTERFACE-NAME__
37953 - name: interface-name
37955 description: Name given to the interface
37958 example: __INTERFACE-NAME__
37959 - name: vlan-interface
37961 description: String that identifies the interface
37964 example: __VLAN-INTERFACE__
37965 - name: l3-interface-ipv6-address
37967 description: IP address
37970 example: __L3-INTERFACE-IPV6-ADDRESS__
37973 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37976 $ref: "#/definitions/relationship"
37980 summary: delete an existing relationship
37981 description: delete an existing relationship
37982 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37991 description: Response codes found in [response codes](https://wiki.onap.org/).
37995 description: unique name of Physical Network Function.
37998 example: __PNF-NAME__
37999 - name: interface-name
38001 description: Name that identifies the link aggregate interface
38004 example: __INTERFACE-NAME__
38005 - name: interface-name
38007 description: Name given to the interface
38010 example: __INTERFACE-NAME__
38011 - name: vlan-interface
38013 description: String that identifies the interface
38016 example: __VLAN-INTERFACE__
38017 - name: l3-interface-ipv6-address
38019 description: IP address
38022 example: __L3-INTERFACE-IPV6-ADDRESS__
38023 /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}:
38027 summary: returns l3-interface-ipv6-address-list
38028 description: returns l3-interface-ipv6-address-list
38029 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38035 description: successful operation
38037 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38039 description: Response codes found in [response codes](https://wiki.onap.org/).
38043 description: unique name of Physical Network Function.
38046 example: __PNF-NAME__
38047 - name: interface-name
38049 description: Name that identifies the link aggregate interface
38052 example: __INTERFACE-NAME__
38053 - name: interface-name
38055 description: Name given to the interface
38058 example: __INTERFACE-NAME__
38059 - name: vlan-interface
38061 description: String that identifies the interface
38064 example: __VLAN-INTERFACE__
38065 - name: l3-interface-ipv6-address
38067 description: IP address
38070 example: __L3-INTERFACE-IPV6-ADDRESS__
38074 summary: create or update an existing l3-interface-ipv6-address-list
38076 Create or update an existing l3-interface-ipv6-address-list.
38078 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38079 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38088 description: Response codes found in [response codes](https://wiki.onap.org/).
38092 description: unique name of Physical Network Function.
38095 example: __PNF-NAME__
38096 - name: interface-name
38098 description: Name that identifies the link aggregate interface
38101 example: __INTERFACE-NAME__
38102 - name: interface-name
38104 description: Name given to the interface
38107 example: __INTERFACE-NAME__
38108 - name: vlan-interface
38110 description: String that identifies the interface
38113 example: __VLAN-INTERFACE__
38114 - name: l3-interface-ipv6-address
38116 description: IP address
38119 example: __L3-INTERFACE-IPV6-ADDRESS__
38122 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38125 $ref: "#/definitions/l3-interface-ipv6-address-list"
38129 summary: update an existing l3-interface-ipv6-address-list
38131 Update an existing l3-interface-ipv6-address-list
38133 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38134 The PUT operation will entirely replace an existing object.
38135 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38137 Other differences between PUT and PATCH are:
38139 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38140 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38141 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38142 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38151 description: Response codes found in [response codes](https://wiki.onap.org/).
38155 description: unique name of Physical Network Function.
38158 example: __PNF-NAME__
38159 - name: interface-name
38161 description: Name that identifies the link aggregate interface
38164 example: __INTERFACE-NAME__
38165 - name: interface-name
38167 description: Name given to the interface
38170 example: __INTERFACE-NAME__
38171 - name: vlan-interface
38173 description: String that identifies the interface
38176 example: __VLAN-INTERFACE__
38177 - name: l3-interface-ipv6-address
38179 description: IP address
38182 example: __L3-INTERFACE-IPV6-ADDRESS__
38185 description: l3-interface-ipv6-address-list object that needs to be updated.
38188 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38192 summary: delete an existing l3-interface-ipv6-address-list
38193 description: delete an existing l3-interface-ipv6-address-list
38194 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38203 description: Response codes found in [response codes](https://wiki.onap.org/).
38207 description: unique name of Physical Network Function.
38210 example: __PNF-NAME__
38211 - name: interface-name
38213 description: Name that identifies the link aggregate interface
38216 example: __INTERFACE-NAME__
38217 - name: interface-name
38219 description: Name given to the interface
38222 example: __INTERFACE-NAME__
38223 - name: vlan-interface
38225 description: String that identifies the interface
38228 example: __VLAN-INTERFACE__
38229 - name: l3-interface-ipv6-address
38231 description: IP address
38234 example: __L3-INTERFACE-IPV6-ADDRESS__
38235 - name: resource-version
38237 description: resource-version for concurrency
38240 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38244 summary: returns vlan
38245 description: returns vlan
38246 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38252 description: successful operation
38254 $ref: "#/getDefinitions/vlan"
38256 description: Response codes found in [response codes](https://wiki.onap.org/).
38260 description: unique name of Physical Network Function.
38263 example: __PNF-NAME__
38264 - name: interface-name
38266 description: Name that identifies the link aggregate interface
38269 example: __INTERFACE-NAME__
38270 - name: interface-name
38272 description: Name given to the interface
38275 example: __INTERFACE-NAME__
38276 - name: vlan-interface
38278 description: String that identifies the interface
38281 example: __VLAN-INTERFACE__
38285 summary: create or update an existing vlan
38287 Create or update an existing vlan.
38289 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38290 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38299 description: Response codes found in [response codes](https://wiki.onap.org/).
38303 description: unique name of Physical Network Function.
38306 example: __PNF-NAME__
38307 - name: interface-name
38309 description: Name that identifies the link aggregate interface
38312 example: __INTERFACE-NAME__
38313 - name: interface-name
38315 description: Name given to the interface
38318 example: __INTERFACE-NAME__
38319 - name: vlan-interface
38321 description: String that identifies the interface
38324 example: __VLAN-INTERFACE__
38327 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
38330 $ref: "#/definitions/vlan"
38334 summary: update an existing vlan
38336 Update an existing vlan
38338 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38339 The PUT operation will entirely replace an existing object.
38340 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38342 Other differences between PUT and PATCH are:
38344 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38345 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38346 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38347 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38356 description: Response codes found in [response codes](https://wiki.onap.org/).
38360 description: unique name of Physical Network Function.
38363 example: __PNF-NAME__
38364 - name: interface-name
38366 description: Name that identifies the link aggregate interface
38369 example: __INTERFACE-NAME__
38370 - name: interface-name
38372 description: Name given to the interface
38375 example: __INTERFACE-NAME__
38376 - name: vlan-interface
38378 description: String that identifies the interface
38381 example: __VLAN-INTERFACE__
38384 description: vlan object that needs to be updated.
38387 $ref: "#/patchDefinitions/vlan"
38391 summary: delete an existing vlan
38392 description: delete an existing vlan
38393 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38402 description: Response codes found in [response codes](https://wiki.onap.org/).
38406 description: unique name of Physical Network Function.
38409 example: __PNF-NAME__
38410 - name: interface-name
38412 description: Name that identifies the link aggregate interface
38415 example: __INTERFACE-NAME__
38416 - name: interface-name
38418 description: Name given to the interface
38421 example: __INTERFACE-NAME__
38422 - name: vlan-interface
38424 description: String that identifies the interface
38427 example: __VLAN-INTERFACE__
38428 - name: resource-version
38430 description: resource-version for concurrency
38433 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38437 summary: returns vlans
38438 description: returns vlans
38439 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
38445 description: successful operation
38447 $ref: "#/getDefinitions/vlans"
38449 description: Response codes found in [response codes](https://wiki.onap.org/).
38453 description: unique name of Physical Network Function.
38456 example: __PNF-NAME__
38457 - name: interface-name
38459 description: Name that identifies the link aggregate interface
38462 example: __INTERFACE-NAME__
38463 - name: interface-name
38465 description: Name given to the interface
38468 example: __INTERFACE-NAME__
38469 - name: vlan-interface
38474 - name: vlan-id-inner
38485 /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:
38489 summary: see node definition for valid relationships
38490 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38499 description: Response codes found in [response codes](https://wiki.onap.org/).
38503 description: unique name of Physical Network Function.
38506 example: __PNF-NAME__
38507 - name: interface-name
38509 description: Name that identifies the link aggregate interface
38512 example: __INTERFACE-NAME__
38513 - name: interface-name
38515 description: Name given to the interface
38518 example: __INTERFACE-NAME__
38521 description: PCI ID used to identify the sriov-vf
38524 example: __PCI-ID__
38527 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38530 $ref: "#/definitions/relationship"
38534 summary: delete an existing relationship
38535 description: delete an existing relationship
38536 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38545 description: Response codes found in [response codes](https://wiki.onap.org/).
38549 description: unique name of Physical Network Function.
38552 example: __PNF-NAME__
38553 - name: interface-name
38555 description: Name that identifies the link aggregate interface
38558 example: __INTERFACE-NAME__
38559 - name: interface-name
38561 description: Name given to the interface
38564 example: __INTERFACE-NAME__
38567 description: PCI ID used to identify the sriov-vf
38570 example: __PCI-ID__
38571 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
38575 summary: returns sriov-vf
38576 description: returns sriov-vf
38577 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38583 description: successful operation
38585 $ref: "#/getDefinitions/sriov-vf"
38587 description: Response codes found in [response codes](https://wiki.onap.org/).
38591 description: unique name of Physical Network Function.
38594 example: __PNF-NAME__
38595 - name: interface-name
38597 description: Name that identifies the link aggregate interface
38600 example: __INTERFACE-NAME__
38601 - name: interface-name
38603 description: Name given to the interface
38606 example: __INTERFACE-NAME__
38609 description: PCI ID used to identify the sriov-vf
38612 example: __PCI-ID__
38616 summary: create or update an existing sriov-vf
38618 Create or update an existing sriov-vf.
38620 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38621 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38630 description: Response codes found in [response codes](https://wiki.onap.org/).
38634 description: unique name of Physical Network Function.
38637 example: __PNF-NAME__
38638 - name: interface-name
38640 description: Name that identifies the link aggregate interface
38643 example: __INTERFACE-NAME__
38644 - name: interface-name
38646 description: Name given to the interface
38649 example: __INTERFACE-NAME__
38652 description: PCI ID used to identify the sriov-vf
38655 example: __PCI-ID__
38658 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38661 $ref: "#/definitions/sriov-vf"
38665 summary: update an existing sriov-vf
38667 Update an existing sriov-vf
38669 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38670 The PUT operation will entirely replace an existing object.
38671 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38673 Other differences between PUT and PATCH are:
38675 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38676 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38677 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38678 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38687 description: Response codes found in [response codes](https://wiki.onap.org/).
38691 description: unique name of Physical Network Function.
38694 example: __PNF-NAME__
38695 - name: interface-name
38697 description: Name that identifies the link aggregate interface
38700 example: __INTERFACE-NAME__
38701 - name: interface-name
38703 description: Name given to the interface
38706 example: __INTERFACE-NAME__
38709 description: PCI ID used to identify the sriov-vf
38712 example: __PCI-ID__
38715 description: sriov-vf object that needs to be updated.
38718 $ref: "#/patchDefinitions/sriov-vf"
38722 summary: delete an existing sriov-vf
38723 description: delete an existing sriov-vf
38724 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38733 description: Response codes found in [response codes](https://wiki.onap.org/).
38737 description: unique name of Physical Network Function.
38740 example: __PNF-NAME__
38741 - name: interface-name
38743 description: Name that identifies the link aggregate interface
38746 example: __INTERFACE-NAME__
38747 - name: interface-name
38749 description: Name given to the interface
38752 example: __INTERFACE-NAME__
38755 description: PCI ID used to identify the sriov-vf
38758 example: __PCI-ID__
38759 - name: resource-version
38761 description: resource-version for concurrency
38764 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38768 summary: returns sriov-vfs
38769 description: returns sriov-vfs
38770 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
38776 description: successful operation
38778 $ref: "#/getDefinitions/sriov-vfs"
38780 description: Response codes found in [response codes](https://wiki.onap.org/).
38784 description: unique name of Physical Network Function.
38787 example: __PNF-NAME__
38788 - name: interface-name
38790 description: Name that identifies the link aggregate interface
38793 example: __INTERFACE-NAME__
38794 - name: interface-name
38796 description: Name given to the interface
38799 example: __INTERFACE-NAME__
38805 - name: vf-vlan-filter
38810 - name: vf-mac-filter
38815 - name: vf-vlan-strip
38820 - name: neutron-network-id
38825 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38829 summary: see node definition for valid relationships
38830 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38839 description: Response codes found in [response codes](https://wiki.onap.org/).
38843 description: unique name of Physical Network Function.
38846 example: __PNF-NAME__
38847 - name: interface-name
38849 description: Name that identifies the link aggregate interface
38852 example: __INTERFACE-NAME__
38853 - name: interface-name
38855 description: Name given to the interface
38858 example: __INTERFACE-NAME__
38861 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
38864 $ref: "#/definitions/relationship"
38868 summary: delete an existing relationship
38869 description: delete an existing relationship
38870 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38879 description: Response codes found in [response codes](https://wiki.onap.org/).
38883 description: unique name of Physical Network Function.
38886 example: __PNF-NAME__
38887 - name: interface-name
38889 description: Name that identifies the link aggregate interface
38892 example: __INTERFACE-NAME__
38893 - name: interface-name
38895 description: Name given to the interface
38898 example: __INTERFACE-NAME__
38899 /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:
38903 summary: see node definition for valid relationships
38904 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38913 description: Response codes found in [response codes](https://wiki.onap.org/).
38917 description: unique name of Physical Network Function.
38920 example: __PNF-NAME__
38921 - name: interface-name
38923 description: Name that identifies the link aggregate interface
38926 example: __INTERFACE-NAME__
38927 - name: interface-name
38929 description: Name given to the interface
38932 example: __INTERFACE-NAME__
38933 - name: l3-interface-ipv4-address
38935 description: IP address
38938 example: __L3-INTERFACE-IPV4-ADDRESS__
38941 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38944 $ref: "#/definitions/relationship"
38948 summary: delete an existing relationship
38949 description: delete an existing relationship
38950 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38959 description: Response codes found in [response codes](https://wiki.onap.org/).
38963 description: unique name of Physical Network Function.
38966 example: __PNF-NAME__
38967 - name: interface-name
38969 description: Name that identifies the link aggregate interface
38972 example: __INTERFACE-NAME__
38973 - name: interface-name
38975 description: Name given to the interface
38978 example: __INTERFACE-NAME__
38979 - name: l3-interface-ipv4-address
38981 description: IP address
38984 example: __L3-INTERFACE-IPV4-ADDRESS__
38985 /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}:
38989 summary: returns l3-interface-ipv4-address-list
38990 description: returns l3-interface-ipv4-address-list
38991 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38997 description: successful operation
38999 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39001 description: Response codes found in [response codes](https://wiki.onap.org/).
39005 description: unique name of Physical Network Function.
39008 example: __PNF-NAME__
39009 - name: interface-name
39011 description: Name that identifies the link aggregate interface
39014 example: __INTERFACE-NAME__
39015 - name: interface-name
39017 description: Name given to the interface
39020 example: __INTERFACE-NAME__
39021 - name: l3-interface-ipv4-address
39023 description: IP address
39026 example: __L3-INTERFACE-IPV4-ADDRESS__
39030 summary: create or update an existing l3-interface-ipv4-address-list
39032 Create or update an existing l3-interface-ipv4-address-list.
39034 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39035 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39044 description: Response codes found in [response codes](https://wiki.onap.org/).
39048 description: unique name of Physical Network Function.
39051 example: __PNF-NAME__
39052 - name: interface-name
39054 description: Name that identifies the link aggregate interface
39057 example: __INTERFACE-NAME__
39058 - name: interface-name
39060 description: Name given to the interface
39063 example: __INTERFACE-NAME__
39064 - name: l3-interface-ipv4-address
39066 description: IP address
39069 example: __L3-INTERFACE-IPV4-ADDRESS__
39072 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39075 $ref: "#/definitions/l3-interface-ipv4-address-list"
39079 summary: update an existing l3-interface-ipv4-address-list
39081 Update an existing l3-interface-ipv4-address-list
39083 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39084 The PUT operation will entirely replace an existing object.
39085 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39087 Other differences between PUT and PATCH are:
39089 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39090 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39091 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39092 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39101 description: Response codes found in [response codes](https://wiki.onap.org/).
39105 description: unique name of Physical Network Function.
39108 example: __PNF-NAME__
39109 - name: interface-name
39111 description: Name that identifies the link aggregate interface
39114 example: __INTERFACE-NAME__
39115 - name: interface-name
39117 description: Name given to the interface
39120 example: __INTERFACE-NAME__
39121 - name: l3-interface-ipv4-address
39123 description: IP address
39126 example: __L3-INTERFACE-IPV4-ADDRESS__
39129 description: l3-interface-ipv4-address-list object that needs to be updated.
39132 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39136 summary: delete an existing l3-interface-ipv4-address-list
39137 description: delete an existing l3-interface-ipv4-address-list
39138 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39147 description: Response codes found in [response codes](https://wiki.onap.org/).
39151 description: unique name of Physical Network Function.
39154 example: __PNF-NAME__
39155 - name: interface-name
39157 description: Name that identifies the link aggregate interface
39160 example: __INTERFACE-NAME__
39161 - name: interface-name
39163 description: Name given to the interface
39166 example: __INTERFACE-NAME__
39167 - name: l3-interface-ipv4-address
39169 description: IP address
39172 example: __L3-INTERFACE-IPV4-ADDRESS__
39173 - name: resource-version
39175 description: resource-version for concurrency
39178 /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:
39182 summary: see node definition for valid relationships
39183 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39192 description: Response codes found in [response codes](https://wiki.onap.org/).
39196 description: unique name of Physical Network Function.
39199 example: __PNF-NAME__
39200 - name: interface-name
39202 description: Name that identifies the link aggregate interface
39205 example: __INTERFACE-NAME__
39206 - name: interface-name
39208 description: Name given to the interface
39211 example: __INTERFACE-NAME__
39212 - name: l3-interface-ipv6-address
39214 description: IP address
39217 example: __L3-INTERFACE-IPV6-ADDRESS__
39220 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39223 $ref: "#/definitions/relationship"
39227 summary: delete an existing relationship
39228 description: delete an existing relationship
39229 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39238 description: Response codes found in [response codes](https://wiki.onap.org/).
39242 description: unique name of Physical Network Function.
39245 example: __PNF-NAME__
39246 - name: interface-name
39248 description: Name that identifies the link aggregate interface
39251 example: __INTERFACE-NAME__
39252 - name: interface-name
39254 description: Name given to the interface
39257 example: __INTERFACE-NAME__
39258 - name: l3-interface-ipv6-address
39260 description: IP address
39263 example: __L3-INTERFACE-IPV6-ADDRESS__
39264 /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}:
39268 summary: returns l3-interface-ipv6-address-list
39269 description: returns l3-interface-ipv6-address-list
39270 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39276 description: successful operation
39278 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39280 description: Response codes found in [response codes](https://wiki.onap.org/).
39284 description: unique name of Physical Network Function.
39287 example: __PNF-NAME__
39288 - name: interface-name
39290 description: Name that identifies the link aggregate interface
39293 example: __INTERFACE-NAME__
39294 - name: interface-name
39296 description: Name given to the interface
39299 example: __INTERFACE-NAME__
39300 - name: l3-interface-ipv6-address
39302 description: IP address
39305 example: __L3-INTERFACE-IPV6-ADDRESS__
39309 summary: create or update an existing l3-interface-ipv6-address-list
39311 Create or update an existing l3-interface-ipv6-address-list.
39313 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39314 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39323 description: Response codes found in [response codes](https://wiki.onap.org/).
39327 description: unique name of Physical Network Function.
39330 example: __PNF-NAME__
39331 - name: interface-name
39333 description: Name that identifies the link aggregate interface
39336 example: __INTERFACE-NAME__
39337 - name: interface-name
39339 description: Name given to the interface
39342 example: __INTERFACE-NAME__
39343 - name: l3-interface-ipv6-address
39345 description: IP address
39348 example: __L3-INTERFACE-IPV6-ADDRESS__
39351 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39354 $ref: "#/definitions/l3-interface-ipv6-address-list"
39358 summary: update an existing l3-interface-ipv6-address-list
39360 Update an existing l3-interface-ipv6-address-list
39362 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39363 The PUT operation will entirely replace an existing object.
39364 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39366 Other differences between PUT and PATCH are:
39368 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39369 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39370 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39371 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39380 description: Response codes found in [response codes](https://wiki.onap.org/).
39384 description: unique name of Physical Network Function.
39387 example: __PNF-NAME__
39388 - name: interface-name
39390 description: Name that identifies the link aggregate interface
39393 example: __INTERFACE-NAME__
39394 - name: interface-name
39396 description: Name given to the interface
39399 example: __INTERFACE-NAME__
39400 - name: l3-interface-ipv6-address
39402 description: IP address
39405 example: __L3-INTERFACE-IPV6-ADDRESS__
39408 description: l3-interface-ipv6-address-list object that needs to be updated.
39411 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39415 summary: delete an existing l3-interface-ipv6-address-list
39416 description: delete an existing l3-interface-ipv6-address-list
39417 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39426 description: Response codes found in [response codes](https://wiki.onap.org/).
39430 description: unique name of Physical Network Function.
39433 example: __PNF-NAME__
39434 - name: interface-name
39436 description: Name that identifies the link aggregate interface
39439 example: __INTERFACE-NAME__
39440 - name: interface-name
39442 description: Name given to the interface
39445 example: __INTERFACE-NAME__
39446 - name: l3-interface-ipv6-address
39448 description: IP address
39451 example: __L3-INTERFACE-IPV6-ADDRESS__
39452 - name: resource-version
39454 description: resource-version for concurrency
39457 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39461 summary: returns l-interface
39462 description: returns l-interface
39463 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39469 description: successful operation
39471 $ref: "#/getDefinitions/l-interface"
39473 description: Response codes found in [response codes](https://wiki.onap.org/).
39477 description: unique name of Physical Network Function.
39480 example: __PNF-NAME__
39481 - name: interface-name
39483 description: Name that identifies the link aggregate interface
39486 example: __INTERFACE-NAME__
39487 - name: interface-name
39489 description: Name given to the interface
39492 example: __INTERFACE-NAME__
39496 summary: create or update an existing l-interface
39498 Create or update an existing l-interface.
39500 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39501 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39510 description: Response codes found in [response codes](https://wiki.onap.org/).
39514 description: unique name of Physical Network Function.
39517 example: __PNF-NAME__
39518 - name: interface-name
39520 description: Name that identifies the link aggregate interface
39523 example: __INTERFACE-NAME__
39524 - name: interface-name
39526 description: Name given to the interface
39529 example: __INTERFACE-NAME__
39532 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
39535 $ref: "#/definitions/l-interface"
39539 summary: update an existing l-interface
39541 Update an existing l-interface
39543 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39544 The PUT operation will entirely replace an existing object.
39545 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39547 Other differences between PUT and PATCH are:
39549 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39550 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39551 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39552 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39561 description: Response codes found in [response codes](https://wiki.onap.org/).
39565 description: unique name of Physical Network Function.
39568 example: __PNF-NAME__
39569 - name: interface-name
39571 description: Name that identifies the link aggregate interface
39574 example: __INTERFACE-NAME__
39575 - name: interface-name
39577 description: Name given to the interface
39580 example: __INTERFACE-NAME__
39583 description: l-interface object that needs to be updated.
39586 $ref: "#/patchDefinitions/l-interface"
39590 summary: delete an existing l-interface
39591 description: delete an existing l-interface
39592 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39601 description: Response codes found in [response codes](https://wiki.onap.org/).
39605 description: unique name of Physical Network Function.
39608 example: __PNF-NAME__
39609 - name: interface-name
39611 description: Name that identifies the link aggregate interface
39614 example: __INTERFACE-NAME__
39615 - name: interface-name
39617 description: Name given to the interface
39620 example: __INTERFACE-NAME__
39621 - name: resource-version
39623 description: resource-version for concurrency
39626 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
39630 summary: returns l-interfaces
39631 description: returns l-interfaces
39632 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
39638 description: successful operation
39640 $ref: "#/getDefinitions/l-interfaces"
39642 description: Response codes found in [response codes](https://wiki.onap.org/).
39646 description: unique name of Physical Network Function.
39649 example: __PNF-NAME__
39650 - name: interface-name
39652 description: Name that identifies the link aggregate interface
39655 example: __INTERFACE-NAME__
39656 - name: interface-name
39661 - name: interface-id
39671 - name: network-name
39676 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
39680 summary: returns lag-interface
39681 description: returns lag-interface
39682 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
39688 description: successful operation
39690 $ref: "#/getDefinitions/lag-interface"
39692 description: Response codes found in [response codes](https://wiki.onap.org/).
39696 description: unique name of Physical Network Function.
39699 example: __PNF-NAME__
39700 - name: interface-name
39702 description: Name that identifies the link aggregate interface
39705 example: __INTERFACE-NAME__
39709 summary: create or update an existing lag-interface
39711 Create or update an existing lag-interface.
39713 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39714 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
39723 description: Response codes found in [response codes](https://wiki.onap.org/).
39727 description: unique name of Physical Network Function.
39730 example: __PNF-NAME__
39731 - name: interface-name
39733 description: Name that identifies the link aggregate interface
39736 example: __INTERFACE-NAME__
39739 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)
39742 $ref: "#/definitions/lag-interface"
39746 summary: update an existing lag-interface
39748 Update an existing lag-interface
39750 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39751 The PUT operation will entirely replace an existing object.
39752 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39754 Other differences between PUT and PATCH are:
39756 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39757 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39758 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39759 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
39768 description: Response codes found in [response codes](https://wiki.onap.org/).
39772 description: unique name of Physical Network Function.
39775 example: __PNF-NAME__
39776 - name: interface-name
39778 description: Name that identifies the link aggregate interface
39781 example: __INTERFACE-NAME__
39784 description: lag-interface object that needs to be updated.
39787 $ref: "#/patchDefinitions/lag-interface"
39791 summary: delete an existing lag-interface
39792 description: delete an existing lag-interface
39793 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
39802 description: Response codes found in [response codes](https://wiki.onap.org/).
39806 description: unique name of Physical Network Function.
39809 example: __PNF-NAME__
39810 - name: interface-name
39812 description: Name that identifies the link aggregate interface
39815 example: __INTERFACE-NAME__
39816 - name: resource-version
39818 description: resource-version for concurrency
39821 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
39825 summary: returns lag-interfaces
39826 description: returns lag-interfaces
39827 operationId: getNetworkPnfsPnfLagInterfaces
39833 description: successful operation
39835 $ref: "#/getDefinitions/lag-interfaces"
39837 description: Response codes found in [response codes](https://wiki.onap.org/).
39841 description: unique name of Physical Network Function.
39844 example: __PNF-NAME__
39845 - name: interface-name
39850 - name: interface-id
39855 - name: interface-role
39860 /network/pnfs/pnf/{pnf-name}:
39864 summary: returns pnf
39865 description: returns pnf
39866 operationId: getNetworkPnfsPnf
39872 description: successful operation
39874 $ref: "#/getDefinitions/pnf"
39876 description: Response codes found in [response codes](https://wiki.onap.org/).
39880 description: unique name of Physical Network Function.
39883 example: __PNF-NAME__
39887 summary: create or update an existing pnf
39889 Create or update an existing pnf.
39891 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39892 operationId: createOrUpdateNetworkPnfsPnf
39901 description: Response codes found in [response codes](https://wiki.onap.org/).
39905 description: unique name of Physical Network Function.
39908 example: __PNF-NAME__
39911 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)
39914 $ref: "#/definitions/pnf"
39918 summary: update an existing pnf
39920 Update an existing pnf
39922 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39923 The PUT operation will entirely replace an existing object.
39924 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39926 Other differences between PUT and PATCH are:
39928 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39929 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39930 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39931 operationId: UpdateNetworkPnfsPnf
39940 description: Response codes found in [response codes](https://wiki.onap.org/).
39944 description: unique name of Physical Network Function.
39947 example: __PNF-NAME__
39950 description: pnf object that needs to be updated.
39953 $ref: "#/patchDefinitions/pnf"
39957 summary: delete an existing pnf
39958 description: delete an existing pnf
39959 operationId: deleteNetworkPnfsPnf
39968 description: Response codes found in [response codes](https://wiki.onap.org/).
39972 description: unique name of Physical Network Function.
39975 example: __PNF-NAME__
39976 - name: resource-version
39978 description: resource-version for concurrency
39985 summary: returns pnfs
39986 description: returns pnfs
39987 operationId: getNetworkPnfs
39993 description: successful operation
39995 $ref: "#/getDefinitions/pnfs"
39997 description: Response codes found in [response codes](https://wiki.onap.org/).
40009 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
40013 summary: see node definition for valid relationships
40014 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
40023 description: Response codes found in [response codes](https://wiki.onap.org/).
40027 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40030 example: __LINK-NAME__
40033 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)
40036 $ref: "#/definitions/relationship"
40040 summary: delete an existing relationship
40041 description: delete an existing relationship
40042 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
40051 description: Response codes found in [response codes](https://wiki.onap.org/).
40055 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40058 example: __LINK-NAME__
40059 /network/physical-links/physical-link/{link-name}:
40063 summary: returns physical-link
40064 description: returns physical-link
40065 operationId: getNetworkPhysicalLinksPhysicalLink
40071 description: successful operation
40073 $ref: "#/getDefinitions/physical-link"
40075 description: Response codes found in [response codes](https://wiki.onap.org/).
40079 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40082 example: __LINK-NAME__
40086 summary: create or update an existing physical-link
40088 Create or update an existing physical-link.
40090 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40091 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
40100 description: Response codes found in [response codes](https://wiki.onap.org/).
40104 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40107 example: __LINK-NAME__
40110 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)
40113 $ref: "#/definitions/physical-link"
40117 summary: update an existing physical-link
40119 Update an existing physical-link
40121 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40122 The PUT operation will entirely replace an existing object.
40123 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40125 Other differences between PUT and PATCH are:
40127 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40128 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40129 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40130 operationId: UpdateNetworkPhysicalLinksPhysicalLink
40139 description: Response codes found in [response codes](https://wiki.onap.org/).
40143 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40146 example: __LINK-NAME__
40149 description: physical-link object that needs to be updated.
40152 $ref: "#/patchDefinitions/physical-link"
40156 summary: delete an existing physical-link
40157 description: delete an existing physical-link
40158 operationId: deleteNetworkPhysicalLinksPhysicalLink
40167 description: Response codes found in [response codes](https://wiki.onap.org/).
40171 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
40174 example: __LINK-NAME__
40175 - name: resource-version
40177 description: resource-version for concurrency
40180 /network/physical-links:
40184 summary: returns physical-links
40185 description: returns physical-links
40186 operationId: getNetworkPhysicalLinks
40192 description: successful operation
40194 $ref: "#/getDefinitions/physical-links"
40196 description: Response codes found in [response codes](https://wiki.onap.org/).
40208 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
40212 summary: see node definition for valid relationships
40213 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
40222 description: Response codes found in [response codes](https://wiki.onap.org/).
40224 - name: ipsec-configuration-id
40226 description: UUID of this configuration
40229 example: __IPSEC-CONFIGURATION-ID__
40232 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)
40235 $ref: "#/definitions/relationship"
40239 summary: delete an existing relationship
40240 description: delete an existing relationship
40241 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
40250 description: Response codes found in [response codes](https://wiki.onap.org/).
40252 - name: ipsec-configuration-id
40254 description: UUID of this configuration
40257 example: __IPSEC-CONFIGURATION-ID__
40258 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
40262 summary: see node definition for valid relationships
40263 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
40272 description: Response codes found in [response codes](https://wiki.onap.org/).
40274 - name: ipsec-configuration-id
40276 description: UUID of this configuration
40279 example: __IPSEC-CONFIGURATION-ID__
40280 - name: vig-address-type
40282 description: indicates whether the VIG is for AVPN or INTERNET
40285 example: __VIG-ADDRESS-TYPE__
40288 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
40291 $ref: "#/definitions/relationship"
40295 summary: delete an existing relationship
40296 description: delete an existing relationship
40297 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
40306 description: Response codes found in [response codes](https://wiki.onap.org/).
40308 - name: ipsec-configuration-id
40310 description: UUID of this configuration
40313 example: __IPSEC-CONFIGURATION-ID__
40314 - name: vig-address-type
40316 description: indicates whether the VIG is for AVPN or INTERNET
40319 example: __VIG-ADDRESS-TYPE__
40320 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
40324 summary: returns vig-server
40325 description: returns vig-server
40326 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40332 description: successful operation
40334 $ref: "#/getDefinitions/vig-server"
40336 description: Response codes found in [response codes](https://wiki.onap.org/).
40338 - name: ipsec-configuration-id
40340 description: UUID of this configuration
40343 example: __IPSEC-CONFIGURATION-ID__
40344 - name: vig-address-type
40346 description: indicates whether the VIG is for AVPN or INTERNET
40349 example: __VIG-ADDRESS-TYPE__
40353 summary: create or update an existing vig-server
40355 Create or update an existing vig-server.
40357 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40358 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40367 description: Response codes found in [response codes](https://wiki.onap.org/).
40369 - name: ipsec-configuration-id
40371 description: UUID of this configuration
40374 example: __IPSEC-CONFIGURATION-ID__
40375 - name: vig-address-type
40377 description: indicates whether the VIG is for AVPN or INTERNET
40380 example: __VIG-ADDRESS-TYPE__
40383 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
40386 $ref: "#/definitions/vig-server"
40390 summary: update an existing vig-server
40392 Update an existing vig-server
40394 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40395 The PUT operation will entirely replace an existing object.
40396 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40398 Other differences between PUT and PATCH are:
40400 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40401 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40402 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40403 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40412 description: Response codes found in [response codes](https://wiki.onap.org/).
40414 - name: ipsec-configuration-id
40416 description: UUID of this configuration
40419 example: __IPSEC-CONFIGURATION-ID__
40420 - name: vig-address-type
40422 description: indicates whether the VIG is for AVPN or INTERNET
40425 example: __VIG-ADDRESS-TYPE__
40428 description: vig-server object that needs to be updated.
40431 $ref: "#/patchDefinitions/vig-server"
40435 summary: delete an existing vig-server
40436 description: delete an existing vig-server
40437 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40446 description: Response codes found in [response codes](https://wiki.onap.org/).
40448 - name: ipsec-configuration-id
40450 description: UUID of this configuration
40453 example: __IPSEC-CONFIGURATION-ID__
40454 - name: vig-address-type
40456 description: indicates whether the VIG is for AVPN or INTERNET
40459 example: __VIG-ADDRESS-TYPE__
40460 - name: resource-version
40462 description: resource-version for concurrency
40465 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
40469 summary: returns vig-servers
40470 description: returns vig-servers
40471 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
40477 description: successful operation
40479 $ref: "#/getDefinitions/vig-servers"
40481 description: Response codes found in [response codes](https://wiki.onap.org/).
40483 - name: ipsec-configuration-id
40485 description: UUID of this configuration
40488 example: __IPSEC-CONFIGURATION-ID__
40489 - name: vig-address-type
40494 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
40498 summary: returns ipsec-configuration
40499 description: returns ipsec-configuration
40500 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
40506 description: successful operation
40508 $ref: "#/getDefinitions/ipsec-configuration"
40510 description: Response codes found in [response codes](https://wiki.onap.org/).
40512 - name: ipsec-configuration-id
40514 description: UUID of this configuration
40517 example: __IPSEC-CONFIGURATION-ID__
40521 summary: create or update an existing ipsec-configuration
40523 Create or update an existing ipsec-configuration.
40525 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40526 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
40535 description: Response codes found in [response codes](https://wiki.onap.org/).
40537 - name: ipsec-configuration-id
40539 description: UUID of this configuration
40542 example: __IPSEC-CONFIGURATION-ID__
40545 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)
40548 $ref: "#/definitions/ipsec-configuration"
40552 summary: update an existing ipsec-configuration
40554 Update an existing ipsec-configuration
40556 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40557 The PUT operation will entirely replace an existing object.
40558 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40560 Other differences between PUT and PATCH are:
40562 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40563 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40564 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40565 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
40574 description: Response codes found in [response codes](https://wiki.onap.org/).
40576 - name: ipsec-configuration-id
40578 description: UUID of this configuration
40581 example: __IPSEC-CONFIGURATION-ID__
40584 description: ipsec-configuration object that needs to be updated.
40587 $ref: "#/patchDefinitions/ipsec-configuration"
40591 summary: delete an existing ipsec-configuration
40592 description: delete an existing ipsec-configuration
40593 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
40602 description: Response codes found in [response codes](https://wiki.onap.org/).
40604 - name: ipsec-configuration-id
40606 description: UUID of this configuration
40609 example: __IPSEC-CONFIGURATION-ID__
40610 - name: resource-version
40612 description: resource-version for concurrency
40615 /network/ipsec-configurations:
40619 summary: returns ipsec-configurations
40620 description: returns ipsec-configurations
40621 operationId: getNetworkIpsecConfigurations
40627 description: successful operation
40629 $ref: "#/getDefinitions/ipsec-configurations"
40631 description: Response codes found in [response codes](https://wiki.onap.org/).
40633 - name: ipsec-configuration-id
40638 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
40642 summary: see node definition for valid relationships
40643 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
40652 description: Response codes found in [response codes](https://wiki.onap.org/).
40654 - name: route-table-reference-id
40656 description: Route Table Reference id, UUID assigned to this instance.
40659 example: __ROUTE-TABLE-REFERENCE-ID__
40662 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)
40665 $ref: "#/definitions/relationship"
40669 summary: delete an existing relationship
40670 description: delete an existing relationship
40671 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
40680 description: Response codes found in [response codes](https://wiki.onap.org/).
40682 - name: route-table-reference-id
40684 description: Route Table Reference id, UUID assigned to this instance.
40687 example: __ROUTE-TABLE-REFERENCE-ID__
40688 /network/route-table-references/route-table-reference/{route-table-reference-id}:
40692 summary: returns route-table-reference
40693 description: returns route-table-reference
40694 operationId: getNetworkRouteTableReferencesRouteTableReference
40700 description: successful operation
40702 $ref: "#/getDefinitions/route-table-reference"
40704 description: Response codes found in [response codes](https://wiki.onap.org/).
40706 - name: route-table-reference-id
40708 description: Route Table Reference id, UUID assigned to this instance.
40711 example: __ROUTE-TABLE-REFERENCE-ID__
40715 summary: create or update an existing route-table-reference
40717 Create or update an existing route-table-reference.
40719 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40720 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
40729 description: Response codes found in [response codes](https://wiki.onap.org/).
40731 - name: route-table-reference-id
40733 description: Route Table Reference id, UUID assigned to this instance.
40736 example: __ROUTE-TABLE-REFERENCE-ID__
40739 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)
40742 $ref: "#/definitions/route-table-reference"
40746 summary: update an existing route-table-reference
40748 Update an existing route-table-reference
40750 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40751 The PUT operation will entirely replace an existing object.
40752 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40754 Other differences between PUT and PATCH are:
40756 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40757 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40758 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40759 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
40768 description: Response codes found in [response codes](https://wiki.onap.org/).
40770 - name: route-table-reference-id
40772 description: Route Table Reference id, UUID assigned to this instance.
40775 example: __ROUTE-TABLE-REFERENCE-ID__
40778 description: route-table-reference object that needs to be updated.
40781 $ref: "#/patchDefinitions/route-table-reference"
40785 summary: delete an existing route-table-reference
40786 description: delete an existing route-table-reference
40787 operationId: deleteNetworkRouteTableReferencesRouteTableReference
40796 description: Response codes found in [response codes](https://wiki.onap.org/).
40798 - name: route-table-reference-id
40800 description: Route Table Reference id, UUID assigned to this instance.
40803 example: __ROUTE-TABLE-REFERENCE-ID__
40804 - name: resource-version
40806 description: resource-version for concurrency
40809 /network/route-table-references:
40813 summary: returns route-table-references
40814 description: returns route-table-references
40815 operationId: getNetworkRouteTableReferences
40821 description: successful operation
40823 $ref: "#/getDefinitions/route-table-references"
40825 description: Response codes found in [response codes](https://wiki.onap.org/).
40827 - name: route-table-reference-id
40832 - name: route-table-reference-fqdn
40837 /network/instance-groups/instance-group/{id}/relationship-list/relationship:
40841 summary: see node definition for valid relationships
40842 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
40851 description: Response codes found in [response codes](https://wiki.onap.org/).
40855 description: Instance Group ID, UUID assigned to this instance.
40861 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)
40864 $ref: "#/definitions/relationship"
40868 summary: delete an existing relationship
40869 description: delete an existing relationship
40870 operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
40879 description: Response codes found in [response codes](https://wiki.onap.org/).
40883 description: Instance Group ID, UUID assigned to this instance.
40887 /network/instance-groups/instance-group/{id}:
40891 summary: returns instance-group
40892 description: returns instance-group
40893 operationId: getNetworkInstanceGroupsInstanceGroup
40899 description: successful operation
40901 $ref: "#/getDefinitions/instance-group"
40903 description: Response codes found in [response codes](https://wiki.onap.org/).
40907 description: Instance Group ID, UUID assigned to this instance.
40914 summary: create or update an existing instance-group
40916 Create or update an existing instance-group.
40918 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40919 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
40928 description: Response codes found in [response codes](https://wiki.onap.org/).
40932 description: Instance Group ID, UUID assigned to this instance.
40938 description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)
40941 $ref: "#/definitions/instance-group"
40945 summary: update an existing instance-group
40947 Update an existing instance-group
40949 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40950 The PUT operation will entirely replace an existing object.
40951 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40953 Other differences between PUT and PATCH are:
40955 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40956 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40957 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40958 operationId: UpdateNetworkInstanceGroupsInstanceGroup
40967 description: Response codes found in [response codes](https://wiki.onap.org/).
40971 description: Instance Group ID, UUID assigned to this instance.
40977 description: instance-group object that needs to be updated.
40980 $ref: "#/patchDefinitions/instance-group"
40984 summary: delete an existing instance-group
40985 description: delete an existing instance-group
40986 operationId: deleteNetworkInstanceGroupsInstanceGroup
40995 description: Response codes found in [response codes](https://wiki.onap.org/).
40999 description: Instance Group ID, UUID assigned to this instance.
41003 - name: resource-version
41005 description: resource-version for concurrency
41008 /network/instance-groups:
41012 summary: returns instance-groups
41013 description: returns instance-groups
41014 operationId: getNetworkInstanceGroups
41020 description: successful operation
41022 $ref: "#/getDefinitions/instance-groups"
41024 description: Response codes found in [response codes](https://wiki.onap.org/).
41031 - name: description
41046 /network/zones/zone/{zone-id}/relationship-list/relationship:
41050 summary: see node definition for valid relationships
41051 operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
41060 description: Response codes found in [response codes](https://wiki.onap.org/).
41064 description: Code assigned by AIC to the zone
41067 example: __ZONE-ID__
41070 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)
41073 $ref: "#/definitions/relationship"
41077 summary: delete an existing relationship
41078 description: delete an existing relationship
41079 operationId: deleteNetworkZonesZoneRelationshipListRelationship
41088 description: Response codes found in [response codes](https://wiki.onap.org/).
41092 description: Code assigned by AIC to the zone
41095 example: __ZONE-ID__
41096 /network/zones/zone/{zone-id}:
41100 summary: returns zone
41101 description: returns zone
41102 operationId: getNetworkZonesZone
41108 description: successful operation
41110 $ref: "#/getDefinitions/zone"
41112 description: Response codes found in [response codes](https://wiki.onap.org/).
41116 description: Code assigned by AIC to the zone
41119 example: __ZONE-ID__
41123 summary: create or update an existing zone
41125 Create or update an existing zone.
41127 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41128 operationId: createOrUpdateNetworkZonesZone
41137 description: Response codes found in [response codes](https://wiki.onap.org/).
41141 description: Code assigned by AIC to the zone
41144 example: __ZONE-ID__
41147 description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)
41150 $ref: "#/definitions/zone"
41154 summary: update an existing zone
41156 Update an existing zone
41158 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41159 The PUT operation will entirely replace an existing object.
41160 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41162 Other differences between PUT and PATCH are:
41164 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41165 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41166 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41167 operationId: UpdateNetworkZonesZone
41176 description: Response codes found in [response codes](https://wiki.onap.org/).
41180 description: Code assigned by AIC to the zone
41183 example: __ZONE-ID__
41186 description: zone object that needs to be updated.
41189 $ref: "#/patchDefinitions/zone"
41193 summary: delete an existing zone
41194 description: delete an existing zone
41195 operationId: deleteNetworkZonesZone
41204 description: Response codes found in [response codes](https://wiki.onap.org/).
41208 description: Code assigned by AIC to the zone
41211 example: __ZONE-ID__
41212 - name: resource-version
41214 description: resource-version for concurrency
41221 summary: returns zones
41222 description: returns zones
41223 operationId: getNetworkZones
41229 description: successful operation
41231 $ref: "#/getDefinitions/zones"
41233 description: Response codes found in [response codes](https://wiki.onap.org/).
41240 - name: design-type
41245 - name: zone-context
41258 $ref: "#/definitions/action-data"
41267 APIs that are more action related than REST (e.g., notify, update).
41271 $ref: "#/definitions/update"
41274 $ref: "#/definitions/notify"
41277 Represents a slice or partial piece of a resource that gets separately allotted
41278 ###### Related Nodes
41279 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
41280 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
41281 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
41282 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
41283 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
41284 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
41285 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
41286 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
41288 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
41289 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
41295 description: Allotted Resource id UUID assigned to this instance.
41298 description: The descriptive information assigned to this allotted resource instance
41301 description: Link back to more information in the controller
41302 model-invariant-id:
41304 description: the ASDC model id for this resource or service model.
41307 description: the ASDC model version for this resource or service model.
41308 persona-model-version:
41310 description: the ASDC model version for this resource or service model.
41313 description: Concurrency value
41314 orchestration-status:
41316 description: Orchestration status
41317 operational-status:
41319 description: Indicator for whether the resource is considered operational
41322 description: Generic description of the type of allotted resource.
41325 description: role in the network that this resource will be providing.
41329 $ref: "#/definitions/tunnel-xconnect"
41333 $ref: "#/definitions/relationship"
41334 allotted-resources:
41336 This object is used to store slices of services being offered
41341 $ref: "#/definitions/allotted-resource"
41344 Availability zone, a collection of compute hosts/pservers
41345 ###### Related Nodes
41346 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
41347 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
41348 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
41349 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
41350 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
41351 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
41352 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
41353 - FROM vce( vce Uses availability-zone, MANY2MANY)
41355 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
41356 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
41359 - availability-zone-name
41362 availability-zone-name:
41364 description: Name of the availability zone. Unique across a cloud region
41367 description: Type of hypervisor. Source of truth should define valid values.
41368 operational-status:
41370 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
41373 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41377 $ref: "#/definitions/relationship"
41378 availability-zones:
41380 Collection of availability zones
41385 $ref: "#/definitions/availability-zone"
41386 az-and-dvs-switches:
41390 $ref: "#/definitions/dvs-switches"
41393 $ref: "#/definitions/availability-zone"
41396 Namespace for business related constructs
41401 $ref: "#/definitions/connector"
41405 $ref: "#/definitions/customer"
41408 ###### Related Nodes
41409 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
41411 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
41417 description: unique identifier of probe
41420 description: identifier of probe
41423 description: type of probe
41426 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41430 $ref: "#/definitions/relationship"
41431 classes-of-service:
41433 class-of-service of probe
41438 $ref: "#/definitions/class-of-service"
41439 cloud-infrastructure:
41441 Namespace for cloud infrastructure.
41446 $ref: "#/definitions/complex"
41450 $ref: "#/definitions/cloud-region"
41454 $ref: "#/definitions/network-profile"
41458 $ref: "#/definitions/pserver"
41459 virtual-data-centers:
41462 $ref: "#/definitions/virtual-data-center"
41465 cloud-region designates an installation of a cloud cluster or region or instantiation
41466 ###### Related Nodes
41467 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
41468 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
41469 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
41470 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
41471 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
41472 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
41473 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
41474 - FROM image( image BelongsTo cloud-region, MANY2ONE)
41475 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
41476 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
41477 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
41478 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
41479 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
41480 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
41482 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
41483 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
41491 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
41494 description: Identifier used by the vendor for the region. Second part of composite key
41497 description: Type of the cloud (e.g., openstack)
41498 owner-defined-type:
41500 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
41501 cloud-region-version:
41503 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
41506 description: URL of the keystone identity service
41509 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
41512 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
41515 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41519 $ref: "#/definitions/volume-group"
41523 $ref: "#/definitions/tenant"
41527 $ref: "#/definitions/flavor"
41531 $ref: "#/definitions/group-assignment"
41535 $ref: "#/definitions/snapshot"
41539 $ref: "#/definitions/image"
41543 $ref: "#/definitions/dvs-switch"
41547 $ref: "#/definitions/oam-network"
41548 availability-zones:
41551 $ref: "#/definitions/availability-zone"
41555 $ref: "#/definitions/relationship"
41561 $ref: "#/definitions/cloud-region"
41564 Collection of physical locations that can house cloud-regions.
41565 ###### Related Nodes
41566 - TO l3-network( complex Uses l3-network, MANY2MANY)
41567 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
41568 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
41569 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
41570 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
41571 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
41572 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
41573 - FROM vce( vce LocatedIn complex, MANY2MANY)
41574 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
41575 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
41576 - FROM zone( zone LocatedIn complex, MANY2ONE)
41578 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
41579 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
41582 - physical-location-id
41583 - physical-location-type
41590 physical-location-id:
41592 description: Unique identifier for physical location, e.g., CLLI
41595 description: Data center code which can be an alternate way to identify a complex
41598 description: Gamma complex name for LCP instance.
41601 description: URL of the keystone identity service
41604 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41605 physical-location-type:
41607 description: Type, e.g., central office, data center.
41633 $ref: "#/definitions/ctag-pool"
41637 $ref: "#/definitions/relationship"
41640 Collection of physical locations that can house cloud-regions.
41645 $ref: "#/definitions/complex"
41648 Port Mirror Configuration.
41649 ###### Related Nodes
41650 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
41651 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
41652 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
41653 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
41654 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
41656 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
41657 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
41658 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
41661 - configuration-type
41662 - configuration-sub-type
41663 - orchestration-status
41664 - operational-status
41665 - configuration-selflink
41666 - model-customization-id
41670 description: UUID assigned to configuration.
41673 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
41674 configuration-name:
41676 description: Name of the configuration.
41677 configuration-type:
41679 description: port-mirroring-configuration.
41680 configuration-sub-type:
41682 description: vprobe, pprobe.
41683 model-invariant-id:
41685 description: the ASDC model id for this resource or service model.
41688 description: the ASDC model version for this resource or service model.
41689 orchestration-status:
41691 description: Orchestration status of the configuration.
41692 operational-status:
41694 description: Indicator for whether the resource is considered operational.
41695 configuration-selflink:
41697 description: URL to endpoint where AAI can get more details from SDN-GC.
41698 model-customization-id:
41700 description: id of the configuration used to customize the resource
41703 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41707 $ref: "#/definitions/relationship"
41711 $ref: "#/definitions/metadatum"
41714 Collection of configurations
41719 $ref: "#/definitions/configuration"
41722 Collection of resource instances used to connect a variety of disparate inventory widgets
41723 ###### Related Nodes
41724 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
41725 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
41726 - FROM service-instance( service-instance Uses connector, MANY2MANY)
41728 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
41730 - resource-instance-id
41732 resource-instance-id:
41734 description: Unique id of resource instance.
41737 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41738 model-invariant-id:
41740 description: the ASDC model id for this resource or service model.
41743 description: the ASDC model version for this resource or service model.
41744 persona-model-version:
41746 description: the ASDC model version for this resource or service model.
41749 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41750 widget-model-version:
41752 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41756 $ref: "#/definitions/relationship"
41760 $ref: "#/definitions/metadatum"
41763 Collection of resource instances used to connect a variety of disparate inventory widgets
41768 $ref: "#/definitions/connector"
41769 constrained-element-set:
41771 This is how we would capture constraints defining allowed sets of elements.
41772 ###### Related Nodes
41773 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
41774 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
41775 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
41777 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
41778 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
41780 - constrained-element-set-uuid
41784 constrained-element-set-uuid:
41792 element-choice-sets:
41795 $ref: "#/definitions/element-choice-set"
41799 $ref: "#/definitions/relationship"
41800 constrained-element-sets:
41802 constrained-element-set:
41805 $ref: "#/definitions/constrained-element-set"
41808 ###### Related Nodes
41809 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
41810 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
41812 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
41822 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41826 $ref: "#/definitions/relationship"
41832 $ref: "#/definitions/ctag-assignment"
41835 A collection of C tags (vlan tags) grouped for a specific purpose.
41836 ###### Related Nodes
41837 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
41838 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
41839 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
41841 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
41844 - availability-zone-name
41845 - ctag-pool-purpose
41849 description: The Target provider edge router
41850 availability-zone-name:
41852 description: Name of the availability zone
41855 description: Describes what the intended purpose of this pool is.
41858 description: Comma separated list of ctags
41861 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41865 $ref: "#/definitions/relationship"
41871 $ref: "#/definitions/ctag-pool"
41874 customer identifiers to provide linkage back to BSS information.
41875 ###### Related Nodes
41876 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
41878 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
41880 - global-customer-id
41884 global-customer-id:
41886 description: Global customer id used across ECOMP to uniquely identify customer.
41889 description: Subscriber name, an alternate way to retrieve a customer.
41892 description: Subscriber type, a way to provide VID with only the INFRA customers.
41895 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41896 service-subscriptions:
41899 $ref: "#/definitions/service-subscription"
41903 $ref: "#/definitions/relationship"
41906 Collection of customer identifiers to provide linkage back to BSS information.
41911 $ref: "#/definitions/customer"
41919 description: See mis-na-virtualization-platform.yang
41922 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41926 $ref: "#/definitions/relationship"
41932 $ref: "#/definitions/cvlan-tag-entry"
41935 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.
41936 ###### Related Nodes
41937 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
41938 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
41946 description: DVS switch name
41949 description: URL used to reach the vcenter
41952 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41956 $ref: "#/definitions/relationship"
41959 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
41964 $ref: "#/definitions/dvs-switch"
41967 Internal map to define the properties of an edge and interpret the map EdgeRules
41985 edge-tag-query-request:
41996 $ref: "#/definitions/start-node-filter"
41997 include-node-filter:
42000 $ref: "#/definitions/include-node-filter"
42004 $ref: "#/definitions/secondary-filter"
42005 edge-tag-query-result:
42007 tagged-inventory-item-list:
42010 $ref: "#/definitions/tagged-inventory-item-list"
42011 element-choice-set:
42013 This is how we would capture constraints defining allowed sets of elements.
42014 ###### Related Nodes
42015 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
42016 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
42018 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
42019 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
42021 - element-choice-set-uuid
42022 - element-choice-set-name
42024 element-choice-set-uuid:
42026 element-choice-set-name:
42035 $ref: "#/definitions/model-element"
42039 $ref: "#/definitions/relationship"
42040 element-choice-sets:
42042 element-choice-set:
42045 $ref: "#/definitions/element-choice-set"
42048 Metadata for entitlement group.
42049 ###### Related Nodes
42050 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
42051 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
42053 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
42060 description: Unique ID for the entitlement group the resource comes from, should be uuid.
42063 description: Unique ID of an entitlement resource.
42066 description: Concurrency value
42070 $ref: "#/definitions/relationship"
42073 Entitlements, keyed by group-uuid and resource-uuid, related to license management
42078 $ref: "#/definitions/entitlement"
42081 Persist EMS address information used by EMS driver.
42082 ###### Related Nodes
42083 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
42085 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
42091 description: Unique ID of EMS.
42094 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42095 esr-system-info-list:
42097 $ref: "#/definitions/esr-system-info-list"
42100 $ref: "#/definitions/relationship-list"
42106 $ref: "#/definitions/esr-ems"
42109 Persist common address information of external systems.
42110 ###### Related Nodes
42111 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
42112 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
42113 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
42114 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
42116 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
42118 - esr-system-info-id
42123 esr-system-info-id:
42125 description: Unique ID of esr system info.
42128 description: name of external system.
42131 description: type of external systems.
42134 description: vendor of external systems.
42137 description: version of external systems.
42140 description: url used to access external systems.
42143 description: username used to access external systems.
42146 description: password used to access external systems.
42149 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
42152 description: protocol of third party SDNC, for example netconf/snmp.
42155 description: ca file content if enabled ssl on auth-url.
42158 description: Whether to verify VIM's certificate.
42161 description: service IP of ftp server.
42164 description: service port of ftp server.
42167 description: domain info for authentication.
42170 description: default tenant of VIM.
42173 description: ftp passive mode or not.
42176 description: resource or performance data file path.
42179 description: the status of external system.
42182 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42186 $ref: "#/definitions/relationship"
42187 esr-system-info-list:
42189 Collection of persistent block-level external system auth info.
42194 $ref: "#/definitions/esr-system-info"
42195 esr-thirdparty-sdnc:
42197 Persist SDNC address information used by ONAP SDNC.
42198 ###### Related Nodes
42199 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
42200 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
42202 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
42204 - thirdparty-sdnc-id
42206 thirdparty-sdnc-id:
42208 description: Unique ID of SDNC.
42211 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
42214 description: password used to access SDNC server.
42217 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42218 esr-system-info-list:
42220 $ref: "#/definitions/esr-system-info-list"
42223 $ref: "#/definitions/relationship-list"
42224 esr-thirdparty-sdnc-list:
42226 esr-thirdparty-sdnc:
42229 $ref: "#/definitions/esr-thirdparty-sdnc"
42232 Persist VNFM address information used by VF-C.
42233 ###### Related Nodes
42234 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
42236 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
42242 description: Unique ID of VNFM.
42245 description: indecate the VIM to deploy VNF.
42248 description: certificate url of VNFM.
42251 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42252 esr-system-info-list:
42254 $ref: "#/definitions/esr-system-info-list"
42257 $ref: "#/definitions/relationship-list"
42263 $ref: "#/definitions/esr-vnfm"
42266 evc object is an optional child object of the Configuration object.
42267 ###### Related Nodes
42268 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
42270 -(4) IF this TO node is deleted, this EVC is DELETED also
42276 description: Unique/key field for the evc object
42277 forwarding-path-topology:
42279 description: Point-to-Point, Multi-Point
42282 description: Commited Information Rate
42285 description: CIR units
42286 connection-diversity-group-id:
42288 description: Diversity Group ID
42291 description: formerly Performance Group
42292 esp-evc-circuit-id:
42294 description: EVC Circuit ID of ESP EVC
42297 description: Committed Information Rate (For ESP)
42300 description: CIR units (For ESP)
42303 description: Identifies ESP
42304 collector-pop-clli:
42306 description: Collector POP CLLI (from the hostname of the access pnf)
42307 inter-connect-type-ingress:
42309 description: Interconnect type on ingress side of EVC.
42310 tagmode-access-ingress:
42312 description: tagode for collector side of EVC
42313 tagmode-access-egress:
42315 description: tagMode for network side of EVC
42319 $ref: "#/definitions/relationship"
42322 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42328 $ref: "#/definitions/evc"
42331 Namespace for external system.
42335 $ref: "#/definitions/esr-ems-list"
42338 $ref: "#/definitions/esr-vnfm-list"
42339 esr-thirdparty-sdnc-list:
42341 $ref: "#/definitions/esr-thirdparty-sdnc-list"
42344 Extra properties for inventory item for response list
42349 $ref: "#/definitions/extra-property"
42359 ###### Related Nodes
42360 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
42361 - FROM vserver( vserver Uses flavor, MANY2ONE)
42363 -FLAVOR cannot be deleted if related to VSERVER
42372 description: Flavor id, expected to be unique across cloud-region.
42375 description: Flavor name
42379 description: Number of CPUs
42383 description: Amount of memory
42387 description: Disk space
42391 description: Amount of ephemeral disk space
42394 description: amount of swap space allocation
42397 description: whether flavor is available to all users or private to the tenant it was created in.
42400 description: URL to endpoint where AAI can get more details
42403 description: Boolean as to whether this flavor is no longer enabled
42406 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42410 $ref: "#/definitions/relationship"
42413 Collection of openstack flavors.
42418 $ref: "#/definitions/flavor"
42421 Entity describing a sequenced segment of forwarding path
42422 ###### Related Nodes
42423 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
42424 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
42425 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
42426 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
42427 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
42429 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
42430 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
42437 description: Unique ID of this segmentation
42440 description: ingress, intermediate, egress
42444 $ref: "#/definitions/relationship"
42447 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42450 forwarder object is an optional child object of the Configuration object.
42451 ###### Related Nodes
42452 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
42454 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
42460 description: Key for forwarder-evc object
42463 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
42466 description: Internal VLAN.
42469 description: SVLAN value for ingress of egress forwarder.
42472 description: CVLAN value for ingress of egress forwarder.
42476 $ref: "#/definitions/relationship"
42479 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42485 $ref: "#/definitions/forwarder-evc"
42491 $ref: "#/definitions/forwarder"
42494 Entity that describes the sequenced forwarding path between interfaces of services or resources
42495 ###### Related Nodes
42496 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
42497 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
42498 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
42500 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
42501 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
42502 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
42504 - forwarding-path-id
42505 - forwarding-path-name
42507 forwarding-path-id:
42509 description: Unique ID of this FP
42510 forwarding-path-name:
42512 description: Name of the FP
42516 $ref: "#/definitions/relationship"
42519 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42522 description: the self link for this FP
42526 $ref: "#/definitions/forwarder"
42532 $ref: "#/definitions/forwarding-path"
42535 General purpose VNF
42536 ###### Related Nodes
42537 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
42538 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
42539 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
42540 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
42541 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
42542 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
42543 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
42544 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
42545 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
42546 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
42547 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
42548 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
42549 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
42550 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
42551 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
42552 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
42553 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
42554 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
42555 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
42556 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
42557 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
42559 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
42565 - is-closed-loop-disabled
42569 description: Unique id of VNF. This is unique across the graph.
42572 description: Name of VNF.
42575 description: Alternate name of VNF.
42578 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.
42581 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
42582 regional-resource-zone:
42584 description: Regional way of organizing pservers, source of truth should define values
42587 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42588 operational-status:
42590 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
42593 description: OBSOLETE - do not use
42596 description: Client should send valid enumerated value
42597 orchestration-status:
42599 description: Orchestration status of this VNF, used by MSO.
42602 description: Heat stack id corresponding to this instance, managed by MSO
42605 description: Corresponds to the SDN-C catalog id used to configure this VCE
42608 description: identifier of managed by company or customer
42611 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
42612 ipv4-loopback0-address:
42614 description: v4 Loopback0 address
42617 description: v6 Loopback address
42618 management-v6-address:
42620 description: v6 management address
42624 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42627 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
42631 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42634 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
42638 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42641 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
42644 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.
42645 is-closed-loop-disabled:
42647 description: used to indicate whether closed loop function is enabled on this node
42650 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42653 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
42654 encrypted-access-flag:
42656 description: indicates whether generic-vnf access uses SSH
42657 entitlement-assignment-group-uuid:
42659 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
42660 entitlement-resource-uuid:
42662 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
42663 license-assignment-group-uuid:
42665 description: UUID of the license assignment group. OBSOLETE - See child relationships.
42668 description: UUID of the actual license resource. OBSOLETE - See child relationships.
42669 model-invariant-id:
42671 description: the ASDC model id for this resource or service model.
42674 description: the ASDC model version for this resource or service model.
42675 persona-model-version:
42677 description: the ASDC model version for this resource or service model.
42678 model-customization-id:
42680 description: captures the id of all the configuration used to customize the resource for the service.
42683 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42684 widget-model-version:
42686 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42689 description: as-number of the VNF
42690 regional-resource-subzone:
42692 description: represents sub zone of the rr plane
42695 description: Generic description of the type of NF
42698 description: English description of Network function that the specific VNF deployment is providing
42701 description: role in the network that this model will be providing
42704 description: string assigned to this model used for naming purposes
42707 description: Path to the controller object.
42711 $ref: "#/definitions/relationship"
42715 $ref: "#/definitions/l-interface"
42719 $ref: "#/definitions/lag-interface"
42723 $ref: "#/definitions/vf-module"
42727 $ref: "#/definitions/license"
42731 $ref: "#/definitions/entitlement"
42739 $ref: "#/definitions/generic-vnf"
42742 Openstack group-assignment used to store exclusivity groups (EG).
42743 ###### Related Nodes
42744 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
42745 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
42746 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
42755 description: Group id, expected to be unique across cloud-region.
42758 description: Group type - the type of group this instance refers to
42761 description: Group name - name assigned to the group
42764 description: Group description - description of the group
42767 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42771 $ref: "#/definitions/relationship"
42774 Collection of openstack group assignments
42779 $ref: "#/definitions/group-assignment"
42782 ###### Related Nodes
42783 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
42785 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
42793 description: host-route id
42796 description: subnet prefix
42799 description: Could be ip-address, hostname, or service-instance
42802 description: Should be ip-address, hostname, or service-instance to match next-hop
42805 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42809 $ref: "#/definitions/relationship"
42815 $ref: "#/definitions/host-route"
42818 Collection of HPA Capabilities
42823 $ref: "#/definitions/hpa-capability"
42826 Represents a HPA capability
42827 ###### Related Nodes
42828 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
42829 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
42830 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
42832 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
42834 - hpa-capability-id
42839 description: UUID to uniquely identify a HPA capability
42842 description: Name of the HPACapability
42845 description: HPA schema version
42848 description: Hardware architecture
42851 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42855 $ref: "#/definitions/relationship"
42856 hpa-feature-attributes:
42859 $ref: "#/definitions/hpa-feature-attributes"
42860 hpa-feature-attributes:
42862 HPA Capability Feature attributes
42863 ###### Related Nodes
42864 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
42866 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
42868 - hpa-attribute-key
42872 description: name of the specific HPA attribute
42873 hpa-attribute-value:
42875 description: JSON string specifying the value, unit and type of the specific HPA attribute
42878 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42882 $ref: "#/definitions/relationship"
42886 ###### Related Nodes
42887 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
42888 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
42889 - FROM vserver( vserver Uses image, MANY2ONE)
42891 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
42892 -IMAGE cannot be deleted if related to VSERVER
42903 description: Image id, expected to be unique across cloud region
42906 description: Image name
42907 image-architecture:
42909 description: Operating system architecture.
42912 description: The common name of the operating system distribution in lowercase
42915 description: The operating system version as specified by the distributor.
42918 description: The application that the image instantiates.
42919 application-vendor:
42921 description: The vendor of the application.
42922 application-version:
42924 description: The version of the application.
42927 description: URL to endpoint where AAI can get more details
42930 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42934 $ref: "#/definitions/relationship"
42938 $ref: "#/definitions/metadatum"
42941 Collectio of Openstack images.
42946 $ref: "#/definitions/image"
42947 include-node-filter:
42953 InstanceFilter for performing a named-query or model query
42956 InstanceFilters for performing a named-query or model query
42961 $ref: "#/definitions/instance-filter"
42964 General mechanism for grouping instances
42965 ###### Related Nodes
42966 - TO model( instance-group Targets model, MANY2MANY)
42967 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
42968 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
42969 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
42970 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
42971 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
42972 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
42973 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
42982 description: Instance Group ID, UUID assigned to this instance.
42985 description: Descriptive text to help identify the usage of this instance-group
42988 description: Only valid value today is lower case ha for high availability
42991 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
42994 description: Concurrency value
42998 $ref: "#/definitions/relationship"
43001 Collection of openstack route table references
43006 $ref: "#/definitions/instance-group"
43011 $ref: "#/definitions/search"
43014 $ref: "#/definitions/actions"
43015 cloud-infrastructure:
43017 $ref: "#/definitions/cloud-infrastructure"
43020 $ref: "#/definitions/business"
43021 service-design-and-creation:
43023 $ref: "#/definitions/service-design-and-creation"
43026 $ref: "#/definitions/network"
43029 $ref: "#/definitions/nodes"
43032 inventory-item-type:
43034 inventory-item-link:
43036 inventory-item-data:
43039 $ref: "#/definitions/inventory-item-data"
43040 tagged-inventory-item-list:
43043 $ref: "#/definitions/tagged-inventory-item-list"
43044 inventory-item-data:
43050 inventory-response-item:
43052 Inventory item for response list
43058 $ref: "#/definitions/extra-properties"
43059 inventory-response-items:
43061 $ref: "#/definitions/inventory-response-items"
43062 inventory-response-items:
43064 Container for inventory items in response list
43066 inventory-response-item:
43069 $ref: "#/definitions/inventory-response-item"
43070 ipsec-configuration:
43072 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
43073 ###### Related Nodes
43074 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
43075 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
43077 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
43079 - ipsec-configuration-id
43081 ipsec-configuration-id:
43083 description: UUID of this configuration
43084 requested-vig-address-type:
43086 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
43087 requested-encryption-strength:
43089 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
43090 requested-dmz-type:
43092 description: can offer a shared DMZ or a DMZ specific to a customer
43093 shared-dmz-network-address:
43095 description: Network address of shared DMZ
43096 requested-customer-name:
43098 description: If the DMZ is a custom DMZ, this field will indicate the customer information
43101 description: can be 1 or 2
43102 ikev1-authentication:
43104 description: Contains values like md5, sha1, sha256, sha384
43107 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
43110 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
43113 description: Group name defined in VIG for clients using aggressive mode
43116 description: pre-shared key for the above group name
43119 description: Lifetime for IKEv1 SA
43120 ipsec-authentication:
43122 description: md5, sha1, sha256, sha384
43125 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
43128 description: Life time for IPSec SA
43131 description: enable PFS or not
43134 description: user ID for xAuth, sm-user, ,nmteHostName
43135 xauth-user-password:
43137 description: Encrypted using the Juniper $9$ algorithm
43140 description: The time between DPD probe
43143 description: Maximum number of DPD before claiming the tunnel is down
43146 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43150 $ref: "#/definitions/relationship"
43154 $ref: "#/definitions/vig-server"
43155 ipsec-configurations:
43157 ipsec-configuration:
43160 $ref: "#/definitions/ipsec-configuration"
43169 Logical interfaces, e.g., a vnic.
43170 ###### Related Nodes
43171 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
43172 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
43173 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
43174 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
43175 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
43176 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
43177 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
43178 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
43179 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
43180 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
43181 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
43182 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
43183 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
43185 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
43186 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
43187 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
43195 description: Name given to the interface
43198 description: E.g., CUSTOMER, UPLINK, etc.
43201 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
43204 description: URL to endpoint where AAI can get more details
43207 description: ID of interface
43210 description: MAC address for the interface
43213 description: Name of the network
43216 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
43217 interface-description:
43219 description: Human friendly text regarding this interface.
43222 description: boolean indicatating whether or not port is a mirrored.
43225 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43228 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
43232 $ref: "#/definitions/vlan"
43236 $ref: "#/definitions/sriov-vf"
43240 $ref: "#/definitions/l-interface"
43244 $ref: "#/definitions/relationship"
43245 l3-interface-ipv4-address-list:
43248 $ref: "#/definitions/l3-interface-ipv4-address-list"
43249 l3-interface-ipv6-address-list:
43252 $ref: "#/definitions/l3-interface-ipv6-address-list"
43255 Collection of logical interfaces.
43260 $ref: "#/definitions/l-interface"
43261 l3-interface-ipv4-address-list:
43264 ###### Related Nodes
43265 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
43266 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
43267 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
43268 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
43269 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
43271 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
43273 - l3-interface-ipv4-address
43275 l3-interface-ipv4-address:
43277 description: IP address
43278 l3-interface-ipv4-prefix-length:
43281 description: Prefix length, 32 for single address
43285 description: Inner VLAN tag
43289 description: Outer VLAN tag
43292 description: Indicator of fixed or floating address
43295 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43296 neutron-network-id:
43298 description: Neutron network id of the interface that address belongs to
43301 description: Neutron id of subnet that address belongs to
43305 $ref: "#/definitions/relationship"
43306 l3-interface-ipv6-address-list:
43309 ###### Related Nodes
43310 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
43311 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
43312 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
43313 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
43314 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
43316 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
43318 - l3-interface-ipv6-address
43320 l3-interface-ipv6-address:
43322 description: IP address
43323 l3-interface-ipv6-prefix-length:
43326 description: Prefix length, 128 for single address
43330 description: Inner VLAN tag
43334 description: Outer VLAN tag
43337 description: Indicator of fixed or floating address
43340 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43341 neutron-network-id:
43343 description: Neutron network id of the interface that address belongs to
43346 description: Neutron id of subnet that address belongs to
43350 $ref: "#/definitions/relationship"
43353 Generic network definition
43354 ###### Related Nodes
43355 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
43356 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
43357 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
43358 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
43359 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
43360 - FROM complex( complex Uses l3-network, MANY2MANY)
43361 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
43362 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
43363 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
43364 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
43365 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
43366 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
43367 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
43368 - FROM tenant( tenant Uses l3-network, MANY2MANY)
43369 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
43371 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
43376 - is-provider-network
43377 - is-shared-network
43378 - is-external-network
43382 description: Network ID, should be uuid. Unique across A&AI.
43385 description: Name of the network, governed by some naming convention..
43388 description: Type of the network - who defines these values?
43391 description: Role the network plans - who defines these values?
43392 network-technology:
43394 description: Network technology - who defines these values?
43395 neutron-network-id:
43397 description: Neutron network id of this Interface
43400 description: Set to true if bound to VPN
43403 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
43404 network-role-instance:
43407 description: network role instance
43410 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43411 orchestration-status:
43413 description: Orchestration status of this VNF, mastered by MSO
43416 description: Heat stack id corresponding to this instance, managed by MSO
43419 description: Corresponds to the SDN-C catalog id used to configure this VCE
43420 contrail-network-fqdn:
43422 description: Contrail FQDN for the network
43423 model-invariant-id:
43425 description: the ASDC model id for this resource or service model.
43428 description: the ASDC model version for this resource or service model.
43429 persona-model-version:
43431 description: the ASDC model version for this resource or service model.
43432 model-customization-id:
43434 description: captures the id of all the configuration used to customize the resource for the service.
43437 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43438 widget-model-version:
43440 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43441 physical-network-name:
43443 description: Name associated with the physical network.
43444 is-provider-network:
43446 description: boolean indicatating whether or not network is a provider network.
43449 description: boolean indicatating whether or not network is a shared network.
43450 is-external-network:
43452 description: boolean indicatating whether or not network is an external network.
43455 description: Path to the controller object.
43456 operational-status:
43458 description: Indicator for whether the resource is considered operational.
43462 $ref: "#/definitions/subnet"
43466 $ref: "#/definitions/ctag-assignment"
43467 segmentation-assignments:
43470 $ref: "#/definitions/segmentation-assignment"
43474 $ref: "#/definitions/relationship"
43475 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
43481 $ref: "#/definitions/l3-network"
43484 Link aggregate interface
43485 ###### Related Nodes
43486 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
43487 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
43488 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
43489 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
43490 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
43491 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
43492 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
43493 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
43495 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
43496 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
43497 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
43504 description: Name that identifies the link aggregate interface
43505 interface-description:
43507 description: Human friendly text regarding this interface.
43510 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43513 description: Captures the numeric part of the speed
43516 description: Captures the units corresponding to the speed
43519 description: ID of interface
43522 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
43525 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43528 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
43532 $ref: "#/definitions/relationship"
43536 $ref: "#/definitions/l-interface"
43539 Collection of link aggregate interfaces.
43544 $ref: "#/definitions/lag-interface"
43547 LAG links can connect lag-interfaces
43548 ###### Related Nodes
43549 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
43550 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
43552 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
43558 description: Alphabetical concatenation of lag-interface names
43561 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43565 $ref: "#/definitions/relationship"
43568 Collection of link aggregation connections
43573 $ref: "#/definitions/lag-link"
43576 Metadata for license group.
43577 ###### Related Nodes
43578 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
43579 - TO vce( license BelongsTo vce, MANY2ONE)(4)
43581 -(4) IF this TO node is deleted, this LICENSE is DELETED also
43588 description: Unique ID for the license group the resource belongs to, should be uuid.
43591 description: Unique ID of a license resource.
43594 description: Concurrency value
43598 $ref: "#/definitions/relationship"
43601 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
43606 $ref: "#/definitions/license"
43609 describes a line-of-business
43610 ###### Related Nodes
43611 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
43614 - line-of-business-name
43616 line-of-business-name:
43618 description: Name of the line-of-business (product)
43621 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43625 $ref: "#/definitions/relationship"
43628 Collection of lines-of-business
43633 $ref: "#/definitions/line-of-business"
43636 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
43637 ###### Related Nodes
43638 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
43639 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
43640 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
43641 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
43642 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
43643 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
43644 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
43645 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
43646 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
43647 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
43648 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
43649 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
43650 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
43651 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
43653 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
43660 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
43663 description: Type of logical link, e.g., evc
43666 description: Captures the numeric part of the speed
43669 description: Captures the units corresponding to the speed
43672 description: v4, v6, or ds for dual stack
43675 description: For example, static or BGP
43678 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43679 model-invariant-id:
43681 description: the ASDC model id for this resource or service model.
43684 description: the ASDC model version for this resource or service model.
43685 persona-model-version:
43687 description: the ASDC model version for this resource or service model.
43690 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43691 widget-model-version:
43693 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43694 operational-status:
43696 description: Indication of operational status of the logical link.
43699 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43702 description: Indication of the network use of the logical link.
43705 description: Alias or alternate name (CLCI or D1 name).
43708 description: UUID of the logical-link, SDNC generates this.
43711 description: Circuit id
43714 description: Reason for this entity, role it is playing
43718 $ref: "#/definitions/relationship"
43721 Collection of logical connections
43726 $ref: "#/definitions/logical-link"
43729 Collection of metadatum (key/value pairs)
43734 $ref: "#/definitions/metadatum"
43738 ###### Related Nodes
43739 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
43740 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
43741 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
43742 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
43744 -(4) IF this TO node is deleted, this METADATUM is DELETED also
43755 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43758 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
43759 ###### Related Nodes
43760 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
43761 - FROM instance-group( instance-group Targets model, MANY2MANY)
43762 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
43763 - FROM named-query( named-query AppliesTo model, ONE2MANY)
43764 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
43766 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
43767 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
43770 - model-invariant-id
43773 model-invariant-id:
43775 description: Unique identifier corresponding to the main definition of a model in ASDC
43778 description: Type of the model, e.g., service, resource, widget, etc.
43781 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43785 $ref: "#/definitions/model-ver"
43789 $ref: "#/definitions/relationship"
43790 model-and-named-query-search:
43792 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
43796 $ref: "#/definitions/query-parameters"
43799 $ref: "#/definitions/instance-filters"
43802 $ref: "#/definitions/secondary-filts"
43805 secondary-filter-cut-point:
43809 This is how we would capture constraints defining allowed sets of elements.
43810 ###### Related Nodes
43811 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
43812 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
43814 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
43815 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
43817 - model-constraint-uuid
43818 - constrained-element-set-uuid-to-replace
43820 model-constraint-uuid:
43822 constrained-element-set-uuid-to-replace:
43824 constrained-element-sets:
43827 $ref: "#/definitions/constrained-element-set"
43830 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43836 $ref: "#/definitions/model-constraint"
43839 Defines how other models combine to make up a higher-level model.
43840 ###### Related Nodes
43841 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
43842 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
43843 - TO model-ver( model-element IsA model-ver, MANY2ONE)
43844 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
43845 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
43846 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
43847 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
43849 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
43850 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
43852 - model-element-uuid
43853 - new-data-del-flag
43856 model-element-uuid:
43860 description: Indicates whether this element was created as part of instantiation from this model
43863 description: How many of this type of element are required/allowed
43868 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43872 $ref: "#/definitions/model-element"
43873 description: Defines how other models combine to make up a higher-level model
43877 $ref: "#/definitions/model-constraint"
43878 description: Describes new constraints on this model element that are not part of that model's definition
43882 $ref: "#/definitions/relationship"
43888 $ref: "#/definitions/model-element"
43891 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
43892 ###### Related Nodes
43893 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
43894 - FROM model-element( model-element IsA model-ver, MANY2ONE)
43895 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
43896 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
43898 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
43899 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
43900 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
43909 description: Unique identifier corresponding to one version of a model in ASDC
43912 description: Name of the model, which can change from version to version.
43915 description: Version
43918 description: Description
43921 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43925 $ref: "#/definitions/model-element"
43929 $ref: "#/definitions/metadatum"
43933 $ref: "#/definitions/relationship"
43939 $ref: "#/definitions/model-ver"
43942 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
43947 $ref: "#/definitions/model"
43948 multicast-configuration:
43950 ###### Related Nodes
43951 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
43954 - multicast-configuration-id
43955 - multicast-protocol
43958 multicast-configuration-id:
43960 description: Unique id of multicast configuration.
43961 multicast-protocol:
43963 description: protocol of multicast configuration
43966 description: rp type of multicast configuration
43969 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43973 $ref: "#/definitions/relationship"
43974 multicast-configurations:
43976 multicast configuration of generic-vnf ip-address
43978 multicast-configuration:
43981 $ref: "#/definitions/multicast-configuration"
43987 $ref: "#/definitions/named-query"
43991 ###### Related Nodes
43992 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
43993 - TO model( named-query AppliesTo model, ONE2MANY)
43994 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
43996 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
44000 - named-query-version
44006 named-query-version:
44008 required-input-param:
44014 named-query-elements:
44017 $ref: "#/definitions/named-query-element"
44021 $ref: "#/definitions/relationship"
44022 named-query-element:
44025 ###### Related Nodes
44026 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
44027 - TO model( named-query-element IsA model, MANY2ONE)
44028 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
44029 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
44030 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
44031 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
44033 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
44034 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
44036 - named-query-element-uuid
44038 named-query-element-uuid:
44040 property-collect-list:
44044 property-limit-desc:
44048 named-query-elements:
44051 $ref: "#/definitions/named-query-element"
44055 $ref: "#/definitions/related-lookup"
44056 property-constraints:
44059 $ref: "#/definitions/property-constraint"
44063 $ref: "#/definitions/relationship"
44064 named-query-elements:
44066 named-query-element:
44069 $ref: "#/definitions/named-query-element"
44072 Namespace for network inventory resources.
44077 $ref: "#/definitions/logical-link"
44081 $ref: "#/definitions/site-pair-set"
44085 $ref: "#/definitions/vpn-binding"
44089 $ref: "#/definitions/vpls-pe"
44090 multicast-configurations:
44093 $ref: "#/definitions/multicast-configuration"
44097 $ref: "#/definitions/vce"
44101 $ref: "#/definitions/vnfc"
44105 $ref: "#/definitions/l3-network"
44109 $ref: "#/definitions/network-policy"
44113 $ref: "#/definitions/generic-vnf"
44117 $ref: "#/definitions/lag-link"
44121 $ref: "#/definitions/newvce"
44125 $ref: "#/definitions/pnf"
44129 $ref: "#/definitions/physical-link"
44130 ipsec-configurations:
44133 $ref: "#/definitions/ipsec-configuration"
44134 route-table-references:
44137 $ref: "#/definitions/route-table-reference"
44141 $ref: "#/definitions/instance-group"
44145 $ref: "#/definitions/zone"
44151 $ref: "#/definitions/network-policy"
44154 ###### Related Nodes
44155 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
44156 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
44159 - network-policy-id
44163 description: UUID representing unique key to this instance
44164 network-policy-fqdn:
44166 description: Contrail FQDN for the policy
44169 description: ID for the openStack Heat instance
44172 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44176 $ref: "#/definitions/relationship"
44179 Network profile populated by SDN-GP for SNMP
44180 ###### Related Nodes
44181 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
44188 description: Unique name of network profile.
44191 description: Encrypted SNMP community string
44194 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44198 $ref: "#/definitions/relationship"
44201 Collection of network profiles
44206 $ref: "#/definitions/network-profile"
44209 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
44210 ###### Related Nodes
44211 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
44213 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
44221 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44224 description: Name of VNF.
44227 description: Alternate name of VNF.
44230 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.
44233 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44234 operational-status:
44236 description: Indicator for whether the resource is considered operational
44239 description: OBSOLETE - do not use
44242 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).
44245 description: Client should send valid enumerated value.
44248 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44249 ipv4-loopback0-address:
44251 description: v4 Loopback0 address
44252 orchestration-status:
44254 description: Orchestration status of this VNF, mastered by MSO.
44257 description: Heat stack id corresponding to this instance, managed by MSO
44260 description: Corresponds to the SDN-C catalog id used to configure this VCE
44264 $ref: "#/definitions/relationship"
44268 $ref: "#/definitions/l-interface"
44271 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
44276 $ref: "#/definitions/newvce"
44279 inventory-item-data:
44282 $ref: "#/definitions/inventory-item-data"
44283 notification-event:
44287 notification-event-header:
44289 $ref: "#/definitions/notification-event-header"
44290 notification-event-header:
44331 $ref: "#/definitions/key-data"
44336 OAM network, to be deprecated shortly. Do not use for new purposes.
44337 ###### Related Nodes
44338 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
44339 - TO complex( oam-network AppliesTo complex, MANY2MANY)
44340 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
44349 description: UUID of the network. Unique across a cloud-region
44352 description: Name of the network.
44356 description: cvlan-id
44357 ipv4-oam-gateway-address:
44359 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
44360 ipv4-oam-gateway-address-prefix-length:
44363 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
44366 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44370 $ref: "#/definitions/relationship"
44373 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
44378 $ref: "#/definitions/oam-network"
44379 operational-environment:
44381 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
44382 ###### Related Nodes
44383 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
44384 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
44387 - operational-environment-id
44388 - operational-environment-name
44389 - operational-environment-type
44390 - operational-environment-status
44394 operational-environment-id:
44396 description: UUID of an operational environment
44397 operational-environment-name:
44399 description: Operational Environment name
44400 operational-environment-type:
44402 description: Operational Environment Type.
44403 operational-environment-status:
44405 description: Status
44408 description: Tenant Context.
44411 description: Workload Context.
44414 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44418 $ref: "#/definitions/relationship"
44419 operational-environments:
44421 a logical partition of the cloud which allows to have multiple environments in the production AIC.
44423 operational-environment:
44426 $ref: "#/definitions/operational-environment"
44429 Allows for legacy POST of old-style and new-style models
44431 - model-invariant-id
44432 - model-name-version-id
44438 model-invariant-id:
44440 description: Unique identifier corresponding to the main definition of a model in ASDC
44441 model-name-version-id:
44443 description: Unique identifier corresponding to one version of a model in ASDC
44446 description: Type of the model, e.g., service, resource, widget, etc.
44449 description: Name of the model, which can change from version to version.
44452 description: Invariant unique ID which does not change from version to version
44455 description: Version
44458 description: Description
44461 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44464 $ref: "#/definitions/model-vers"
44467 $ref: "#/definitions/relationship-list"
44470 Collection of owning-entities
44475 $ref: "#/definitions/owning-entity"
44478 describes an owning-entity
44479 ###### Related Nodes
44480 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
44484 - owning-entity-name
44488 description: UUID of an owning entity
44489 owning-entity-name:
44491 description: Owning entity name
44494 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44498 $ref: "#/definitions/relationship"
44501 Physical interface (e.g., nic)
44502 ###### Related Nodes
44503 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
44504 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
44505 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
44506 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
44507 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
44508 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
44509 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
44511 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
44512 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
44513 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
44520 description: Name that identifies the physical interface
44523 description: Captures the numeric part of the speed
44526 description: Captures the units corresponding to the speed
44529 description: Nature of the services and connectivity on this port.
44530 equipment-identifier:
44532 description: CLEI or other specification for p-interface hardware.
44535 description: Role specification for p-interface hardware.
44538 description: Indicates the physical properties of the interface.
44541 description: Trigger for operational monitoring of this resource by Service Assurance systems.
44544 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44547 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
44551 $ref: "#/definitions/relationship"
44555 $ref: "#/definitions/l-interface"
44558 Collection of physical interfaces.
44563 $ref: "#/definitions/p-interface"
44566 Collection of physical connections, typically between p-interfaces
44567 ###### Related Nodes
44568 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
44570 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
44576 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44579 description: Captures the numeric part of the speed
44582 description: Captures the units corresponding to the speed
44585 description: Circuit it
44588 description: Dual access mode (e.g., primary, secondary
44591 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
44592 service-provider-name:
44594 description: Name of the service Provider on this link.
44597 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44601 $ref: "#/definitions/relationship"
44604 Collection of physical connections, typically between p-interfaces
44609 $ref: "#/definitions/physical-link"
44612 describes a platform
44613 ###### Related Nodes
44614 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
44621 description: Name of the platform
44624 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44628 $ref: "#/definitions/relationship"
44631 Collection of platforms
44636 $ref: "#/definitions/platform"
44639 PNF represents a physical network function. typically equipment used in the D1 world.
44640 ###### Related Nodes
44641 - TO complex( pnf LocatedIn complex, MANY2ONE)
44642 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
44643 - TO zone( pnf LocatedIn zone, MANY2ONE)
44644 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
44645 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
44646 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
44647 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
44649 -(1) IF this PNF node is deleted, this FROM node is DELETED also
44656 description: unique name of Physical Network Function.
44659 description: name of Physical Network Function.
44662 description: source of name2
44665 description: id of pnf
44668 description: Equipment type. Source of truth should define valid values.
44671 description: Equipment vendor. Source of truth should define valid values.
44674 description: Equipment model. Source of truth should define valid values.
44677 description: identifier of managed by company or customer
44680 description: ipv4-oam-address with new naming convention for IP addresses
44683 description: sw-version is the version of SW for the hosted application on the PNF.
44686 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.
44689 description: ID of the physical frame (relay rack) where pnf is installed.
44692 description: Serial number of the device
44693 ipaddress-v4-loopback-0:
44695 description: IPV4 Loopback 0 address
44696 ipaddress-v6-loopback-0:
44698 description: IPV6 Loopback 0 address
44701 description: IPV4 AIM address
44704 description: IPV6 AIM address
44707 description: IPV6 OAM address
44710 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44713 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44716 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
44719 description: Nf Role is the role performed by this instance in the network.
44723 $ref: "#/definitions/relationship"
44727 $ref: "#/definitions/p-interface"
44731 $ref: "#/definitions/lag-interface"
44734 Collection of Physical Network Functions.
44739 $ref: "#/definitions/pnf"
44742 Used to capture the network interfaces of this VCE
44743 ###### Related Nodes
44744 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
44745 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
44747 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
44748 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
44751 - orchestration-status
44755 description: Unique ID of the interface
44756 neutron-network-id:
44758 description: Neutron network id of this Interface
44759 neutron-network-name:
44761 description: Neutron network name of this Interface
44764 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44767 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44770 description: Unique ID for port group in vmware
44773 description: Likely to duplicate value of neutron network name
44776 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
44777 orchestration-status:
44779 description: Orchestration status of this VNF, mastered by MSO
44782 description: Heat stack id corresponding to this instance, managed by MSO
44785 description: Corresponds to the SDN-C catalog id used to configure this VCE
44789 $ref: "#/definitions/cvlan-tag-entry"
44793 $ref: "#/definitions/relationship"
44799 $ref: "#/definitions/port-group"
44802 describes the project
44803 ###### Related Nodes
44804 - TO service-instance( project Uses service-instance, ONE2MANY)
44811 description: Name of the project deploying a service
44814 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44818 $ref: "#/definitions/relationship"
44821 Collection of projects
44826 $ref: "#/definitions/project"
44829 Property holder for query properties or instance properties
44835 property-constraint:
44838 ###### Related Nodes
44839 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
44841 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
44843 - property-constraint-uuid
44848 property-constraint-uuid:
44858 property-constraints:
44860 property-constraint:
44863 $ref: "#/definitions/property-constraint"
44866 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
44867 ###### Related Nodes
44868 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
44869 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
44870 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
44871 - TO complex( pserver LocatedIn complex, MANY2ONE)
44872 - TO zone( pserver LocatedIn zone, MANY2ONE)
44873 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
44874 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
44875 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
44876 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
44877 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
44879 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
44880 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
44888 description: Value from executing hostname on the compute node.
44891 description: PTNII name
44895 description: Number of cpus
44899 description: Disk size, in GBs
44903 description: RAM size, in MBs
44906 description: Equipment type. Source of truth should define valid values.
44909 description: Equipment vendor. Source of truth should define valid values.
44912 description: Equipment model. Source of truth should define valid values.
44915 description: Fully-qualified domain name
44918 description: URL to endpoint where AAI can get more details
44921 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
44924 description: Serial number, may be queried
44925 ipaddress-v4-loopback-0:
44927 description: IPV4 Loopback 0 address
44928 ipaddress-v6-loopback-0:
44930 description: IPV6 Loopback 0 address
44933 description: IPV4 AIM address
44936 description: IPV6 AIM address
44939 description: IPV6 OAM address
44942 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44945 description: ID of Pserver
44948 description: internet topology of Pserver
44951 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.
44954 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44957 description: alternative pserver name
44960 description: purpose of pserver
44963 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
44967 $ref: "#/definitions/relationship"
44971 $ref: "#/definitions/p-interface"
44975 $ref: "#/definitions/lag-interface"
44978 Collection of compute hosts.
44983 $ref: "#/definitions/pserver"
44986 QueryParameters for performing a named-query or model query
44990 $ref: "#/definitions/named-query"
44993 $ref: "#/definitions/overloaded-model"
44997 ###### Related Nodes
44998 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
45000 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
45002 - related-lookup-uuid
45004 - source-node-property
45006 - target-node-property
45008 related-lookup-uuid:
45012 source-node-property:
45016 target-node-property:
45018 property-collect-list:
45025 $ref: "#/definitions/relationship"
45031 $ref: "#/definitions/related-lookup"
45032 related-to-property:
45036 description: Key part of a key/value pair
45039 description: Value part of a key/value pair
45044 description: A keyword provided by A&AI to indicate type of node.
45047 description: URL to the object in A&AI.
45051 $ref: "#/definitions/relationship-data"
45055 - relationship-value
45059 description: A keyword provided by A&AI to indicate an attribute.
45060 relationship-value:
45062 description: Value of the attribute.
45068 $ref: "#/definitions/relationship"
45069 reserved-prop-names:
45071 Internal map to define some reserved properties of a vertex
45073 last-mod-source-of-truth:
45091 Response container for the results of a named-query or model query
45093 inventory-response-items:
45095 $ref: "#/definitions/inventory-response-items"
45100 description: The specific type of node in the A&AI graph
45103 description: The URL to the specific resource
45104 route-table-reference:
45106 Openstack route table reference.
45107 ###### Related Nodes
45108 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
45111 - route-table-reference-id
45112 - route-table-reference-fqdn
45114 route-table-reference-id:
45116 description: Route Table Reference id, UUID assigned to this instance.
45117 route-table-reference-fqdn:
45119 description: FQDN entry in the route table.
45122 description: Concurrency value
45126 $ref: "#/definitions/relationship"
45127 route-table-references:
45129 Collection of openstack route table references
45131 route-table-reference:
45134 $ref: "#/definitions/route-table-reference"
45137 Route target information
45138 ###### Related Nodes
45139 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
45141 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
45143 - global-route-target
45144 - route-target-role
45146 global-route-target:
45148 description: Number used to identify an RT, globally unique in the network
45151 description: Role assigned to this route target
45154 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45158 $ref: "#/definitions/relationship"
45161 Collection of route target information
45166 $ref: "#/definitions/route-target"
45169 ###### Related Nodes
45170 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
45171 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
45173 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
45174 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
45176 - routing-instance-id
45178 routing-instance-id:
45180 description: Unique id of routing instance
45183 description: rpm owner
45186 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45190 $ref: "#/definitions/site-pair"
45194 $ref: "#/definitions/relationship"
45197 set of probes related to generic-vnf routing instance
45202 $ref: "#/definitions/routing-instance"
45207 $ref: "#/definitions/oam-networks"
45208 az-and-dvs-switches:
45211 $ref: "#/definitions/az-and-dvs-switches"
45214 edge-tag-query-result:
45216 $ref: "#/definitions/edge-tag-query-result"
45217 edge-tag-query-request:
45219 $ref: "#/definitions/edge-tag-query-request"
45222 $ref: "#/definitions/search-results"
45225 $ref: "#/definitions/sdn-zone-response"
45231 $ref: "#/definitions/result-data"
45234 SecondaryFilt for performing a named-query or model query
45245 SecondaryFilts for performing a named-query or model query
45250 $ref: "#/definitions/secondary-filt"
45251 segmentation-assignment:
45253 Openstack segmentation assignment.
45254 ###### Related Nodes
45255 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
45257 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
45263 description: Route Table Reference id, UUID assigned to this instance.
45266 description: Concurrency value
45270 $ref: "#/definitions/relationship"
45271 segmentation-assignments:
45273 Collection of openstack segmentation assignments
45275 segmentation-assignment:
45278 $ref: "#/definitions/segmentation-assignment"
45281 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
45284 - service-description
45288 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
45289 service-description:
45291 description: Description of the service
45294 description: URL to endpoint where AAI can get more details
45297 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45300 description: service version
45304 $ref: "#/definitions/relationship"
45305 service-capabilities:
45307 Collection of service capabilities.
45309 service-capability:
45312 $ref: "#/definitions/service-capability"
45313 service-capability:
45315 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
45316 ###### Related Nodes
45317 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
45318 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
45320 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
45328 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
45331 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.
45334 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45338 $ref: "#/definitions/relationship"
45339 service-design-and-creation:
45341 Namespace for objects managed by ASDC
45346 $ref: "#/definitions/vnf-image"
45350 $ref: "#/definitions/service"
45351 service-capabilities:
45354 $ref: "#/definitions/service-capability"
45358 $ref: "#/definitions/model"
45362 $ref: "#/definitions/named-query"
45365 Instance of a service
45366 ###### Related Nodes
45367 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
45368 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
45369 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
45370 - TO connector( service-instance Uses connector, MANY2MANY)
45371 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
45372 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
45373 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
45374 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
45375 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
45376 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
45377 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
45378 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
45379 - TO vce( service-instance ComposedOf vce, ONE2MANY)
45380 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
45381 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
45382 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
45384 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
45385 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
45386 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
45388 - service-instance-id
45390 service-instance-id:
45392 description: Uniquely identifies this instance of a service
45393 service-instance-name:
45395 description: This field will store a name assigned to the service-instance.
45396 model-invariant-id:
45398 description: the ASDC model id for this resource or service model.
45401 description: the ASDC model version for this resource or service model.
45402 persona-model-version:
45404 description: the ASDC model version for this resource or service model.
45407 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45408 widget-model-version:
45410 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45413 description: Indicates the total bandwidth to be used for this service.
45416 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
45417 bandwidth-down-wan1:
45419 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
45422 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
45423 bandwidth-down-wan2:
45425 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
45428 description: URL customers will use to access the vHN Portal.
45429 service-instance-location-id:
45431 description: An identifier that customers assign to the location where this service is being used.
45434 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45437 description: Path to the controller object.
45438 orchestration-status:
45440 description: Orchestration status of this service.
45444 $ref: "#/definitions/relationship"
45448 $ref: "#/definitions/metadatum"
45449 allotted-resources:
45452 $ref: "#/definitions/allotted-resource"
45455 Collection of service instances
45460 $ref: "#/definitions/service-instance"
45461 service-subscription:
45463 Object that group service instances.
45464 ###### Related Nodes
45465 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
45466 - TO tenant( service-subscription Uses tenant, MANY2MANY)
45467 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
45469 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
45470 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
45476 description: Value defined by orchestration to identify this service across ECOMP.
45477 temp-ub-sub-account-id:
45479 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
45482 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45486 $ref: "#/definitions/service-instance"
45490 $ref: "#/definitions/relationship"
45491 service-subscriptions:
45493 Collection of objects that group service instances.
45495 service-subscription:
45498 $ref: "#/definitions/service-subscription"
45501 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
45506 $ref: "#/definitions/service"
45509 ###### Related Nodes
45510 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
45511 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
45513 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
45514 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
45520 description: unique identifier of probe
45523 description: Prefix address
45526 description: Prefix address
45529 description: ip version, v4, v6
45530 destination-hostname:
45532 description: Hostname of the destination equipment to which SLAs are measured against.
45533 destination-equip-type:
45535 description: The type of destinatination equipment. Could be Router, etc.
45538 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45539 classes-of-service:
45542 $ref: "#/definitions/class-of-service"
45546 $ref: "#/definitions/relationship"
45549 Set of instances for probes used to measure service level agreements
45550 ###### Related Nodes
45551 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
45552 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
45554 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
45560 description: Unique id of site pair set.
45563 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45567 $ref: "#/definitions/routing-instance"
45571 $ref: "#/definitions/relationship"
45574 Collection of sets of instances for probes related to generic-vnf
45579 $ref: "#/definitions/site-pair-set"
45587 $ref: "#/definitions/site-pair"
45591 ###### Related Nodes
45592 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
45593 - FROM vserver( vserver Uses snapshot, ONE2ONE)
45600 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
45603 description: Snapshot name
45604 snapshot-architecture:
45606 description: Operating system architecture
45607 snapshot-os-distro:
45609 description: The common name of the operating system distribution in lowercase
45610 snapshot-os-version:
45612 description: The operating system version as specified by the distributor.
45615 description: The application that the image instantiates.
45616 application-vendor:
45618 description: The vendor of the application.
45619 application-version:
45621 description: The version of the application.
45624 description: URL to endpoint where AAI can get more details
45627 description: This field contains the UUID of the previous snapshot (if any).
45630 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45634 $ref: "#/definitions/relationship"
45637 Collection of openstack snapshots
45642 $ref: "#/definitions/snapshot"
45645 SR-IOV Physical Function
45646 ###### Related Nodes
45647 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
45648 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
45650 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
45656 description: Identifier for the sriov-pf
45659 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45663 $ref: "#/definitions/relationship"
45666 Collection of SR-IOV Physical Functions.
45671 $ref: "#/definitions/sriov-pf"
45674 SR-IOV Virtual Function (not to be confused with virtual network function)
45675 ###### Related Nodes
45676 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
45678 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
45684 description: PCI ID used to identify the sriov-vf
45687 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
45690 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
45693 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
45694 vf-vlan-anti-spoof-check:
45696 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.
45697 vf-mac-anti-spoof-check:
45699 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.
45702 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
45703 vf-broadcast-allow:
45705 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
45706 vf-unknown-multicast-allow:
45708 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
45709 vf-unknown-unicast-allow:
45711 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
45714 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
45717 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
45720 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45721 neutron-network-id:
45723 description: Neutron network id of the interface
45727 $ref: "#/definitions/relationship"
45730 Collection of SR-IOV Virtual Functions.
45735 $ref: "#/definitions/sriov-vf"
45744 ###### Related Nodes
45745 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
45746 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
45747 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
45749 -(4) IF this TO node is deleted, this SUBNET is DELETED also
45750 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
45758 description: Subnet ID, should be UUID.
45761 description: Name associated with the subnet.
45764 description: Neutron id of this subnet
45767 description: gateway ip address
45768 network-start-address:
45770 description: network start address
45773 description: cidr mask
45776 description: ip version
45777 orchestration-status:
45779 description: Orchestration status of this VNF, mastered by MSO
45782 description: dhcp enabled
45785 description: the start address reserved for use by dhcp
45788 description: the last address reserved for use by dhcp
45791 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45795 $ref: "#/definitions/relationship"
45801 $ref: "#/definitions/subnet"
45802 tagged-inventory-item-list:
45807 $ref: "#/definitions/inventory-item"
45811 ###### Related Nodes
45812 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
45813 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
45814 - TO l3-network( tenant Uses l3-network, MANY2MANY)
45815 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
45816 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
45817 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
45819 -TENANT cannot be deleted if related to VSERVER
45827 description: Unique id relative to the cloud-region.
45830 description: Readable name of tenant
45833 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45837 $ref: "#/definitions/vserver"
45841 $ref: "#/definitions/relationship"
45844 Collection of openstack tenants.
45849 $ref: "#/definitions/tenant"
45852 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
45853 ###### Related Nodes
45854 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
45856 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
45859 - bandwidth-up-wan1
45860 - bandwidth-down-wan1
45861 - bandwidth-up-wan2
45862 - bandwidth-down-wan2
45866 description: Allotted Resource id UUID assigned to this instance.
45869 description: The WAN uplink bandwidth for WAN1
45870 bandwidth-down-wan1:
45872 description: The WAN downlink bandwidth for WAN1
45875 description: The WAN uplink bandwidth for WAN2
45876 bandwidth-down-wan2:
45878 description: The WAN downlink bandwidth for WAN2
45881 description: Concurrency value
45885 $ref: "#/definitions/relationship"
45888 This object is used to store the specific tunnel cross connect aspects of an allotted resource
45893 $ref: "#/definitions/tunnel-xconnect"
45896 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
45905 $ref: "#/definitions/update-node-key"
45911 $ref: "#/definitions/action"
45920 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
45921 ###### Related Nodes
45922 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
45923 - TO complex( vce LocatedIn complex, MANY2MANY)
45924 - TO vserver( vce HostedOn vserver, ONE2MANY)
45925 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
45926 - FROM license( license BelongsTo vce, MANY2ONE)(1)
45927 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
45928 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
45930 -(1) IF this VCE node is deleted, this FROM node is DELETED also
45938 description: Unique id of VNF. This is unique across the graph.
45941 description: Name of VNF.
45944 description: Alternate name of VNF.
45947 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.
45950 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
45951 regional-resource-zone:
45953 description: Regional way of organizing pservers, source of truth should define values
45956 description: Trigger for operational monitoring of this resource by Service Assurance systems.
45957 operational-status:
45959 description: Indicator for whether the resource is considered operational
45962 description: OBSOLETE - do not use
45965 description: Network role being played by this VNF
45966 orchestration-status:
45968 description: Orchestration status of this VNF, mastered by MSO
45971 description: Heat stack id corresponding to this instance, managed by MSO
45974 description: Corresponds to the SDN-C catalog id used to configure this VCE
45977 description: Unique ID of VPE connected to this VCE.
45978 v6-vce-wan-address:
45980 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
45983 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
45986 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45987 ipv4-loopback0-address:
45989 description: Loopback0 address
45990 entitlement-resource-uuid:
45992 description: OBSOLETE - see child relationships
45996 $ref: "#/definitions/port-group"
46000 $ref: "#/definitions/license"
46004 $ref: "#/definitions/entitlement"
46008 $ref: "#/definitions/relationship"
46011 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
46016 $ref: "#/definitions/vce"
46019 a deployment unit of VNFCs
46020 ###### Related Nodes
46021 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
46022 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
46023 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
46024 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
46025 - TO vserver( vf-module Uses vserver, ONE2MANY)
46027 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
46028 -VF-MODULE cannot be deleted if related to VNFC
46032 - is-base-vf-module
46036 description: Unique ID of vf-module.
46039 description: Name of vf-module
46042 description: Heat stack id corresponding to this instance.
46043 orchestration-status:
46045 description: orchestration status of this vf-module, mastered by MSO
46048 description: used to indicate whether or not this object is base vf module
46051 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46052 model-invariant-id:
46054 description: the ASDC model id for this resource or service model.
46057 description: the ASDC model version for this resource or service model.
46058 persona-model-version:
46060 description: the ASDC model version for this resource or service model.
46061 model-customization-id:
46063 description: captures the id of all the configuration used to customize the resource for the service.
46066 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
46067 widget-model-version:
46069 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
46070 contrail-service-instance-fqdn:
46072 description: the Contrail unique ID for a service-instance
46076 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
46079 description: Path to the controller object.
46083 $ref: "#/definitions/relationship"
46086 Collection of vf-modules, a deployment unit of VNFCs
46091 $ref: "#/definitions/vf-module"
46094 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
46095 ###### Related Nodes
46096 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
46098 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
46104 description: indicates whether the VIG is for AVPN or INTERNET
46107 description: v4 IP of the vig server
46110 description: v6 IP of the vig server
46113 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46117 $ref: "#/definitions/relationship"
46123 $ref: "#/definitions/vig-server"
46124 vip-ipv4-address-list:
46127 ###### Related Nodes
46128 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
46129 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
46130 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
46131 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
46138 description: IP address
46139 vip-ipv4-prefix-length:
46142 description: Prefix length, 32 for single address
46146 description: Inner VLAN tag
46150 description: Outer VLAN tag
46153 description: Indicator of fixed or floating address
46156 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46157 neutron-network-id:
46159 description: Neutron network id of the interface that address belongs to
46162 description: Neutron id of subnet that address belongs to
46166 $ref: "#/definitions/relationship"
46167 vip-ipv6-address-list:
46170 ###### Related Nodes
46171 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
46172 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
46173 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
46174 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
46181 description: IP address
46182 vip-ipv6-prefix-length:
46185 description: Prefix length, 128 for single address
46189 description: Inner VLAN tag
46193 description: Outer VLAN tag
46196 description: Indicator of fixed or floating address
46199 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46200 neutron-network-id:
46202 description: Neutron network id of the interface that address belongs to
46205 description: Neutron id of subnet that address belongs to
46209 $ref: "#/definitions/relationship"
46210 virtual-data-center:
46212 Virtual organization of cloud infrastructure elements in a data center context
46213 ###### Related Nodes
46214 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
46215 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
46216 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
46224 description: Unique ID of the vdc
46227 description: Name of the virtual data center
46230 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46234 $ref: "#/definitions/relationship"
46235 virtual-data-centers:
46237 Virtual organization of cloud infrastructure elements in a data center context
46239 virtual-data-center:
46242 $ref: "#/definitions/virtual-data-center"
46246 ###### Related Nodes
46247 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
46248 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
46249 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
46250 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
46251 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
46252 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
46253 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
46255 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
46256 -(2) IF this VLAN node is deleted, this TO node is DELETED also
46257 -(4) IF this TO node is deleted, this VLAN is DELETED also
46264 description: String that identifies the interface
46268 description: Inner VLAN tag
46272 description: Outer VLAN tag
46275 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46278 description: Captures the numeric part of the speed
46281 description: Captures the units corresponding to the speed
46284 description: Used to describe (the service associated with) the vlan
46285 backdoor-connection:
46287 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
46290 description: This indicates the customers VPN ID associated with this vlan
46291 orchestration-status:
46293 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
46296 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
46300 $ref: "#/definitions/relationship"
46301 l3-interface-ipv4-address-list:
46304 $ref: "#/definitions/l3-interface-ipv4-address-list"
46305 l3-interface-ipv6-address-list:
46308 $ref: "#/definitions/l3-interface-ipv6-address-list"
46314 $ref: "#/definitions/vlan"
46323 description: Unique id of VNF. This is unique across the graph.
46326 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
46327 ###### Related Nodes
46328 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
46330 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
46335 - application-vendor
46339 description: Unique ID of this asset
46342 description: The application that the image instantiates.
46343 application-vendor:
46345 description: The vendor of the application.
46346 application-version:
46348 description: The version of the application.
46351 description: URL to endpoint where AAI can get more details
46354 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46358 $ref: "#/definitions/relationship"
46361 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
46366 $ref: "#/definitions/vnf-image"
46369 ###### Related Nodes
46370 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
46371 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
46372 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
46374 -(4) IF this TO node is deleted, this VNFC is DELETED also
46377 - vnfc-function-code
46380 - is-closed-loop-disabled
46384 description: Unique ID of vnfc.
46385 vnfc-function-code:
46387 description: function code
46393 description: prov status of this vnfc
46394 orchestration-status:
46396 description: Orchestration status of this VNF, mastered by APP-C
46397 ipaddress-v4-oam-vip:
46399 description: Oam V4 vip address of this vnfc
46402 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
46403 is-closed-loop-disabled:
46405 description: used to indicate whether closed loop function is enabled on this node
46408 description: Group notation of VNFC
46411 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46415 $ref: "#/definitions/relationship"
46418 virtual network components associated with a vserver from application controller.
46423 $ref: "#/definitions/vnfc"
46426 Ephemeral Block storage volume.
46427 ###### Related Nodes
46428 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
46430 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
46437 description: Unique ID of block storage volume relative to the vserver.
46440 description: URL to endpoint where AAI can get more details
46443 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46447 $ref: "#/definitions/relationship"
46450 Persistent block-level storage.
46451 ###### Related Nodes
46452 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
46453 - TO complex( volume-group LocatedIn complex, MANY2ONE)
46454 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
46455 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
46456 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
46460 - volume-group-name
46465 description: Unique ID of volume-group.
46468 description: Name of the volume group.
46471 description: Heat stack id corresponding to this volume-group
46474 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.
46475 orchestration-status:
46477 description: Orchestration status of this volume-group
46478 model-customization-id:
46480 description: captures the id of all the configuration used to customize the resource for the service.
46481 vf-module-model-customization-id:
46483 description: helps relate the volume group to the vf-module whose components will require the volume group
46486 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46490 $ref: "#/definitions/relationship"
46493 Collection of persistent block-level storage.
46498 $ref: "#/definitions/volume-group"
46501 Collection of ephemeral Block storage volumes.
46506 $ref: "#/definitions/volume"
46509 VPLS Provider Edge routers.
46510 ###### Related Nodes
46511 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
46512 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
46513 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
46514 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
46516 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
46524 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
46527 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).
46530 description: Client should send valid enumerated value, e.g., VPLS-PE.
46534 description: Temporary location for stag to get to VCE
46537 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46541 $ref: "#/definitions/relationship"
46545 $ref: "#/definitions/p-interface"
46549 $ref: "#/definitions/lag-interface"
46552 Collection of VPLS Provider Edge routers
46557 $ref: "#/definitions/vpls-pe"
46561 ###### Related Nodes
46562 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
46563 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
46564 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
46566 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
46567 -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
46575 description: VPN ID, globally unique within A&AI
46578 description: VPN Name
46581 description: the platform associated with the VPN example AVPN, Mobility
46584 description: Type of the vpn, should be taken from enumerated/valid values
46585 route-distinguisher:
46587 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
46590 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46594 $ref: "#/definitions/route-target"
46598 $ref: "#/definitions/relationship"
46599 description: l3-networks relate to vpn-bindings
46605 $ref: "#/definitions/vpn-binding"
46608 Virtual Servers, aka virtual machine or VM.
46609 ###### Related Nodes
46610 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
46611 - TO flavor( vserver Uses flavor, MANY2ONE)
46612 - TO image( vserver Uses image, MANY2ONE)
46613 - TO pserver( vserver HostedOn pserver, MANY2ONE)
46614 - TO snapshot( vserver Uses snapshot, ONE2ONE)
46615 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
46616 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
46617 - FROM vce( vce HostedOn vserver, ONE2MANY)
46618 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
46619 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
46620 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
46622 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
46623 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
46629 - is-closed-loop-disabled
46633 description: Unique identifier for this vserver relative to its tenant
46636 description: Name of vserver
46639 description: Alternative name of vserver
46642 description: Trigger for operational monitoring of this resource by Service Assurance systems.
46645 description: URL to endpoint where AAI can get more details
46648 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.
46649 is-closed-loop-disabled:
46651 description: Used to indicate whether closed loop function is enabled on this node
46654 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46658 $ref: "#/definitions/volume"
46662 $ref: "#/definitions/relationship"
46666 $ref: "#/definitions/l-interface"
46669 Collection of virtual Servers, aka virtual machines or VMs.
46674 $ref: "#/definitions/vserver"
46677 A zone is a grouping of assets in a location homing to the same connections into the CBB
46678 ###### Related Nodes
46679 - TO complex( zone LocatedIn complex, MANY2ONE)
46680 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
46681 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
46682 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
46692 description: Code assigned by AIC to the zone
46695 description: English name associated with the zone
46698 description: Design of zone [Medium/Large?]
46701 description: Context of zone [production/test]
46704 description: Status of a zone.
46707 description: Concurrency value
46711 $ref: "#/definitions/relationship"
46714 Collection of zones
46719 $ref: "#/definitions/zone"
46728 $ref: "#/patchDefinitions/action-data"
46737 APIs that are more action related than REST (e.g., notify, update).
46741 $ref: "#/patchDefinitions/update"
46744 $ref: "#/patchDefinitions/notify"
46747 Represents a slice or partial piece of a resource that gets separately allotted
46748 ###### Related Nodes
46749 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
46750 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
46751 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
46752 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
46753 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
46754 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
46755 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
46756 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
46758 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
46759 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
46765 description: Allotted Resource id UUID assigned to this instance.
46768 description: The descriptive information assigned to this allotted resource instance
46771 description: Link back to more information in the controller
46772 model-invariant-id:
46774 description: the ASDC model id for this resource or service model.
46777 description: the ASDC model version for this resource or service model.
46778 persona-model-version:
46780 description: the ASDC model version for this resource or service model.
46781 allotted-resources:
46783 This object is used to store slices of services being offered
46788 $ref: "#/patchDefinitions/allotted-resource"
46791 Availability zone, a collection of compute hosts/pservers
46792 ###### Related Nodes
46793 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
46794 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
46795 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
46796 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
46797 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
46798 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
46799 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
46800 - FROM vce( vce Uses availability-zone, MANY2MANY)
46802 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
46803 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
46806 - availability-zone-name
46809 availability-zone-name:
46811 description: Name of the availability zone. Unique across a cloud region
46814 description: Type of hypervisor. Source of truth should define valid values.
46815 operational-status:
46817 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
46818 availability-zones:
46820 Collection of availability zones
46825 $ref: "#/patchDefinitions/availability-zone"
46826 az-and-dvs-switches:
46830 $ref: "#/patchDefinitions/dvs-switches"
46833 $ref: "#/patchDefinitions/availability-zone"
46836 Namespace for business related constructs
46841 $ref: "#/patchDefinitions/connector"
46845 $ref: "#/patchDefinitions/customer"
46848 ###### Related Nodes
46849 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
46851 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
46857 description: unique identifier of probe
46860 description: identifier of probe
46863 description: type of probe
46864 classes-of-service:
46866 class-of-service of probe
46871 $ref: "#/patchDefinitions/class-of-service"
46872 cloud-infrastructure:
46874 Namespace for cloud infrastructure.
46879 $ref: "#/patchDefinitions/complex"
46883 $ref: "#/patchDefinitions/cloud-region"
46887 $ref: "#/patchDefinitions/network-profile"
46891 $ref: "#/patchDefinitions/pserver"
46892 virtual-data-centers:
46895 $ref: "#/patchDefinitions/virtual-data-center"
46898 cloud-region designates an installation of a cloud cluster or region or instantiation
46899 ###### Related Nodes
46900 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
46901 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
46902 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
46903 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
46904 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
46905 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
46906 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
46907 - FROM image( image BelongsTo cloud-region, MANY2ONE)
46908 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
46909 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
46910 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
46911 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
46912 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
46913 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
46915 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
46916 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
46924 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
46927 description: Identifier used by the vendor for the region. Second part of composite key
46930 description: Type of the cloud (e.g., openstack)
46931 owner-defined-type:
46933 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
46934 cloud-region-version:
46936 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
46939 description: URL of the keystone identity service
46942 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
46945 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
46951 $ref: "#/patchDefinitions/cloud-region"
46954 Collection of physical locations that can house cloud-regions.
46955 ###### Related Nodes
46956 - TO l3-network( complex Uses l3-network, MANY2MANY)
46957 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
46958 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
46959 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
46960 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
46961 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
46962 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
46963 - FROM vce( vce LocatedIn complex, MANY2MANY)
46964 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
46965 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
46966 - FROM zone( zone LocatedIn complex, MANY2ONE)
46968 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
46969 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
46972 - physical-location-id
46973 - physical-location-type
46980 physical-location-id:
46982 description: Unique identifier for physical location, e.g., CLLI
46985 description: Data center code which can be an alternate way to identify a complex
46988 description: Gamma complex name for LCP instance.
46991 description: URL of the keystone identity service
46994 Collection of physical locations that can house cloud-regions.
46999 $ref: "#/patchDefinitions/complex"
47002 Port Mirror Configuration.
47003 ###### Related Nodes
47004 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
47005 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
47006 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
47007 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
47008 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
47010 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
47011 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
47012 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
47015 - configuration-type
47016 - configuration-sub-type
47017 - orchestration-status
47018 - operational-status
47019 - configuration-selflink
47020 - model-customization-id
47024 description: UUID assigned to configuration.
47027 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
47028 configuration-name:
47030 description: Name of the configuration.
47031 configuration-type:
47033 description: port-mirroring-configuration.
47034 configuration-sub-type:
47036 description: vprobe, pprobe.
47037 model-invariant-id:
47039 description: the ASDC model id for this resource or service model.
47042 description: the ASDC model version for this resource or service model.
47043 orchestration-status:
47045 description: Orchestration status of the configuration.
47046 operational-status:
47048 description: Indicator for whether the resource is considered operational.
47049 configuration-selflink:
47051 description: URL to endpoint where AAI can get more details from SDN-GC.
47052 model-customization-id:
47054 description: id of the configuration used to customize the resource
47057 Collection of configurations
47062 $ref: "#/patchDefinitions/configuration"
47065 Collection of resource instances used to connect a variety of disparate inventory widgets
47066 ###### Related Nodes
47067 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
47068 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
47069 - FROM service-instance( service-instance Uses connector, MANY2MANY)
47071 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
47073 - resource-instance-id
47075 resource-instance-id:
47077 description: Unique id of resource instance.
47080 Collection of resource instances used to connect a variety of disparate inventory widgets
47085 $ref: "#/patchDefinitions/connector"
47086 constrained-element-set:
47088 This is how we would capture constraints defining allowed sets of elements.
47089 ###### Related Nodes
47090 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
47091 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
47092 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
47094 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
47095 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
47097 - constrained-element-set-uuid
47101 constrained-element-set-uuid:
47107 constrained-element-sets:
47109 constrained-element-set:
47112 $ref: "#/patchDefinitions/constrained-element-set"
47115 ###### Related Nodes
47116 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
47117 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
47119 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
47132 $ref: "#/patchDefinitions/ctag-assignment"
47135 A collection of C tags (vlan tags) grouped for a specific purpose.
47136 ###### Related Nodes
47137 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
47138 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
47139 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
47141 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
47144 - availability-zone-name
47145 - ctag-pool-purpose
47149 description: The Target provider edge router
47150 availability-zone-name:
47152 description: Name of the availability zone
47155 description: Describes what the intended purpose of this pool is.
47158 description: Comma separated list of ctags
47164 $ref: "#/patchDefinitions/ctag-pool"
47167 customer identifiers to provide linkage back to BSS information.
47168 ###### Related Nodes
47169 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
47171 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
47173 - global-customer-id
47177 global-customer-id:
47179 description: Global customer id used across ECOMP to uniquely identify customer.
47182 description: Subscriber name, an alternate way to retrieve a customer.
47185 description: Subscriber type, a way to provide VID with only the INFRA customers.
47188 Collection of customer identifiers to provide linkage back to BSS information.
47193 $ref: "#/patchDefinitions/customer"
47201 description: See mis-na-virtualization-platform.yang
47207 $ref: "#/patchDefinitions/cvlan-tag-entry"
47210 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.
47211 ###### Related Nodes
47212 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
47213 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
47221 description: DVS switch name
47224 description: URL used to reach the vcenter
47227 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
47232 $ref: "#/patchDefinitions/dvs-switch"
47235 Internal map to define the properties of an edge and interpret the map EdgeRules
47253 edge-tag-query-request:
47264 $ref: "#/patchDefinitions/start-node-filter"
47265 include-node-filter:
47268 $ref: "#/patchDefinitions/include-node-filter"
47272 $ref: "#/patchDefinitions/secondary-filter"
47273 edge-tag-query-result:
47275 tagged-inventory-item-list:
47278 $ref: "#/patchDefinitions/tagged-inventory-item-list"
47279 element-choice-set:
47281 This is how we would capture constraints defining allowed sets of elements.
47282 ###### Related Nodes
47283 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
47284 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
47286 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
47287 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
47289 - element-choice-set-uuid
47290 - element-choice-set-name
47292 element-choice-set-uuid:
47294 element-choice-set-name:
47298 element-choice-sets:
47300 element-choice-set:
47303 $ref: "#/patchDefinitions/element-choice-set"
47306 Metadata for entitlement group.
47307 ###### Related Nodes
47308 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
47309 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
47311 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
47318 description: Unique ID for the entitlement group the resource comes from, should be uuid.
47321 description: Unique ID of an entitlement resource.
47324 Entitlements, keyed by group-uuid and resource-uuid, related to license management
47329 $ref: "#/patchDefinitions/entitlement"
47332 Persist EMS address information used by EMS driver.
47333 ###### Related Nodes
47334 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
47336 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
47342 description: Unique ID of EMS.
47348 $ref: "#/patchDefinitions/esr-ems"
47351 Persist common address information of external systems.
47352 ###### Related Nodes
47353 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
47354 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
47355 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
47356 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
47358 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
47360 - esr-system-info-id
47365 esr-system-info-id:
47367 description: Unique ID of esr system info.
47370 description: name of external system.
47373 description: type of external systems.
47376 description: vendor of external systems.
47379 description: version of external systems.
47382 description: url used to access external systems.
47385 description: username used to access external systems.
47388 description: password used to access external systems.
47391 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
47394 description: protocol of third party SDNC, for example netconf/snmp.
47397 description: ca file content if enabled ssl on auth-url.
47400 description: Whether to verify VIM's certificate.
47403 description: service IP of ftp server.
47406 description: service port of ftp server.
47409 description: domain info for authentication.
47412 description: default tenant of VIM.
47415 description: ftp passive mode or not.
47418 description: resource or performance data file path.
47421 description: the status of external system.
47422 esr-system-info-list:
47424 Collection of persistent block-level external system auth info.
47429 $ref: "#/patchDefinitions/esr-system-info"
47430 esr-thirdparty-sdnc:
47432 Persist SDNC address information used by ONAP SDNC.
47433 ###### Related Nodes
47434 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
47435 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
47437 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
47439 - thirdparty-sdnc-id
47441 thirdparty-sdnc-id:
47443 description: Unique ID of SDNC.
47446 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
47449 description: password used to access SDNC server.
47450 esr-thirdparty-sdnc-list:
47452 esr-thirdparty-sdnc:
47455 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
47458 Persist VNFM address information used by VF-C.
47459 ###### Related Nodes
47460 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
47462 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
47468 description: Unique ID of VNFM.
47471 description: indecate the VIM to deploy VNF.
47474 description: certificate url of VNFM.
47480 $ref: "#/patchDefinitions/esr-vnfm"
47483 evc object is an optional child object of the Configuration object.
47484 ###### Related Nodes
47485 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
47487 -(4) IF this TO node is deleted, this EVC is DELETED also
47493 description: Unique/key field for the evc object
47494 forwarding-path-topology:
47496 description: Point-to-Point, Multi-Point
47499 description: Commited Information Rate
47502 description: CIR units
47503 connection-diversity-group-id:
47505 description: Diversity Group ID
47508 description: formerly Performance Group
47509 esp-evc-circuit-id:
47511 description: EVC Circuit ID of ESP EVC
47514 description: Committed Information Rate (For ESP)
47517 description: CIR units (For ESP)
47520 description: Identifies ESP
47521 collector-pop-clli:
47523 description: Collector POP CLLI (from the hostname of the access pnf)
47524 inter-connect-type-ingress:
47526 description: Interconnect type on ingress side of EVC.
47527 tagmode-access-ingress:
47529 description: tagode for collector side of EVC
47530 tagmode-access-egress:
47532 description: tagMode for network side of EVC
47538 $ref: "#/patchDefinitions/evc"
47541 Namespace for external system.
47545 $ref: "#/patchDefinitions/esr-ems-list"
47548 $ref: "#/patchDefinitions/esr-vnfm-list"
47549 esr-thirdparty-sdnc-list:
47551 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
47554 Extra properties for inventory item for response list
47559 $ref: "#/patchDefinitions/extra-property"
47569 ###### Related Nodes
47570 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
47571 - FROM vserver( vserver Uses flavor, MANY2ONE)
47573 -FLAVOR cannot be deleted if related to VSERVER
47582 description: Flavor id, expected to be unique across cloud-region.
47585 description: Flavor name
47589 description: Number of CPUs
47593 description: Amount of memory
47597 description: Disk space
47601 description: Amount of ephemeral disk space
47604 description: amount of swap space allocation
47607 description: whether flavor is available to all users or private to the tenant it was created in.
47610 description: URL to endpoint where AAI can get more details
47613 description: Boolean as to whether this flavor is no longer enabled
47616 Collection of openstack flavors.
47621 $ref: "#/patchDefinitions/flavor"
47624 Entity describing a sequenced segment of forwarding path
47625 ###### Related Nodes
47626 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
47627 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
47628 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
47629 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
47630 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
47632 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
47633 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
47640 description: Unique ID of this segmentation
47643 description: ingress, intermediate, egress
47646 forwarder object is an optional child object of the Configuration object.
47647 ###### Related Nodes
47648 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
47650 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
47656 description: Key for forwarder-evc object
47659 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
47662 description: Internal VLAN.
47665 description: SVLAN value for ingress of egress forwarder.
47668 description: CVLAN value for ingress of egress forwarder.
47674 $ref: "#/patchDefinitions/forwarder-evc"
47680 $ref: "#/patchDefinitions/forwarder"
47683 Entity that describes the sequenced forwarding path between interfaces of services or resources
47684 ###### Related Nodes
47685 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
47686 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
47687 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
47689 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
47690 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
47691 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
47693 - forwarding-path-id
47694 - forwarding-path-name
47696 forwarding-path-id:
47698 description: Unique ID of this FP
47699 forwarding-path-name:
47701 description: Name of the FP
47707 $ref: "#/patchDefinitions/forwarding-path"
47710 General purpose VNF
47711 ###### Related Nodes
47712 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
47713 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
47714 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
47715 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
47716 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
47717 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
47718 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
47719 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
47720 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
47721 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
47722 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
47723 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
47724 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
47725 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
47726 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
47727 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
47728 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
47729 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
47730 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
47731 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
47732 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
47734 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
47740 - is-closed-loop-disabled
47744 description: Unique id of VNF. This is unique across the graph.
47747 description: Name of VNF.
47750 description: Alternate name of VNF.
47753 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.
47756 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
47757 regional-resource-zone:
47759 description: Regional way of organizing pservers, source of truth should define values
47762 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47763 operational-status:
47765 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
47768 description: OBSOLETE - do not use
47771 description: Client should send valid enumerated value
47772 orchestration-status:
47774 description: Orchestration status of this VNF, used by MSO.
47777 description: Heat stack id corresponding to this instance, managed by MSO
47780 description: Corresponds to the SDN-C catalog id used to configure this VCE
47783 description: identifier of managed by company or customer
47786 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
47787 ipv4-loopback0-address:
47789 description: v4 Loopback0 address
47792 description: v6 Loopback address
47793 management-v6-address:
47795 description: v6 management address
47799 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47802 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
47806 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47809 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
47813 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47816 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
47819 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.
47820 is-closed-loop-disabled:
47822 description: used to indicate whether closed loop function is enabled on this node
47830 $ref: "#/patchDefinitions/generic-vnf"
47833 Openstack group-assignment used to store exclusivity groups (EG).
47834 ###### Related Nodes
47835 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
47836 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
47837 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
47846 description: Group id, expected to be unique across cloud-region.
47849 description: Group type - the type of group this instance refers to
47852 description: Group name - name assigned to the group
47855 description: Group description - description of the group
47858 Collection of openstack group assignments
47863 $ref: "#/patchDefinitions/group-assignment"
47866 ###### Related Nodes
47867 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
47869 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
47877 description: host-route id
47880 description: subnet prefix
47883 description: Could be ip-address, hostname, or service-instance
47886 description: Should be ip-address, hostname, or service-instance to match next-hop
47892 $ref: "#/patchDefinitions/host-route"
47895 Collection of HPA Capabilities
47900 $ref: "#/patchDefinitions/hpa-capability"
47903 Represents a HPA capability
47904 ###### Related Nodes
47905 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
47906 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
47907 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
47909 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
47911 - hpa-capability-id
47916 description: UUID to uniquely identify a HPA capability
47919 description: Name of the HPACapability
47922 description: HPA schema version
47925 description: Hardware architecture
47926 hpa-feature-attributes:
47928 HPA Capability Feature attributes
47929 ###### Related Nodes
47930 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
47932 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
47934 - hpa-attribute-key
47938 description: name of the specific HPA attribute
47939 hpa-attribute-value:
47941 description: JSON string specifying the value, unit and type of the specific HPA attribute
47945 ###### Related Nodes
47946 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
47947 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
47948 - FROM vserver( vserver Uses image, MANY2ONE)
47950 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
47951 -IMAGE cannot be deleted if related to VSERVER
47962 description: Image id, expected to be unique across cloud region
47965 description: Image name
47966 image-architecture:
47968 description: Operating system architecture.
47971 description: The common name of the operating system distribution in lowercase
47974 description: The operating system version as specified by the distributor.
47977 description: The application that the image instantiates.
47978 application-vendor:
47980 description: The vendor of the application.
47981 application-version:
47983 description: The version of the application.
47986 description: URL to endpoint where AAI can get more details
47989 Collectio of Openstack images.
47994 $ref: "#/patchDefinitions/image"
47995 include-node-filter:
48001 InstanceFilter for performing a named-query or model query
48004 InstanceFilters for performing a named-query or model query
48009 $ref: "#/patchDefinitions/instance-filter"
48012 General mechanism for grouping instances
48013 ###### Related Nodes
48014 - TO model( instance-group Targets model, MANY2MANY)
48015 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
48016 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
48017 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48018 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48019 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
48020 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
48021 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
48030 description: Instance Group ID, UUID assigned to this instance.
48033 description: Descriptive text to help identify the usage of this instance-group
48036 description: Only valid value today is lower case ha for high availability
48039 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
48042 Collection of openstack route table references
48047 $ref: "#/patchDefinitions/instance-group"
48052 $ref: "#/patchDefinitions/search"
48055 $ref: "#/patchDefinitions/actions"
48056 cloud-infrastructure:
48058 $ref: "#/patchDefinitions/cloud-infrastructure"
48061 $ref: "#/patchDefinitions/business"
48062 service-design-and-creation:
48064 $ref: "#/patchDefinitions/service-design-and-creation"
48067 $ref: "#/patchDefinitions/network"
48070 $ref: "#/patchDefinitions/nodes"
48073 inventory-item-type:
48075 inventory-item-link:
48077 inventory-item-data:
48080 $ref: "#/patchDefinitions/inventory-item-data"
48081 tagged-inventory-item-list:
48084 $ref: "#/patchDefinitions/tagged-inventory-item-list"
48085 inventory-item-data:
48091 inventory-response-item:
48093 Inventory item for response list
48099 $ref: "#/patchDefinitions/extra-properties"
48100 inventory-response-items:
48102 $ref: "#/patchDefinitions/inventory-response-items"
48103 inventory-response-items:
48105 Container for inventory items in response list
48107 inventory-response-item:
48110 $ref: "#/patchDefinitions/inventory-response-item"
48111 ipsec-configuration:
48113 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
48114 ###### Related Nodes
48115 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
48116 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
48118 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
48120 - ipsec-configuration-id
48122 ipsec-configuration-id:
48124 description: UUID of this configuration
48125 requested-vig-address-type:
48127 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
48128 requested-encryption-strength:
48130 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
48131 requested-dmz-type:
48133 description: can offer a shared DMZ or a DMZ specific to a customer
48134 shared-dmz-network-address:
48136 description: Network address of shared DMZ
48137 requested-customer-name:
48139 description: If the DMZ is a custom DMZ, this field will indicate the customer information
48142 description: can be 1 or 2
48143 ikev1-authentication:
48145 description: Contains values like md5, sha1, sha256, sha384
48148 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
48151 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
48154 description: Group name defined in VIG for clients using aggressive mode
48157 description: pre-shared key for the above group name
48160 description: Lifetime for IKEv1 SA
48161 ipsec-authentication:
48163 description: md5, sha1, sha256, sha384
48166 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
48169 description: Life time for IPSec SA
48172 description: enable PFS or not
48175 description: user ID for xAuth, sm-user, ,nmteHostName
48176 xauth-user-password:
48178 description: Encrypted using the Juniper $9$ algorithm
48181 description: The time between DPD probe
48184 description: Maximum number of DPD before claiming the tunnel is down
48185 ipsec-configurations:
48187 ipsec-configuration:
48190 $ref: "#/patchDefinitions/ipsec-configuration"
48199 Logical interfaces, e.g., a vnic.
48200 ###### Related Nodes
48201 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
48202 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
48203 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
48204 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
48205 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
48206 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
48207 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
48208 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
48209 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
48210 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
48211 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
48212 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
48213 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
48215 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
48216 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
48217 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
48225 description: Name given to the interface
48228 description: E.g., CUSTOMER, UPLINK, etc.
48231 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
48234 description: URL to endpoint where AAI can get more details
48237 description: ID of interface
48240 description: MAC address for the interface
48243 description: Name of the network
48246 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
48247 interface-description:
48249 description: Human friendly text regarding this interface.
48252 description: boolean indicatating whether or not port is a mirrored.
48255 Collection of logical interfaces.
48260 $ref: "#/patchDefinitions/l-interface"
48261 l3-interface-ipv4-address-list:
48264 ###### Related Nodes
48265 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48266 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
48267 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
48268 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
48269 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
48271 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
48273 - l3-interface-ipv4-address
48275 l3-interface-ipv4-address:
48277 description: IP address
48278 l3-interface-ipv4-prefix-length:
48281 description: Prefix length, 32 for single address
48285 description: Inner VLAN tag
48289 description: Outer VLAN tag
48292 description: Indicator of fixed or floating address
48293 l3-interface-ipv6-address-list:
48296 ###### Related Nodes
48297 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48298 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
48299 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
48300 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
48301 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
48303 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
48305 - l3-interface-ipv6-address
48307 l3-interface-ipv6-address:
48309 description: IP address
48310 l3-interface-ipv6-prefix-length:
48313 description: Prefix length, 128 for single address
48317 description: Inner VLAN tag
48321 description: Outer VLAN tag
48324 description: Indicator of fixed or floating address
48327 Generic network definition
48328 ###### Related Nodes
48329 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
48330 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
48331 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
48332 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
48333 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
48334 - FROM complex( complex Uses l3-network, MANY2MANY)
48335 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
48336 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
48337 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
48338 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
48339 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
48340 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
48341 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
48342 - FROM tenant( tenant Uses l3-network, MANY2MANY)
48343 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
48345 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
48350 - is-provider-network
48351 - is-shared-network
48352 - is-external-network
48356 description: Network ID, should be uuid. Unique across A&AI.
48359 description: Name of the network, governed by some naming convention..
48362 description: Type of the network - who defines these values?
48365 description: Role the network plans - who defines these values?
48366 network-technology:
48368 description: Network technology - who defines these values?
48369 neutron-network-id:
48371 description: Neutron network id of this Interface
48374 description: Set to true if bound to VPN
48377 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
48378 network-role-instance:
48381 description: network role instance
48387 $ref: "#/patchDefinitions/l3-network"
48390 Link aggregate interface
48391 ###### Related Nodes
48392 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
48393 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
48394 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
48395 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
48396 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
48397 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
48398 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
48399 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
48401 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
48402 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
48403 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
48410 description: Name that identifies the link aggregate interface
48411 interface-description:
48413 description: Human friendly text regarding this interface.
48416 Collection of link aggregate interfaces.
48421 $ref: "#/patchDefinitions/lag-interface"
48424 LAG links can connect lag-interfaces
48425 ###### Related Nodes
48426 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
48427 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
48429 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
48435 description: Alphabetical concatenation of lag-interface names
48438 Collection of link aggregation connections
48443 $ref: "#/patchDefinitions/lag-link"
48446 Metadata for license group.
48447 ###### Related Nodes
48448 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
48449 - TO vce( license BelongsTo vce, MANY2ONE)(4)
48451 -(4) IF this TO node is deleted, this LICENSE is DELETED also
48458 description: Unique ID for the license group the resource belongs to, should be uuid.
48461 description: Unique ID of a license resource.
48464 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
48469 $ref: "#/patchDefinitions/license"
48472 describes a line-of-business
48473 ###### Related Nodes
48474 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
48477 - line-of-business-name
48479 line-of-business-name:
48481 description: Name of the line-of-business (product)
48484 Collection of lines-of-business
48489 $ref: "#/patchDefinitions/line-of-business"
48492 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
48493 ###### Related Nodes
48494 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
48495 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
48496 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
48497 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
48498 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
48499 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
48500 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
48501 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
48502 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
48503 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
48504 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
48505 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
48506 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
48507 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
48509 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
48516 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
48519 description: Type of logical link, e.g., evc
48522 description: Captures the numeric part of the speed
48525 description: Captures the units corresponding to the speed
48528 description: v4, v6, or ds for dual stack
48531 description: For example, static or BGP
48534 Collection of logical connections
48539 $ref: "#/patchDefinitions/logical-link"
48542 Collection of metadatum (key/value pairs)
48547 $ref: "#/patchDefinitions/metadatum"
48551 ###### Related Nodes
48552 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
48553 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
48554 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
48555 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
48557 -(4) IF this TO node is deleted, this METADATUM is DELETED also
48568 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
48569 ###### Related Nodes
48570 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
48571 - FROM instance-group( instance-group Targets model, MANY2MANY)
48572 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
48573 - FROM named-query( named-query AppliesTo model, ONE2MANY)
48574 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
48576 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
48577 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
48580 - model-invariant-id
48583 model-invariant-id:
48585 description: Unique identifier corresponding to the main definition of a model in ASDC
48588 description: Type of the model, e.g., service, resource, widget, etc.
48589 model-and-named-query-search:
48591 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
48595 $ref: "#/patchDefinitions/query-parameters"
48598 $ref: "#/patchDefinitions/instance-filters"
48601 $ref: "#/patchDefinitions/secondary-filts"
48604 secondary-filter-cut-point:
48608 This is how we would capture constraints defining allowed sets of elements.
48609 ###### Related Nodes
48610 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
48611 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
48613 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
48614 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
48616 - model-constraint-uuid
48617 - constrained-element-set-uuid-to-replace
48619 model-constraint-uuid:
48621 constrained-element-set-uuid-to-replace:
48623 constrained-element-sets:
48626 $ref: "#/patchDefinitions/constrained-element-set"
48632 $ref: "#/patchDefinitions/model-constraint"
48635 Defines how other models combine to make up a higher-level model.
48636 ###### Related Nodes
48637 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
48638 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
48639 - TO model-ver( model-element IsA model-ver, MANY2ONE)
48640 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
48641 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
48642 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
48643 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
48645 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
48646 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
48648 - model-element-uuid
48649 - new-data-del-flag
48652 model-element-uuid:
48656 description: Indicates whether this element was created as part of instantiation from this model
48659 description: How many of this type of element are required/allowed
48667 $ref: "#/patchDefinitions/model-element"
48670 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
48671 ###### Related Nodes
48672 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
48673 - FROM model-element( model-element IsA model-ver, MANY2ONE)
48674 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
48675 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
48677 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
48678 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
48679 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
48688 description: Unique identifier corresponding to one version of a model in ASDC
48691 description: Name of the model, which can change from version to version.
48694 description: Version
48697 description: Description
48703 $ref: "#/patchDefinitions/model-ver"
48706 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
48711 $ref: "#/patchDefinitions/model"
48712 multicast-configuration:
48714 ###### Related Nodes
48715 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
48718 - multicast-configuration-id
48719 - multicast-protocol
48722 multicast-configuration-id:
48724 description: Unique id of multicast configuration.
48725 multicast-protocol:
48727 description: protocol of multicast configuration
48730 description: rp type of multicast configuration
48731 multicast-configurations:
48733 multicast configuration of generic-vnf ip-address
48735 multicast-configuration:
48738 $ref: "#/patchDefinitions/multicast-configuration"
48744 $ref: "#/patchDefinitions/named-query"
48748 ###### Related Nodes
48749 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
48750 - TO model( named-query AppliesTo model, ONE2MANY)
48751 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
48753 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
48757 - named-query-version
48763 named-query-version:
48765 required-input-param:
48769 named-query-element:
48772 ###### Related Nodes
48773 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
48774 - TO model( named-query-element IsA model, MANY2ONE)
48775 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
48776 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
48777 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
48778 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
48780 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
48781 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
48783 - named-query-element-uuid
48785 named-query-element-uuid:
48787 property-collect-list:
48789 named-query-elements:
48791 named-query-element:
48794 $ref: "#/patchDefinitions/named-query-element"
48797 Namespace for network inventory resources.
48802 $ref: "#/patchDefinitions/logical-link"
48806 $ref: "#/patchDefinitions/site-pair-set"
48810 $ref: "#/patchDefinitions/vpn-binding"
48814 $ref: "#/patchDefinitions/vpls-pe"
48815 multicast-configurations:
48818 $ref: "#/patchDefinitions/multicast-configuration"
48822 $ref: "#/patchDefinitions/vce"
48826 $ref: "#/patchDefinitions/vnfc"
48830 $ref: "#/patchDefinitions/l3-network"
48834 $ref: "#/patchDefinitions/network-policy"
48838 $ref: "#/patchDefinitions/generic-vnf"
48842 $ref: "#/patchDefinitions/lag-link"
48846 $ref: "#/patchDefinitions/newvce"
48850 $ref: "#/patchDefinitions/pnf"
48854 $ref: "#/patchDefinitions/physical-link"
48855 ipsec-configurations:
48858 $ref: "#/patchDefinitions/ipsec-configuration"
48859 route-table-references:
48862 $ref: "#/patchDefinitions/route-table-reference"
48866 $ref: "#/patchDefinitions/instance-group"
48870 $ref: "#/patchDefinitions/zone"
48876 $ref: "#/patchDefinitions/network-policy"
48879 ###### Related Nodes
48880 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
48881 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
48884 - network-policy-id
48888 description: UUID representing unique key to this instance
48889 network-policy-fqdn:
48891 description: Contrail FQDN for the policy
48894 description: ID for the openStack Heat instance
48897 Network profile populated by SDN-GP for SNMP
48898 ###### Related Nodes
48899 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
48906 description: Unique name of network profile.
48909 description: Encrypted SNMP community string
48912 Collection of network profiles
48917 $ref: "#/patchDefinitions/network-profile"
48920 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
48921 ###### Related Nodes
48922 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
48924 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
48932 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
48935 description: Name of VNF.
48938 description: Alternate name of VNF.
48941 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.
48944 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
48945 operational-status:
48947 description: Indicator for whether the resource is considered operational
48950 description: OBSOLETE - do not use
48953 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).
48956 description: Client should send valid enumerated value.
48959 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
48964 $ref: "#/patchDefinitions/newvce"
48967 inventory-item-data:
48970 $ref: "#/patchDefinitions/inventory-item-data"
48971 notification-event:
48975 notification-event-header:
48977 $ref: "#/patchDefinitions/notification-event-header"
48978 notification-event-header:
49019 $ref: "#/patchDefinitions/key-data"
49024 OAM network, to be deprecated shortly. Do not use for new purposes.
49025 ###### Related Nodes
49026 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
49027 - TO complex( oam-network AppliesTo complex, MANY2MANY)
49028 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
49037 description: UUID of the network. Unique across a cloud-region
49040 description: Name of the network.
49044 description: cvlan-id
49045 ipv4-oam-gateway-address:
49047 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
49048 ipv4-oam-gateway-address-prefix-length:
49051 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
49054 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
49059 $ref: "#/patchDefinitions/oam-network"
49060 operational-environment:
49062 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
49063 ###### Related Nodes
49064 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
49065 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
49068 - operational-environment-id
49069 - operational-environment-name
49070 - operational-environment-type
49071 - operational-environment-status
49075 operational-environment-id:
49077 description: UUID of an operational environment
49078 operational-environment-name:
49080 description: Operational Environment name
49081 operational-environment-type:
49083 description: Operational Environment Type.
49084 operational-environment-status:
49086 description: Status
49089 description: Tenant Context.
49092 description: Workload Context.
49093 operational-environments:
49095 a logical partition of the cloud which allows to have multiple environments in the production AIC.
49097 operational-environment:
49100 $ref: "#/patchDefinitions/operational-environment"
49103 Allows for legacy POST of old-style and new-style models
49105 - model-invariant-id
49106 - model-name-version-id
49112 model-invariant-id:
49114 description: Unique identifier corresponding to the main definition of a model in ASDC
49115 model-name-version-id:
49117 description: Unique identifier corresponding to one version of a model in ASDC
49120 description: Type of the model, e.g., service, resource, widget, etc.
49123 description: Name of the model, which can change from version to version.
49126 description: Invariant unique ID which does not change from version to version
49129 description: Version
49132 description: Description
49135 Collection of owning-entities
49140 $ref: "#/patchDefinitions/owning-entity"
49143 describes an owning-entity
49144 ###### Related Nodes
49145 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
49149 - owning-entity-name
49153 description: UUID of an owning entity
49154 owning-entity-name:
49156 description: Owning entity name
49159 Physical interface (e.g., nic)
49160 ###### Related Nodes
49161 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
49162 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
49163 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
49164 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
49165 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
49166 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
49167 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
49169 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
49170 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
49171 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
49178 description: Name that identifies the physical interface
49181 description: Captures the numeric part of the speed
49184 description: Captures the units corresponding to the speed
49187 description: Nature of the services and connectivity on this port.
49188 equipment-identifier:
49190 description: CLEI or other specification for p-interface hardware.
49193 description: Role specification for p-interface hardware.
49196 description: Indicates the physical properties of the interface.
49199 description: Trigger for operational monitoring of this resource by Service Assurance systems.
49202 Collection of physical interfaces.
49207 $ref: "#/patchDefinitions/p-interface"
49210 Collection of physical connections, typically between p-interfaces
49211 ###### Related Nodes
49212 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
49214 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
49220 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
49223 description: Captures the numeric part of the speed
49226 description: Captures the units corresponding to the speed
49229 description: Circuit it
49232 description: Dual access mode (e.g., primary, secondary
49235 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
49236 service-provider-name:
49238 description: Name of the service Provider on this link.
49241 Collection of physical connections, typically between p-interfaces
49246 $ref: "#/patchDefinitions/physical-link"
49249 describes a platform
49250 ###### Related Nodes
49251 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
49258 description: Name of the platform
49261 Collection of platforms
49266 $ref: "#/patchDefinitions/platform"
49269 PNF represents a physical network function. typically equipment used in the D1 world.
49270 ###### Related Nodes
49271 - TO complex( pnf LocatedIn complex, MANY2ONE)
49272 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
49273 - TO zone( pnf LocatedIn zone, MANY2ONE)
49274 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
49275 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
49276 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
49277 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
49279 -(1) IF this PNF node is deleted, this FROM node is DELETED also
49286 description: unique name of Physical Network Function.
49289 description: name of Physical Network Function.
49292 description: source of name2
49295 description: id of pnf
49298 description: Equipment type. Source of truth should define valid values.
49301 description: Equipment vendor. Source of truth should define valid values.
49304 description: Equipment model. Source of truth should define valid values.
49307 description: identifier of managed by company or customer
49310 description: ipv4-oam-address with new naming convention for IP addresses
49313 description: sw-version is the version of SW for the hosted application on the PNF.
49316 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.
49319 description: ID of the physical frame (relay rack) where pnf is installed.
49322 description: Serial number of the device
49323 ipaddress-v4-loopback-0:
49325 description: IPV4 Loopback 0 address
49326 ipaddress-v6-loopback-0:
49328 description: IPV6 Loopback 0 address
49331 description: IPV4 AIM address
49334 description: IPV6 AIM address
49337 description: IPV6 OAM address
49340 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
49343 Collection of Physical Network Functions.
49348 $ref: "#/patchDefinitions/pnf"
49351 Used to capture the network interfaces of this VCE
49352 ###### Related Nodes
49353 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
49354 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
49356 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
49357 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
49360 - orchestration-status
49364 description: Unique ID of the interface
49365 neutron-network-id:
49367 description: Neutron network id of this Interface
49368 neutron-network-name:
49370 description: Neutron network name of this Interface
49373 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49379 $ref: "#/patchDefinitions/port-group"
49382 describes the project
49383 ###### Related Nodes
49384 - TO service-instance( project Uses service-instance, ONE2MANY)
49391 description: Name of the project deploying a service
49394 Collection of projects
49399 $ref: "#/patchDefinitions/project"
49402 Property holder for query properties or instance properties
49408 property-constraint:
49411 ###### Related Nodes
49412 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
49414 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
49416 - property-constraint-uuid
49421 property-constraint-uuid:
49429 property-constraints:
49431 property-constraint:
49434 $ref: "#/patchDefinitions/property-constraint"
49437 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
49438 ###### Related Nodes
49439 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
49440 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
49441 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
49442 - TO complex( pserver LocatedIn complex, MANY2ONE)
49443 - TO zone( pserver LocatedIn zone, MANY2ONE)
49444 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
49445 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
49446 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
49447 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
49448 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
49450 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
49451 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
49459 description: Value from executing hostname on the compute node.
49462 description: PTNII name
49466 description: Number of cpus
49470 description: Disk size, in GBs
49474 description: RAM size, in MBs
49477 description: Equipment type. Source of truth should define valid values.
49480 description: Equipment vendor. Source of truth should define valid values.
49483 description: Equipment model. Source of truth should define valid values.
49486 description: Fully-qualified domain name
49489 description: URL to endpoint where AAI can get more details
49492 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
49495 description: Serial number, may be queried
49496 ipaddress-v4-loopback-0:
49498 description: IPV4 Loopback 0 address
49499 ipaddress-v6-loopback-0:
49501 description: IPV6 Loopback 0 address
49504 description: IPV4 AIM address
49507 description: IPV6 AIM address
49510 description: IPV6 OAM address
49513 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
49516 description: ID of Pserver
49519 description: internet topology of Pserver
49522 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.
49525 Collection of compute hosts.
49530 $ref: "#/patchDefinitions/pserver"
49533 QueryParameters for performing a named-query or model query
49537 $ref: "#/patchDefinitions/named-query"
49540 $ref: "#/patchDefinitions/overloaded-model"
49544 ###### Related Nodes
49545 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
49547 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
49549 - related-lookup-uuid
49551 - source-node-property
49553 - target-node-property
49555 related-lookup-uuid:
49559 source-node-property:
49563 target-node-property:
49565 property-collect-list:
49572 $ref: "#/patchDefinitions/related-lookup"
49573 related-to-property:
49577 description: Key part of a key/value pair
49580 description: Value part of a key/value pair
49585 description: A keyword provided by A&AI to indicate type of node.
49588 description: URL to the object in A&AI.
49592 $ref: "#/patchDefinitions/relationship-data"
49593 related-to-property:
49596 $ref: "#/patchDefinitions/related-to-property"
49600 - relationship-value
49604 description: A keyword provided by A&AI to indicate an attribute.
49605 relationship-value:
49607 description: Value of the attribute.
49608 reserved-prop-names:
49610 Internal map to define some reserved properties of a vertex
49612 last-mod-source-of-truth:
49630 Response container for the results of a named-query or model query
49632 inventory-response-items:
49634 $ref: "#/patchDefinitions/inventory-response-items"
49639 description: The specific type of node in the A&AI graph
49642 description: The URL to the specific resource
49643 route-table-reference:
49645 Openstack route table reference.
49646 ###### Related Nodes
49647 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
49650 - route-table-reference-id
49651 - route-table-reference-fqdn
49653 route-table-reference-id:
49655 description: Route Table Reference id, UUID assigned to this instance.
49656 route-table-reference-fqdn:
49658 description: FQDN entry in the route table.
49659 route-table-references:
49661 Collection of openstack route table references
49663 route-table-reference:
49666 $ref: "#/patchDefinitions/route-table-reference"
49669 Route target information
49670 ###### Related Nodes
49671 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
49673 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
49675 - global-route-target
49676 - route-target-role
49678 global-route-target:
49680 description: Number used to identify an RT, globally unique in the network
49683 description: Role assigned to this route target
49686 Collection of route target information
49691 $ref: "#/patchDefinitions/route-target"
49694 ###### Related Nodes
49695 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
49696 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
49698 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
49699 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
49701 - routing-instance-id
49703 routing-instance-id:
49705 description: Unique id of routing instance
49708 description: rpm owner
49711 set of probes related to generic-vnf routing instance
49716 $ref: "#/patchDefinitions/routing-instance"
49721 $ref: "#/patchDefinitions/oam-networks"
49722 az-and-dvs-switches:
49725 $ref: "#/patchDefinitions/az-and-dvs-switches"
49728 edge-tag-query-result:
49730 $ref: "#/patchDefinitions/edge-tag-query-result"
49731 edge-tag-query-request:
49733 $ref: "#/patchDefinitions/edge-tag-query-request"
49736 $ref: "#/patchDefinitions/search-results"
49739 $ref: "#/patchDefinitions/sdn-zone-response"
49745 $ref: "#/patchDefinitions/result-data"
49748 SecondaryFilt for performing a named-query or model query
49759 SecondaryFilts for performing a named-query or model query
49764 $ref: "#/patchDefinitions/secondary-filt"
49765 segmentation-assignment:
49767 Openstack segmentation assignment.
49768 ###### Related Nodes
49769 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
49771 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
49777 description: Route Table Reference id, UUID assigned to this instance.
49778 segmentation-assignments:
49780 Collection of openstack segmentation assignments
49782 segmentation-assignment:
49785 $ref: "#/patchDefinitions/segmentation-assignment"
49788 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
49791 - service-description
49795 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
49796 service-description:
49798 description: Description of the service
49801 description: URL to endpoint where AAI can get more details
49802 service-capabilities:
49804 Collection of service capabilities.
49806 service-capability:
49809 $ref: "#/patchDefinitions/service-capability"
49810 service-capability:
49812 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
49813 ###### Related Nodes
49814 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
49815 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
49817 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
49825 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
49828 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.
49829 service-design-and-creation:
49831 Namespace for objects managed by ASDC
49836 $ref: "#/patchDefinitions/vnf-image"
49840 $ref: "#/patchDefinitions/service"
49841 service-capabilities:
49844 $ref: "#/patchDefinitions/service-capability"
49848 $ref: "#/patchDefinitions/model"
49852 $ref: "#/patchDefinitions/named-query"
49855 Instance of a service
49856 ###### Related Nodes
49857 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
49858 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
49859 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
49860 - TO connector( service-instance Uses connector, MANY2MANY)
49861 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
49862 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
49863 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
49864 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
49865 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
49866 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49867 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
49868 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
49869 - TO vce( service-instance ComposedOf vce, ONE2MANY)
49870 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
49871 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
49872 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49874 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
49875 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
49876 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
49878 - service-instance-id
49880 service-instance-id:
49882 description: Uniquely identifies this instance of a service
49883 service-instance-name:
49885 description: This field will store a name assigned to the service-instance.
49886 model-invariant-id:
49888 description: the ASDC model id for this resource or service model.
49891 description: the ASDC model version for this resource or service model.
49892 persona-model-version:
49894 description: the ASDC model version for this resource or service model.
49897 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49898 widget-model-version:
49900 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49903 description: Indicates the total bandwidth to be used for this service.
49906 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
49907 bandwidth-down-wan1:
49909 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
49912 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
49913 bandwidth-down-wan2:
49915 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
49918 description: URL customers will use to access the vHN Portal.
49919 service-instance-location-id:
49921 description: An identifier that customers assign to the location where this service is being used.
49924 Collection of service instances
49929 $ref: "#/patchDefinitions/service-instance"
49930 service-subscription:
49932 Object that group service instances.
49933 ###### Related Nodes
49934 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
49935 - TO tenant( service-subscription Uses tenant, MANY2MANY)
49936 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
49938 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
49939 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
49945 description: Value defined by orchestration to identify this service across ECOMP.
49946 temp-ub-sub-account-id:
49948 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
49949 service-subscriptions:
49951 Collection of objects that group service instances.
49953 service-subscription:
49956 $ref: "#/patchDefinitions/service-subscription"
49959 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
49964 $ref: "#/patchDefinitions/service"
49967 ###### Related Nodes
49968 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
49969 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
49971 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
49972 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
49978 description: unique identifier of probe
49981 description: Prefix address
49984 description: Prefix address
49987 description: ip version, v4, v6
49988 destination-hostname:
49990 description: Hostname of the destination equipment to which SLAs are measured against.
49991 destination-equip-type:
49993 description: The type of destinatination equipment. Could be Router, etc.
49996 Set of instances for probes used to measure service level agreements
49997 ###### Related Nodes
49998 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
49999 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
50001 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
50007 description: Unique id of site pair set.
50010 Collection of sets of instances for probes related to generic-vnf
50015 $ref: "#/patchDefinitions/site-pair-set"
50023 $ref: "#/patchDefinitions/site-pair"
50027 ###### Related Nodes
50028 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
50029 - FROM vserver( vserver Uses snapshot, ONE2ONE)
50036 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
50039 description: Snapshot name
50040 snapshot-architecture:
50042 description: Operating system architecture
50043 snapshot-os-distro:
50045 description: The common name of the operating system distribution in lowercase
50046 snapshot-os-version:
50048 description: The operating system version as specified by the distributor.
50051 description: The application that the image instantiates.
50052 application-vendor:
50054 description: The vendor of the application.
50055 application-version:
50057 description: The version of the application.
50060 description: URL to endpoint where AAI can get more details
50063 description: This field contains the UUID of the previous snapshot (if any).
50066 Collection of openstack snapshots
50071 $ref: "#/patchDefinitions/snapshot"
50074 SR-IOV Physical Function
50075 ###### Related Nodes
50076 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
50077 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
50079 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
50085 description: Identifier for the sriov-pf
50088 Collection of SR-IOV Physical Functions.
50093 $ref: "#/patchDefinitions/sriov-pf"
50096 SR-IOV Virtual Function (not to be confused with virtual network function)
50097 ###### Related Nodes
50098 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
50100 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
50106 description: PCI ID used to identify the sriov-vf
50109 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
50112 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
50115 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
50116 vf-vlan-anti-spoof-check:
50118 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.
50119 vf-mac-anti-spoof-check:
50121 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.
50124 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
50125 vf-broadcast-allow:
50127 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
50128 vf-unknown-multicast-allow:
50130 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
50131 vf-unknown-unicast-allow:
50133 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
50136 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
50139 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
50142 Collection of SR-IOV Virtual Functions.
50147 $ref: "#/patchDefinitions/sriov-vf"
50156 ###### Related Nodes
50157 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
50158 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
50159 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
50161 -(4) IF this TO node is deleted, this SUBNET is DELETED also
50162 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
50170 description: Subnet ID, should be UUID.
50173 description: Name associated with the subnet.
50176 description: Neutron id of this subnet
50179 description: gateway ip address
50180 network-start-address:
50182 description: network start address
50185 description: cidr mask
50188 description: ip version
50189 orchestration-status:
50191 description: Orchestration status of this VNF, mastered by MSO
50194 description: dhcp enabled
50197 description: the start address reserved for use by dhcp
50200 description: the last address reserved for use by dhcp
50206 $ref: "#/patchDefinitions/subnet"
50207 tagged-inventory-item-list:
50212 $ref: "#/patchDefinitions/inventory-item"
50216 ###### Related Nodes
50217 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
50218 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
50219 - TO l3-network( tenant Uses l3-network, MANY2MANY)
50220 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
50221 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
50222 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
50224 -TENANT cannot be deleted if related to VSERVER
50232 description: Unique id relative to the cloud-region.
50235 description: Readable name of tenant
50238 Collection of openstack tenants.
50243 $ref: "#/patchDefinitions/tenant"
50246 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
50247 ###### Related Nodes
50248 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
50250 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
50253 - bandwidth-up-wan1
50254 - bandwidth-down-wan1
50255 - bandwidth-up-wan2
50256 - bandwidth-down-wan2
50260 description: Allotted Resource id UUID assigned to this instance.
50263 description: The WAN uplink bandwidth for WAN1
50264 bandwidth-down-wan1:
50266 description: The WAN downlink bandwidth for WAN1
50269 description: The WAN uplink bandwidth for WAN2
50270 bandwidth-down-wan2:
50272 description: The WAN downlink bandwidth for WAN2
50275 This object is used to store the specific tunnel cross connect aspects of an allotted resource
50280 $ref: "#/patchDefinitions/tunnel-xconnect"
50283 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
50292 $ref: "#/patchDefinitions/update-node-key"
50298 $ref: "#/patchDefinitions/action"
50307 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
50308 ###### Related Nodes
50309 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
50310 - TO complex( vce LocatedIn complex, MANY2MANY)
50311 - TO vserver( vce HostedOn vserver, ONE2MANY)
50312 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
50313 - FROM license( license BelongsTo vce, MANY2ONE)(1)
50314 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
50315 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
50317 -(1) IF this VCE node is deleted, this FROM node is DELETED also
50325 description: Unique id of VNF. This is unique across the graph.
50328 description: Name of VNF.
50331 description: Alternate name of VNF.
50334 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.
50337 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
50338 regional-resource-zone:
50340 description: Regional way of organizing pservers, source of truth should define values
50343 description: Trigger for operational monitoring of this resource by Service Assurance systems.
50344 operational-status:
50346 description: Indicator for whether the resource is considered operational
50349 description: OBSOLETE - do not use
50352 description: Network role being played by this VNF
50353 orchestration-status:
50355 description: Orchestration status of this VNF, mastered by MSO
50358 description: Heat stack id corresponding to this instance, managed by MSO
50361 description: Corresponds to the SDN-C catalog id used to configure this VCE
50364 description: Unique ID of VPE connected to this VCE.
50365 v6-vce-wan-address:
50367 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
50370 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
50373 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
50378 $ref: "#/patchDefinitions/vce"
50381 a deployment unit of VNFCs
50382 ###### Related Nodes
50383 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
50384 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
50385 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
50386 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
50387 - TO vserver( vf-module Uses vserver, ONE2MANY)
50389 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
50390 -VF-MODULE cannot be deleted if related to VNFC
50394 - is-base-vf-module
50398 description: Unique ID of vf-module.
50401 description: Name of vf-module
50404 description: Heat stack id corresponding to this instance.
50405 orchestration-status:
50407 description: orchestration status of this vf-module, mastered by MSO
50410 description: used to indicate whether or not this object is base vf module
50413 Collection of vf-modules, a deployment unit of VNFCs
50418 $ref: "#/patchDefinitions/vf-module"
50421 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
50422 ###### Related Nodes
50423 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
50425 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
50431 description: indicates whether the VIG is for AVPN or INTERNET
50434 description: v4 IP of the vig server
50437 description: v6 IP of the vig server
50443 $ref: "#/patchDefinitions/vig-server"
50444 vip-ipv4-address-list:
50447 ###### Related Nodes
50448 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
50449 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
50450 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
50451 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
50458 description: IP address
50459 vip-ipv4-prefix-length:
50462 description: Prefix length, 32 for single address
50466 description: Inner VLAN tag
50470 description: Outer VLAN tag
50473 description: Indicator of fixed or floating address
50474 vip-ipv6-address-list:
50477 ###### Related Nodes
50478 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
50479 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
50480 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
50481 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
50488 description: IP address
50489 vip-ipv6-prefix-length:
50492 description: Prefix length, 128 for single address
50496 description: Inner VLAN tag
50500 description: Outer VLAN tag
50503 description: Indicator of fixed or floating address
50504 virtual-data-center:
50506 Virtual organization of cloud infrastructure elements in a data center context
50507 ###### Related Nodes
50508 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
50509 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
50510 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
50518 description: Unique ID of the vdc
50521 description: Name of the virtual data center
50522 virtual-data-centers:
50524 Virtual organization of cloud infrastructure elements in a data center context
50526 virtual-data-center:
50529 $ref: "#/patchDefinitions/virtual-data-center"
50533 ###### Related Nodes
50534 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
50535 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
50536 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
50537 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
50538 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
50539 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
50540 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
50542 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
50543 -(2) IF this VLAN node is deleted, this TO node is DELETED also
50544 -(4) IF this TO node is deleted, this VLAN is DELETED also
50551 description: String that identifies the interface
50555 description: Inner VLAN tag
50559 description: Outer VLAN tag
50565 $ref: "#/patchDefinitions/vlan"
50574 description: Unique id of VNF. This is unique across the graph.
50577 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
50578 ###### Related Nodes
50579 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
50581 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
50586 - application-vendor
50590 description: Unique ID of this asset
50593 description: The application that the image instantiates.
50594 application-vendor:
50596 description: The vendor of the application.
50597 application-version:
50599 description: The version of the application.
50602 description: URL to endpoint where AAI can get more details
50605 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
50610 $ref: "#/patchDefinitions/vnf-image"
50613 ###### Related Nodes
50614 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
50615 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
50616 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
50618 -(4) IF this TO node is deleted, this VNFC is DELETED also
50621 - vnfc-function-code
50624 - is-closed-loop-disabled
50628 description: Unique ID of vnfc.
50629 vnfc-function-code:
50631 description: function code
50637 description: prov status of this vnfc
50638 orchestration-status:
50640 description: Orchestration status of this VNF, mastered by APP-C
50641 ipaddress-v4-oam-vip:
50643 description: Oam V4 vip address of this vnfc
50646 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50647 is-closed-loop-disabled:
50649 description: used to indicate whether closed loop function is enabled on this node
50652 description: Group notation of VNFC
50655 virtual network components associated with a vserver from application controller.
50660 $ref: "#/patchDefinitions/vnfc"
50663 Ephemeral Block storage volume.
50664 ###### Related Nodes
50665 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
50667 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
50674 description: Unique ID of block storage volume relative to the vserver.
50677 description: URL to endpoint where AAI can get more details
50680 Persistent block-level storage.
50681 ###### Related Nodes
50682 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
50683 - TO complex( volume-group LocatedIn complex, MANY2ONE)
50684 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
50685 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
50686 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
50690 - volume-group-name
50695 description: Unique ID of volume-group.
50698 description: Name of the volume group.
50701 description: Heat stack id corresponding to this volume-group
50704 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.
50705 orchestration-status:
50707 description: Orchestration status of this volume-group
50708 model-customization-id:
50710 description: captures the id of all the configuration used to customize the resource for the service.
50711 vf-module-model-customization-id:
50713 description: helps relate the volume group to the vf-module whose components will require the volume group
50716 Collection of persistent block-level storage.
50721 $ref: "#/patchDefinitions/volume-group"
50724 Collection of ephemeral Block storage volumes.
50729 $ref: "#/patchDefinitions/volume"
50732 VPLS Provider Edge routers.
50733 ###### Related Nodes
50734 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
50735 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
50736 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
50737 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
50739 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
50747 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50750 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).
50753 description: Client should send valid enumerated value, e.g., VPLS-PE.
50757 description: Temporary location for stag to get to VCE
50760 Collection of VPLS Provider Edge routers
50765 $ref: "#/patchDefinitions/vpls-pe"
50769 ###### Related Nodes
50770 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
50771 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
50772 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
50774 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
50775 -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
50783 description: VPN ID, globally unique within A&AI
50786 description: VPN Name
50789 description: the platform associated with the VPN example AVPN, Mobility
50792 description: Type of the vpn, should be taken from enumerated/valid values
50793 route-distinguisher:
50795 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
50801 $ref: "#/patchDefinitions/vpn-binding"
50804 Virtual Servers, aka virtual machine or VM.
50805 ###### Related Nodes
50806 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
50807 - TO flavor( vserver Uses flavor, MANY2ONE)
50808 - TO image( vserver Uses image, MANY2ONE)
50809 - TO pserver( vserver HostedOn pserver, MANY2ONE)
50810 - TO snapshot( vserver Uses snapshot, ONE2ONE)
50811 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
50812 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
50813 - FROM vce( vce HostedOn vserver, ONE2MANY)
50814 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
50815 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
50816 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
50818 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
50819 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
50825 - is-closed-loop-disabled
50829 description: Unique identifier for this vserver relative to its tenant
50832 description: Name of vserver
50835 description: Alternative name of vserver
50838 description: Trigger for operational monitoring of this resource by Service Assurance systems.
50841 description: URL to endpoint where AAI can get more details
50844 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.
50845 is-closed-loop-disabled:
50847 description: Used to indicate whether closed loop function is enabled on this node
50850 Collection of virtual Servers, aka virtual machines or VMs.
50855 $ref: "#/patchDefinitions/vserver"
50858 A zone is a grouping of assets in a location homing to the same connections into the CBB
50859 ###### Related Nodes
50860 - TO complex( zone LocatedIn complex, MANY2ONE)
50861 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
50862 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
50863 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
50873 description: Code assigned by AIC to the zone
50876 description: English name associated with the zone
50879 description: Design of zone [Medium/Large?]
50882 description: Context of zone [production/test]
50885 description: Status of a zone.
50888 Collection of zones
50893 $ref: "#/patchDefinitions/zone"
50902 $ref: "#/getDefinitions/action-data"
50911 APIs that are more action related than REST (e.g., notify, update).
50915 $ref: "#/getDefinitions/update"
50918 $ref: "#/getDefinitions/notify"
50921 Represents a slice or partial piece of a resource that gets separately allotted
50922 ###### Related Nodes
50923 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
50924 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
50925 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
50926 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
50927 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
50928 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
50929 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
50930 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
50932 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
50933 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
50939 description: Allotted Resource id UUID assigned to this instance.
50942 description: The descriptive information assigned to this allotted resource instance
50945 description: Link back to more information in the controller
50946 model-invariant-id:
50948 description: the ASDC model id for this resource or service model.
50951 description: the ASDC model version for this resource or service model.
50952 persona-model-version:
50954 description: the ASDC model version for this resource or service model.
50957 description: Concurrency value
50958 orchestration-status:
50960 description: Orchestration status
50961 operational-status:
50963 description: Indicator for whether the resource is considered operational
50966 description: Generic description of the type of allotted resource.
50969 description: role in the network that this resource will be providing.
50973 $ref: "#/getDefinitions/tunnel-xconnect"
50977 $ref: "#/getDefinitions/relationship"
50978 allotted-resources:
50980 This object is used to store slices of services being offered
50985 $ref: "#/getDefinitions/allotted-resource"
50988 Availability zone, a collection of compute hosts/pservers
50989 ###### Related Nodes
50990 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
50991 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
50992 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
50993 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
50994 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
50995 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
50996 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
50997 - FROM vce( vce Uses availability-zone, MANY2MANY)
50999 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
51000 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
51003 - availability-zone-name
51006 availability-zone-name:
51008 description: Name of the availability zone. Unique across a cloud region
51011 description: Type of hypervisor. Source of truth should define valid values.
51012 operational-status:
51014 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
51017 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51021 $ref: "#/getDefinitions/relationship"
51022 availability-zones:
51024 Collection of availability zones
51029 $ref: "#/getDefinitions/availability-zone"
51030 az-and-dvs-switches:
51034 $ref: "#/getDefinitions/dvs-switches"
51037 $ref: "#/getDefinitions/availability-zone"
51040 Namespace for business related constructs
51045 $ref: "#/getDefinitions/connector"
51049 $ref: "#/getDefinitions/customer"
51052 ###### Related Nodes
51053 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
51055 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
51061 description: unique identifier of probe
51064 description: identifier of probe
51067 description: type of probe
51070 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51074 $ref: "#/getDefinitions/relationship"
51075 classes-of-service:
51077 class-of-service of probe
51082 $ref: "#/getDefinitions/class-of-service"
51083 cloud-infrastructure:
51085 Namespace for cloud infrastructure.
51090 $ref: "#/getDefinitions/complex"
51094 $ref: "#/getDefinitions/cloud-region"
51098 $ref: "#/getDefinitions/network-profile"
51102 $ref: "#/getDefinitions/pserver"
51103 virtual-data-centers:
51106 $ref: "#/getDefinitions/virtual-data-center"
51109 cloud-region designates an installation of a cloud cluster or region or instantiation
51110 ###### Related Nodes
51111 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
51112 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
51113 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
51114 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
51115 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
51116 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
51117 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
51118 - FROM image( image BelongsTo cloud-region, MANY2ONE)
51119 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
51120 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
51121 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
51122 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
51123 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
51124 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
51126 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
51127 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
51135 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
51138 description: Identifier used by the vendor for the region. Second part of composite key
51141 description: Type of the cloud (e.g., openstack)
51142 owner-defined-type:
51144 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
51145 cloud-region-version:
51147 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
51150 description: URL of the keystone identity service
51153 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
51156 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
51159 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51163 $ref: "#/getDefinitions/volume-group"
51167 $ref: "#/getDefinitions/tenant"
51171 $ref: "#/getDefinitions/flavor"
51175 $ref: "#/getDefinitions/group-assignment"
51179 $ref: "#/getDefinitions/snapshot"
51183 $ref: "#/getDefinitions/image"
51187 $ref: "#/getDefinitions/dvs-switch"
51191 $ref: "#/getDefinitions/oam-network"
51192 availability-zones:
51195 $ref: "#/getDefinitions/availability-zone"
51199 $ref: "#/getDefinitions/relationship"
51205 $ref: "#/getDefinitions/cloud-region"
51208 Collection of physical locations that can house cloud-regions.
51209 ###### Related Nodes
51210 - TO l3-network( complex Uses l3-network, MANY2MANY)
51211 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
51212 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
51213 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
51214 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
51215 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
51216 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
51217 - FROM vce( vce LocatedIn complex, MANY2MANY)
51218 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
51219 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
51220 - FROM zone( zone LocatedIn complex, MANY2ONE)
51222 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
51223 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
51226 - physical-location-id
51227 - physical-location-type
51234 physical-location-id:
51236 description: Unique identifier for physical location, e.g., CLLI
51239 description: Data center code which can be an alternate way to identify a complex
51242 description: Gamma complex name for LCP instance.
51245 description: URL of the keystone identity service
51248 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51249 physical-location-type:
51251 description: Type, e.g., central office, data center.
51277 $ref: "#/getDefinitions/ctag-pool"
51281 $ref: "#/getDefinitions/relationship"
51284 Collection of physical locations that can house cloud-regions.
51289 $ref: "#/getDefinitions/complex"
51292 Port Mirror Configuration.
51293 ###### Related Nodes
51294 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
51295 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
51296 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
51297 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
51298 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
51300 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
51301 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
51302 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
51305 - configuration-type
51306 - configuration-sub-type
51307 - orchestration-status
51308 - operational-status
51309 - configuration-selflink
51310 - model-customization-id
51314 description: UUID assigned to configuration.
51317 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
51318 configuration-name:
51320 description: Name of the configuration.
51321 configuration-type:
51323 description: port-mirroring-configuration.
51324 configuration-sub-type:
51326 description: vprobe, pprobe.
51327 model-invariant-id:
51329 description: the ASDC model id for this resource or service model.
51332 description: the ASDC model version for this resource or service model.
51333 orchestration-status:
51335 description: Orchestration status of the configuration.
51336 operational-status:
51338 description: Indicator for whether the resource is considered operational.
51339 configuration-selflink:
51341 description: URL to endpoint where AAI can get more details from SDN-GC.
51342 model-customization-id:
51344 description: id of the configuration used to customize the resource
51347 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51351 $ref: "#/getDefinitions/relationship"
51355 $ref: "#/getDefinitions/metadatum"
51358 Collection of configurations
51363 $ref: "#/getDefinitions/configuration"
51366 Collection of resource instances used to connect a variety of disparate inventory widgets
51367 ###### Related Nodes
51368 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
51369 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
51370 - FROM service-instance( service-instance Uses connector, MANY2MANY)
51372 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
51374 - resource-instance-id
51376 resource-instance-id:
51378 description: Unique id of resource instance.
51381 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51382 model-invariant-id:
51384 description: the ASDC model id for this resource or service model.
51387 description: the ASDC model version for this resource or service model.
51388 persona-model-version:
51390 description: the ASDC model version for this resource or service model.
51393 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51394 widget-model-version:
51396 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51400 $ref: "#/getDefinitions/relationship"
51404 $ref: "#/getDefinitions/metadatum"
51407 Collection of resource instances used to connect a variety of disparate inventory widgets
51412 $ref: "#/getDefinitions/connector"
51413 constrained-element-set:
51415 This is how we would capture constraints defining allowed sets of elements.
51416 ###### Related Nodes
51417 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
51418 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
51419 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
51421 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
51422 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
51424 - constrained-element-set-uuid
51428 constrained-element-set-uuid:
51436 element-choice-sets:
51439 $ref: "#/getDefinitions/element-choice-set"
51443 $ref: "#/getDefinitions/relationship"
51444 constrained-element-sets:
51446 constrained-element-set:
51449 $ref: "#/getDefinitions/constrained-element-set"
51452 ###### Related Nodes
51453 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
51454 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
51456 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
51466 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51470 $ref: "#/getDefinitions/relationship"
51476 $ref: "#/getDefinitions/ctag-assignment"
51479 A collection of C tags (vlan tags) grouped for a specific purpose.
51480 ###### Related Nodes
51481 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
51482 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
51483 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
51485 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
51488 - availability-zone-name
51489 - ctag-pool-purpose
51493 description: The Target provider edge router
51494 availability-zone-name:
51496 description: Name of the availability zone
51499 description: Describes what the intended purpose of this pool is.
51502 description: Comma separated list of ctags
51505 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51509 $ref: "#/getDefinitions/relationship"
51515 $ref: "#/getDefinitions/ctag-pool"
51518 customer identifiers to provide linkage back to BSS information.
51519 ###### Related Nodes
51520 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
51522 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
51524 - global-customer-id
51528 global-customer-id:
51530 description: Global customer id used across ECOMP to uniquely identify customer.
51533 description: Subscriber name, an alternate way to retrieve a customer.
51536 description: Subscriber type, a way to provide VID with only the INFRA customers.
51539 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51540 service-subscriptions:
51543 $ref: "#/getDefinitions/service-subscription"
51547 $ref: "#/getDefinitions/relationship"
51550 Collection of customer identifiers to provide linkage back to BSS information.
51555 $ref: "#/getDefinitions/customer"
51563 description: See mis-na-virtualization-platform.yang
51566 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51570 $ref: "#/getDefinitions/relationship"
51576 $ref: "#/getDefinitions/cvlan-tag-entry"
51579 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.
51580 ###### Related Nodes
51581 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
51582 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
51590 description: DVS switch name
51593 description: URL used to reach the vcenter
51596 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51600 $ref: "#/getDefinitions/relationship"
51603 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
51608 $ref: "#/getDefinitions/dvs-switch"
51611 Internal map to define the properties of an edge and interpret the map EdgeRules
51629 edge-tag-query-request:
51640 $ref: "#/getDefinitions/start-node-filter"
51641 include-node-filter:
51644 $ref: "#/getDefinitions/include-node-filter"
51648 $ref: "#/getDefinitions/secondary-filter"
51649 edge-tag-query-result:
51651 tagged-inventory-item-list:
51654 $ref: "#/getDefinitions/tagged-inventory-item-list"
51655 element-choice-set:
51657 This is how we would capture constraints defining allowed sets of elements.
51658 ###### Related Nodes
51659 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
51660 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
51662 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
51663 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
51665 - element-choice-set-uuid
51666 - element-choice-set-name
51668 element-choice-set-uuid:
51670 element-choice-set-name:
51679 $ref: "#/getDefinitions/model-element"
51683 $ref: "#/getDefinitions/relationship"
51684 element-choice-sets:
51686 element-choice-set:
51689 $ref: "#/getDefinitions/element-choice-set"
51692 Metadata for entitlement group.
51693 ###### Related Nodes
51694 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
51695 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
51697 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
51704 description: Unique ID for the entitlement group the resource comes from, should be uuid.
51707 description: Unique ID of an entitlement resource.
51710 description: Concurrency value
51714 $ref: "#/getDefinitions/relationship"
51717 Entitlements, keyed by group-uuid and resource-uuid, related to license management
51722 $ref: "#/getDefinitions/entitlement"
51725 Persist EMS address information used by EMS driver.
51726 ###### Related Nodes
51727 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
51729 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
51735 description: Unique ID of EMS.
51738 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51739 esr-system-info-list:
51741 $ref: "#/getDefinitions/esr-system-info-list"
51744 $ref: "#/getDefinitions/relationship-list"
51750 $ref: "#/getDefinitions/esr-ems"
51753 Persist common address information of external systems.
51754 ###### Related Nodes
51755 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
51756 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
51757 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
51758 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
51760 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
51762 - esr-system-info-id
51767 esr-system-info-id:
51769 description: Unique ID of esr system info.
51772 description: name of external system.
51775 description: type of external systems.
51778 description: vendor of external systems.
51781 description: version of external systems.
51784 description: url used to access external systems.
51787 description: username used to access external systems.
51790 description: password used to access external systems.
51793 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
51796 description: protocol of third party SDNC, for example netconf/snmp.
51799 description: ca file content if enabled ssl on auth-url.
51802 description: Whether to verify VIM's certificate.
51805 description: service IP of ftp server.
51808 description: service port of ftp server.
51811 description: domain info for authentication.
51814 description: default tenant of VIM.
51817 description: ftp passive mode or not.
51820 description: resource or performance data file path.
51823 description: the status of external system.
51826 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51830 $ref: "#/getDefinitions/relationship"
51831 esr-system-info-list:
51833 Collection of persistent block-level external system auth info.
51838 $ref: "#/getDefinitions/esr-system-info"
51839 esr-thirdparty-sdnc:
51841 Persist SDNC address information used by ONAP SDNC.
51842 ###### Related Nodes
51843 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
51844 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
51846 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
51848 - thirdparty-sdnc-id
51850 thirdparty-sdnc-id:
51852 description: Unique ID of SDNC.
51855 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
51858 description: password used to access SDNC server.
51861 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51862 esr-system-info-list:
51864 $ref: "#/getDefinitions/esr-system-info-list"
51867 $ref: "#/getDefinitions/relationship-list"
51868 esr-thirdparty-sdnc-list:
51870 esr-thirdparty-sdnc:
51873 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
51876 Persist VNFM address information used by VF-C.
51877 ###### Related Nodes
51878 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
51880 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
51886 description: Unique ID of VNFM.
51889 description: indecate the VIM to deploy VNF.
51892 description: certificate url of VNFM.
51895 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51896 esr-system-info-list:
51898 $ref: "#/getDefinitions/esr-system-info-list"
51901 $ref: "#/getDefinitions/relationship-list"
51907 $ref: "#/getDefinitions/esr-vnfm"
51910 evc object is an optional child object of the Configuration object.
51911 ###### Related Nodes
51912 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
51914 -(4) IF this TO node is deleted, this EVC is DELETED also
51920 description: Unique/key field for the evc object
51921 forwarding-path-topology:
51923 description: Point-to-Point, Multi-Point
51926 description: Commited Information Rate
51929 description: CIR units
51930 connection-diversity-group-id:
51932 description: Diversity Group ID
51935 description: formerly Performance Group
51936 esp-evc-circuit-id:
51938 description: EVC Circuit ID of ESP EVC
51941 description: Committed Information Rate (For ESP)
51944 description: CIR units (For ESP)
51947 description: Identifies ESP
51948 collector-pop-clli:
51950 description: Collector POP CLLI (from the hostname of the access pnf)
51951 inter-connect-type-ingress:
51953 description: Interconnect type on ingress side of EVC.
51954 tagmode-access-ingress:
51956 description: tagode for collector side of EVC
51957 tagmode-access-egress:
51959 description: tagMode for network side of EVC
51963 $ref: "#/getDefinitions/relationship"
51966 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51972 $ref: "#/getDefinitions/evc"
51975 Namespace for external system.
51979 $ref: "#/getDefinitions/esr-ems-list"
51982 $ref: "#/getDefinitions/esr-vnfm-list"
51983 esr-thirdparty-sdnc-list:
51985 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
51988 Extra properties for inventory item for response list
51993 $ref: "#/getDefinitions/extra-property"
52003 ###### Related Nodes
52004 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
52005 - FROM vserver( vserver Uses flavor, MANY2ONE)
52007 -FLAVOR cannot be deleted if related to VSERVER
52016 description: Flavor id, expected to be unique across cloud-region.
52019 description: Flavor name
52023 description: Number of CPUs
52027 description: Amount of memory
52031 description: Disk space
52035 description: Amount of ephemeral disk space
52038 description: amount of swap space allocation
52041 description: whether flavor is available to all users or private to the tenant it was created in.
52044 description: URL to endpoint where AAI can get more details
52047 description: Boolean as to whether this flavor is no longer enabled
52050 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52054 $ref: "#/getDefinitions/relationship"
52057 Collection of openstack flavors.
52062 $ref: "#/getDefinitions/flavor"
52065 Entity describing a sequenced segment of forwarding path
52066 ###### Related Nodes
52067 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
52068 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
52069 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
52070 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
52071 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
52073 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
52074 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
52081 description: Unique ID of this segmentation
52084 description: ingress, intermediate, egress
52088 $ref: "#/getDefinitions/relationship"
52091 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52094 forwarder object is an optional child object of the Configuration object.
52095 ###### Related Nodes
52096 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
52098 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
52104 description: Key for forwarder-evc object
52107 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
52110 description: Internal VLAN.
52113 description: SVLAN value for ingress of egress forwarder.
52116 description: CVLAN value for ingress of egress forwarder.
52120 $ref: "#/getDefinitions/relationship"
52123 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52129 $ref: "#/getDefinitions/forwarder-evc"
52135 $ref: "#/getDefinitions/forwarder"
52138 Entity that describes the sequenced forwarding path between interfaces of services or resources
52139 ###### Related Nodes
52140 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
52141 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
52142 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
52144 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
52145 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
52146 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
52148 - forwarding-path-id
52149 - forwarding-path-name
52151 forwarding-path-id:
52153 description: Unique ID of this FP
52154 forwarding-path-name:
52156 description: Name of the FP
52160 $ref: "#/getDefinitions/relationship"
52163 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52166 description: the self link for this FP
52170 $ref: "#/getDefinitions/forwarder"
52176 $ref: "#/getDefinitions/forwarding-path"
52179 General purpose VNF
52180 ###### Related Nodes
52181 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
52182 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
52183 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
52184 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
52185 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
52186 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
52187 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
52188 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
52189 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
52190 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
52191 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
52192 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
52193 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
52194 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
52195 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
52196 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
52197 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
52198 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
52199 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
52200 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
52201 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
52203 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
52209 - is-closed-loop-disabled
52213 description: Unique id of VNF. This is unique across the graph.
52216 description: Name of VNF.
52219 description: Alternate name of VNF.
52222 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.
52225 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
52226 regional-resource-zone:
52228 description: Regional way of organizing pservers, source of truth should define values
52231 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52232 operational-status:
52234 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
52237 description: OBSOLETE - do not use
52240 description: Client should send valid enumerated value
52241 orchestration-status:
52243 description: Orchestration status of this VNF, used by MSO.
52246 description: Heat stack id corresponding to this instance, managed by MSO
52249 description: Corresponds to the SDN-C catalog id used to configure this VCE
52252 description: identifier of managed by company or customer
52255 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
52256 ipv4-loopback0-address:
52258 description: v4 Loopback0 address
52261 description: v6 Loopback address
52262 management-v6-address:
52264 description: v6 management address
52268 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
52271 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
52275 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
52278 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
52282 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
52285 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
52288 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.
52289 is-closed-loop-disabled:
52291 description: used to indicate whether closed loop function is enabled on this node
52294 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52297 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
52298 encrypted-access-flag:
52300 description: indicates whether generic-vnf access uses SSH
52301 entitlement-assignment-group-uuid:
52303 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
52304 entitlement-resource-uuid:
52306 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
52307 license-assignment-group-uuid:
52309 description: UUID of the license assignment group. OBSOLETE - See child relationships.
52312 description: UUID of the actual license resource. OBSOLETE - See child relationships.
52313 model-invariant-id:
52315 description: the ASDC model id for this resource or service model.
52318 description: the ASDC model version for this resource or service model.
52319 persona-model-version:
52321 description: the ASDC model version for this resource or service model.
52322 model-customization-id:
52324 description: captures the id of all the configuration used to customize the resource for the service.
52327 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52328 widget-model-version:
52330 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52333 description: as-number of the VNF
52334 regional-resource-subzone:
52336 description: represents sub zone of the rr plane
52339 description: Generic description of the type of NF
52342 description: English description of Network function that the specific VNF deployment is providing
52345 description: role in the network that this model will be providing
52348 description: string assigned to this model used for naming purposes
52351 description: Path to the controller object.
52355 $ref: "#/getDefinitions/relationship"
52359 $ref: "#/getDefinitions/l-interface"
52363 $ref: "#/getDefinitions/lag-interface"
52367 $ref: "#/getDefinitions/vf-module"
52371 $ref: "#/getDefinitions/license"
52375 $ref: "#/getDefinitions/entitlement"
52383 $ref: "#/getDefinitions/generic-vnf"
52386 Openstack group-assignment used to store exclusivity groups (EG).
52387 ###### Related Nodes
52388 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
52389 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
52390 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
52399 description: Group id, expected to be unique across cloud-region.
52402 description: Group type - the type of group this instance refers to
52405 description: Group name - name assigned to the group
52408 description: Group description - description of the group
52411 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52415 $ref: "#/getDefinitions/relationship"
52418 Collection of openstack group assignments
52423 $ref: "#/getDefinitions/group-assignment"
52426 ###### Related Nodes
52427 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
52429 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
52437 description: host-route id
52440 description: subnet prefix
52443 description: Could be ip-address, hostname, or service-instance
52446 description: Should be ip-address, hostname, or service-instance to match next-hop
52449 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52453 $ref: "#/getDefinitions/relationship"
52459 $ref: "#/getDefinitions/host-route"
52462 Collection of HPA Capabilities
52467 $ref: "#/getDefinitions/hpa-capability"
52470 Represents a HPA capability
52471 ###### Related Nodes
52472 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
52473 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
52474 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
52476 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
52478 - hpa-capability-id
52483 description: UUID to uniquely identify a HPA capability
52486 description: Name of the HPACapability
52489 description: HPA schema version
52492 description: Hardware architecture
52495 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52499 $ref: "#/getDefinitions/relationship"
52500 hpa-feature-attributes:
52503 $ref: "#/getDefinitions/hpa-feature-attributes"
52504 hpa-feature-attributes:
52506 HPA Capability Feature attributes
52507 ###### Related Nodes
52508 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
52510 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
52512 - hpa-attribute-key
52516 description: name of the specific HPA attribute
52517 hpa-attribute-value:
52519 description: JSON string specifying the value, unit and type of the specific HPA attribute
52522 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52526 $ref: "#/getDefinitions/relationship"
52530 ###### Related Nodes
52531 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
52532 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
52533 - FROM vserver( vserver Uses image, MANY2ONE)
52535 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
52536 -IMAGE cannot be deleted if related to VSERVER
52547 description: Image id, expected to be unique across cloud region
52550 description: Image name
52551 image-architecture:
52553 description: Operating system architecture.
52556 description: The common name of the operating system distribution in lowercase
52559 description: The operating system version as specified by the distributor.
52562 description: The application that the image instantiates.
52563 application-vendor:
52565 description: The vendor of the application.
52566 application-version:
52568 description: The version of the application.
52571 description: URL to endpoint where AAI can get more details
52574 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52578 $ref: "#/getDefinitions/relationship"
52582 $ref: "#/getDefinitions/metadatum"
52585 Collectio of Openstack images.
52590 $ref: "#/getDefinitions/image"
52591 include-node-filter:
52597 InstanceFilter for performing a named-query or model query
52600 InstanceFilters for performing a named-query or model query
52605 $ref: "#/getDefinitions/instance-filter"
52608 General mechanism for grouping instances
52609 ###### Related Nodes
52610 - TO model( instance-group Targets model, MANY2MANY)
52611 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
52612 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
52613 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
52614 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
52615 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
52616 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
52617 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
52626 description: Instance Group ID, UUID assigned to this instance.
52629 description: Descriptive text to help identify the usage of this instance-group
52632 description: Only valid value today is lower case ha for high availability
52635 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
52638 description: Concurrency value
52642 $ref: "#/getDefinitions/relationship"
52645 Collection of openstack route table references
52650 $ref: "#/getDefinitions/instance-group"
52655 $ref: "#/getDefinitions/search"
52658 $ref: "#/getDefinitions/actions"
52659 cloud-infrastructure:
52661 $ref: "#/getDefinitions/cloud-infrastructure"
52664 $ref: "#/getDefinitions/business"
52665 service-design-and-creation:
52667 $ref: "#/getDefinitions/service-design-and-creation"
52670 $ref: "#/getDefinitions/network"
52673 $ref: "#/getDefinitions/nodes"
52676 inventory-item-type:
52678 inventory-item-link:
52680 inventory-item-data:
52683 $ref: "#/getDefinitions/inventory-item-data"
52684 tagged-inventory-item-list:
52687 $ref: "#/getDefinitions/tagged-inventory-item-list"
52688 inventory-item-data:
52694 inventory-response-item:
52696 Inventory item for response list
52702 $ref: "#/getDefinitions/extra-properties"
52703 inventory-response-items:
52705 $ref: "#/getDefinitions/inventory-response-items"
52706 inventory-response-items:
52708 Container for inventory items in response list
52710 inventory-response-item:
52713 $ref: "#/getDefinitions/inventory-response-item"
52714 ipsec-configuration:
52716 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
52717 ###### Related Nodes
52718 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
52719 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
52721 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
52723 - ipsec-configuration-id
52725 ipsec-configuration-id:
52727 description: UUID of this configuration
52728 requested-vig-address-type:
52730 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
52731 requested-encryption-strength:
52733 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
52734 requested-dmz-type:
52736 description: can offer a shared DMZ or a DMZ specific to a customer
52737 shared-dmz-network-address:
52739 description: Network address of shared DMZ
52740 requested-customer-name:
52742 description: If the DMZ is a custom DMZ, this field will indicate the customer information
52745 description: can be 1 or 2
52746 ikev1-authentication:
52748 description: Contains values like md5, sha1, sha256, sha384
52751 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
52754 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
52757 description: Group name defined in VIG for clients using aggressive mode
52760 description: pre-shared key for the above group name
52763 description: Lifetime for IKEv1 SA
52764 ipsec-authentication:
52766 description: md5, sha1, sha256, sha384
52769 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
52772 description: Life time for IPSec SA
52775 description: enable PFS or not
52778 description: user ID for xAuth, sm-user, ,nmteHostName
52779 xauth-user-password:
52781 description: Encrypted using the Juniper $9$ algorithm
52784 description: The time between DPD probe
52787 description: Maximum number of DPD before claiming the tunnel is down
52790 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52794 $ref: "#/getDefinitions/relationship"
52798 $ref: "#/getDefinitions/vig-server"
52799 ipsec-configurations:
52801 ipsec-configuration:
52804 $ref: "#/getDefinitions/ipsec-configuration"
52813 Logical interfaces, e.g., a vnic.
52814 ###### Related Nodes
52815 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
52816 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
52817 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
52818 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
52819 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
52820 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
52821 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
52822 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
52823 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
52824 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
52825 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
52826 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
52827 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
52829 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
52830 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
52831 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
52839 description: Name given to the interface
52842 description: E.g., CUSTOMER, UPLINK, etc.
52845 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
52848 description: URL to endpoint where AAI can get more details
52851 description: ID of interface
52854 description: MAC address for the interface
52857 description: Name of the network
52860 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
52861 interface-description:
52863 description: Human friendly text regarding this interface.
52866 description: boolean indicatating whether or not port is a mirrored.
52869 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52872 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52876 $ref: "#/getDefinitions/vlan"
52880 $ref: "#/getDefinitions/sriov-vf"
52884 $ref: "#/getDefinitions/l-interface"
52888 $ref: "#/getDefinitions/relationship"
52889 l3-interface-ipv4-address-list:
52892 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
52893 l3-interface-ipv6-address-list:
52896 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
52899 Collection of logical interfaces.
52904 $ref: "#/getDefinitions/l-interface"
52905 l3-interface-ipv4-address-list:
52908 ###### Related Nodes
52909 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
52910 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52911 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
52912 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
52913 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
52915 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
52917 - l3-interface-ipv4-address
52919 l3-interface-ipv4-address:
52921 description: IP address
52922 l3-interface-ipv4-prefix-length:
52925 description: Prefix length, 32 for single address
52929 description: Inner VLAN tag
52933 description: Outer VLAN tag
52936 description: Indicator of fixed or floating address
52939 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52940 neutron-network-id:
52942 description: Neutron network id of the interface that address belongs to
52945 description: Neutron id of subnet that address belongs to
52949 $ref: "#/getDefinitions/relationship"
52950 l3-interface-ipv6-address-list:
52953 ###### Related Nodes
52954 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
52955 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52956 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
52957 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
52958 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
52960 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
52962 - l3-interface-ipv6-address
52964 l3-interface-ipv6-address:
52966 description: IP address
52967 l3-interface-ipv6-prefix-length:
52970 description: Prefix length, 128 for single address
52974 description: Inner VLAN tag
52978 description: Outer VLAN tag
52981 description: Indicator of fixed or floating address
52984 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52985 neutron-network-id:
52987 description: Neutron network id of the interface that address belongs to
52990 description: Neutron id of subnet that address belongs to
52994 $ref: "#/getDefinitions/relationship"
52997 Generic network definition
52998 ###### Related Nodes
52999 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
53000 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
53001 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
53002 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
53003 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
53004 - FROM complex( complex Uses l3-network, MANY2MANY)
53005 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
53006 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
53007 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
53008 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
53009 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
53010 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
53011 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
53012 - FROM tenant( tenant Uses l3-network, MANY2MANY)
53013 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
53015 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
53020 - is-provider-network
53021 - is-shared-network
53022 - is-external-network
53026 description: Network ID, should be uuid. Unique across A&AI.
53029 description: Name of the network, governed by some naming convention..
53032 description: Type of the network - who defines these values?
53035 description: Role the network plans - who defines these values?
53036 network-technology:
53038 description: Network technology - who defines these values?
53039 neutron-network-id:
53041 description: Neutron network id of this Interface
53044 description: Set to true if bound to VPN
53047 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
53048 network-role-instance:
53051 description: network role instance
53054 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53055 orchestration-status:
53057 description: Orchestration status of this VNF, mastered by MSO
53060 description: Heat stack id corresponding to this instance, managed by MSO
53063 description: Corresponds to the SDN-C catalog id used to configure this VCE
53064 contrail-network-fqdn:
53066 description: Contrail FQDN for the network
53067 model-invariant-id:
53069 description: the ASDC model id for this resource or service model.
53072 description: the ASDC model version for this resource or service model.
53073 persona-model-version:
53075 description: the ASDC model version for this resource or service model.
53076 model-customization-id:
53078 description: captures the id of all the configuration used to customize the resource for the service.
53081 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53082 widget-model-version:
53084 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53085 physical-network-name:
53087 description: Name associated with the physical network.
53088 is-provider-network:
53090 description: boolean indicatating whether or not network is a provider network.
53093 description: boolean indicatating whether or not network is a shared network.
53094 is-external-network:
53096 description: boolean indicatating whether or not network is an external network.
53099 description: Path to the controller object.
53100 operational-status:
53102 description: Indicator for whether the resource is considered operational.
53106 $ref: "#/getDefinitions/subnet"
53110 $ref: "#/getDefinitions/ctag-assignment"
53111 segmentation-assignments:
53114 $ref: "#/getDefinitions/segmentation-assignment"
53118 $ref: "#/getDefinitions/relationship"
53119 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
53125 $ref: "#/getDefinitions/l3-network"
53128 Link aggregate interface
53129 ###### Related Nodes
53130 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
53131 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
53132 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
53133 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
53134 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
53135 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
53136 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
53137 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
53139 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
53140 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
53141 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
53148 description: Name that identifies the link aggregate interface
53149 interface-description:
53151 description: Human friendly text regarding this interface.
53154 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53157 description: Captures the numeric part of the speed
53160 description: Captures the units corresponding to the speed
53163 description: ID of interface
53166 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
53169 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53172 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
53176 $ref: "#/getDefinitions/relationship"
53180 $ref: "#/getDefinitions/l-interface"
53183 Collection of link aggregate interfaces.
53188 $ref: "#/getDefinitions/lag-interface"
53191 LAG links can connect lag-interfaces
53192 ###### Related Nodes
53193 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
53194 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
53196 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
53202 description: Alphabetical concatenation of lag-interface names
53205 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53209 $ref: "#/getDefinitions/relationship"
53212 Collection of link aggregation connections
53217 $ref: "#/getDefinitions/lag-link"
53220 Metadata for license group.
53221 ###### Related Nodes
53222 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
53223 - TO vce( license BelongsTo vce, MANY2ONE)(4)
53225 -(4) IF this TO node is deleted, this LICENSE is DELETED also
53232 description: Unique ID for the license group the resource belongs to, should be uuid.
53235 description: Unique ID of a license resource.
53238 description: Concurrency value
53242 $ref: "#/getDefinitions/relationship"
53245 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
53250 $ref: "#/getDefinitions/license"
53253 describes a line-of-business
53254 ###### Related Nodes
53255 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
53258 - line-of-business-name
53260 line-of-business-name:
53262 description: Name of the line-of-business (product)
53265 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53269 $ref: "#/getDefinitions/relationship"
53272 Collection of lines-of-business
53277 $ref: "#/getDefinitions/line-of-business"
53280 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
53281 ###### Related Nodes
53282 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
53283 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
53284 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
53285 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
53286 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
53287 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
53288 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
53289 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
53290 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
53291 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
53292 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
53293 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
53294 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
53295 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
53297 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
53304 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
53307 description: Type of logical link, e.g., evc
53310 description: Captures the numeric part of the speed
53313 description: Captures the units corresponding to the speed
53316 description: v4, v6, or ds for dual stack
53319 description: For example, static or BGP
53322 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53323 model-invariant-id:
53325 description: the ASDC model id for this resource or service model.
53328 description: the ASDC model version for this resource or service model.
53329 persona-model-version:
53331 description: the ASDC model version for this resource or service model.
53334 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53335 widget-model-version:
53337 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53338 operational-status:
53340 description: Indication of operational status of the logical link.
53343 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
53346 description: Indication of the network use of the logical link.
53349 description: Alias or alternate name (CLCI or D1 name).
53352 description: UUID of the logical-link, SDNC generates this.
53355 description: Circuit id
53358 description: Reason for this entity, role it is playing
53362 $ref: "#/getDefinitions/relationship"
53365 Collection of logical connections
53370 $ref: "#/getDefinitions/logical-link"
53373 Collection of metadatum (key/value pairs)
53378 $ref: "#/getDefinitions/metadatum"
53382 ###### Related Nodes
53383 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
53384 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
53385 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
53386 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
53388 -(4) IF this TO node is deleted, this METADATUM is DELETED also
53399 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53402 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
53403 ###### Related Nodes
53404 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
53405 - FROM instance-group( instance-group Targets model, MANY2MANY)
53406 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
53407 - FROM named-query( named-query AppliesTo model, ONE2MANY)
53408 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
53410 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
53411 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
53414 - model-invariant-id
53417 model-invariant-id:
53419 description: Unique identifier corresponding to the main definition of a model in ASDC
53422 description: Type of the model, e.g., service, resource, widget, etc.
53425 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53429 $ref: "#/getDefinitions/model-ver"
53433 $ref: "#/getDefinitions/relationship"
53434 model-and-named-query-search:
53436 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
53440 $ref: "#/getDefinitions/query-parameters"
53443 $ref: "#/getDefinitions/instance-filters"
53446 $ref: "#/getDefinitions/secondary-filts"
53449 secondary-filter-cut-point:
53453 This is how we would capture constraints defining allowed sets of elements.
53454 ###### Related Nodes
53455 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
53456 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
53458 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
53459 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
53461 - model-constraint-uuid
53462 - constrained-element-set-uuid-to-replace
53464 model-constraint-uuid:
53466 constrained-element-set-uuid-to-replace:
53468 constrained-element-sets:
53471 $ref: "#/getDefinitions/constrained-element-set"
53474 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53480 $ref: "#/getDefinitions/model-constraint"
53483 Defines how other models combine to make up a higher-level model.
53484 ###### Related Nodes
53485 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
53486 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
53487 - TO model-ver( model-element IsA model-ver, MANY2ONE)
53488 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
53489 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
53490 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
53491 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
53493 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
53494 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
53496 - model-element-uuid
53497 - new-data-del-flag
53500 model-element-uuid:
53504 description: Indicates whether this element was created as part of instantiation from this model
53507 description: How many of this type of element are required/allowed
53512 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53516 $ref: "#/getDefinitions/model-element"
53517 description: Defines how other models combine to make up a higher-level model
53521 $ref: "#/getDefinitions/model-constraint"
53522 description: Describes new constraints on this model element that are not part of that model's definition
53526 $ref: "#/getDefinitions/relationship"
53532 $ref: "#/getDefinitions/model-element"
53535 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
53536 ###### Related Nodes
53537 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
53538 - FROM model-element( model-element IsA model-ver, MANY2ONE)
53539 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
53540 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
53542 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
53543 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
53544 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
53553 description: Unique identifier corresponding to one version of a model in ASDC
53556 description: Name of the model, which can change from version to version.
53559 description: Version
53562 description: Description
53565 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53569 $ref: "#/getDefinitions/model-element"
53573 $ref: "#/getDefinitions/metadatum"
53577 $ref: "#/getDefinitions/relationship"
53583 $ref: "#/getDefinitions/model-ver"
53586 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
53591 $ref: "#/getDefinitions/model"
53592 multicast-configuration:
53594 ###### Related Nodes
53595 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
53598 - multicast-configuration-id
53599 - multicast-protocol
53602 multicast-configuration-id:
53604 description: Unique id of multicast configuration.
53605 multicast-protocol:
53607 description: protocol of multicast configuration
53610 description: rp type of multicast configuration
53613 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53617 $ref: "#/getDefinitions/relationship"
53618 multicast-configurations:
53620 multicast configuration of generic-vnf ip-address
53622 multicast-configuration:
53625 $ref: "#/getDefinitions/multicast-configuration"
53631 $ref: "#/getDefinitions/named-query"
53635 ###### Related Nodes
53636 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
53637 - TO model( named-query AppliesTo model, ONE2MANY)
53638 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
53640 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
53644 - named-query-version
53650 named-query-version:
53652 required-input-param:
53658 named-query-elements:
53661 $ref: "#/getDefinitions/named-query-element"
53665 $ref: "#/getDefinitions/relationship"
53666 named-query-element:
53669 ###### Related Nodes
53670 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
53671 - TO model( named-query-element IsA model, MANY2ONE)
53672 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
53673 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
53674 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
53675 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
53677 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
53678 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
53680 - named-query-element-uuid
53682 named-query-element-uuid:
53684 property-collect-list:
53688 property-limit-desc:
53692 named-query-elements:
53695 $ref: "#/getDefinitions/named-query-element"
53699 $ref: "#/getDefinitions/related-lookup"
53700 property-constraints:
53703 $ref: "#/getDefinitions/property-constraint"
53707 $ref: "#/getDefinitions/relationship"
53708 named-query-elements:
53710 named-query-element:
53713 $ref: "#/getDefinitions/named-query-element"
53716 Namespace for network inventory resources.
53721 $ref: "#/getDefinitions/logical-link"
53725 $ref: "#/getDefinitions/site-pair-set"
53729 $ref: "#/getDefinitions/vpn-binding"
53733 $ref: "#/getDefinitions/vpls-pe"
53734 multicast-configurations:
53737 $ref: "#/getDefinitions/multicast-configuration"
53741 $ref: "#/getDefinitions/vce"
53745 $ref: "#/getDefinitions/vnfc"
53749 $ref: "#/getDefinitions/l3-network"
53753 $ref: "#/getDefinitions/network-policy"
53757 $ref: "#/getDefinitions/generic-vnf"
53761 $ref: "#/getDefinitions/lag-link"
53765 $ref: "#/getDefinitions/newvce"
53769 $ref: "#/getDefinitions/pnf"
53773 $ref: "#/getDefinitions/physical-link"
53774 ipsec-configurations:
53777 $ref: "#/getDefinitions/ipsec-configuration"
53778 route-table-references:
53781 $ref: "#/getDefinitions/route-table-reference"
53785 $ref: "#/getDefinitions/instance-group"
53789 $ref: "#/getDefinitions/zone"
53795 $ref: "#/getDefinitions/network-policy"
53798 ###### Related Nodes
53799 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
53800 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
53803 - network-policy-id
53807 description: UUID representing unique key to this instance
53808 network-policy-fqdn:
53810 description: Contrail FQDN for the policy
53813 description: ID for the openStack Heat instance
53816 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53820 $ref: "#/getDefinitions/relationship"
53823 Network profile populated by SDN-GP for SNMP
53824 ###### Related Nodes
53825 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
53832 description: Unique name of network profile.
53835 description: Encrypted SNMP community string
53838 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53842 $ref: "#/getDefinitions/relationship"
53845 Collection of network profiles
53850 $ref: "#/getDefinitions/network-profile"
53853 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
53854 ###### Related Nodes
53855 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
53857 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
53865 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
53868 description: Name of VNF.
53871 description: Alternate name of VNF.
53874 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.
53877 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
53878 operational-status:
53880 description: Indicator for whether the resource is considered operational
53883 description: OBSOLETE - do not use
53886 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).
53889 description: Client should send valid enumerated value.
53892 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53893 ipv4-loopback0-address:
53895 description: v4 Loopback0 address
53896 orchestration-status:
53898 description: Orchestration status of this VNF, mastered by MSO.
53901 description: Heat stack id corresponding to this instance, managed by MSO
53904 description: Corresponds to the SDN-C catalog id used to configure this VCE
53908 $ref: "#/getDefinitions/relationship"
53912 $ref: "#/getDefinitions/l-interface"
53915 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
53920 $ref: "#/getDefinitions/newvce"
53923 inventory-item-data:
53926 $ref: "#/getDefinitions/inventory-item-data"
53927 notification-event:
53931 notification-event-header:
53933 $ref: "#/getDefinitions/notification-event-header"
53934 notification-event-header:
53975 $ref: "#/getDefinitions/key-data"
53980 OAM network, to be deprecated shortly. Do not use for new purposes.
53981 ###### Related Nodes
53982 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
53983 - TO complex( oam-network AppliesTo complex, MANY2MANY)
53984 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
53993 description: UUID of the network. Unique across a cloud-region
53996 description: Name of the network.
54000 description: cvlan-id
54001 ipv4-oam-gateway-address:
54003 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
54004 ipv4-oam-gateway-address-prefix-length:
54007 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
54010 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54014 $ref: "#/getDefinitions/relationship"
54017 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
54022 $ref: "#/getDefinitions/oam-network"
54023 operational-environment:
54025 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
54026 ###### Related Nodes
54027 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
54028 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
54031 - operational-environment-id
54032 - operational-environment-name
54033 - operational-environment-type
54034 - operational-environment-status
54038 operational-environment-id:
54040 description: UUID of an operational environment
54041 operational-environment-name:
54043 description: Operational Environment name
54044 operational-environment-type:
54046 description: Operational Environment Type.
54047 operational-environment-status:
54049 description: Status
54052 description: Tenant Context.
54055 description: Workload Context.
54058 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54062 $ref: "#/getDefinitions/relationship"
54063 operational-environments:
54065 a logical partition of the cloud which allows to have multiple environments in the production AIC.
54067 operational-environment:
54070 $ref: "#/getDefinitions/operational-environment"
54073 Allows for legacy POST of old-style and new-style models
54075 - model-invariant-id
54076 - model-name-version-id
54082 model-invariant-id:
54084 description: Unique identifier corresponding to the main definition of a model in ASDC
54085 model-name-version-id:
54087 description: Unique identifier corresponding to one version of a model in ASDC
54090 description: Type of the model, e.g., service, resource, widget, etc.
54093 description: Name of the model, which can change from version to version.
54096 description: Invariant unique ID which does not change from version to version
54099 description: Version
54102 description: Description
54105 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54108 $ref: "#/getDefinitions/model-vers"
54111 $ref: "#/getDefinitions/relationship-list"
54114 Collection of owning-entities
54119 $ref: "#/getDefinitions/owning-entity"
54122 describes an owning-entity
54123 ###### Related Nodes
54124 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
54128 - owning-entity-name
54132 description: UUID of an owning entity
54133 owning-entity-name:
54135 description: Owning entity name
54138 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54142 $ref: "#/getDefinitions/relationship"
54145 Physical interface (e.g., nic)
54146 ###### Related Nodes
54147 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
54148 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
54149 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
54150 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
54151 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
54152 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
54153 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
54155 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
54156 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
54157 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
54164 description: Name that identifies the physical interface
54167 description: Captures the numeric part of the speed
54170 description: Captures the units corresponding to the speed
54173 description: Nature of the services and connectivity on this port.
54174 equipment-identifier:
54176 description: CLEI or other specification for p-interface hardware.
54179 description: Role specification for p-interface hardware.
54182 description: Indicates the physical properties of the interface.
54185 description: Trigger for operational monitoring of this resource by Service Assurance systems.
54188 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54191 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
54195 $ref: "#/getDefinitions/relationship"
54199 $ref: "#/getDefinitions/l-interface"
54202 Collection of physical interfaces.
54207 $ref: "#/getDefinitions/p-interface"
54210 Collection of physical connections, typically between p-interfaces
54211 ###### Related Nodes
54212 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
54214 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
54220 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
54223 description: Captures the numeric part of the speed
54226 description: Captures the units corresponding to the speed
54229 description: Circuit it
54232 description: Dual access mode (e.g., primary, secondary
54235 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
54236 service-provider-name:
54238 description: Name of the service Provider on this link.
54241 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54245 $ref: "#/getDefinitions/relationship"
54248 Collection of physical connections, typically between p-interfaces
54253 $ref: "#/getDefinitions/physical-link"
54256 describes a platform
54257 ###### Related Nodes
54258 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
54265 description: Name of the platform
54268 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54272 $ref: "#/getDefinitions/relationship"
54275 Collection of platforms
54280 $ref: "#/getDefinitions/platform"
54283 PNF represents a physical network function. typically equipment used in the D1 world.
54284 ###### Related Nodes
54285 - TO complex( pnf LocatedIn complex, MANY2ONE)
54286 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
54287 - TO zone( pnf LocatedIn zone, MANY2ONE)
54288 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
54289 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
54290 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
54291 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
54293 -(1) IF this PNF node is deleted, this FROM node is DELETED also
54300 description: unique name of Physical Network Function.
54303 description: name of Physical Network Function.
54306 description: source of name2
54309 description: id of pnf
54312 description: Equipment type. Source of truth should define valid values.
54315 description: Equipment vendor. Source of truth should define valid values.
54318 description: Equipment model. Source of truth should define valid values.
54321 description: identifier of managed by company or customer
54324 description: ipv4-oam-address with new naming convention for IP addresses
54327 description: sw-version is the version of SW for the hosted application on the PNF.
54330 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.
54333 description: ID of the physical frame (relay rack) where pnf is installed.
54336 description: Serial number of the device
54337 ipaddress-v4-loopback-0:
54339 description: IPV4 Loopback 0 address
54340 ipaddress-v6-loopback-0:
54342 description: IPV6 Loopback 0 address
54345 description: IPV4 AIM address
54348 description: IPV6 AIM address
54351 description: IPV6 OAM address
54354 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
54357 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54360 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
54363 description: Nf Role is the role performed by this instance in the network.
54367 $ref: "#/getDefinitions/relationship"
54371 $ref: "#/getDefinitions/p-interface"
54375 $ref: "#/getDefinitions/lag-interface"
54378 Collection of Physical Network Functions.
54383 $ref: "#/getDefinitions/pnf"
54386 Used to capture the network interfaces of this VCE
54387 ###### Related Nodes
54388 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
54389 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
54391 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
54392 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
54395 - orchestration-status
54399 description: Unique ID of the interface
54400 neutron-network-id:
54402 description: Neutron network id of this Interface
54403 neutron-network-name:
54405 description: Neutron network name of this Interface
54408 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
54411 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54414 description: Unique ID for port group in vmware
54417 description: Likely to duplicate value of neutron network name
54420 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
54421 orchestration-status:
54423 description: Orchestration status of this VNF, mastered by MSO
54426 description: Heat stack id corresponding to this instance, managed by MSO
54429 description: Corresponds to the SDN-C catalog id used to configure this VCE
54433 $ref: "#/getDefinitions/cvlan-tag-entry"
54437 $ref: "#/getDefinitions/relationship"
54443 $ref: "#/getDefinitions/port-group"
54446 describes the project
54447 ###### Related Nodes
54448 - TO service-instance( project Uses service-instance, ONE2MANY)
54455 description: Name of the project deploying a service
54458 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54462 $ref: "#/getDefinitions/relationship"
54465 Collection of projects
54470 $ref: "#/getDefinitions/project"
54473 Property holder for query properties or instance properties
54479 property-constraint:
54482 ###### Related Nodes
54483 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
54485 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
54487 - property-constraint-uuid
54492 property-constraint-uuid:
54502 property-constraints:
54504 property-constraint:
54507 $ref: "#/getDefinitions/property-constraint"
54510 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
54511 ###### Related Nodes
54512 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
54513 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
54514 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
54515 - TO complex( pserver LocatedIn complex, MANY2ONE)
54516 - TO zone( pserver LocatedIn zone, MANY2ONE)
54517 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
54518 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
54519 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
54520 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
54521 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
54523 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
54524 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
54532 description: Value from executing hostname on the compute node.
54535 description: PTNII name
54539 description: Number of cpus
54543 description: Disk size, in GBs
54547 description: RAM size, in MBs
54550 description: Equipment type. Source of truth should define valid values.
54553 description: Equipment vendor. Source of truth should define valid values.
54556 description: Equipment model. Source of truth should define valid values.
54559 description: Fully-qualified domain name
54562 description: URL to endpoint where AAI can get more details
54565 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
54568 description: Serial number, may be queried
54569 ipaddress-v4-loopback-0:
54571 description: IPV4 Loopback 0 address
54572 ipaddress-v6-loopback-0:
54574 description: IPV6 Loopback 0 address
54577 description: IPV4 AIM address
54580 description: IPV6 AIM address
54583 description: IPV6 OAM address
54586 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
54589 description: ID of Pserver
54592 description: internet topology of Pserver
54595 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.
54598 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54601 description: alternative pserver name
54604 description: purpose of pserver
54607 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
54611 $ref: "#/getDefinitions/relationship"
54615 $ref: "#/getDefinitions/p-interface"
54619 $ref: "#/getDefinitions/lag-interface"
54622 Collection of compute hosts.
54627 $ref: "#/getDefinitions/pserver"
54630 QueryParameters for performing a named-query or model query
54634 $ref: "#/getDefinitions/named-query"
54637 $ref: "#/getDefinitions/overloaded-model"
54641 ###### Related Nodes
54642 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
54644 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
54646 - related-lookup-uuid
54648 - source-node-property
54650 - target-node-property
54652 related-lookup-uuid:
54656 source-node-property:
54660 target-node-property:
54662 property-collect-list:
54669 $ref: "#/getDefinitions/relationship"
54675 $ref: "#/getDefinitions/related-lookup"
54676 related-to-property:
54680 description: Key part of a key/value pair
54683 description: Value part of a key/value pair
54688 description: A keyword provided by A&AI to indicate type of node.
54691 description: URL to the object in A&AI.
54695 $ref: "#/getDefinitions/relationship-data"
54696 related-to-property:
54699 $ref: "#/getDefinitions/related-to-property"
54703 - relationship-value
54707 description: A keyword provided by A&AI to indicate an attribute.
54708 relationship-value:
54710 description: Value of the attribute.
54716 $ref: "#/getDefinitions/relationship"
54717 reserved-prop-names:
54719 Internal map to define some reserved properties of a vertex
54721 last-mod-source-of-truth:
54739 Response container for the results of a named-query or model query
54741 inventory-response-items:
54743 $ref: "#/getDefinitions/inventory-response-items"
54748 description: The specific type of node in the A&AI graph
54751 description: The URL to the specific resource
54752 route-table-reference:
54754 Openstack route table reference.
54755 ###### Related Nodes
54756 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
54759 - route-table-reference-id
54760 - route-table-reference-fqdn
54762 route-table-reference-id:
54764 description: Route Table Reference id, UUID assigned to this instance.
54765 route-table-reference-fqdn:
54767 description: FQDN entry in the route table.
54770 description: Concurrency value
54774 $ref: "#/getDefinitions/relationship"
54775 route-table-references:
54777 Collection of openstack route table references
54779 route-table-reference:
54782 $ref: "#/getDefinitions/route-table-reference"
54785 Route target information
54786 ###### Related Nodes
54787 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
54789 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
54791 - global-route-target
54792 - route-target-role
54794 global-route-target:
54796 description: Number used to identify an RT, globally unique in the network
54799 description: Role assigned to this route target
54802 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54806 $ref: "#/getDefinitions/relationship"
54809 Collection of route target information
54814 $ref: "#/getDefinitions/route-target"
54817 ###### Related Nodes
54818 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
54819 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
54821 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
54822 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
54824 - routing-instance-id
54826 routing-instance-id:
54828 description: Unique id of routing instance
54831 description: rpm owner
54834 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54838 $ref: "#/getDefinitions/site-pair"
54842 $ref: "#/getDefinitions/relationship"
54845 set of probes related to generic-vnf routing instance
54850 $ref: "#/getDefinitions/routing-instance"
54855 $ref: "#/getDefinitions/oam-networks"
54856 az-and-dvs-switches:
54859 $ref: "#/getDefinitions/az-and-dvs-switches"
54862 edge-tag-query-result:
54864 $ref: "#/getDefinitions/edge-tag-query-result"
54865 edge-tag-query-request:
54867 $ref: "#/getDefinitions/edge-tag-query-request"
54870 $ref: "#/getDefinitions/search-results"
54873 $ref: "#/getDefinitions/sdn-zone-response"
54879 $ref: "#/getDefinitions/result-data"
54882 SecondaryFilt for performing a named-query or model query
54893 SecondaryFilts for performing a named-query or model query
54898 $ref: "#/getDefinitions/secondary-filt"
54899 segmentation-assignment:
54901 Openstack segmentation assignment.
54902 ###### Related Nodes
54903 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
54905 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
54911 description: Route Table Reference id, UUID assigned to this instance.
54914 description: Concurrency value
54918 $ref: "#/getDefinitions/relationship"
54919 segmentation-assignments:
54921 Collection of openstack segmentation assignments
54923 segmentation-assignment:
54926 $ref: "#/getDefinitions/segmentation-assignment"
54929 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
54932 - service-description
54936 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
54937 service-description:
54939 description: Description of the service
54942 description: URL to endpoint where AAI can get more details
54945 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54948 description: service version
54952 $ref: "#/getDefinitions/relationship"
54953 service-capabilities:
54955 Collection of service capabilities.
54957 service-capability:
54960 $ref: "#/getDefinitions/service-capability"
54961 service-capability:
54963 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
54964 ###### Related Nodes
54965 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
54966 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
54968 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
54976 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
54979 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.
54982 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54986 $ref: "#/getDefinitions/relationship"
54987 service-design-and-creation:
54989 Namespace for objects managed by ASDC
54994 $ref: "#/getDefinitions/vnf-image"
54998 $ref: "#/getDefinitions/service"
54999 service-capabilities:
55002 $ref: "#/getDefinitions/service-capability"
55006 $ref: "#/getDefinitions/model"
55010 $ref: "#/getDefinitions/named-query"
55013 Instance of a service
55014 ###### Related Nodes
55015 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
55016 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
55017 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
55018 - TO connector( service-instance Uses connector, MANY2MANY)
55019 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
55020 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
55021 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
55022 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
55023 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
55024 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
55025 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
55026 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
55027 - TO vce( service-instance ComposedOf vce, ONE2MANY)
55028 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
55029 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
55030 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
55032 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
55033 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
55034 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
55036 - service-instance-id
55038 service-instance-id:
55040 description: Uniquely identifies this instance of a service
55041 service-instance-name:
55043 description: This field will store a name assigned to the service-instance.
55044 model-invariant-id:
55046 description: the ASDC model id for this resource or service model.
55049 description: the ASDC model version for this resource or service model.
55050 persona-model-version:
55052 description: the ASDC model version for this resource or service model.
55055 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55056 widget-model-version:
55058 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55061 description: Indicates the total bandwidth to be used for this service.
55064 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
55065 bandwidth-down-wan1:
55067 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
55070 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
55071 bandwidth-down-wan2:
55073 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
55076 description: URL customers will use to access the vHN Portal.
55077 service-instance-location-id:
55079 description: An identifier that customers assign to the location where this service is being used.
55082 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55085 description: Path to the controller object.
55086 orchestration-status:
55088 description: Orchestration status of this service.
55092 $ref: "#/getDefinitions/relationship"
55096 $ref: "#/getDefinitions/metadatum"
55097 allotted-resources:
55100 $ref: "#/getDefinitions/allotted-resource"
55103 Collection of service instances
55108 $ref: "#/getDefinitions/service-instance"
55109 service-subscription:
55111 Object that group service instances.
55112 ###### Related Nodes
55113 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
55114 - TO tenant( service-subscription Uses tenant, MANY2MANY)
55115 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
55117 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
55118 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
55124 description: Value defined by orchestration to identify this service across ECOMP.
55125 temp-ub-sub-account-id:
55127 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
55130 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55134 $ref: "#/getDefinitions/service-instance"
55138 $ref: "#/getDefinitions/relationship"
55139 service-subscriptions:
55141 Collection of objects that group service instances.
55143 service-subscription:
55146 $ref: "#/getDefinitions/service-subscription"
55149 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
55154 $ref: "#/getDefinitions/service"
55157 ###### Related Nodes
55158 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
55159 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
55161 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
55162 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
55168 description: unique identifier of probe
55171 description: Prefix address
55174 description: Prefix address
55177 description: ip version, v4, v6
55178 destination-hostname:
55180 description: Hostname of the destination equipment to which SLAs are measured against.
55181 destination-equip-type:
55183 description: The type of destinatination equipment. Could be Router, etc.
55186 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55187 classes-of-service:
55190 $ref: "#/getDefinitions/class-of-service"
55194 $ref: "#/getDefinitions/relationship"
55197 Set of instances for probes used to measure service level agreements
55198 ###### Related Nodes
55199 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
55200 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
55202 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
55208 description: Unique id of site pair set.
55211 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55215 $ref: "#/getDefinitions/routing-instance"
55219 $ref: "#/getDefinitions/relationship"
55222 Collection of sets of instances for probes related to generic-vnf
55227 $ref: "#/getDefinitions/site-pair-set"
55235 $ref: "#/getDefinitions/site-pair"
55239 ###### Related Nodes
55240 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
55241 - FROM vserver( vserver Uses snapshot, ONE2ONE)
55248 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
55251 description: Snapshot name
55252 snapshot-architecture:
55254 description: Operating system architecture
55255 snapshot-os-distro:
55257 description: The common name of the operating system distribution in lowercase
55258 snapshot-os-version:
55260 description: The operating system version as specified by the distributor.
55263 description: The application that the image instantiates.
55264 application-vendor:
55266 description: The vendor of the application.
55267 application-version:
55269 description: The version of the application.
55272 description: URL to endpoint where AAI can get more details
55275 description: This field contains the UUID of the previous snapshot (if any).
55278 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55282 $ref: "#/getDefinitions/relationship"
55285 Collection of openstack snapshots
55290 $ref: "#/getDefinitions/snapshot"
55293 SR-IOV Physical Function
55294 ###### Related Nodes
55295 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
55296 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
55298 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
55304 description: Identifier for the sriov-pf
55307 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55311 $ref: "#/getDefinitions/relationship"
55314 Collection of SR-IOV Physical Functions.
55319 $ref: "#/getDefinitions/sriov-pf"
55322 SR-IOV Virtual Function (not to be confused with virtual network function)
55323 ###### Related Nodes
55324 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
55326 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
55332 description: PCI ID used to identify the sriov-vf
55335 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
55338 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
55341 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
55342 vf-vlan-anti-spoof-check:
55344 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.
55345 vf-mac-anti-spoof-check:
55347 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.
55350 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
55351 vf-broadcast-allow:
55353 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
55354 vf-unknown-multicast-allow:
55356 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
55357 vf-unknown-unicast-allow:
55359 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
55362 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
55365 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
55368 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55369 neutron-network-id:
55371 description: Neutron network id of the interface
55375 $ref: "#/getDefinitions/relationship"
55378 Collection of SR-IOV Virtual Functions.
55383 $ref: "#/getDefinitions/sriov-vf"
55392 ###### Related Nodes
55393 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
55394 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
55395 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
55397 -(4) IF this TO node is deleted, this SUBNET is DELETED also
55398 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
55406 description: Subnet ID, should be UUID.
55409 description: Name associated with the subnet.
55412 description: Neutron id of this subnet
55415 description: gateway ip address
55416 network-start-address:
55418 description: network start address
55421 description: cidr mask
55424 description: ip version
55425 orchestration-status:
55427 description: Orchestration status of this VNF, mastered by MSO
55430 description: dhcp enabled
55433 description: the start address reserved for use by dhcp
55436 description: the last address reserved for use by dhcp
55439 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55443 $ref: "#/getDefinitions/relationship"
55449 $ref: "#/getDefinitions/subnet"
55450 tagged-inventory-item-list:
55455 $ref: "#/getDefinitions/inventory-item"
55459 ###### Related Nodes
55460 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
55461 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
55462 - TO l3-network( tenant Uses l3-network, MANY2MANY)
55463 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
55464 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
55465 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
55467 -TENANT cannot be deleted if related to VSERVER
55475 description: Unique id relative to the cloud-region.
55478 description: Readable name of tenant
55481 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55485 $ref: "#/getDefinitions/vserver"
55489 $ref: "#/getDefinitions/relationship"
55492 Collection of openstack tenants.
55497 $ref: "#/getDefinitions/tenant"
55500 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
55501 ###### Related Nodes
55502 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
55504 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
55507 - bandwidth-up-wan1
55508 - bandwidth-down-wan1
55509 - bandwidth-up-wan2
55510 - bandwidth-down-wan2
55514 description: Allotted Resource id UUID assigned to this instance.
55517 description: The WAN uplink bandwidth for WAN1
55518 bandwidth-down-wan1:
55520 description: The WAN downlink bandwidth for WAN1
55523 description: The WAN uplink bandwidth for WAN2
55524 bandwidth-down-wan2:
55526 description: The WAN downlink bandwidth for WAN2
55529 description: Concurrency value
55533 $ref: "#/getDefinitions/relationship"
55536 This object is used to store the specific tunnel cross connect aspects of an allotted resource
55541 $ref: "#/getDefinitions/tunnel-xconnect"
55544 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
55553 $ref: "#/getDefinitions/update-node-key"
55559 $ref: "#/getDefinitions/action"
55568 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
55569 ###### Related Nodes
55570 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
55571 - TO complex( vce LocatedIn complex, MANY2MANY)
55572 - TO vserver( vce HostedOn vserver, ONE2MANY)
55573 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
55574 - FROM license( license BelongsTo vce, MANY2ONE)(1)
55575 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
55576 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
55578 -(1) IF this VCE node is deleted, this FROM node is DELETED also
55586 description: Unique id of VNF. This is unique across the graph.
55589 description: Name of VNF.
55592 description: Alternate name of VNF.
55595 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.
55598 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
55599 regional-resource-zone:
55601 description: Regional way of organizing pservers, source of truth should define values
55604 description: Trigger for operational monitoring of this resource by Service Assurance systems.
55605 operational-status:
55607 description: Indicator for whether the resource is considered operational
55610 description: OBSOLETE - do not use
55613 description: Network role being played by this VNF
55614 orchestration-status:
55616 description: Orchestration status of this VNF, mastered by MSO
55619 description: Heat stack id corresponding to this instance, managed by MSO
55622 description: Corresponds to the SDN-C catalog id used to configure this VCE
55625 description: Unique ID of VPE connected to this VCE.
55626 v6-vce-wan-address:
55628 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
55631 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
55634 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55635 ipv4-loopback0-address:
55637 description: Loopback0 address
55638 entitlement-resource-uuid:
55640 description: OBSOLETE - see child relationships
55644 $ref: "#/getDefinitions/port-group"
55648 $ref: "#/getDefinitions/license"
55652 $ref: "#/getDefinitions/entitlement"
55656 $ref: "#/getDefinitions/relationship"
55659 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
55664 $ref: "#/getDefinitions/vce"
55667 a deployment unit of VNFCs
55668 ###### Related Nodes
55669 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
55670 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
55671 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
55672 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
55673 - TO vserver( vf-module Uses vserver, ONE2MANY)
55675 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
55676 -VF-MODULE cannot be deleted if related to VNFC
55680 - is-base-vf-module
55684 description: Unique ID of vf-module.
55687 description: Name of vf-module
55690 description: Heat stack id corresponding to this instance.
55691 orchestration-status:
55693 description: orchestration status of this vf-module, mastered by MSO
55696 description: used to indicate whether or not this object is base vf module
55699 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55700 model-invariant-id:
55702 description: the ASDC model id for this resource or service model.
55705 description: the ASDC model version for this resource or service model.
55706 persona-model-version:
55708 description: the ASDC model version for this resource or service model.
55709 model-customization-id:
55711 description: captures the id of all the configuration used to customize the resource for the service.
55714 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55715 widget-model-version:
55717 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55718 contrail-service-instance-fqdn:
55720 description: the Contrail unique ID for a service-instance
55724 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
55727 description: Path to the controller object.
55731 $ref: "#/getDefinitions/relationship"
55734 Collection of vf-modules, a deployment unit of VNFCs
55739 $ref: "#/getDefinitions/vf-module"
55742 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
55743 ###### Related Nodes
55744 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
55746 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
55752 description: indicates whether the VIG is for AVPN or INTERNET
55755 description: v4 IP of the vig server
55758 description: v6 IP of the vig server
55761 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55765 $ref: "#/getDefinitions/relationship"
55771 $ref: "#/getDefinitions/vig-server"
55772 vip-ipv4-address-list:
55775 ###### Related Nodes
55776 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
55777 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
55778 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
55779 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
55786 description: IP address
55787 vip-ipv4-prefix-length:
55790 description: Prefix length, 32 for single address
55794 description: Inner VLAN tag
55798 description: Outer VLAN tag
55801 description: Indicator of fixed or floating address
55804 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55805 neutron-network-id:
55807 description: Neutron network id of the interface that address belongs to
55810 description: Neutron id of subnet that address belongs to
55814 $ref: "#/getDefinitions/relationship"
55815 vip-ipv6-address-list:
55818 ###### Related Nodes
55819 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
55820 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
55821 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
55822 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
55829 description: IP address
55830 vip-ipv6-prefix-length:
55833 description: Prefix length, 128 for single address
55837 description: Inner VLAN tag
55841 description: Outer VLAN tag
55844 description: Indicator of fixed or floating address
55847 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55848 neutron-network-id:
55850 description: Neutron network id of the interface that address belongs to
55853 description: Neutron id of subnet that address belongs to
55857 $ref: "#/getDefinitions/relationship"
55858 virtual-data-center:
55860 Virtual organization of cloud infrastructure elements in a data center context
55861 ###### Related Nodes
55862 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
55863 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
55864 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
55872 description: Unique ID of the vdc
55875 description: Name of the virtual data center
55878 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55882 $ref: "#/getDefinitions/relationship"
55883 virtual-data-centers:
55885 Virtual organization of cloud infrastructure elements in a data center context
55887 virtual-data-center:
55890 $ref: "#/getDefinitions/virtual-data-center"
55894 ###### Related Nodes
55895 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
55896 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
55897 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
55898 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
55899 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
55900 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
55901 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
55903 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
55904 -(2) IF this VLAN node is deleted, this TO node is DELETED also
55905 -(4) IF this TO node is deleted, this VLAN is DELETED also
55912 description: String that identifies the interface
55916 description: Inner VLAN tag
55920 description: Outer VLAN tag
55923 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55926 description: Captures the numeric part of the speed
55929 description: Captures the units corresponding to the speed
55932 description: Used to describe (the service associated with) the vlan
55933 backdoor-connection:
55935 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
55938 description: This indicates the customers VPN ID associated with this vlan
55939 orchestration-status:
55941 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
55944 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
55948 $ref: "#/getDefinitions/relationship"
55949 l3-interface-ipv4-address-list:
55952 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
55953 l3-interface-ipv6-address-list:
55956 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
55962 $ref: "#/getDefinitions/vlan"
55971 description: Unique id of VNF. This is unique across the graph.
55974 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
55975 ###### Related Nodes
55976 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
55978 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
55983 - application-vendor
55987 description: Unique ID of this asset
55990 description: The application that the image instantiates.
55991 application-vendor:
55993 description: The vendor of the application.
55994 application-version:
55996 description: The version of the application.
55999 description: URL to endpoint where AAI can get more details
56002 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56006 $ref: "#/getDefinitions/relationship"
56009 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
56014 $ref: "#/getDefinitions/vnf-image"
56017 ###### Related Nodes
56018 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
56019 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
56020 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
56022 -(4) IF this TO node is deleted, this VNFC is DELETED also
56025 - vnfc-function-code
56028 - is-closed-loop-disabled
56032 description: Unique ID of vnfc.
56033 vnfc-function-code:
56035 description: function code
56041 description: prov status of this vnfc
56042 orchestration-status:
56044 description: Orchestration status of this VNF, mastered by APP-C
56045 ipaddress-v4-oam-vip:
56047 description: Oam V4 vip address of this vnfc
56050 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
56051 is-closed-loop-disabled:
56053 description: used to indicate whether closed loop function is enabled on this node
56056 description: Group notation of VNFC
56059 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56063 $ref: "#/getDefinitions/relationship"
56066 virtual network components associated with a vserver from application controller.
56071 $ref: "#/getDefinitions/vnfc"
56074 Ephemeral Block storage volume.
56075 ###### Related Nodes
56076 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
56078 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
56085 description: Unique ID of block storage volume relative to the vserver.
56088 description: URL to endpoint where AAI can get more details
56091 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56095 $ref: "#/getDefinitions/relationship"
56098 Persistent block-level storage.
56099 ###### Related Nodes
56100 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
56101 - TO complex( volume-group LocatedIn complex, MANY2ONE)
56102 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
56103 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
56104 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
56108 - volume-group-name
56113 description: Unique ID of volume-group.
56116 description: Name of the volume group.
56119 description: Heat stack id corresponding to this volume-group
56122 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.
56123 orchestration-status:
56125 description: Orchestration status of this volume-group
56126 model-customization-id:
56128 description: captures the id of all the configuration used to customize the resource for the service.
56129 vf-module-model-customization-id:
56131 description: helps relate the volume group to the vf-module whose components will require the volume group
56134 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56138 $ref: "#/getDefinitions/relationship"
56141 Collection of persistent block-level storage.
56146 $ref: "#/getDefinitions/volume-group"
56149 Collection of ephemeral Block storage volumes.
56154 $ref: "#/getDefinitions/volume"
56157 VPLS Provider Edge routers.
56158 ###### Related Nodes
56159 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
56160 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
56161 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
56162 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
56164 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
56172 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
56175 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).
56178 description: Client should send valid enumerated value, e.g., VPLS-PE.
56182 description: Temporary location for stag to get to VCE
56185 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56189 $ref: "#/getDefinitions/relationship"
56193 $ref: "#/getDefinitions/p-interface"
56197 $ref: "#/getDefinitions/lag-interface"
56200 Collection of VPLS Provider Edge routers
56205 $ref: "#/getDefinitions/vpls-pe"
56209 ###### Related Nodes
56210 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
56211 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
56212 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
56214 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
56215 -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
56223 description: VPN ID, globally unique within A&AI
56226 description: VPN Name
56229 description: the platform associated with the VPN example AVPN, Mobility
56232 description: Type of the vpn, should be taken from enumerated/valid values
56233 route-distinguisher:
56235 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
56238 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56242 $ref: "#/getDefinitions/route-target"
56246 $ref: "#/getDefinitions/relationship"
56247 description: l3-networks relate to vpn-bindings
56253 $ref: "#/getDefinitions/vpn-binding"
56256 Virtual Servers, aka virtual machine or VM.
56257 ###### Related Nodes
56258 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
56259 - TO flavor( vserver Uses flavor, MANY2ONE)
56260 - TO image( vserver Uses image, MANY2ONE)
56261 - TO pserver( vserver HostedOn pserver, MANY2ONE)
56262 - TO snapshot( vserver Uses snapshot, ONE2ONE)
56263 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
56264 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
56265 - FROM vce( vce HostedOn vserver, ONE2MANY)
56266 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
56267 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
56268 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
56270 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
56271 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
56277 - is-closed-loop-disabled
56281 description: Unique identifier for this vserver relative to its tenant
56284 description: Name of vserver
56287 description: Alternative name of vserver
56290 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56293 description: URL to endpoint where AAI can get more details
56296 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.
56297 is-closed-loop-disabled:
56299 description: Used to indicate whether closed loop function is enabled on this node
56302 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56306 $ref: "#/getDefinitions/volume"
56310 $ref: "#/getDefinitions/relationship"
56314 $ref: "#/getDefinitions/l-interface"
56317 Collection of virtual Servers, aka virtual machines or VMs.
56322 $ref: "#/getDefinitions/vserver"
56325 A zone is a grouping of assets in a location homing to the same connections into the CBB
56326 ###### Related Nodes
56327 - TO complex( zone LocatedIn complex, MANY2ONE)
56328 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
56329 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
56330 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
56340 description: Code assigned by AIC to the zone
56343 description: English name associated with the zone
56346 description: Design of zone [Medium/Large?]
56349 description: Context of zone [production/test]
56352 description: Status of a zone.
56355 description: Concurrency value
56359 $ref: "#/getDefinitions/relationship"
56362 Collection of zones
56367 $ref: "#/getDefinitions/zone"